A control used to select one or more fixed values.
 |
 |
 |
| Android | iOS | Windows Phone |
|---|
Use the Titanium.UI.createPicker method or Alloy <Picker> element to create a picker control.
On Android, the useSpinner property must be enabled to support multiple columns.
By default, the spinner is automatically sized to fit its content and can overflow
to additional spinner rows. The size of the picker can be adjusted with the width
and height properties, but may omit picker columns or cut off picker rows
if the size is set too small. This property is deprecated. Please use the default
Android native "dropdown" style by not setting useSpinner to true.
On iOS, the height property is only available in iOS 9 and later.
By default, the size of the picker, including its background, is fixed at the
same height as the iPhone keyboard to respect the
iOS Human Interface Guidelines.
The default width on iOS is 320px and the height is 228px.
The contents of the picker are sized to fit the picker, which may cut off text
in the picker rows. Adding views to picker rows is also supported on iOS.
On iPad, Apple recommends using a picker only in a popover. Since the size of the picker cannot be adjusted, it is not suitable for the main screen.
Note: you can only set the columns property for the plain picker.
If you set the type property to anything else except
Titanium.UI.PICKER_TYPE_PLAIN, you cannot modify the picker's columns.
Examples
Multi-Column Picker using Alloy XML Markup
Creates a picker with two columns. You can optionally use Column and Row as shorthand
notation for PickerColumn and PickerRow, respectively.
app/views/index.xml:
<Alloy>
<Window id="win" backgroundColor="white" layout="vertical" exitOnClose="true">
<Picker id="picker" top="50" selectionIndicator="true" useSpinner="true">
<PickerColumn id="column1">
<PickerRow title="Bananas"/>
<PickerRow title="Strawberries"/>
<PickerRow title="Mangos"/>
<PickerRow title="Grapes"/>
</PickerColumn>
<!-- Picker shorthand notation -->
<Column id="column2">
<Row title="red"/>
<Row title="green"/>
<Row title="blue"/>
<Row title="orange"/>
</Column>
</Picker>
</Window>
</Alloy>
Date Picker using Alloy XML Markup
Creates a date picker, then monitors the change event to see when the user updates the picker.
For the date string, use string values accepted by the moment.js constructor in the XML and TSS files. If you are defining dates in the controller code, use a JavaScript Date object.
app/views/index.xml:
<Alloy>
<Window backgroundColor="blue">
<Picker id="picker"
onChange="report"
type="Ti.UI.PICKER_TYPE_DATE"
minDate="2014,4,1"
maxDate="May 1, 2014 12:00:00"
value="2014-04-15T12:00:00">
</Picker>
</Window>
</Alloy>
app/controllers/index.js:
function report(e) {
Ti.API.info('User selected: ' + e.value);
}
$.index.open();
Basic Single Column Picker
Create a one-column, platform-specific style, picker and automatically select a row.
Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow({
exitOnClose: true,
layout: 'vertical'
});
var picker = Ti.UI.createPicker({
top:50
});
var data = [];
data[0]=Ti.UI.createPickerRow({title:'Bananas'});
data[1]=Ti.UI.createPickerRow({title:'Strawberries'});
data[2]=Ti.UI.createPickerRow({title:'Mangos'});
data[3]=Ti.UI.createPickerRow({title:'Grapes'});
picker.add(data);
picker.selectionIndicator = true;
win.add(picker);
win.open();
// must be after picker has been displayed
picker.setSelectedRow(0, 2, false); // select Mangos
Multi-Column Picker
Create a two-column, platform-specific style, picker and automatically select a row in each column.
Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow({
exitOnClose: true,
layout: 'vertical'
});
var picker = Ti.UI.createPicker({
top:50,
useSpinner: true
});
picker.selectionIndicator = true;
var fruit = [ 'Bananas', 'Strawberries', 'Mangos', 'Grapes' ];
var color = [ 'red', 'green', 'blue', 'orange' ];
var column1 = Ti.UI.createPickerColumn();
for(var i=0, ilen=fruit.length; i<ilen; i++){
var row = Ti.UI.createPickerRow({
title: fruit[i]
});
column1.addRow(row);
}
var column2 = Ti.UI.createPickerColumn();
for(var i=0, ilen=color.length; i<ilen; i++){
var row = Ti.UI.createPickerRow({ title: color[i] });
column2.addRow(row);
}
picker.add([column1,column2]);
win.add(picker);
win.open();
// must be after picker has been displayed
picker.setSelectedRow(0, 2, false); // select Mangos
picker.setSelectedRow(1, 3, false); // select Orange
Date Picker
Create a date picker and handle the subsequent user action.
Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow({
exitOnClose: true,
layout: 'vertical'
});
var picker = Ti.UI.createPicker({
type:Ti.UI.PICKER_TYPE_DATE,
minDate:new Date(2009,0,1),
maxDate:new Date(2014,11,31),
value:new Date(2014,3,12),
top:50
});
win.add(picker);
win.open();
picker.addEventListener('change',function(e){
Ti.API.info("User selected date: " + e.value.toLocaleString());
});
Date Picker using showDatePickerDialog() (Android only)
Create a date picker that is automatically displayed as a modal dialog and handle the subsequent user action.
Ti.UI.backgroundColor = 'white';
var picker = Ti.UI.createPicker({
type:Ti.UI.PICKER_TYPE_DATE,
minDate:new Date(2009,0,1),
maxDate:new Date(2014,11,31),
value:new Date(2014,3,12)
});
picker.showDatePickerDialog({
value: new Date(2010,8,1),
callback: function(e) {
if (e.cancel) {
Ti.API.info('User canceled dialog');
} else {
Ti.API.info('User selected date: ' + e.value);
}
}
});
- 0.8
- 0.8
- 0.8
Properties
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
- 3.0.0
- 3.0.0
- 3.0.0
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:
- 3.0.0
- 3.0.0
- 3.0.0
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.
- 3.0.0
- 3.0.0
- 3.0.0
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.
- 3.0.0
- 3.0.0
- 3.0.0
Current position of the view during an animation.
Current position of the view during an animation.
- 0.9
- 0.9
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.
- 3.2.0
- 3.2.0
- 3.2.0
Background color of the picker, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: White (iOS), Transparent (Android)
- 0.9.0
- 5.2.0
- 5.2.0
Overrides: Titanium.UI.View.backgroundColor
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
- 3.0.0
- 3.0.0
- 3.0.0
Determines whether the calenderView is visible.
If 'calendarViewShown' is 'true', the calenderView is visible
Default: false
- 0.8
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.
- 3.3.0
- 3.3.0
Columns used for this picker, as an array of Titanium.UI.PickerColumn objects.
Columns used for this picker, as an array of Titanium.UI.PickerColumn objects.
You can only set columns for the plain picker. If you set the type to anything
else except Titanium.UI.PICKER_TYPE_PLAIN, you cannot modify the columns.
In an Alloy application you can specify this property with a <PickerColumn> (or <Column>)
element that contains one or more <PickerRow> (or <Row>) elements, as shown below:
<Alloy>
<Window>
<Picker useSpinner="true">
<PickerColumn id="column1">
<PickerRow title="Bananas"/>
<PickerRow title="Strawberries"/>
<PickerRow title="Mangos"/>
</PickerColumn>
<!-- Picker shorthand notation -->
<Column id="column2">
<Row title="red"/>
<Row title="green"/>
<Row title="blue"/>
</Column>
</Picker>
</Window>
</Alloy>
Duration in milliseconds used for a Countdown Timer picker.
Duration in milliseconds used for a Countdown Timer picker.
Applicable to Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER picker types.
- 0.8
- 0.8
Sets the text color of date- and time-pickers.
Applicable to Titanium.UI.PICKER_TYPE_TIME and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types. The picker type Titanium.UI.PICKER_TYPE_DATE does not support text customizing as stated in the UIKit User Interface Catalog.
Default: Black
- 5.2.0
- 5.2.0
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.
- 5.0.0
Whether view should be focusable while navigating with the trackball.
Default: false
- 0.9
Font to use for text.
Font to use for text.
Only applicable to Titanium.UI.PICKER_TYPE_DATE and Titanium.UI.PICKER_TYPE_TIME picker types for android. For Titanium.UI.PICKER_TYPE_PLAIN, refer to Titanium.UI.PickerColumn for android, and Titanium.UI.PickerRow for iphone / ipad.
- 0.8
Determines whether the Time pickers display in 24-hour or 12-hour clock format.
Applicable to Titanium.UI.PICKER_TYPE_TIME and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types.
When this property is enabled, a time picker is displayed with hours 0 through 23, or with hours 1 through 12 and am/pm controls otherwise.
For backward compatibility, the default value of this property depends on the style of picker in use.
For a spinner picker (when useSpinner is true), this defaults to true (24-hour format.)
For a native picker (when useSpinner is either un-set or false), this defaults to false
(12-hour format.)
The value of this property may be modified even after a picker is rendered and the UI will be updated accordingly.
Default: true (spinner enabled), false (otherwise)
- 0.8
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:
- Titanium.UI.SIZE. The view should size itself to fit its contents.
- Titanium.UI.FILL. The view should size itself to fill its parent.
- 'auto'. Represents the default sizing behavior for a given type of
view. The use of 'auto' is deprecated, and should be replaced with the
SIZEorFILLconstants 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:
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
- 2.1.0
- 2.1.0
- 2.1.0
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
- 0.9
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.
- 3.6.0
Locale used when displaying Date and Time picker values.
Applicable to Titanium.UI.PICKER_TYPE_DATE, Titanium.UI.PICKER_TYPE_TIME and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types.
Locale must be represented as a combination of ISO 2-letter language and country codes.
For example, en-US or en-GB. See the
ISO 639-1 and
ISO 3166-1 alpha-2
sections of wikipedia for reference.
On iOS, the system locale is always used.
Default: System Settings
- 0.8
Maximum date displayed when a Date picker is in use.
Maximum date displayed when a Date picker is in use.
Applicable to Titanium.UI.PICKER_TYPE_DATE and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types.
For JavaScript files, use a JavaScript Date object.
For Alloy XML and TSS files, use a date string that can be parsed by the moment.js constructor, which includes ISO-8601 and RFC2822 dates.
This property is ignored when maxDate is less than minDate.
Minimum date displayed when a Date picker is in use.
Minimum date displayed when a Date picker is in use.
Applicable to Titanium.UI.PICKER_TYPE_DATE and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types.
For JavaScript files, use a JavaScript Date object.
For Alloy XML and TSS files, use a date string that can be parsed by the moment.js constructor, which includes ISO-8601 and RFC2822 dates.
This property is ignored when maxDate is less than minDate.
Interval in minutes displayed when one of the Time types of pickers is in use.
Applicable to Titanium.UI.PICKER_TYPE_TIME and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types.
The minimum permitted value is 1 and maximum is 30. If the value cannot be evenly divided into 60, the default value is used.
Default: 1
- 0.8
- 0.8
Creates a native Android control for creating a Time Spinner with Type Ti.UI.PICKER_TYPE_TIME.
This is invoked rather than the default native "dropdown" style.
If true, the nativeSpinner is enabled.
This property should be set either at picker creation, i.e.
Titanium.UI.createPicker({ nativeSpinner:true });, or before the picker is added to its parent.
Example as follows: var picker = Ti.UI.createPicker({ type:Ti.UI.PICKER_TYPE_TIME, nativeSpinner: true, format24: false, minuteInterval: 4, minDate:new Date(2009,0,1), maxDate:new Date(2014,11,31), value:new Date(2014,3,12) });
Default: false
- 5.4.0
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).
Default: 1.0 (opaque)
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
- 3.3.0
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.
- 5.1.0
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.
- 3.3.0
- 3.3.0
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.
- 2.0.0
- 2.0.0
- 2.0.0
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.
- 5.4.0
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.
- 5.4.0
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.
- 5.4.0
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.
- 5.4.0
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.
- 5.4.0
Determines whether the visual selection indicator is shown.
If true, selection indicator is enabled.
On iOS 7 and later, the picker indicator is always shown and you cannot control it.
On iOS 6 and prior, if enabled, a blue bar is displayed to indicate the current selection.
Default: true (Android), false (iPhone, iPad)
Determines whether calling the method setSelectedRow opens when called
If true, selection will open when setSelectedRow is called.
If false, selection will not open when setSelectedRow is called.
Default: false (Android)
- 5.0.0
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:
- Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
- Titanium.UI.Android.SOFT_KEYBOARD_HIDE_ON_FOCUS
- Titanium.UI.Android.SOFT_KEYBOARD_SHOW_ON_FOCUS
Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
- 0.9
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
- 6.1.0
Optional touch feedback ripple color. This has no effect unless touchFeedback is true.
Requires: Android 5.0 and later
Default: Theme provided color.
- 6.1.0
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.
- 5.0.2
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.
- 5.0.0
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.
- 5.0.0
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.
- 5.0.0
Determines the type of picker displayed
You can only set columns for the plain picker. If you set the type to anything
else except Titanium.UI.PICKER_TYPE_PLAIN, you cannot modify the columns.
PICKER_TYPE_DATE_AND_TIME is only available for iOS.
PICKER_TYPE_COUNT_DOWN_TIMER is only available for iOS.
This API can be assigned the following constants:
- Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER
- Titanium.UI.PICKER_TYPE_DATE
- Titanium.UI.PICKER_TYPE_DATE_AND_TIME
- Titanium.UI.PICKER_TYPE_PLAIN
- Titanium.UI.PICKER_TYPE_TIME
Default: Titanium.UI.PICKER_TYPE_PLAIN
Determines whether the non-native Android control, with a spinning wheel that looks and behaves like the iOS picker, is invoked rather than the default native "dropdown" style.
deprecated since 5.2.1
This property is deprecated. Please use the default native "dropdown" style.
If true, the spinner is enabled.
This property should be set either at picker creation, i.e.
Titanium.UI.createPicker({ useSpinner:true });, or before the picker is added to its parent.
This property must be enabled for multi-column pickers.
Default: false
- 0.8
Date and time value for Date and Time pickers.
Date and time value for Date and Time pickers.
Applicable to Titanium.UI.PICKER_TYPE_DATE, Titanium.UI.PICKER_TYPE_TIME and Titanium.UI.PICKER_TYPE_DATE_AND_TIME picker types.
For JavaScript files, use a JavaScript Date object.
For Alloy XML and TSS files, use a date string that can be parsed by the moment.js constructor, which includes ISO-8601 and RFC2822 dates.
Determines the color of the shadow.
Default: Undefined. Behaves as if transparent.
- 3.3.0
- 3.3.0
Determines the offset for the shadow of the view.
Default: Undefined. Behaves as if set to (0,-3)
- 3.3.0
- 3.3.0
Determines the blur radius used to create the shadow.
Default: Undefined. Behaves as if set to 3.
- 3.3.0
- 3.3.0
Determines whether the view is visible.
Default: true
Number of visible rows to display. This is only applicable to a plain picker and when the
useSpinner is true.
The spinner-style Android picker shows 5 rows by default; one selected in the middle and 2 above and below. Set to an odd number to ensure the selected row is in the middle.
Default: 5
- 0.8
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:
- Titanium.UI.SIZE. The view should size itself to fit its contents.
- Titanium.UI.FILL. The view should size itself to fill its parent.
- 'auto'. Represents the default sizing behavior for a given type of
view. The use of 'auto' is deprecated, and should be replaced with the
SIZEorFILLconstants 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:
Methods
Adds rows or columns to the picker.
Once you use this method to add rows and columns to a picker, you cannot remove or manipulate them.
- 0.9
- 0.9
- 0.9
Parameters
- data : Array<Titanium.UI.PickerRow>/Titanium.UI.PickerRow/Array<Titanium.UI.PickerColumn>/Titanium.UI.PickerColumn
A row, set of rows, a column of rows or a set of columns of rows. When this method is used to add a row or set of rows, a single-column picker is created.
Returns
- void
Overrides: Titanium.UI.View.add
Adds the specified callback as an event listener for the named event.
Parameters
- name : String
Name of the event.
- callback : Callback<Object>
Callback function to invoke when the event is fired.
Returns
- void
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.
Parameters
- animation : Titanium.UI.Animation/Dictionary<Titanium.UI.Animation>
Either a dictionary of animation properties or an Animation object.
- callback : Callback<Object>
Function to be invoked upon completion of the animation.
Returns
- void
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.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- props : Dictionary
A dictionary of properties to apply.
Returns
- void
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.
- 1.8
- 1.8
- 1.8
Parameters
- point : Point
A point in this view's coordinate system.
If this argument is missing an
xoryproperty, or the properties can not be converted into numbers, an exception will be raised. - destinationView : Titanium.UI.View
View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.
Returns
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.
- 2.0.0
- 2.0.0
- 2.0.0
Returns
- void
Fires a synthesized event to any registered listeners.
Parameters
- name : String
Name of the event.
- event : Dictionary
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Returns
- void
Gets the value of the backgroundColor property.
- 0.9.0
- 5.2.0
- 5.2.0
Returns
- String
Overrides: Titanium.UI.View.getBackgroundColor
Gets the selected row for a column, or null if none exists.
Parameters
- index : Number
A column index.
Returns
Gets the value of the useSpinner property.
deprecated since 5.2.1
This property is deprecated. Please use the default native "dropdown" style.
- 0.8
Returns
- Boolean
Returns the matching view of a given view ID.
- 6.1.0
- 6.1.0
- 6.1.0
Parameters
- id : String
The ID of the view that should be returned. Use the
idproperty in your views to enable it for indexing in this method.
Returns
Hides this view.
Parameters
- options : AnimationOption (optional)
Animation options for Android. Since Release 5.1.0.
Returns
- void
Inserts a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
- 3.3.0
- 3.3.0
- 3.3.0
Parameters
- params : Dictionary
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.
Returns
- void
Repopulates values for a column.
- 0.8
- 0.8
Parameters
- column : Titanium.UI.PickerColumn
Column to repopulate.
Returns
- void
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);
Parameters
- name : String
Name of the event.
- callback : Callback<Object>
Callback function to remove. Must be the same function passed to
addEventListener.
Returns
- void
Replaces a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
- 3.3.0
- 3.3.0
- 3.3.0
Parameters
- params : Dictionary
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.
Returns
- void
Sets the value of the accessibilityHidden property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityHidden : Boolean
New value for the property.
Returns
- void
Sets the value of the accessibilityHint property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityHint : String
New value for the property.
Returns
- void
Sets the value of the accessibilityLabel property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityLabel : String
New value for the property.
Returns
- void
Sets the value of the accessibilityValue property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityValue : String
New value for the property.
Returns
- void
Sets the value of the backgroundColor property.
- 0.9.0
- 5.2.0
- 5.2.0
Parameters
- backgroundColor : String
New value for the property.
Returns
- void
Overrides: Titanium.UI.View.setBackgroundColor
Sets the value of the borderColor property.
Parameters
- borderColor : String
New value for the property.
Returns
- void
Sets the value of the borderRadius property.
Parameters
- borderRadius : Number
New value for the property.
Returns
- void
Sets the value of the borderWidth property.
Parameters
- borderWidth : Number
New value for the property.
Returns
- void
Sets the value of the bottom property.
Parameters
- bottom : Number/String
New value for the property.
Returns
- void
Sets the value of the bubbleParent property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- bubbleParent : Boolean
New value for the property.
Returns
- void
Sets the value of the calendarViewShown property.
- 0.8
Parameters
- calendarViewShown : Boolean
New value for the property.
Returns
- void
Sets the value of the clipMode property.
- 3.3.0
- 3.3.0
Parameters
- clipMode : Number
New value for the property.
Returns
- void
Sets the value of the columns property.
Parameters
- columns : Array<Titanium.UI.PickerColumn>
New value for the property.
Returns
- void
Sets the value of the countDownDuration property.
- 0.8
- 0.8
Parameters
- countDownDuration : Number
New value for the property.
Returns
- void
Sets the value of the dateTimeColor property.
- 5.2.0
- 5.2.0
Parameters
- dateTimeColor : String
New value for the property.
Returns
- void
Sets the value of the elevation property.
- 5.0.0
Parameters
- elevation : Number
New value for the property.
Returns
- void
Sets the value of the focusable property.
- 0.9
Parameters
- focusable : Boolean
New value for the property.
Returns
- void
Sets the value of the format24 property.
- 0.8
Parameters
- format24 : Boolean
New value for the property.
Returns
- void
Sets the value of the height property.
Parameters
- height : Number/String
New value for the property.
Returns
- void
Sets the value of the hiddenBehavior property.
- 6.1.0
Parameters
- hiddenBehavior : Number
New value for the property.
Returns
- void
Sets the value of the horizontalWrap property.
- 2.1.0
- 2.1.0
- 2.1.0
Parameters
- horizontalWrap : Boolean
New value for the property.
Returns
- void
Sets the value of the keepScreenOn property.
- 0.9
Parameters
- keepScreenOn : Boolean
New value for the property.
Returns
- void
Sets the value of the left property.
Parameters
- left : Number/String
New value for the property.
Returns
- void
Sets the value of the lifecycleContainer property.
- 3.6.0
Parameters
- lifecycleContainer : Titanium.UI.Window/Titanium.UI.TabGroup
New value for the property.
Returns
- void
Sets the value of the locale property.
- 0.8
Parameters
- locale : String
New value for the property.
Returns
- void
Sets the value of the maxDate property.
Parameters
- maxDate : Date
New value for the property.
Returns
- void
Sets the value of the minDate property.
Parameters
- minDate : Date
New value for the property.
Returns
- void
Sets the value of the minuteInterval property.
- 0.8
- 0.8
Parameters
- minuteInterval : Number
New value for the property.
Returns
- void
Sets the value of the nativeSpinner property.
- 5.4.0
Parameters
- nativeSpinner : Boolean
New value for the property.
Returns
- void
Sets the value of the opacity property.
Parameters
- opacity : Number
New value for the property.
Returns
- void
Sets the value of the overrideCurrentAnimation property.
- 3.3.0
Parameters
- overrideCurrentAnimation : Boolean
New value for the property.
Returns
- void
Sets the value of the previewContext property.
- 5.1.0
Parameters
- previewContext : Titanium.UI.iOS.PreviewContext
New value for the property.
Returns
- void
Sets the value of the pullBackgroundColor property.
- 3.3.0
- 3.3.0
Parameters
- pullBackgroundColor : String
New value for the property.
Returns
- void
Sets the value of the right property.
Parameters
- right : Number/String
New value for the property.
Returns
- void
Sets the value of the rotation property.
- 5.4.0
Parameters
- rotation : Number
New value for the property.
Returns
- void
Sets the value of the rotationX property.
- 5.4.0
Parameters
- rotationX : Number
New value for the property.
Returns
- void
Sets the value of the rotationY property.
- 5.4.0
Parameters
- rotationY : Number
New value for the property.
Returns
- void
Sets the value of the scaleX property.
- 5.4.0
Parameters
- scaleX : Number
New value for the property.
Returns
- void
Sets the value of the scaleY property.
- 5.4.0
Parameters
- scaleY : Number
New value for the property.
Returns
- void
Selects a column's row.
On iOS, this method must be called after the picker is rendered. On Android, the picker has a default value of 0 for both column and row index.
Parameters
- column : Number
A column index.
- row : Number
A row index.
- animated : Boolean (optional)
Determines whether the selection should be animated. (iPhone, iPad-only)
Returns
- void
Sets the value of the selectionIndicator property.
Parameters
- selectionIndicator : Boolean
New value for the property.
Returns
- void
Sets the value of the selectionOpens property.
- 5.0.0
Parameters
- selectionOpens : Boolean
New value for the property.
Returns
- void
Sets the value of the softKeyboardOnFocus property.
- 0.9
Parameters
- softKeyboardOnFocus : Number
New value for the property.
Returns
- void
Sets the value of the top property.
Parameters
- top : Number/String
New value for the property.
Returns
- void
Sets the value of the touchEnabled property.
Parameters
- touchEnabled : Boolean
New value for the property.
Returns
- void
Sets the value of the touchFeedback property.
- 6.1.0
Parameters
- touchFeedback : Boolean
New value for the property.
Returns
- void
Sets the value of the touchFeedbackColor property.
- 6.1.0
Parameters
- touchFeedbackColor : String
New value for the property.
Returns
- void
Sets the value of the transform property.
Parameters
- transform : Titanium.UI.2DMatrix/Titanium.UI.3DMatrix
New value for the property.
Returns
- void
Sets the value of the transitionName property.
- 5.0.2
Parameters
- transitionName : String
New value for the property.
Returns
- void
Sets the value of the translationX property.
- 5.0.0
Parameters
- translationX : Number
New value for the property.
Returns
- void
Sets the value of the translationY property.
- 5.0.0
Parameters
- translationY : Number
New value for the property.
Returns
- void
Sets the value of the translationZ property.
- 5.0.0
Parameters
- translationZ : Number
New value for the property.
Returns
- void
Sets the value of the useSpinner property.
deprecated since 5.2.1
This property is deprecated. Please use the default native "dropdown" style.
- 0.8
Parameters
- useSpinner : Boolean
New value for the property.
Returns
- void
Sets the value of the viewShadowColor property.
- 3.3.0
- 3.3.0
Parameters
- viewShadowColor : String
New value for the property.
Returns
- void
Sets the value of the viewShadowOffset property.
- 3.3.0
- 3.3.0
Parameters
- viewShadowOffset : Point
New value for the property.
Returns
- void
Sets the value of the viewShadowRadius property.
- 3.3.0
- 3.3.0
Parameters
- viewShadowRadius : Number
New value for the property.
Returns
- void
Sets the value of the visible property.
Parameters
- visible : Boolean
New value for the property.
Returns
- void
Sets the value of the visibleItems property.
- 0.8
Parameters
- visibleItems : Number
New value for the property.
Returns
- void
Sets the value of the width property.
Parameters
- width : Number/String
New value for the property.
Returns
- void
Makes this view visible.
Parameters
- options : AnimationOption (optional)
Animation options for Android. Since Release 5.1.0.
Returns
- void
Shows Date picker as a modal dialog.
Applicable to the Titanium.UI.PICKER_TYPE_DATE picker type.
See "Date Picker using showDatePickerDialog()" for an example.
- 0.8
Parameters
- dictObj : Object
Dictionary object with a subset of
Titanium.UI.Pickerproperties and a callback defined. Acceptable object properties arecallback,okButtonTitle,titleandvalue.
Returns
- void
Shows Time picker as a modal dialog.
Applicable to the Titanium.UI.PICKER_TYPE_TIME picker type.
See "Date Picker using showDatePickerDialog()" for a similar example.
- 0.8
Parameters
- dictObj : Object
Dictionary object with a subset of
Titanium.UI.Pickerproperties and a callback defined. Acceptable object properties arecallback,format24,okButtonTitle,titleandvalue.
Returns
- void
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.
- 2.0.0
- 2.0.0
- 2.0.0
Returns
- void
Returns an image of the rendered view, as a Blob.
The honorScaleFactor method is only supported on iOS.
Parameters
- callback : Callback<Titanium.Blob> (optional)
Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
- honorScaleFactor : Boolean (optional)
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.
Returns
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.
- 2.0.0
- 2.0.0
- 2.0.0
Parameters
- params : Dictionary
Layout properties to be updated.
Returns
- void
Events
Fired when the value of any column's row is changed.
Properties
- columnIndex : Number
Selected column index. On iOS, only applicable to Titanium.UI.PICKER_TYPE_PLAIN picker types.
- rowIndex : Number
Selected row index. On iOS, only applicable to Titanium.UI.PICKER_TYPE_PLAIN picker types.
- column : Titanium.UI.PickerColumn
The column object. On iOS, only applicable to Titanium.UI.PICKER_TYPE_PLAIN picker types.
- countDownDuration : Number
The selected duration in milliseconds. Applicable to Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER picker types.
- value : String
The selected value. Applicable to date/time pickers only. This property is read-only on Android.
- row : Titanium.UI.PickerRow
The row object. On iOS, only applicable to Titanium.UI.PICKER_TYPE_PLAIN picker types.
- selectedValue : Array<String>
Array of selected values, one element per column in the picker. Applicable to Titanium.UI.PICKER_TYPE_PLAIN picker types.
- source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Fired when the device detects a click against the view.
This event is only available for non-spinner plain pickers.
- 3.0.0
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.click
Fired when the device detects a double click against the view.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Fired when the device detects a double tap against the view.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
- 0.9
Properties
- source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
- 3.1.0
Properties
- keyCode : Number
The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
- source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
- 0.9
Properties
- source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
- 1.8.0
- 1.8.0
Properties
- scale : Number
The scale factor relative to the points of the two touches in screen coordinates.
- velocity : Number
The velocity of the pinch in scale factor per second.
- source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
- 2.0.0
- 2.0.0
- 2.0.0
Properties
- source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Fired when the device detects a single tap against the view.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Fired when the device detects a swipe gesture against the view.
Properties
- direction : String
Direction of the swipe--either 'left', 'right', 'up', or 'down'.
- x : Number
X coordinate of the event's endpoint from the
sourceview's coordinate system. - y : Number
Y coordinate of the event's endpoint from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
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.
- size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
- maximumPossibleForce : Number
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.
- altitudeAngle : Number
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.
- timestamp : Number
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.
- azimuthUnitVectorInViewX : Number
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.
- azimuthUnitVectorInViewY : Number
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
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
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.
- size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
- maximumPossibleForce : Number
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.
- altitudeAngle : Number
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.
- timestamp : Number
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.
- azimuthUnitVectorInViewX : Number
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.
- azimuthUnitVectorInViewY : Number
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
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
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
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
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.
- size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
- maximumPossibleForce : Number
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.
- altitudeAngle : Number
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.
- timestamp : Number
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.
- azimuthUnitVectorInViewX : Number
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.
- azimuthUnitVectorInViewY : Number
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
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Fired as soon as the device detects a touch gesture.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
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.
- size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
- maximumPossibleForce : Number
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.
- altitudeAngle : Number
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.
- timestamp : Number
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.
- azimuthUnitVectorInViewX : Number
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.
- azimuthUnitVectorInViewY : Number
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
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.
Fired when the device detects a two-finger tap against the view.
- 3.0.0
- 0.9
- 0.9
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - source : Object
Source object that fired the event.
- type : String
Name of the event fired.
- bubbles : Boolean
True if the event will try to bubble up if possible.
- cancelBubble : Boolean
Set to true to stop the event from bubbling.