# Titanium.UI.Picker
A control used to select one or more fixed values.
# Overview
Android | iOS |
---|---|
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 (opens new window).
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 Titanium.UI.Picker.columns property for the plain picker.
If you set the Titanium.UI.Picker.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>
app/controllers/index.js
:
$.win.open();
# 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);
}
}
});
# Properties
# accessibilityDisableLongPress CREATION ONLY
Boolean value to remove the long press notification for the device's accessibility service.
Will disable the "double tap and hold for long press" message when selecting an item.
Default: true
Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.
On iOS this is a direct analog of the accessibilityElementsHidden
property defined in the
UIAccessibility
Protocol.
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
# accessibilityHint
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: null
# accessibilityLabel
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.
Defaults to Title or label of the control.
# accessibilityValue
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.
Defaults to State or value of the control.
# apiName READONLY
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, Titanium.UI.Button
returns Ti.UI.Button
.
# backgroundColor
Background color of the picker, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Android: If you want to change the backgroundColor you have to set the borderStyle
to
Ti.UI.INPUT_BORDERSTYLE_ROUNDED
or Ti.UI.INPUT_BORDERSTYLE_NONE
Default: White (iOS), Transparent (Android)
# borderColor
Border color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Defaults to the normal background color of this view (Android), black (iOS).
# borderRadius
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px
.
Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.
If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a
backgroundColor
with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)"
.
Default: 0
# borderStyle CREATION ONLY
Border style to use when picker is shown as a text field or drop-down field.
This is an Android only property which only applies to pickers of type:
-
PICKER_TYPE_DATE or PICKER_TYPE_TIME that also have datePickerStyle set to DATE_PICKER_STYLE_COMPACT.
-
PICKER_TYPE_PLAIN that also have property useSpinner set
false
to show a drop-down picker.
Default: Titanium.UI.INPUT_BORDERSTYLE_FILLED
# borderWidth
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
# bottom
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.
Defaults to undefined
.
# bubbleParent
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
# calendarViewShown
Determines whether the calenderView is visible.
If 'calendarViewShown' is 'true', the calenderView is visible
Default: false
# clipMode
View's clipping behavior.
Setting this to CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.
Defaults to undefined
. Behaves as if set to CLIP_MODE_DEFAULT.
# columns
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>
# countDownDuration
Duration in milliseconds used for a Countdown Timer picker.
Applicable to PICKER_TYPE_COUNT_DOWN_TIMER picker types.
# datePickerStyle CREATION ONLY
Determines how a date or time picker should appear.
Used to display the picker has calendar/clock view, as wheel spinners, or as a field which displays selection dialog when tapped on.
This property is ignored if the type property is set to PICKER_TYPE_PLAIN.
Default: Titanium.UI.DATE_PICKER_STYLE_AUTOMATIC
# dateTimeColor
Sets the text color of date- and time-pickers.
Applicable to PICKER_TYPE_TIME and PICKER_TYPE_DATE_AND_TIME picker types. The picker type PICKER_TYPE_DATE does not support text customizing as stated in the UIKit User Interface Catalog.
Important: On iOS 14+, you also have to set the datePickerStyle to DATE_PICKER_STYLE_WHEELS in order to use this property.
Default: black
# elevation
Base elevation of the view relative to its parent in pixels.
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.
# filterTouchesWhenObscured
Discards touch related events if another app's system overlay covers the view.
This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.
Setting this property to true
causes touch related events (including "click") to not be fired
if a system overlay overlaps the view.
Default: false
# focusable
Whether view should be focusable while navigating with the trackball.
Default: false
# font
Font to use for text.
Only applicable to PICKER_TYPE_DATE and PICKER_TYPE_TIME picker types for android. For PICKER_TYPE_PLAIN, refer to Titanium.UI.PickerColumn for android, and Titanium.UI.PickerRow for iphone / ipad.
# format24
Determines whether the Time pickers display in 24-hour or 12-hour clock format.
Only applcable to pickers of type PICKER_TYPE_TIME.
When this property is set true
, a time picker is displayed with hours 0 through 23.
When set false
, hours will be 1 through 12 with am/pm controls.
Default: false
# height
View height, in platform-specific units.
Defaults to: If undefined, defaults to either FILL or 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. The view should size itself to fit its contents.
- 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
SIZE
orFILL
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.
Sets the behavior when hiding an object to release or keep the free space
If setting hiddenBehavior
to HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied.
For example: in a vertical layout the views below the object will move up when you hide
an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE
.
- HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
- HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.
Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.
# hintText
Text to be shown above date/time when picker is shown as a text field or drop-down field.
This is an Android only property which only applies to pickers of type:
-
PICKER_TYPE_DATE or PICKER_TYPE_TIME that also have datePickerStyle set to DATE_PICKER_STYLE_COMPACT.
-
PICKER_TYPE_PLAIN that also have property useSpinner set
false
to show a drop-down picker.
Default: undefined
# horizontalMotionEffect
Adds a horizontal parallax effect to the view
Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.
# horizontalWrap
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
# id
View's identifier.
The id
property of the Ti.UI.View represents the view's identifier. The identifier string does
not have to be unique. You can use this property with getViewById method.
# keepScreenOn
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.
For iOS look at idleTimerDisabled.
Default: false
# left
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.
Defaults to undefined
.
# lifecycleContainer
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.
# locale
Locale used when displaying Date and Time picker values.
Applicable to PICKER_TYPE_DATE, PICKER_TYPE_TIME and 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
# maxDate
Maximum date displayed when a Date picker is in use.
Applicable to PICKER_TYPE_DATE and 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
.
# minDate
Minimum date displayed when a Date picker is in use.
Applicable to PICKER_TYPE_DATE and 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
.
# minuteInterval
Interval in minutes displayed when one of the Time types of pickers is in use.
Applicable to PICKER_TYPE_TIME and 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
# nativeSpinner CREATION ONLY
Determines if a multicolumn spinner or single column drop-down picker should be used.
This property is intended to be used by time picker types.
If true
, Android will show hour, minute, and am/pm spinners like iOS.
If false
, Android will display a clock view.
If undefined
with Titanium 10.0.1 or higher, the
datePickerStyle property is used.
As of Titanium 10.0.1, this property has the same effect as the useSpinner property which also shows a native spinner.
const picker = Ti.UI.createPicker({
type: Ti.UI.PICKER_TYPE_TIME,
nativeSpinner: true,
format24: false,
minuteInterval: 4,
minDate: new Date(2018, 5, 24),
maxDate: new Date(2020, 5, 24),
value: new Date(2019, 5, 24)
});
Default: false
# opacity
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). Defaults to 1.0 (opaque).
# overrideCurrentAnimation CREATION ONLY
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.
Defaults to undefined
but behaves as false
# overrideUserInterfaceStyle
Forces the picker to used assigned theme instead of the system theme.
When set to USER_INTERFACE_STYLE_DARK or USER_INTERFACE_STYLE_LIGHT, the picker will ignore the system's current theme and use the theme assigned to this property instead.
When set to USER_INTERFACE_STYLE_UNSPECIFIED, the picker will use the system's current theme.
Default: Titanium.UI.USER_INTERFACE_STYLE_UNSPECIFIED
# previewContext
The preview context used in the 3D-Touch feature "Peek and Pop".
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 forceTouchSupported.
# pullBackgroundColor
Background color of the wrapper view when this view is used as either pullView or headerPullView.
Defaults to undefined
. Results in a light grey background color on the wrapper view.
# rect READONLY
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.
# right
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.
Defaults to undefined
.
# rotation
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
# rotationX
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
# rotationY
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
# scaleX
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
# scaleY
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
# selectionIndicator DEPRECATED
DEPRECATED SINCE 10.0.1
This property is ignored as of Titanium 10.0.1.
Determines whether the visual selection indicator is shown.
As of Titanium 10.0.1, this property will be ignored and Android will always show an indicator.
Default: true
# selectionOpens
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)
# size READONLY
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.
# softKeyboardOnFocus
Determines keyboard behavior when this view is focused. Defaults to SOFT_KEYBOARD_DEFAULT_ON_FOCUS.
# textAlign
Horizontal text alignment of the date picker when using PICKER_TYPE_DATE.
Default: Titanium.UI.TEXT_ALIGNMENT_LEFT>,
# tooltip
The default text to display in the control's tooltip.
Assigning a value to this property causes the tool tip to be displayed for the view.
Setting the property to null
cancels the display of the tool tip for the view.
Note: This property is only used for apps targeting macOS Catalyst.
# top
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.
# touchEnabled
Determines whether view should receive touch events.
If false, will forward the events to peers.
Default: true
# touchFeedback
A material design visual construct that provides an instantaneous visual confirmation of touch point.
Touch feedback is only applied to a view's background. It is never applied to the view's foreground content such as a Titanium.UI.ImageView's image.
For Titanium versions older than 9.1.0, touch feedback only works if you set the backgroundColor property to a non-transparent color.
Default: false
# touchFeedbackColor
Optional touch feedback ripple color. This has no effect unless touchFeedback
is true.
Defaults to provided theme color.
# transform
Transformation matrix to apply to the view.
Android only supports Matrix2D transforms.
Default: Identity matrix
# transitionName
A name to identify this view in activity transition.
Name should be unique in the View hierarchy.
# translationX
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
# translationY
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
# translationZ
Depth of the view relative to its elevation in pixels.
Translation values are applied to the static post layout value.