The web view allows you to open an HTML5 based view which can load either local or remote content.
Use the Titanium.UI.createWebView method or <WebView> Alloy element to create a web view.
Web views are more expensive to create than other native views because of the requirement to load the HTML browser into memory.
The web view content can be any valid web content such as HTML, PDF, SVG or other WebKit supported content types.
JavaScript in the web view executes in its own context. The web view can interact with this content, but most of this functionality is limited to local content.
Local Scripts
When running local web content (that is, content that is included in the application's resources), scripts have access to the Titanium namespace. In particular, when running local web content:
You can use Titanium.App.addEventListener and Titanium.App.fireEvent to receive and send application-level events.
Events can be logged using the Titanium.API logging methods.
Remote Scripts
Scripts downloaded from remote web servers cannot access the Titanium namespace.
To interact with remote content, wait until the content is loaded, then use the evalJS method to execute a JavaScript expression inside the web view and retrieve the value of an expression.
During the build process for creating a package, all JavaScript files, that is, any file with a '.js' extension, are removed and their content is encrypted and obfuscated into one resource, causing these files to not load properly in a WebView if they are loaded externally.
For JavaScript files referenced in static local HTML files, these JavaScript files are omitted from processing and left intact, which means they can be correctly loaded in the WebView.
For local JavaScript files not referenced in static local HTML files, for example, a dynamically-generated HTML file referencing a local JavaScript file, rename the file extension of the local JavaScript files to '.jslocal' instead of '.js'.
The build process for testing your application on the simulator, emulator or device does not affect the loading of local JavaScript files.
On the iOS platform, the native web view handles scrolling and other related touch
events internally. If you add event listeners on the web view or its parent views
for any of the standard touch events (touchstart, click, and so on), these events
do not reach the native web view, and the user will not be able to scroll, zoom, click
on links, and so on. To prevent this default behavior, set
willHandleTouches to false.
In other words, you can have either Titanium-style events against the web view instance, or internal JavaScript events in the DOM, but not both.
Android 4.4 and Later Support
Starting with Android 4.4 (API Level 19), the WebView component is based off of Chromium, introducing a number of changes to its rendering engine. Web content may look or behave differently depending on the Android version. The WebView does not have full feature parity with Chrome for Android.
By default, the Chromium WebView uses hardware acceleration, which may cause content to fail to render. If the WebView fails to render the content, the web view will clear itself, displaying only the default background color. The following log messages will be displayed in the console:
[WARN] : AwContents: nativeOnDraw failed; clearing to background color.
[INFO] : chromium: [INFO:async_pixel_transfer_manager_android.cc(56)]
To workaround this issue, you can enable software rendering by setting the WebView's borderRadius property to a value greater than zero.
If you are developing local HTML content and size your elements using percentages, the WebView may not calculate the sizes correctly when hardware acceleration is enabled, resulting in the same behavior previously mentioned.
To workaround this issue, you can use the previously mentioned workaround to enable software
rendering, use absolute size values or use the
onresize event to set the
heights of the components. For example, if you have a div element with an id set to component
that needs to use the entire web view, the following callback resizes the content to use the
full height of the web view:
window.onresize= function(){
document.getElementById("component").style.height = window.innerHeight + 'px';
};
For more information, see the following topics:
Plugin Support
The Android web view supports native plugins such as Flash Player. Note that the Chromium-based web view introduced in Android 4.4 does not support the Flash Player plugin.
To use plugin content, you must set the pluginState property to either WEBVIEW_PLUGINS_ON or WEBVIEW_PLUGINS_ON_DEMAND.
You must also call pause when the current activity is paused, to prevent plugin content from continuing to run in the background. Call resume when the current activity is resumed. You can do this by adding listeners for the Activity.pause and Activity.resume events.
Accessing Cookies
On Android, the web view uses the system cookie store which does not share cookies with the Titanium.Network.HTTPClient cookie store. Developers can manage their cookies for both cookie stores using the methods Titanium.Network.addHTTPCookie, Titanium.Network.addSystemCookie, Titanium.Network.getHTTPCookies, Titanium.Network.getHTTPCookiesForDomain, Titanium.Network.getSystemCookies, Titanium.Network.removeHTTPCookie, Titanium.Network.removeHTTPCookiesForDomain, Titanium.Network.removeAllHTTPCookies, Titanium.Network.removeSystemCookie, Titanium.Network.removeAllSystemCookies.
See Integrating Web Content in the Titanium Mobile Guides for more information on using web views, including use cases, more code examples, and best practices for web view content.
Create a web view to a remote URL and open the window as modal.
var webview = Titanium.UI.createWebView({url:'http://www.appcelerator.com'});
var window = Titanium.UI.createWindow();
window.add(webview);
window.open({modal:true});
Previous example as an Alloy view.
<Alloy>
<Window id="win" modal="true">
<WebView id="webview" url="http://www.appcelerator.com" />
</Window>
</Alloy>
Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.
Requires: Android 4.0 and later iOS 5.0 and later
On iOS this is a direct analog of the accessibilityElementsHidden property defined in the
UIAccessibility
Protocol.
The native property is only available in iOS 5.0 and later; if
accessibilityHidden is specified on earlier versions of iOS, it is ignored.
On Android, setting accessibilityHidden calls the native
View.setImportantForAccessibility
method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and
later; if this property is specified on earlier versions of Android, it is ignored.
Default: false
Briefly describes what performing an action (such as a click) on the view will do.
On iOS this is a direct analog of the accessibilityHint property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityValue in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default:
A succint label identifying the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityLabel property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityValue and accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: Title or label of the control.
A string describing the value (if any) of the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityValue property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: State or value of the control.
A Boolean value that determines whether pressing on a link displays a preview of the destination for the link.
Requires: iOS 9.0 and later
This property is available on devices that support 3D Touch. Default value is false.
If you set this value to true for a web view, users (with devices that support 3D Touch)
can preview link destinations, and can preview detected data such as addresses, by pressing on links.
Such previews are known to users as peeks. If a user presses deeper, the preview navigates (or pops,
in user terminology) to the destination. Because pop navigation switches the user from your app to
Safari, it is opt-in, by way of this property, rather default behavior for this class.
Default: false
Coordinate of the view about which to pivot an animation.
Used on iOS only. For Android, use Titanium.UI.Animation.anchorPoint.
Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at
the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right
corner.
See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration.
Default: Center of this view.
Current position of the view during an animation.
Current position of the view during an animation.
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
Background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Transparent
Disabled background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view.
Disabled background image for the view, specified as a local file path or URL.
Default: If `backgroundDisabledImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is disabled.
Focused background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
For normal views, the focused color is only used if focusable is true.
Default: Same as the normal background color of this view.
Focused background image for the view, specified as a local file path or URL.
For normal views, the focused background is only used if focusable is true.
Default: If `backgroundFocusedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is focused.
A background gradient for the view.
A gradient can be defined as either linear or radial. A linear gradient varies continuously
along a line between the startPoint and endPoint.
A radial gradient is interpolated between two circles, defined by startPoint and
startRadius and endPoint and endRadius respectively.
The start and end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:
{ x: 30, y: 30 }
Or: { x: '50%', y: '50%' }
When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]
Android's linear gradients ignores backfillStart and backfillEnd, treating them as if
they are true. Android's radial gradients ignore the endPoint property.
The following code excerpt creates two views, one with a linear gradient and one with a radial gradient.
var win1 = Titanium.UI.createWindow({
title:'Tab 1',
backgroundColor:'#fff',
layout: 'vertical'
});
var radialGradient = Ti.UI.createView({
top: 10,
width: 100,
height: 100,
backgroundGradient: {
type: 'radial',
startPoint: { x: 50, y: 50 },
endPoint: { x: 50, y: 50 },
colors: [ 'red', 'blue'],
startRadius: 50,
endRadius: 0,
backfillStart: true
}
});
var linearGradient = Ti.UI.createView({
top: 10,
width: 100,
height: 100,
backgroundGradient: {
type: 'linear',
startPoint: { x: '0%', y: '50%' },
endPoint: { x: '100%', y: '50%' },
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],
}
});
win1.add(radialGradient);
win1.add(linearGradient);
win1.open();
Default: No gradient
Background image for the view, specified as a local file path or URL.
Default: Default behavior when `backgroundImage` is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, text fields, and so on), platform-specific default images are used.
Size of the left end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
Determines whether to tile a background across a view.
Setting this to true makes the set backgroundImage repeat across the view as a series
of tiles. The tiling begins in the upper-left corner, where the upper-left corner of the
background image is rendered. The image is then tiled to fill the available space of the
view.
Note that setting this to true may incur performance penalties for large views or
background images, as the tiling must be redone whenever a view is resized.
On iOS, the following views do not currently support tiled backgrounds:
Default: false
Selected background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
focusable must be true for normal views.
Default: Background color of this view.
Selected background image url for the view, specified as a local file path or URL.
For normal views, the selected background is only used if focusable is true.
Default: If `backgroundSelectedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is selected.
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
An array of url strings to blacklist.
An array of url strings to blacklist.
An array of url strings to blacklist. This will stop the webview from going to urls listed in the blacklist. Note, this only applies in the links clicked inside the webview. The first website that is loaded will not be stopped even if it matches the blacklist.
Border color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view (Android), black (iOS).
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Default: 0
Border width of the view.
If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.
Default: 0
View's bottom position, in platform-specific units.
View's bottom position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
Determines how a cache is used in this web view.
This API can be assigned the following constants:
Default: Titanium.UI.Android.WEBVIEW_LOAD_DEFAULT
View's center position, in the parent view's coordinates.
View's center position, in the parent view's coordinates.
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Array of this view's child views.
Array of this view's child views.
View's clipping behavior.
Setting this to Titanium.UI.iOS.CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to Titanium.UI.iOS.CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to Titanium.UI.iOS.CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.
Default: Undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.
Determines whether the view will bounce when scrolling to the edge of the scrollable region.
Set to true to disable the bounce effect.
Default: false
Determines whether or not the webview should not be able to display the context menu.
Set to true to disable the context menu. Note that disabling the context menu will
also disable the text selection on iOS.
Default: false
Base elevation of the view relative to its parent in pixels.
Requires: Android 5 and later
The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.
Note: The elevation property only works on Titanium.UI.View objects.
Many Android components have a default elevation that cannot be modified.
For more information, see
Google design guidelines: Elevation and shadows.
Enable adding javascript interfaces internally to webview prior to JELLY_BEAN_MR1 (Android 4.2)
This property is introduced to prevent a security issue with older devices (< JELLY_BEAN_MR1)
Default: true
If true, zoom controls are enabled.
Default: true
Whether view should be focusable while navigating with the trackball.
Default: false
Lets the webview handle platform supported urls
By default any urls that are not handled by the Titanium platform but can be handled by the
shared application are automatically sent to the shared application and the webview does not
open these. When this property is set to true the webview will attempt to handle these
urls and they will not be sent to the shared application. An example is links to telephone
numbers.
Default: undefined. Behaves as if false
View height, in platform-specific units.
View height, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
SIZE or
FILL constants if it is necessary to set the view's behavior explicitly.This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.
This API can be assigned the following constants:
Hides activity indicator when loading remote URL.
Default: false
Determines whether the layout has wrapping behavior.
For more information, see the discussion of horizontal layout mode in the description of the layout property.
Default: true
Controls whether to ignore invalid SSL certificates or not.
If set to true, the web page loads despite having an invalid SSL certificate.
If set to false, a web page with an invalid SSL certificate does not load.
iOS Note: As soon as you set this property to true, iOS will cache the response
for the lifetime of the current web view.
Default: undefined but behaves as false
Determines whether to keep the device screen on.
When true the screen will not power down. Note: enabling this feature will use more
power, thereby adversely affecting run time when on battery.
Default: false
A Boolean value indicating whether web content can programmatically display the keyboard.
When this property is set to true, the user must explicitly tap the elements in the web view to display the keyboard (or other relevant input view) for that element. When set to false, a focus event on an element causes the input view to be displayed and associated with that element automatically.
Default: undefined but behaves as true
Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.
There are three layout options:
composite (or absolute). Default layout. A child view is positioned based on its
positioning properties or "pins" (top, bottom, left, right and center).
If no positioning properties are specified, the child is centered.
The child is always sized based on its width and height properties, if these are
specified. If the child's height or width is not specified explicitly, it may be
calculated implicitly from the positioning properties. For example, if both left and
center.x are specified, they can be used to calculate the width of the child control.
Because the size and position properties can conflict, there is a specific precedence
order for the layout properties. For vertical positioning, the precedence
order is: height, top, center.y, bottom.
The following table summarizes the various combinations of properties that can
be used for vertical positioning, in order from highest precedence to lowest.
(For example, if height, center.y and bottom are all specified, the
height and center.y values take precedence.)
| Scenario | Behavior |
|---|---|
| `height` & `top` specified | Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored. |
| `height` & `center.y` specified | Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored. |
| `height` & `bottom` specified | Child positioned `bottom` units from parent's bottom, using specified `height`. |
| `top` & `center.y` specified | Child positioned with top edge `top` units from parent's top and center at `center.y`. Height is determined implicitly; any `bottom` value is ignored. |
| `top` & `bottom` specified | Child positioned with top edge `top` units from parent's top and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. |
| Only `top` specified | Child positioned `top` units from parent's top, and uses the default height calculation for the view type. |
| `center.y` and `bottom` specified | Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. |
| Only `center.y` specified | Child positioned with center at `center.y`, and uses the default height calculation for the view type. |
| Only `bottom` specified | Child positioned with bottom edge `bottom` units from parent's bottom, and uses the default height calculation for the view type. |
| `height`, `top`, `center.y`, and `bottom` unspecified | Child centered vertically in the parent and uses the default height calculation for the child view type. |
Horizontal positioning works like vertical positioning, except that the
precedence is width, left, center.x, right.
For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.
vertical. Children are laid out vertically from top to bottom. The first child
is laid out top units from its parent's bounding box. Each subsequent child is
laid out below the previous child. The space between children is equal to the
upper child's bottom value plus the lower child's top value.Each child is positioned horizontally as in the composite layout mode.
horizontal. Horizontal layouts have different behavior depending on whether wrapping
is enabled. Wrapping is enabled by default (the horizontalWrap property is true).With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.
Wrapping behavior is available on iOS and Android (Release 2.1.0 and later).
When the horizontalWrap property is set to true, the first row is placed at the top of the
parent view, and successive rows are placed below the first row. Each child is
positioned vertically within its row somewhat like composite layout mode.
In particular:
top or bottom is specified, the child is centered in the
row.top or bottom is specified, the child is aligned to either
the top or bottom of the row, with the specified amount of padding.top and bottom is specified for a given child, the properties
are both treated as padding.If the horizontalWrap property is false, the behavior is more equivalent to a vertical layout.
Children are laid or horizontally from left to right in a single row. The left and
right properties are used as padding between the children, and the top and bottom
properties are used to position the children vertically.
On Android and iOS prior to Release
2.1.0, the horizontal layout always wraps and the horizontalWrap property is not supported.
Default: Composite layout
View's left position, in platform-specific units.
View's left position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
Enables using light touches to make a selection and activate mouseovers.
Setting this property solves the problem of web links with specific length not triggering a link click in Android.
This is only an Android specific property and has no effect starting from API level 18.
This flag is true by default to retain backwards compatibility with previous
behavior.
Default: true
Indicates if the webview is loading content.
Indicates if the webview is loading content.
Callback function called when there is a request for the application to create a new window to host new content.
Callback function called when there is a request for the application to create a new window to host new content.
For example, the request is triggered if a web page wants to open a URL in a new window. By default, Titanium will open a new full-size window to host the new content. Use the callback to override the default behavior.
The callback needs to create a new WebView object to host the content in and add the WebView to the
application UI. The callback must return either a WebView object to host the content in or null if
it does not wish to handle the request.
The callback is passed a dictionary with two boolean properties:
isDialog: set to true if the content should be opened in a dialog window rather than a
full-size window.isUserGesture: set to true if the user initiated the request with a gesture, such as
tapping a link.The following example opens new web content in a new tab rather than a new window:
var tabGroup = Ti.UI.createTabGroup(),
win = Ti.UI.createWindow(),
tab = Ti.UI.createTab({window: win, title: 'Start Page'}),
webview = Ti.UI.createWebView({ url:'index.html'});
webview.onCreateWindow = function(e) {
var newWin = Ti.UI.createWindow(),
newWebView = Ti.UI.createWebView(),
newTab = Ti.UI.createTab({window: newWin, title: 'New Page'});
newWin.add(newWebView);
tabGroup.addTab(newTab);
return newWebView;
};
win.add(webview);
tabGroup.addTab(tab);
tabGroup.open();
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).
Default: 1.0 (opaque)
Determines the behavior when the user overscrolls the view.
This API can be assigned the following constants:
Default: Titanium.UI.Android.OVER_SCROLL_ALWAYS
When on, animate call overrides current animation if applicable.
If this property is set to false, the animate call is ignored if the view is currently being animated.
Default: undefined but behaves as false
Determines how to treat content that requires plugins in this web view.
Requires: Android 2.2 and later
This setting affects the loading of content that requires web plugins, such as Flash Player.
To use the Flash Player plugin, hardware acceleration must be enabled for your
application. To enable hardware acceleration, add the tool-api-level and
manifest elements shown below inside the android element in your tiapp.xml file.
<android xmlns:android="http://schemas.android.com/apk/res/android">
<tool-api-level>11</tool-api-level>
<manifest>
<application android:hardwareAccelerated="true"/>
</manifest>
</android>
See Android documentation for WebSettings.PluginState.
This property only works on Android devices at API Level 8 or greater.
This API can be assigned the following constants:
Default: Titanium.UI.Android.WEBVIEW_PLUGINS_OFF
The preview context used in the 3D-Touch feature "Peek and Pop".
Requires: iOS 9.0 and later
Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.
Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.
Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.
Default: Undefined. Results in a light grey background color on the wrapper view.
The bounding box of the view relative to its parent, in system units.
The bounding box of the view relative to its parent, in system units.
The view's bounding box is defined by its size and position.
The view's size is rect.width x rect.height. The view's top-left position relative to
its parent is (rect.x , rect.y).
On Android it will also return rect.absoluteX and 'rect.absoluteY' which are relative to
the main window.
The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.
Sets extra request headers for this web view to use on subsequent URL requests.
Sets extra request headers for this web view to use on subsequent URL requests.
Setting this property allows you to set custom headers to the URL requests.
The parameter will be key-value pairs: {"Custom-field1":"value1", "Custom-field2":"value2"}
On Android you should avoid Calling setRequestHeaders() right after createWebView(). Use the requestHeaders property
inside createWebView() or put it inside the window open event.
View's right position, in platform-specific units.
View's right position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Clockwise 2D rotation of the view in degrees.
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (x-axis).
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (y-axis).
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
Scaling of the view in x-axis in pixels.
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
Scaling of the view in y-axis in pixels.
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
If true, scale contents to fit the web view.
On iOS, setting this to true sets the initial zoom level to show the entire
page, and enables the user to zoom the web view in and out. Setting this to
false prevents the user from zooming the web view.
On Android, only controls the initial zoom level.
Default: `false` on iOS. On Android, `false` when content is specified as a local URL, `true` for any other kind of content (remote URL, `Blob`, or `File`).
Controls whether the scroll-to-top gesture is effective.
The scroll-to-top gesture is a tap on the status bar; The default value of this property is true. This gesture works when you have a single visible web view. If there are multiple table views, web views, text areas, and/or scroll views visible, you will need to disable (set to false) on the above views you DON'T want this behaviour on. The remaining view will then respond to scroll-to-top gesture.
Default: true
The size of the view in system units.
The size of the view in system units.
Although property returns a Dimension dictionary, only the width and height
properties are valid. The position properties--x and y--are always 0.
To find the position and size of the view, use the rect property instead.
The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.
Determines keyboard behavior when this view is focused.
This API can be assigned the following constants:
Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
The view's tintColor. This property is applicable on iOS 7 and greater.
Requires: iOS 7.0 and later
This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.
Default:
The view's top position.
The view's top position.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Determines whether view should receive touch events.
If false, will forward the events to peers.
Default: true
A material design visual construct that provides an instantaneous visual confirmation of touch point.
Requires: Android 5.0 and later
This is an opt-in feature available from Android Lollipop. Touch feedback is applied only if the backgroundColor is a solid color.
Default: false
Optional touch feedback ripple color. This has no effect unless touchFeedback is true.
Requires: Android 5.0 and later
Default: Theme provided color.
Transformation matrix to apply to the view.
Android only supports 2DMatrix transforms.
Default: Identity matrix
A name to identify this view in activity transition.
Requires: Android 5 and later
Name should be unique in the View hierarchy.
Horizontal location of the view relative to its left position in pixels.
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
Vertical location of the view relative to its top position in pixels.
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
Depth of the view relative to its elevation in pixels.
Requires: Android 5 and later
Translation values are applied to the static post layout value.
The User-Agent header used by the web view when requesting content.
On the iOS platform, this is not per-webview. Once you have set this property for a webview it will not change for same. But while creating new webview it can be changed to new user agent.
Default: System default user-agent value.
Determines the color of the shadow.
Default: Undefined. Behaves as if transparent.
Determines the offset for the shadow of the view.
Default: Undefined. Behaves as if set to (0,-3)
Determines the blur radius used to create the shadow.
Default: Undefined. Behaves as if set to 3.
Determines whether the view is visible.
Default: true
View's width, in platform-specific units.
View's width, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
SIZE or
FILL constants if it is necessary to set the view's behavior explicitly.This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.
This API can be assigned the following constants:
Explicitly specifies if this web view handles touches.
On the iOS platform, if this web view or any of its parent views have touch listeners, the Titanium component intercepts all touch events. This prevents the user from interacting with the native web view components.
Set this flag to false to disable the default behavior. Setting this property to false
allows the user to interact with the native web view and still honor any touch events sent to
its parents. No touch events will be generated when the user interacts with the web view itself.
Set this flag to true if you want to receive touch events from the web view and
the user does not need to interact with the web content directly.
This flag is true by default to retain backwards compatibility with previous
behavior.
Default: true
Z-index stack order position, relative to other sibling views.
Z-index stack order position, relative to other sibling views.
A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Animates this view.
The Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.
Note that if you use animate to move a view, the view's actual position is changed, but
its layout properties, such as top, left, center and so on are not changed--these
reflect the original values set by the user, not the actual position of the view.
The rect property can be used to determine the actual size and position of the view.
Either a dictionary of animation properties or an Animation object.
Function to be invoked upon completion of the animation.
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
A dictionary of properties to apply.
Returns true if the web view can go back in its history list.
Returns true if the web view can go forward in its history list.
Translates a point from this view's coordinate system to another view's coordinate system.
Returns null if either view is not in the view hierarchy.
Keep in mind that views may be removed from the view hierarchy if their window is blurred or if the view is offscreen (such as in some situations with Titanium.UI.ScrollableView).
If this view is a Titanium.UI.ScrollView, the view's x and y offsets are subtracted from the return value.
A point in this view's coordinate system.
If this argument is missing an x or y property, or the properties can not be
converted into numbers, an exception will be raised.
View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.
Evaluates a JavaScript expression inside the context of the web view and optionally, returns a result.
The JavaScript expression must be passed in as a string. If you are passing in any objects, you must serialize them to strings using stringify.
The evalJS method returns a string representing the value of the expression. For
example, the following call retrieves the document.title element from the
document currently loaded into the web view.
var docTitle = myWebView.evalJS('document.title');
It is not necessary to include return in the JavaScript. In fact, the following
call returns the empty string:
myWebView.evalJS('return document.title');
JavaScript code as a string. The code will be evaluated inside the web view context.
Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
Since the layout pass scheduled is asynchronous, the rect
and size values may not be available immediately after
finishLayout is called.
To be notified when the layout pass completes, add a listener for the postlayout event.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Returns the matching view of a given view ID.
The ID of the view that should be returned. Use the id property in your views to
enable it for indexing in this method.
Goes back one entry in the web view's history list, to the previous page.
Goes forward one entry in this web view's history list, if possible.
Hides this view.
Animation options for Android. Since Release 5.1.0.
Inserts a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
Pass an object with the following key-value pairs:
view (Titanium.UI.View): View to insertposition (Number): Position in the children array to
insert the view. If omitted, inserts the view to the end of the array.Pauses native webview plugins.
Add a pause handler to your Titanium.Android.Activity and invoke
this method to pause native plugins. This is important with Flash content
as it will continue in the background unless this method is invoked.
Call resume to unpause native plugins.
Releases memory when the web view is no longer needed.
Removes a child view from this view's hierarchy.
View to remove from this view's hierarchy.
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Forces the web view to repaint its contents.
Replaces a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
Pass an object with the following key-value pairs:
view (Titanium.UI.View): View to insertposition (Number): Position in the children array of
the view elment to replace.Resume native webview plugins.
Used to unpause native plugins after calling pause.
Add a resume handler to your Titanium.Android.Activity and invoke
this method to resume native plugins.
Sets the value of the accessibilityHidden property.
New value for the property.
Sets the value of the accessibilityHint property.
New value for the property.
Sets the value of the accessibilityLabel property.
New value for the property.
Sets the value of the accessibilityValue property.
New value for the property.
Sets the value of the allowsLinkPreview property.
New value for the property.
Sets the value of the anchorPoint property.
New value for the property.
Sets the value of the backgroundColor property.
New value for the property.
Sets the value of the backgroundDisabledColor property.
New value for the property.
Sets the value of the backgroundDisabledImage property.
New value for the property.
Sets the value of the backgroundFocusedColor property.
New value for the property.
Sets the value of the backgroundFocusedImage property.
New value for the property.
Sets the value of the backgroundGradient property.
New value for the property.
Sets the value of the backgroundImage property.
New value for the property.
Sets the value of the backgroundLeftCap property.
New value for the property.
Sets the value of the backgroundRepeat property.
New value for the property.
Sets the value of the backgroundSelectedColor property.
New value for the property.
Sets the value of the backgroundSelectedImage property.
New value for the property.
Sets the value of the backgroundTopCap property.
New value for the property.
Sets the basic authentication for this web view to use on subsequent URl requests.
Basic auth username.
Basic auth password.
Sets the value of the blacklistedURLs property.
New value for the property.
Sets the value of the borderColor property.
New value for the property.
Sets the value of the borderRadius property.
New value for the property.
Sets the value of the borderWidth property.
New value for the property.
Sets the value of the bottom property.
New value for the property.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the cacheMode property.
New value for the property.
Sets the value of the clipMode property.
New value for the property.
Sets the value of the data property.
New value for the property.
Sets the value of the disableBounce property.
New value for the property.
Sets the value of the disableContextMenu property.
New value for the property.
Sets the value of the elevation property.
New value for the property.
Sets the value of the enableJavascriptInterface property.
New value for the property.
Sets the value of the enableZoomControls property.
New value for the property.
Sets the value of the focusable property.
New value for the property.
Sets the value of the handlePlatformUrl property.
New value for the property.
Sets the value of the height property.
New value for the property.
Sets the value of the hiddenBehavior property.
New value for the property.
Sets the value of the hideLoadIndicator property.
New value for the property.
Sets the value of the horizontalWrap property.
New value for the property.
Sets the value of the ignoreSslError property.
New value for the property.
Sets the value of the keepScreenOn property.
New value for the property.
Sets the value of the keyboardDisplayRequiresUserAction property.
New value for the property.
Sets the value of the layout property.
New value for the property.
Sets the value of the left property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the lightTouchEnabled property.
New value for the property.
Sets the value of the loading property.
New value for the property.
Sets the value of the onCreateWindow property.
New value for the property.
Sets the value of the opacity property.
New value for the property.
Sets the value of the overScrollMode property.
New value for the property.
Sets the value of the overrideCurrentAnimation property.
New value for the property.
Sets the value of the pluginState property.
New value for the property.
Sets the value of the previewContext property.
New value for the property.
Sets the value of the pullBackgroundColor property.
New value for the property.
Sets the value of the requestHeaders property.
New value for the property.
Sets the value of the right property.
New value for the property.
Sets the value of the rotation property.
New value for the property.
Sets the value of the rotationX property.
New value for the property.
Sets the value of the rotationY property.
New value for the property.
Sets the value of the scaleX property.
New value for the property.
Sets the value of the scaleY property.
New value for the property.
Sets the value of the scalesPageToFit property.
New value for the property.
Sets the value of the scrollsToTop property.
New value for the property.
Sets the value of the softKeyboardOnFocus property.
New value for the property.
Sets the value of the tintColor property.
New value for the property.
Sets the value of the top property.
New value for the property.
Sets the value of the touchEnabled property.
New value for the property.
Sets the value of the touchFeedback property.
New value for the property.
Sets the value of the touchFeedbackColor property.
New value for the property.
Sets the value of the transform property.
New value for the property.
Sets the value of the transitionName property.
New value for the property.
Sets the value of the translationX property.
New value for the property.
Sets the value of the translationY property.
New value for the property.
Sets the value of the translationZ property.
New value for the property.
Sets the value of the userAgent property.
New value for the property.
Sets the value of the viewShadowColor property.
New value for the property.
Sets the value of the viewShadowOffset property.
New value for the property.
Sets the value of the viewShadowRadius property.
New value for the property.
Sets the value of the visible property.
New value for the property.
Sets the value of the width property.
New value for the property.
Sets the value of the willHandleTouches property.
New value for the property.
Sets the value of the zIndex property.
New value for the property.
Makes this view visible.
Animation options for Android. Since Release 5.1.0.
Starts a batch update of this view's layout properties.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
To prevent a layout pass each time a property is modified, call startLayout before
changing any properties that may change this view's layout. This initiates a batch update
mode where layout changes are deferred.
Call finishLayout to end batch update mode and trigger a layout pass. For example:
view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();
Note that any property changes made during the batch update may be deferred until
finishLayout is called. This may vary somewhat by platform. For example, changing the
text of a label may trigger a layout pass. In iOS, updating the label text is
deferred.
See also: updateLayout, finishLayout, postlayout event.
Stops loading a currently loading page.
Returns an image of the rendered view, as a Blob.
The honorScaleFactor method is only supported on iOS.
Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
Determines whether the image is scaled based on scale factor of main screen. (iOS only)
When set to true, image is scale factor is honored. When set to false, the image in the blob has the same dimensions for retina and non-retina devices.
Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
This is another way to perform a batch update. The updateLayout method is called with a
dictionary of layout properties to perform the batch update. For example:
view.updateLayout({top:50, left:50});
This is equivalent to the following:
view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();
See also: startLayout, finishLayout, postlayout event.
Layout properties to be updated.
Fired before the web view starts loading its content.
This event may fire multiple times depending on the content or URL. For example, if you set the URL of the web view to a URL that redirects to another URL, such as an HTTP URL redirecting to an HTTPS URL, this event is fired for the original URL and the redirect URL.
This event does not fire when navigating remote web pages.
URL of the web document being loaded.
Constant indicating the user's action.
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a blacklisted URL is stopped.
The URL of the web document that is stopped.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a click against the view.
There is a subtle difference between singletap and click events.
A singletap event is generated when the user taps the screen briefly without moving their finger. This gesture will also generate a click event.
However, a click event can also be generated when the user touches, moves their finger, and then removes it from the screen.
On Android, a click event can also be generated by a trackball click.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a double click against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a double tap against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the web view cannot load the content.
The errorCode value refers to one of the Titanium.UI URL_ERROR constants or, if it does not
match one of those constants, it refers to a platform-specific constant. The platform-specific
values are underlying iOS NSURLError*
or Android WebViewClient ERROR_* constants.
Indicates a successful operation. Returns false.
Error message, if any returned. May be undefined.
Error code. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.
This API can be assigned the following constants:
URL of the web document.
Error message. Use error instead.
A constant or underlying platform specific error code. Use code instead.
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the view element gains focus.
This event only fires when using the trackball to navigate.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a hardware key is pressed in the view.
A keypressed event is generated by pressing a hardware key. On Android, this event can only be fired when the property focusable is set to true. On iOS the event is generated only when using Ti.UI.TextArea, Ti.UI.TextField and Ti.UI.SearchBar.
The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the web view content is loaded.
URL of the web document.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a long click.
A long click is generated by touching and holding on the touchscreen or holding down the trackball button.
The event occurs before the finger/button is lifted.
A longpress and a longclick can occur together.
As the trackball can fire this event, it is not intended to return the x and y
coordinates of the touch, even when it is generated by the touchscreen.
A longclick blocks a click, meaning that a click event will not fire when a
longclick listener exists.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a long press.
A long press is generated by touching and holding on the touchscreen. Unlike a longclick,
it does not respond to the trackball button.
The event occurs before the finger is lifted.
A longpress and a longclick can occur together.
In contrast to a longclick, this event returns the x and y coordinates of the touch.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when loading resource.
Android only. Notify the host application that the WebView will load the resource specified by the given url.
The url of the resource that will load.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a blacklisted URL is stopped.
deprecated since 6.1.0
Use the cross-platform blacklisturl event instead.
The URL of the web document that is stopped.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a pinch gesture.
A pinch is a touch and expand or contract with two fingers. The event occurs continuously until a finger is lifted again.
The scale factor relative to the points of the two touches in screen coordinates.
The velocity of the pinch in scale factor per second.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a layout cycle is finished.
This event is fired when the view and its ancestors have been laid out. The rect and size values should be usable when this event is fired.
This event is typically triggered by either changing layout properties or by changing the orientation of the device. Note that changing the layout of child views or ancestors can also trigger a relayout of this view.
Note that altering any properties that affect layout from the postlayout callback
may result in an endless loop.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a single tap against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when an SSL error occurred.
Android only. This is a synchronous event and the developer can change the value of ignoreSslError
to control if the request should proceed or fail.
SSL error code.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a swipe gesture against the view.
Direction of the swipe--either 'left', 'right', 'up', or 'down'.
X coordinate of the event's endpoint from the source view's coordinate system.
Y coordinate of the event's endpoint from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a touch event is interrupted by the device.
A touchcancel can happen in circumstances such as an incoming call to allow the UI to clean up state.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a touch event is completed.
On the Android platform, other gesture events, such as longpress or swipe, cancel touch
events, so this event may not be triggered after a touchstart event.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Penciland are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired as soon as the device detects movement of a touch.
Event coordinates are always relative to the view in which the initial touch occurred
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired as soon as the device detects a touch gesture.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a two-finger tap against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.