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

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.

• 0.9
• 0.9

Current position of the view during an animation.

• 0.9
• 0.9

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 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.

• 0.9

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.

• 0.9

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.

• 0.9

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.

• 0.9

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.

Examples

Linear and Radial Gradients

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

• 0.9
• 0.9

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:

• Titanium.UI.Button
• Titanium.UI.TextField
• Titanium.UI.Label

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.

• 0.9

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.

• 0.9

Size of the top end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

• 0.9
• 0.9

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.

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

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.

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

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

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 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:

• Titanium.UI.FILL
• Titanium.UI.SIZE

Sets the behavior when hiding an object to release or keep the free space

If setting hiddenBehavior to Titanium.UI.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.

• Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
• Titanium.UI.HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.

This API can be assigned the following constants:

• Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE
• Titanium.UI.HIDDEN_BEHAVIOR_GONE

Default: Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE

• 6.1.0

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

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:

  • If neither top or bottom is specified, the child is centered in the row.
  • If either top or bottom is specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding.
  • If both 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.

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.

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

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 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.

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.

Translation values are applied to the static post layout value.

• 5.4.0

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).

Translation values are applied to the static post layout value.

• 5.4.0

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.

Translation values are applied to the static post layout value.

• 5.4.0

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 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:

• 3.1.3
• 3.1.3

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.

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.

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 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

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 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:

• Titanium.UI.FILL
• Titanium.UI.SIZE

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.

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 x or y property, 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

• Point

Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.

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 accessibilityHidden property.

• 3.0.0
• 3.0.0
• 3.0.0

Returns

• Boolean

Gets the value of the accessibilityHint property.

• 3.0.0
• 3.0.0
• 3.0.0

Returns

• String

Gets the value of the accessibilityLabel property.

• 3.0.0
• 3.0.0
• 3.0.0

Returns

• String

Gets the value of the accessibilityValue property.

• 3.0.0
• 3.0.0
• 3.0.0

Returns

• String

Gets the value of the anchorPoint property.

• 0.9
• 0.9

Returns

• Point

Gets the value of the animatedCenter property.

• 0.9
• 0.9

Returns

• Point

Gets the value of the apiName property.

• 3.2.0
• 3.2.0
• 3.2.0

Returns

• String

Gets the value of the backgroundColor property.

Returns

• String

Gets the value of the backgroundDisabledColor property.

• 0.9

Returns

• String

Gets the value of the backgroundDisabledImage property.

• 0.9

Returns

• String

Gets the value of the backgroundFocusedColor property.

• 0.9

Returns

• String

Gets the value of the backgroundFocusedImage property.

• 0.9

Returns

• String

Gets the value of the backgroundGradient property.

Returns

• Gradient

Gets the value of the backgroundImage property.

Returns

• String

Gets the value of the backgroundLeftCap property.

• 0.9
• 0.9

Returns

• Number

Gets the value of the backgroundRepeat property.

Returns

• Boolean

Gets the value of the backgroundSelectedColor property.

• 0.9

Returns

• String

Gets the value of the backgroundSelectedImage property.

• 0.9

Returns

• String

Gets the value of the backgroundTopCap property.

• 0.9
• 0.9

Returns

• Number

Gets the value of the borderColor property.

Returns

• String

Gets the value of the borderRadius property.

Returns

• Number

Gets the value of the borderWidth property.

Returns

• Number

Gets the value of the bottom property.

Returns

• Number/String

Gets the value of the bubbleParent property.

• 3.0.0
• 3.0.0
• 3.0.0

Returns

• Boolean

Gets the value of the center property.

Returns

• Point

Gets the value of the children property.

Returns

• Titanium.UI.View[]

Gets the value of the clipMode property.

• 3.3.0
• 3.3.0

Returns

• Number

Gets the value of the elevation property.

• 5.0.0

Returns

• Number

Gets the value of the focusable property.

• 0.9

Returns

• Boolean

Gets the value of the height property.

Returns

• Number/String

Gets the value of the hiddenBehavior property.

• 6.1.0

Returns

• Number

Gets the value of the horizontalWrap property.

• 2.1.0
• 2.1.0
• 2.1.0

Returns

• Boolean

Gets the value of the keepScreenOn property.

• 0.9

Returns

• Boolean

Gets the value of the layout property.

Returns

• String

Gets the value of the left property.

Returns

• Number/String

Gets the value of the lifecycleContainer property.

• 3.6.0

Returns

• Titanium.UI.Window/Titanium.UI.TabGroup

Gets the value of the opacity property.

Returns

• Number

Gets the value of the overrideCurrentAnimation property.

• 3.3.0

Returns

• Boolean

Gets the value of the previewContext property.

• 5.1.0

Returns

• Titanium.UI.iOS.PreviewContext

Gets the value of the pullBackgroundColor property.

• 3.3.0
• 3.3.0

Returns

• String

Gets the value of the rect property.

• 2.0.0
• 2.0.0
• 2.0.0

Returns

• Dimension

Gets the value of the right property.

Returns

• Number/String

Gets the value of the rotation property.

• 5.4.0

Returns

• Number

Gets the value of the rotationX property.

• 5.4.0

Returns

• Number

Gets the value of the rotationY property.

• 5.4.0

Returns

• Number

Gets the value of the scaleX property.

• 5.4.0

Returns

• Number

Gets the value of the scaleY property.

• 5.4.0

Returns

• Number

Gets the value of the size property.

Returns

• Dimension

Gets the value of the softKeyboardOnFocus property.

• 0.9

Returns

• Number

Gets the value of the tintColor property.

• 3.1.3
• 3.1.3

Returns

• String

Gets the value of the top property.

Returns

• Number/String

Gets the value of the touchEnabled property.

Returns

• Boolean

Gets the value of the touchFeedback property.

• 6.1.0

Returns

• Boolean

Gets the value of the touchFeedbackColor property.

• 6.1.0

Returns

• String

Gets the value of the transform property.

Returns

• Titanium.UI.2DMatrix/Titanium.UI.3DMatrix

Gets the value of the transitionName property.

• 5.0.2

Returns

• String

Gets the value of the translationX property.

• 5.0.0

Returns

• Number

Gets the value of the translationY property.

• 5.0.0

Returns

• Number

Gets the value of the translationZ property.

• 5.0.0

Returns

• Number

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 id property in your views to enable it for indexing in this method.

Returns

• Titanium.UI.View

Gets the value of the viewShadowColor property.

• 3.3.0
• 3.3.0

Returns

• String

Gets the value of the viewShadowOffset property.

• 3.3.0
• 3.3.0

Returns

• Point

Gets the value of the viewShadowRadius property.

• 3.3.0
• 3.3.0

Returns

• Number

Gets the value of the visible property.

Returns

• Boolean

Gets the value of the width property.

Returns

• Number/String

Gets the value of the zIndex property.

Returns

• Number

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 insert
  • position (Number): Position in the children array to insert the view. If omitted, inserts the view to the end of the array.

Returns

• void

Removes all child views from this view's hierarchy.

• 3.1.0
• 3.1.0
• 3.1.0

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 insert
  • position (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 anchorPoint property.

• 0.9
• 0.9

Parameters

• anchorPoint : Point

  New value for the property.

Returns

• void

Sets the value of the backgroundColor property.

Parameters

• backgroundColor : String

  New value for the property.

Returns

• void

Sets the value of the backgroundDisabledColor property.

• 0.9

Parameters

• backgroundDisabledColor : String

  New value for the property.

Returns

• void

Sets the value of the backgroundDisabledImage property.

• 0.9

Parameters

• backgroundDisabledImage : String

  New value for the property.

Returns

• void

Sets the value of the backgroundFocusedColor property.

• 0.9

Parameters

• backgroundFocusedColor : String

  New value for the property.

Returns

• void

Sets the value of the backgroundFocusedImage property.

• 0.9

Parameters

• backgroundFocusedImage : String

  New value for the property.

Returns

• void

Sets the value of the backgroundGradient property.

Parameters

• backgroundGradient : Gradient

  New value for the property.

Returns

• void

Sets the value of the backgroundImage property.

Parameters

• backgroundImage : String

  New value for the property.

Returns

• void

Sets the value of the backgroundLeftCap property.

• 0.9
• 0.9

Parameters

• backgroundLeftCap : Number

  New value for the property.

Returns

• void

Sets the value of the backgroundRepeat property.

Parameters

• backgroundRepeat : Boolean

  New value for the property.

Returns

• void

Sets the value of the backgroundSelectedColor property.

• 0.9

Parameters

• backgroundSelectedColor : String

  New value for the property.

Returns

• void

Sets the value of the backgroundSelectedImage property.

• 0.9

Parameters

• backgroundSelectedImage : String

  New value for the property.

Returns

• void

Sets the value of the backgroundTopCap property.

• 0.9
• 0.9

Parameters

• backgroundTopCap : Number

  New value for the property.

Returns

• void

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 center property.

Parameters

• center : Point

  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 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 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 layout property.

Parameters

• layout : String

  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 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

Sets the value of the softKeyboardOnFocus property.

• 0.9

Parameters

• softKeyboardOnFocus : Number

  New value for the property.

Returns

• void

Sets the value of the tintColor property.

• 3.1.3
• 3.1.3

Parameters

• tintColor : String

  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 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 width property.

Parameters

• width : Number/String

  New value for the property.

Returns

• void

Sets the value of the zIndex property.

Parameters

• zIndex : Number

  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

Starts a batch update of this view's 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

• Titanium.Blob

Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.

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

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.

Properties

• x : Number

  X coordinate of the event from the source view's coordinate system.

• y : Number

  Y coordinate of the event from the source view'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 click against the view.

Properties

• x : Number

  X coordinate of the event from the source view's coordinate system.

• y : Number

  Y coordinate of the event from the source view'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 source view's coordinate system.

• y : Number

  Y coordinate of the event from the source view'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 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 source view's coordinate system.

• y : Number

  Y coordinate of the event from the source view'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 source view's coordinate system.

• y : Number

  Y coordinate of the event from the source view'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 source view's coordinate system.

• y : Number

  Y coordinate of the event's endpoint from the source view'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 source view's coordinate system.

• y : Number

  Y coordinate of the event from the source view'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.

  •  
  •  
  •