Titanium.UI.Label

> Titanium.UI.Label

A text label, with optional background image.

Use the Titanium.UI.createLabel method or Alloy element to create a label.

Examples

Basic Label

Create a center-aligned label with a text shadow and specified-size font, and another containing forced line breaks and unicode symbols.

var win = Ti.UI.createWindow({
  backgroundColor: 'white',
  exitOnClose: true,
  fullscreen: false,
  layout: 'vertical',
  title: 'Label Demo'
});

var label1 = Ti.UI.createLabel({
  color: '#900',
  font: { fontSize:48 },
  shadowColor: '#aaa',
  shadowOffset: {x:5, y:5},
  shadowRadius: 3,
  text: 'A simple label',
  textAlign: Ti.UI.TEXT_ALIGNMENT_CENTER,
  top: 30,
  width: Ti.UI.SIZE, height: Ti.UI.SIZE
});

var label2 = Ti.UI.createLabel({
  color:'blue',
  text: 'A long label with\na few line breaks\nand unicode (UTF8)\nsymbols such as\na white chess piece \u2655\nand the euro symbol \u20ac\nlooks like this!\n',
  textAlign: Ti.UI.TEXT_ALIGNMENT_LEFT,
  top: 30,
  width: 300, height: 200
});

win.add(label1);
win.add(label2);
win.open();

Alloy XML Markup

Previous example as an Alloy view.

The font and shadowOffset properties need to be defined in the TSS or controller file. These property values are dictionaries, rather than single values, so they cannot be included in markup.

<Alloy>
    <Window id="win" backgroundColor="white" exitOnClose="true" fullscreen="false" layout="vertical" title="Label Demo">

        <!-- The text property can either be defined as an attribute or as node text. -->
        <Label id="label1" color="#900" shadowColor="#aaa" text="A simple label" textAlign="Ti.UI.TEXT_ALIGNMENT_CENTER"
            top="30" width="Ti.UI.SIZE" height="Ti.UI.SIZE" />
        <Label id="label2" color="blue" textAlign="Ti.UI.TEXT_ALIGNMENT_LEFT" top="30" width="300" height="200">
            A long label with\na few line breaks\nand unicode (UTF8)\nsymbols such as\na white chess piece \u2655\nand the euro symbol \u20ac\nlooks like this!\n
        </Label>
    </Window>
</Alloy>

  • 0.8
  • 3.1.2
  • 0.8
  • 0.8
  • 1.8
  • 3.1
Defined By

Properties

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service. ...

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

Briefly describes what performing an action (such as a click) on the view will do.

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.

  • 3.0
  • 3.0
  • 3.0
A succint label identifying the view for the device's accessibility service. ...

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
  • 3.0
  • 3.0
A string describing the value (if any) of the view for the device's accessibility service. ...

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
  • 3.0
  • 3.0
Coordinate of the view about which to pivot an animation. ...

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.

Current position of the view during an animation.

  • 0.9
  • 0.9
apiName : Stringreadonly

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

Specify an attributed string for the label.

Specify an attributed string for the label.

If set, the label ignores the text, color, and shadow properties.

  • 3.2
  • 3.2
Background color of the view, as a color name or hex triplet. ...

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

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

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

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

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

Mobile Web and Tizen have two limitations: backfillStart and backfillEnd are ignored and the system behaves as if they are true, and endPoint is not supported for radial gradients.

Android currently only supports linear gradients. It also ignores backfillStart and backfillEnd treating them as if they are true.

Example

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: '90%',
        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

  • 0.9
  • 0.9
  • 1.8
  • 3.1
  • 0.9
Background image for the view, specified as a local file path or URL. ...

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

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
Titanium.UI.Label
backgroundPaddingBottom : Number

Number of pixels to extend the background image past the label on the bottom.

Number of pixels to extend the background image past the label on the bottom.

  • 0.8
  • 0.8
Titanium.UI.Label
backgroundPaddingLeft : Number

Number of pixels to extend the background image past the label on the left.

Number of pixels to extend the background image past the label on the left.

  • 0.8
  • 0.8
Titanium.UI.Label
backgroundPaddingRight : Number

Number of pixels to extend the background image past the label on the right.

Number of pixels to extend the background image past the label on the right.

  • 0.8
  • 0.8
Titanium.UI.Label
backgroundPaddingTop : Number

Number of pixels to extend the background image past the label on the top.

Number of pixels to extend the background image past the label on the top.

  • 0.8
  • 0.8
Determines whether to tile a background across a view. ...

Determines whether to tile a background across a view.

Setting this to true makes the set backgroundImage repeat across the view as a series of tiles. The tiling begins in the upper-left corner, where the upper-left corner of the background image is rendered. The image is then tiled to fill the available space of the view.

Note that setting this to true may incur performance penalties for large views or background images, as the tiling must be redone whenever a view is resized.

On iOS, the following views do not currently support tiled backgrounds:

Default: false

  • 0.9
  • 0.9
  • 0.9
Selected background color of the view, as a color name or hex triplet. ...

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
  • 1.8
  • 3.1
Selected background image url for the view, specified as a local file path or URL. ...

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
  • 1.8
  • 3.1
Size of the top end cap. ...

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

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, Mobile Web, Tizen), black (iOS).

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Radius for the rounded corners of the view's border. ...

Radius for the rounded corners of the view's border.

Each corner is rounded using an arc of a circle.

Default: 0

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Border width of the view. ...

Border width of the view.

Default: 0

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
: Number/String
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. ...

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
  • 3.0
  • 3.0
View's center position, in the parent view's coordinates. ...

View's center position, in the parent view's coordinates.

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Array of this view's child views.

Array of this view's child views.

View's clipping behavior. ...

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
  • 3.3
Titanium.UI.Label
color : String

Color of the label text, as a color name or hex triplet.

Color of the label text, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Titanium.UI.Label
: Boolean
Turn on/off the addition of ellipses at the end of the label if the text is too large to fit. ...

Turn on/off the addition of ellipses at the end of the label if the text is too large to fit.

Default: false

  • 0.8
  • 1.8
  • 3.1
: Booleandeprecated
Determines if the view is enabled or disabled. ...

Determines if the view is enabled or disabled.

deprecated since 3.3.0

This is deprecated on Android. Use touchEnabled property instead.

Set to true to enable or false to disable the view.

Default: Enabled by default. (Property value may be undefined.)

  • 0.9
  • 3.1.2
Whether view should be focusable while navigating with the trackball. ...

Whether view should be focusable while navigating with the trackball.

Default: false

  • 0.9
Titanium.UI.Label
font : Font

Font to use for the label text.

Font to use for the label text.

height : Number/String

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 SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

    On Mobile Web and Tizen, 'auto' always selects SIZE behavior.

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 property can be assigned the following constants:

Titanium.UI.Label
highlightedColor : String

Color of the label when in the highlighted state, as a color name or hex triplet.

Color of the label when in the highlighted state, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Used when the label is part of a view that can be highlighted, such as a Titanium.UI.TableViewRow.

  • 0.8
  • 0.8
  • 0.8
Determines whether the layout has wrapping behavior. ...

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
  • 2.1
  • 2.1
  • 2.1
  • 3.1
Titanium.UI.Label
html : String

Simple HTML formatting.

Simple HTML formatting.

  • 0.8
  • 1.8
  • 3.1
Titanium.UI.Label
: Boolean
Includes extra top and bottom padding to make room for accents that go above normal ascent and descent. ...

Includes extra top and bottom padding to make room for accents that go above normal ascent and descent.

Default: undefined but behaves as true

  • 3.3
Determines whether to keep the device screen on. ...

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

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

    ScenarioBehavior
    height & top specifiedChild positioned top unit from parent's top, using specified height; any center.y and bottom values are ignored.
    height & center.y specifiedChild positioned with center at center.y, using specified height; any bottom value is ignored.
    height & bottom specifiedChild positioned bottom units from parent's bottom, using specified height.
    top & center.y specifiedChild 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 specifiedChild 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 specifiedChild positioned top units from parent's top, and uses the default height calculation for the view type.
    center.y and bottom specifiedChild positioned with center at center.y and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only center.y specifiedChild positioned with center at center.y, and uses the default height calculation for the view type.
    Only bottom specifiedChild 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 unspecifiedChild 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, Android, Tizen and Mobile Web (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 Mobile Web prior to Release 2.1.0, the horizontal layout does not wrap by default, and does not support the horizontalWrap property. 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

: Number/String
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.

Titanium.UI.Label
minimumFontSize : Number

Minimum font size when the font is sized based on the contents.

Minimum font size when the font is sized based on the contents.

Enables font scaling to fit and forces the label content to be limited to a single line.

  • 0.8
  • 0.8
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). ...

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

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
Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.Ta...

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

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

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
  • 2.0
  • 2.0
  • 2.0
  • 3.1
: Number/String
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.

Titanium.UI.Label
shadowColor : String

Shadow color of the text, as a color name or hex triplet.

Shadow color of the text, as a color name or hex triplet.

Use in conjunction with shadowOffset and shadowRadius. For information about color values, see the "Colors" section of Titanium.UI.

  • 3.2
  • 0.8
  • 0.8
  • 1.8
  • 3.1
Titanium.UI.Label
shadowOffset : Dictionary

Shadow offset of the text, as a dictionary with the properties x and y.

Shadow offset of the text, as a dictionary with the properties x and y.

Use in conjunction with shadowColor and shadowRadius.

  • 3.2
  • 0.8
  • 0.8
  • 1.8
  • 3.1
Titanium.UI.Label
shadowRadius : Number

Shadow radius of the text.

Shadow radius of the text.

Use in conjunction with shadowColor and shadowOffset.

  • 3.2
  • 3.2

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.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Determines keyboard behavior when this view is focused. ...
Titanium.UI.Label
text : String

Label text.

Label text.

Use the backslash and letter n line feed character combination, ie \n, to force a new line.

Use unicode characters, such as those included in (but not limited to) the Unicode List of Useful Symbols section of wikipedia, to insert special characters and symbols.

See the example in label for a demonstration.

Titanium.UI.Label
: String/Number
Text alignment. ...

Text alignment.

This property can be assigned the following constants:

Titanium.UI.Label
textid : String

Key identifying a string from the locale file to use for the label text.

Key identifying a string from the locale file to use for the label text.

Only one of text or textid should be specified.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1
The view's tintColor. ...

The view's tintColor. This property is applicable on iOS 7 and greater.

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.

  • 3.1.3
  • 3.1.3
top : Number/String

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

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

Transformation matrix to apply to the view. ...

Transformation matrix to apply to the view.

Android, Tizen and Mobile Web only support 2DMatrix transforms.

Default: Identity matrix

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Titanium.UI.Label
: Number/String
Vertical text alignment, specified using one of the vertical alignment constants from Titanium.UI. ...

Vertical text alignment, specified using one of the vertical alignment constants from Titanium.UI.

On iPhone and iPad the default value of the property is undefined. The behavior of the label depends on the actual content height. If the actual content height is larger than the available height the text is truncated at the end and the content is center aligned.

On Android, the default value of the property is undefined, and the default behavior when the property is undefined is to center the text vertically.

This property can be assigned the following constants:

Default: Titanium.UI.TEXT_VERTICAL_ALIGNMENT_CENTER on Mobile Web. Undefined on Android, iPhone and iPad.

  • 3.0
  • 3.1.2
  • 3.0
  • 3.0
  • 2.0
  • 3.1
Determines the color of the shadow. ...

Determines the color of the shadow.

Default: Undefined. Behaves as if transparent.

  • 3.3
  • 3.3
Determines the offset for the shadow of the view. ...

Determines the offset for the shadow of the view.

Default: Undefined. Behaves as if set to (0,-3)

  • 3.3
  • 3.3
Determines the blur radius used to create the shadow. ...

Determines the blur radius used to create the shadow.

Default: Undefined. Behaves as if set to 3.

  • 3.3
  • 3.3
Determines whether the view is visible. ...

Determines whether the view is visible.

Default: true

width : Number/String

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 SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

On Mobile Web and Tizen, 'auto' always selects SIZE behavior.

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 property can be assigned the following constants:

Titanium.UI.Label
: Boolean
Enable or disable word wrapping in the label. ...

Enable or disable word wrapping in the label.

Default: true

  • 0.8
  • 1.8
  • 3.1
  • 3.1.2
Z-index stack order position, relative to other sibling views. ...

Z-index stack order position, relative to other sibling views.

A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.

Defined By

Methods

Titanium.UI.Label
( view ) : void
Adds a child to this view's hierarchy. ...

Adds a child to this view's hierarchy.

Adding children to a Label is not supported on all platforms.

If you need to add views on top of this object, consider using another view as a container for both this object and the views you want to appear on top of it.

See also: Titanium.UI.View.add.

  • 0.8
  • 0.8
  • 1.8
  • 3.1

Parameters

Returns

  • void

Overrides: Titanium.UI.View.add

( name, callback ) : void
Adds the specified callback as an event listener for the named event. ...

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
( animation, callback ) : void
Animates this view. ...

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. Note that on Mobile Web and Tizen, the rect property is not updated after animation. This is a known issue TIMOB-8930.

Parameters

Returns

  • void
Applies the properties to the proxy. ...

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
  • 3.3
  • 3.0
  • 3.0
  • 3.0
  • 3.1

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
( point, destinationView ) : Point
Translates a point from this view's coordinate system to another view's coordinate system. ...

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
  • 2.0
  • 3.1

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

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

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

On Mobile Web and Tizen, this method has no effect, but is included for parity.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Returns

  • void
( name, event ) : void
Fires a synthesized event to any registered listeners. ...

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

Gets the value of the accessibilityHidden property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • Boolean
Gets the value of the accessibilityHint property. ...

Gets the value of the accessibilityHint property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • String
Gets the value of the accessibilityLabel property. ...

Gets the value of the accessibilityLabel property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • String
Gets the value of the accessibilityValue property. ...

Gets the value of the accessibilityValue property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • String
Gets the value of the anchorPoint property. ...

Gets the value of the anchorPoint property.

  • 0.9
  • 0.9

Returns

Gets the value of the animatedCenter property. ...

Gets the value of the animatedCenter property.

  • 0.9
  • 0.9

Returns

Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2

Returns

  • String
Gets the value of the attributedString property. ...

Gets the value of the attributedString property.

  • 3.2
  • 3.2

Returns

Gets the value of the backgroundColor property. ...

Gets the value of the backgroundColor property.

Returns

  • String
Gets the value of the backgroundDisabledColor property. ...

Gets the value of the backgroundDisabledColor property.

  • 0.9

Returns

  • String
Gets the value of the backgroundDisabledImage property. ...

Gets the value of the backgroundDisabledImage property.

  • 0.9

Returns

  • String
Gets the value of the backgroundFocusedColor property. ...

Gets the value of the backgroundFocusedColor property.

  • 0.9

Returns

  • String
Gets the value of the backgroundFocusedImage property. ...

Gets the value of the backgroundFocusedImage property.

  • 0.9

Returns

  • String
Gets the value of the backgroundGradient property. ...

Gets the value of the backgroundGradient property.

  • 0.9
  • 0.9
  • 1.8
  • 3.1
  • 0.9

Returns

Gets the value of the backgroundImage property. ...

Gets the value of the backgroundImage property.

Returns

  • String
Gets the value of the backgroundLeftCap property. ...

Gets the value of the backgroundLeftCap property.

  • 0.9
  • 0.9

Returns

  • Number
Titanium.UI.Label
( ) : Number
Gets the value of the backgroundPaddingBottom property. ...

Gets the value of the backgroundPaddingBottom property.

  • 0.8
  • 0.8

Returns

  • Number
Titanium.UI.Label
( ) : Number
Gets the value of the backgroundPaddingLeft property. ...

Gets the value of the backgroundPaddingLeft property.

  • 0.8
  • 0.8

Returns

  • Number
Titanium.UI.Label
( ) : Number
Gets the value of the backgroundPaddingRight property. ...

Gets the value of the backgroundPaddingRight property.

  • 0.8
  • 0.8

Returns

  • Number
Titanium.UI.Label
( ) : Number
Gets the value of the backgroundPaddingTop property. ...

Gets the value of the backgroundPaddingTop property.

  • 0.8
  • 0.8

Returns

  • Number
Gets the value of the backgroundRepeat property. ...

Gets the value of the backgroundRepeat property.

  • 0.9
  • 0.9
  • 0.9

Returns

  • Boolean
Gets the value of the backgroundSelectedColor property. ...

Gets the value of the backgroundSelectedColor property.

  • 0.9
  • 1.8
  • 3.1

Returns

  • String
Gets the value of the backgroundSelectedImage property. ...

Gets the value of the backgroundSelectedImage property.

  • 0.9
  • 1.8
  • 3.1

Returns

  • String
Gets the value of the backgroundTopCap property. ...

Gets the value of the backgroundTopCap property.

  • 0.9
  • 0.9

Returns

  • Number
Gets the value of the borderColor property. ...

Gets the value of the borderColor property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

  • String
Gets the value of the borderRadius property. ...

Gets the value of the borderRadius property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

  • Number
Gets the value of the borderWidth property. ...

Gets the value of the borderWidth property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

  • Number
( ) : Number/String
Gets the value of the bottom property. ...

Gets the value of the bottom property.

Returns

  • Number/String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • Boolean
Gets the value of the center property. ...

Gets the value of the center property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

Gets the value of the children property. ...

Gets the value of the children property.

Returns

Gets the value of the clipMode property. ...

Gets the value of the clipMode property.

  • 3.3
  • 3.3

Returns

  • Number
Titanium.UI.Label
( ) : String
Gets the value of the color property. ...

Gets the value of the color property.

Returns

  • String
Titanium.UI.Label
( ) : Boolean
Gets the value of the ellipsize property. ...

Gets the value of the ellipsize property.

  • 0.8
  • 1.8
  • 3.1

Returns

  • Boolean
( ) : Booleandeprecated
Gets the value of the enabled property. ...

Gets the value of the enabled property.

deprecated since 3.3.0

  • 0.9
  • 3.1.2

Returns

  • Boolean
Gets the value of the focusable property. ...

Gets the value of the focusable property.

  • 0.9

Returns

  • Boolean
Titanium.UI.Label
( ) : Font
Gets the value of the font property. ...

Gets the value of the font property.

Returns

( ) : Number/String
Gets the value of the height property. ...

Gets the value of the height property.

Returns

  • Number/String
Titanium.UI.Label
( ) : String
Gets the value of the highlightedColor property. ...

Gets the value of the highlightedColor property.

  • 0.8
  • 0.8
  • 0.8

Returns

  • String
Gets the value of the horizontalWrap property. ...

Gets the value of the horizontalWrap property.

  • 2.1
  • 2.1
  • 2.1
  • 2.1
  • 3.1

Returns

  • Boolean
Titanium.UI.Label
( ) : String
Gets the value of the html property. ...

Gets the value of the html property.

  • 0.8
  • 1.8
  • 3.1

Returns

  • String
Titanium.UI.Label
( ) : Boolean
Gets the value of the includeFontPadding property. ...

Gets the value of the includeFontPadding property.

  • 3.3

Returns

  • Boolean
Gets the value of the keepScreenOn property. ...

Gets the value of the keepScreenOn property.

  • 0.9

Returns

  • Boolean
Gets the value of the layout property. ...

Gets the value of the layout property.

Returns

  • String
( ) : Number/String
Gets the value of the left property. ...

Gets the value of the left property.

Returns

  • Number/String
Titanium.UI.Label
( ) : Number
Gets the value of the minimumFontSize property. ...

Gets the value of the minimumFontSize property.

  • 0.8
  • 0.8

Returns

  • Number
Gets the value of the opacity property. ...

Gets the value of the opacity property.

Returns

  • Number
Gets the value of the overrideCurrentAnimation property. ...

Gets the value of the overrideCurrentAnimation property.

  • 3.3

Returns

  • Boolean
Gets the value of the pullBackgroundColor property. ...

Gets the value of the pullBackgroundColor property.

  • 3.3
  • 3.3

Returns

  • String
Gets the value of the rect property. ...

Gets the value of the rect property.

  • 2.0
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Returns

( ) : Number/String
Gets the value of the right property. ...

Gets the value of the right property.

Returns

  • Number/String
Titanium.UI.Label
( ) : String
Gets the value of the shadowColor property. ...

Gets the value of the shadowColor property.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Returns

  • String
Titanium.UI.Label
( ) : Dictionary
Gets the value of the shadowOffset property. ...

Gets the value of the shadowOffset property.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Returns

Titanium.UI.Label
( ) : Number
Gets the value of the shadowRadius property. ...

Gets the value of the shadowRadius property.

  • 3.2
  • 3.2

Returns

  • Number
Gets the value of the size property. ...

Gets the value of the size property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

Gets the value of the softKeyboardOnFocus property. ...

Gets the value of the softKeyboardOnFocus property.

  • 0.9

Returns

  • Number
Titanium.UI.Label
( ) : String
Gets the value of the text property. ...

Gets the value of the text property.

Returns

  • String
Titanium.UI.Label
( ) : String/Number
Gets the value of the textAlign property. ...

Gets the value of the textAlign property.

Returns

  • String/Number
Titanium.UI.Label
( ) : String
Gets the value of the textid property. ...

Gets the value of the textid property.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Returns

  • String
Gets the value of the tintColor property. ...

Gets the value of the tintColor property.

  • 3.1.3
  • 3.1.3

Returns

  • String
( ) : Number/String
Gets the value of the top property. ...

Gets the value of the top property.

Returns

  • Number/String
Gets the value of the touchEnabled property. ...

Gets the value of the touchEnabled property.

Returns

  • Boolean
Gets the value of the transform property. ...

Gets the value of the transform property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

Titanium.UI.Label
( ) : Number/String
Gets the value of the verticalAlign property. ...

Gets the value of the verticalAlign property.

  • 0.8
  • 3.1.2
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Returns

  • Number/String
Gets the value of the viewShadowColor property. ...

Gets the value of the viewShadowColor property.

  • 3.3
  • 3.3

Returns

  • String
Gets the value of the viewShadowOffset property. ...

Gets the value of the viewShadowOffset property.

  • 3.3
  • 3.3

Returns

Gets the value of the viewShadowRadius property. ...

Gets the value of the viewShadowRadius property.

  • 3.3
  • 3.3

Returns

  • Number
Gets the value of the visible property. ...

Gets the value of the visible property.

Returns

  • Boolean
( ) : Number/String
Gets the value of the width property. ...

Gets the value of the width property.

Returns

  • Number/String
Titanium.UI.Label
( ) : Boolean
Gets the value of the wordWrap property. ...

Gets the value of the wordWrap property.

  • 0.8
  • 1.8
  • 3.1
  • 3.1.2

Returns

  • Boolean
Gets the value of the zIndex property. ...

Gets the value of the zIndex property.

Returns

  • Number
Hides this view. ...

Hides this view.

Returns

  • void
Titanium.UI.Label
( view ) : void
Removes a child view from this view's hierarchy. ...

Removes a child view from this view's hierarchy.

See also: add, Titanium.UI.View.add.

  • 0.8
  • 0.8
  • 1.8
  • 3.1

Parameters

Returns

  • void

Overrides: Titanium.UI.View.remove

Removes all child views from this view's hierarchy. ...

Removes all child views from this view's hierarchy.

  • 3.1
  • 3.3
  • 3.1
  • 3.1
  • 1.8
  • 3.1

Returns

  • void
( name, callback ) : void
Removes the specified callback as an event listener for the named event. ...

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
( accessibilityHidden ) : void
Sets the value of the accessibilityHidden property. ...

Sets the value of the accessibilityHidden property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityHidden : Boolean

    New value for the property.

Returns

  • void
( accessibilityHint ) : void
Sets the value of the accessibilityHint property. ...

Sets the value of the accessibilityHint property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityHint : String

    New value for the property.

Returns

  • void
( accessibilityLabel ) : void
Sets the value of the accessibilityLabel property. ...

Sets the value of the accessibilityLabel property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityLabel : String

    New value for the property.

Returns

  • void
( accessibilityValue ) : void
Sets the value of the accessibilityValue property. ...

Sets the value of the accessibilityValue property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityValue : String

    New value for the property.

Returns

  • void
( anchorPoint ) : void
Sets the value of the anchorPoint property. ...

Sets the value of the anchorPoint property.

  • 0.9
  • 0.9

Parameters

  • anchorPoint : Point

    New value for the property.

Returns

  • void
Titanium.UI.Label
( attributedString ) : void
Sets the value of the attributedString property. ...

Sets the value of the attributedString property.

  • 3.2
  • 3.2

Parameters

Returns

  • void
( backgroundColor ) : void
Sets the value of the backgroundColor property. ...

Sets the value of the backgroundColor property.

Parameters

  • backgroundColor : String

    New value for the property.

Returns

  • void
( backgroundDisabledColor ) : void
Sets the value of the backgroundDisabledColor property. ...

Sets the value of the backgroundDisabledColor property.

  • 0.9

Parameters

  • backgroundDisabledColor : String

    New value for the property.

Returns

  • void
( backgroundDisabledImage ) : void
Sets the value of the backgroundDisabledImage property. ...

Sets the value of the backgroundDisabledImage property.

  • 0.9

Parameters

  • backgroundDisabledImage : String

    New value for the property.

Returns

  • void
( backgroundFocusedColor ) : void
Sets the value of the backgroundFocusedColor property. ...

Sets the value of the backgroundFocusedColor property.

  • 0.9

Parameters

  • backgroundFocusedColor : String

    New value for the property.

Returns

  • void
( backgroundFocusedImage ) : void
Sets the value of the backgroundFocusedImage property. ...

Sets the value of the backgroundFocusedImage property.

  • 0.9

Parameters

  • backgroundFocusedImage : String

    New value for the property.

Returns

  • void
( backgroundGradient ) : void
Sets the value of the backgroundGradient property. ...

Sets the value of the backgroundGradient property.

  • 0.9
  • 0.9
  • 1.8
  • 3.1
  • 0.9

Parameters

  • backgroundGradient : Gradient

    New value for the property.

Returns

  • void
( backgroundImage ) : void
Sets the value of the backgroundImage property. ...

Sets the value of the backgroundImage property.

Parameters

  • backgroundImage : String

    New value for the property.

Returns

  • void
( backgroundLeftCap ) : void
Sets the value of the backgroundLeftCap property. ...

Sets the value of the backgroundLeftCap property.

  • 0.9
  • 0.9

Parameters

  • backgroundLeftCap : Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( backgroundPaddingBottom ) : void
Sets the value of the backgroundPaddingBottom property. ...

Sets the value of the backgroundPaddingBottom property.

  • 0.8
  • 0.8

Parameters

  • backgroundPaddingBottom : Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( backgroundPaddingLeft ) : void
Sets the value of the backgroundPaddingLeft property. ...

Sets the value of the backgroundPaddingLeft property.

  • 0.8
  • 0.8

Parameters

  • backgroundPaddingLeft : Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( backgroundPaddingRight ) : void
Sets the value of the backgroundPaddingRight property. ...

Sets the value of the backgroundPaddingRight property.

  • 0.8
  • 0.8

Parameters

  • backgroundPaddingRight : Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( backgroundPaddingTop ) : void
Sets the value of the backgroundPaddingTop property. ...

Sets the value of the backgroundPaddingTop property.

  • 0.8
  • 0.8

Parameters

  • backgroundPaddingTop : Number

    New value for the property.

Returns

  • void
( backgroundRepeat ) : void
Sets the value of the backgroundRepeat property. ...

Sets the value of the backgroundRepeat property.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • backgroundRepeat : Boolean

    New value for the property.

Returns

  • void
( backgroundSelectedColor ) : void
Sets the value of the backgroundSelectedColor property. ...

Sets the value of the backgroundSelectedColor property.

  • 0.9
  • 1.8
  • 3.1

Parameters

  • backgroundSelectedColor : String

    New value for the property.

Returns

  • void
( backgroundSelectedImage ) : void
Sets the value of the backgroundSelectedImage property. ...

Sets the value of the backgroundSelectedImage property.

  • 0.9
  • 1.8
  • 3.1

Parameters

  • backgroundSelectedImage : String

    New value for the property.

Returns

  • void
( backgroundTopCap ) : void
Sets the value of the backgroundTopCap property. ...

Sets the value of the backgroundTopCap property.

  • 0.9
  • 0.9

Parameters

  • backgroundTopCap : Number

    New value for the property.

Returns

  • void
( borderColor ) : void
Sets the value of the borderColor property. ...

Sets the value of the borderColor property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • borderColor : String

    New value for the property.

Returns

  • void
( borderRadius ) : void
Sets the value of the borderRadius property. ...

Sets the value of the borderRadius property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • borderRadius : Number

    New value for the property.

Returns

  • void
( borderWidth ) : void
Sets the value of the borderWidth property. ...

Sets the value of the borderWidth property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • borderWidth : Number

    New value for the property.

Returns

  • void
( bottom ) : void
Sets the value of the bottom property. ...

Sets the value of the bottom property.

Parameters

  • bottom : Number/String

    New value for the property.

Returns

  • void
( bubbleParent ) : void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
( center ) : void
Sets the value of the center property. ...

Sets the value of the center property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • center : Point

    New value for the property.

Returns

  • void
( clipMode ) : void
Sets the value of the clipMode property. ...

Sets the value of the clipMode property.

  • 3.3
  • 3.3

Parameters

  • clipMode : Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( color ) : void
Sets the value of the color property. ...

Sets the value of the color property.

Parameters

  • color : String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( ellipsize ) : void
Sets the value of the ellipsize property. ...

Sets the value of the ellipsize property.

  • 0.8
  • 1.8
  • 3.1

Parameters

  • ellipsize : Boolean

    New value for the property.

Returns

  • void
( enabled ) : voiddeprecated
Sets the value of the enabled property. ...

Sets the value of the enabled property.

deprecated since 3.3.0

  • 0.9
  • 3.1.2

Parameters

  • enabled : Boolean

    New value for the property.

Returns

  • void
( focusable ) : void
Sets the value of the focusable property. ...

Sets the value of the focusable property.

  • 0.9

Parameters

  • focusable : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.Label
( font ) : void
Sets the value of the font property. ...

Sets the value of the font property.

Parameters

  • font : Font

    New value for the property.

Returns

  • void
( height ) : void
Sets the value of the height property. ...

Sets the value of the height property.

Parameters

  • height : Number/String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( highlightedColor ) : void
Sets the value of the highlightedColor property. ...

Sets the value of the highlightedColor property.

  • 0.8
  • 0.8
  • 0.8

Parameters

  • highlightedColor : String

    New value for the property.

Returns

  • void
( horizontalWrap ) : void
Sets the value of the horizontalWrap property. ...

Sets the value of the horizontalWrap property.

  • 2.1
  • 2.1
  • 2.1
  • 2.1
  • 3.1

Parameters

  • horizontalWrap : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.Label
( html ) : void
Sets the value of the html property. ...

Sets the value of the html property.

  • 0.8
  • 1.8
  • 3.1

Parameters

  • html : String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( includeFontPadding ) : void
Sets the value of the includeFontPadding property. ...

Sets the value of the includeFontPadding property.

  • 3.3

Parameters

  • includeFontPadding : Boolean

    New value for the property.

Returns

  • void
( keepScreenOn ) : void
Sets the value of the keepScreenOn property. ...

Sets the value of the keepScreenOn property.

  • 0.9

Parameters

  • keepScreenOn : Boolean

    New value for the property.

Returns

  • void
( layout ) : void
Sets the value of the layout property. ...

Sets the value of the layout property.

Parameters

  • layout : String

    New value for the property.

Returns

  • void
Sets the value of the left property. ...

Sets the value of the left property.

Parameters

  • left : Number/String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( minimumFontSize ) : void
Sets the value of the minimumFontSize property. ...

Sets the value of the minimumFontSize property.

  • 0.8
  • 0.8

Parameters

  • minimumFontSize : Number

    New value for the property.

Returns

  • void
( opacity ) : void
Sets the value of the opacity property. ...

Sets the value of the opacity property.

Parameters

  • opacity : Number

    New value for the property.

Returns

  • void
( pullBackgroundColor ) : void
Sets the value of the pullBackgroundColor property. ...

Sets the value of the pullBackgroundColor property.

  • 3.3
  • 3.3

Parameters

  • pullBackgroundColor : String

    New value for the property.

Returns

  • void
( right ) : void
Sets the value of the right property. ...

Sets the value of the right property.

Parameters

  • right : Number/String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( shadowColor ) : void
Sets the value of the shadowColor property. ...

Sets the value of the shadowColor property.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Parameters

  • shadowColor : String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( shadowOffset ) : void
Sets the value of the shadowOffset property. ...

Sets the value of the shadowOffset property.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Parameters

  • shadowOffset : Dictionary

    New value for the property.

Returns

  • void
Titanium.UI.Label
( shadowRadius ) : void
Sets the value of the shadowRadius property. ...

Sets the value of the shadowRadius property.

  • 3.2
  • 3.2

Parameters

  • shadowRadius : Number

    New value for the property.

Returns

  • void
( softKeyboardOnFocus ) : void
Sets the value of the softKeyboardOnFocus property. ...

Sets the value of the softKeyboardOnFocus property.

  • 0.9

Parameters

  • softKeyboardOnFocus : Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( text ) : void
Sets the value of the text property. ...

Sets the value of the text property.

Parameters

  • text : String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( textAlign ) : void
Sets the value of the textAlign property. ...

Sets the value of the textAlign property.

Parameters

  • textAlign : String/Number

    New value for the property.

Returns

  • void
Titanium.UI.Label
( textid ) : void
Sets the value of the textid property. ...

Sets the value of the textid property.

  • 0.8
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Parameters

  • textid : String

    New value for the property.

Returns

  • void
( tintColor ) : void
Sets the value of the tintColor property. ...

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

Sets the value of the top property.

Parameters

  • top : Number/String

    New value for the property.

Returns

  • void
( touchEnabled ) : void
Sets the value of the touchEnabled property. ...

Sets the value of the touchEnabled property.

Parameters

  • touchEnabled : Boolean

    New value for the property.

Returns

  • void
( transform ) : void
Sets the value of the transform property. ...

Sets the value of the transform property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

Returns

  • void
Titanium.UI.Label
( verticalAlign ) : void
Sets the value of the verticalAlign property. ...

Sets the value of the verticalAlign property.

  • 0.8
  • 3.1.2
  • 0.8
  • 0.8
  • 1.8
  • 3.1

Parameters

  • verticalAlign : Number/String

    New value for the property.

Returns

  • void
( viewShadowColor ) : void
Sets the value of the viewShadowColor property. ...

Sets the value of the viewShadowColor property.

  • 3.3
  • 3.3

Parameters

  • viewShadowColor : String

    New value for the property.

Returns

  • void
( viewShadowOffset ) : void
Sets the value of the viewShadowOffset property. ...

Sets the value of the viewShadowOffset property.

  • 3.3
  • 3.3

Parameters

  • viewShadowOffset : Point

    New value for the property.

Returns

  • void
( viewShadowRadius ) : void
Sets the value of the viewShadowRadius property. ...

Sets the value of the viewShadowRadius property.

  • 3.3
  • 3.3

Parameters

  • viewShadowRadius : Number

    New value for the property.

Returns

  • void
( visible ) : void
Sets the value of the visible property. ...

Sets the value of the visible property.

Parameters

  • visible : Boolean

    New value for the property.

Returns

  • void
( width ) : void
Sets the value of the width property. ...

Sets the value of the width property.

Parameters

  • width : Number/String

    New value for the property.

Returns

  • void
Titanium.UI.Label
( wordWrap ) : void
Sets the value of the wordWrap property. ...

Sets the value of the wordWrap property.

  • 0.8
  • 1.8
  • 3.1
  • 3.1.2

Parameters

  • wordWrap : Boolean

    New value for the property.

Returns

  • void
( zIndex ) : void
Sets the value of the zIndex property. ...

Sets the value of the zIndex property.

Parameters

  • zIndex : Number

    New value for the property.

Returns

  • void
Makes this view visible. ...

Makes this view visible.

Returns

  • void
( ) : voiddeprecated
Starts a batch update of this view's layout properties. ...

Starts a batch update of this view's layout properties.

deprecated since 3.0.0

Use the 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, while on Mobile Web and Tizen, the label text is updated immediately but the control is not resized until finishLayout is called.

See also: updateLayout, finishLayout, postlayout event.

On Mobile Web and Tizen, this method is included for parity only, and thus has no effect.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Returns

  • void
( [callback], [honorScaleFactor] ) : Titanium.Blob
Returns an image of the rendered view, as a Blob. ...

Returns an image of the rendered view, as a Blob.

The honorScaleFactor method is only supported on iOS.

  • 0.9
  • 0.9
  • 0.9

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. On Tizen, this function is asynchronous only. The callback is mandatory and function always returns "undefined".

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

    Default: False

Returns

( params ) : voiddeprecated
Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated. ...

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

On Mobile Web and Tizen, this method is included for parity only, and thus has no effect.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Parameters

  • params : Dictionary

    Layout properties to be updated.

Returns

  • void
Defined By

Events

Fired when the device detects a click against the view. ...

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

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when the device detects a double click against the view. ...

Fired when the device detects a double click against the view.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when the device detects a double tap against the view. ...

Fired when the device detects a double tap against the view.

  • 0.9
  • 0.9
  • 0.9

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when the view element gains focus. ...

Fired when the view element gains focus.

This event only fires when using the trackball to navigate.

  • 0.9

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when a hardware key is pressed in the view. ...

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.

  • 3.1

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

Fired when the device detects a long click. ...

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

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a long press. ...

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.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when the device detects a pinch gesture. ...

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

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • scale : Number

    The scale factor relative to the points of the two touches in screen coordinates.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • velocity : Number

    The velocity of the pinch in scale factor per second.

Fired when a layout cycle is finished. ...

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. On Mobile Web, this event can also be triggered by resizing the browser window.

Note that altering any properties that affect layout from the postlayout callback may result in an endless loop.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a single tap against the view. ...

Fired when the device detects a single tap against the view.

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when the device detects a swipe gesture against the view. ...

Fired when the device detects a swipe gesture against the view.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • direction : String

    Direction of the swipe--either 'left', 'right', 'up', or 'down'.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when a touch event is interrupted by the device. ...

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

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when a touch event is completed. ...

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

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired as soon as the device detects movement of a touch. ...

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

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired as soon as the device detects a touch gesture. ...

Fired as soon as the device detects a touch gesture.

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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

Fired when the device detects a two-finger tap against the view. ...

Fired when the device detects a two-finger tap against the view.

  • 3.0
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

    True if the event will try to bubble up if possible.

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

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