Titanium.UI.ImageView

A view to display a single image or series of animated images.

Use the Titanium.UI.createImageView method or <ImageView> Alloy element to create an ImageView.

Specifying either a width or height property for this view will scale its image(s) with the aspect ratio maintained, up to a maximum size that does not exceed its parent view.

Remote Images

You can display both local and remote images in an ImageView. When loading remote images, you should set the defaultImage property to a local image, which will be displayed while the remote image is being downloaded. Remote images are cached automatically on the iOS-, Android- and Windows platform.

Android Note: Android 6 and later uses runtime permissions to secure the user's privacy. Therefore, you should call Titanium.Filesystem.requestStoragePermissions before attempting to load remote images.

Read more about remote images and general best practices in the Image Best Practices Guide.

Android 9-Patch Scaled Images

A nine-patch (9-patch) image is simply a standard png image with a transparent border of a single pixel, containing "guides" defined by solid black (#000) color fills. Guides added to the top and left edges determine that the image may be stretched in horizontal and vertical planes respectively. Optionally, the content area may be defined by guides added to the bottom and right edges.

Although any image editor may be used to create the guides, certain settings can cause the edges of the graphic to "bleed" into the transparent border, consequently making it non-transparent. Thus, the draw9patch utility provided in the Android SDK tools directory is recommended for this purpose.

For further information about nine-patch images and the Android utility, see the Nine-patch and Draw 9-patch sections of the Android Developer website.

The nine-patch technique may be used with any of Titanium's static image properties. See the "Button with Nine-patch Background Image" example for a demonstration.

Extends: Titanium.UI.View · Since: 0.9

Properties #

accessibilityDisableLongPress#

extendedcreation only

Type: Boolean

Boolean value to remove the long press notification for the device's accessibility service.

Will disable the "double tap and hold for long press" message when selecting an item.

accessibilityHidden#

extended

Type: Boolean

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

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the
UIAccessibility Protocol.

On Android, setting accessibilityHidden calls the native
View.setImportantForAccessibility
method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and
later; if this property is specified on earlier versions of Android, it is ignored.

accessibilityHint#

extended

Type: String

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
Titanium.UI.View.accessibilityLabel and Titanium.UI.View.accessibilityValue in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.

accessibilityLabel#

extended

Type: String

A succinct 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
Titanium.UI.View.accessibilityValue and Titanium.UI.View.accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Defaults to Title or label of the control.

accessibilityValue#

extended

Type: String

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
Titanium.UI.View.accessibilityLabel and Titanium.UI.View.accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Defaults to State or value of the control.

anchorPoint#

extended

Type: Point

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.
The default is center of this view.

animatedCenter#

extended

Type: Point

Current position of the view during an animation.

animating#

Type: Boolean

Indicates whether animation is running.

apiName#

extended

Type: String

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.

autorotate#

creation only

Type: Boolean

Indicates whether the image should be rotated based on EXIF orientation data.

Before Titanium 10.1.0, this defaulted to false on Android.

backgroundColor#

extended

Type: String, Titanium.UI.Color

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

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

backgroundDisabledColor#

extended

Type: String

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.
Defaults to the normal background color of this view.

backgroundDisabledImage#

extended

Type: String

Disabled background image for the view, specified as a local file path or URL.

If backgroundDisabledImage is undefined, and the normal background imagebackgroundImage
is set, the normal image is used when this view is disabled.

backgroundFocusedColor#

extended

Type: String

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.
Defaults to the normal background color of this view.

backgroundFocusedImage#

extended

Type: String

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.
If backgroundFocusedImage is undefined, and the normal background image backgroundImage
is set, the normal image is used when this view is focused.

backgroundGradient#

extended

Type: Gradient

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 points, 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.
Defaults to no gradient.

backgroundImage#

extended

Type: String

Background image for the view, specified as a local file path or URL.

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, textfields, and so on), platform-specific default images are used.

backgroundLeftCap#

extended

Type: Number

Size of the left end cap.

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

backgroundRepeat#

extended

Type: Boolean

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:

backgroundSelectedColor#

extended

Type: String, Titanium.UI.Color

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.
Defaults to transparent, so the background color of this view will be used.

backgroundSelectedImage#

extended

Type: String

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.

If backgroundSelectedImage is undefined, and the normal background image backgroundImage is set
the normal image is used when this view is selected.

backgroundTopCap#

extended

Type: Number

Size of the top end cap.

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

borderColor#

extended

Type: String, Titanium.UI.Color

Border color of the view, as a color name or hex triplet.

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

Defaults to the normal background color of this view (Android), black (iOS).

borderRadius#

extended

Type: Number, String, Array<Number>, Array<String>

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

Each corner is rounded using an arc of a circle.
Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px.
Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.

If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a
backgroundColor with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)".

borderWidth#

extended

Type: Number

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.

bottom#

extended

Type: Number, String

View's bottom position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent
view's layout property. Can be either a float value or a
dimension string (for example, '50%' or '10px').

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

Defaults to undefined.

bubbleParent#

extended

Type: Boolean

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.

center#

extended

Type: Point

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.

Defaults to undefined.

clipMode#

extended

Type: Number

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.

Defaults to undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.

decodeRetries#

Type: Number

Number of times to retry decoding the bitmap at a URL.

Defaults to 2 on Titanium 10.1.0 and higher. Defaults to 5 on older SDK versions.

defaultImage#

Type: String

Local path to the default image to display while loading a remote image.

duration#

Type: Number

Amount of time in milliseconds to animate one cycle.

Starting with release 2.1.1, the minimum duration is 30 ms and the default duration is 200 ms.

On Android, prior to release 2.1.1, if any images are assigned to the images property when the animation is
started, duration will be set to the number of images multiplied by 33 ms. If no images
are assigned, duration will be set to 100 ms.

On iOS, prior to release 2.1.1, the default is 30 ms.

On Android, if the value of duration is changed, stop
and start need to be called for the new value to take effect.

elevation#

extended

Type: Number

Base elevation of the view relative to its parent in pixels.

The elevation of a view determines the appearance of its shadow.
Higher elevations produce larger and softer shadows.

Note: The elevation property only works on Titanium.UI.View objects.
Many Android components have a default elevation that cannot be modified.
For more information, see
Google design guidelines: Elevation and shadows.

enableZoomControls#

Type: Boolean

Show zoom controls when the user touches the image view.

filterTouchesWhenObscured#

extended

Type: Boolean

Discards touch related events if another app's system overlay covers the view.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a
system overlay to intercept touch events in your app or to trick the end-user to tap on UI
in your app intended for the overlay.

Setting this property to true causes touch related events (including "click") to not be fired
if a system overlay overlaps the view.

focusable#

extended

Type: Boolean

Whether view should be focusable while navigating with the trackball.

height#

extended

Type: Number, String

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.

hiddenBehavior#

extended

Type: Number

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.

Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.

hires#

Type: Boolean

Set to true to prevent scaling of 2x/3x-resolution remote images for retina
displays.

Causes images to display at 50%, where one pixel of the graphic maps to one physical pixel
on-screen. This functionality is automatically determined for local images via their
filenames, and thus this property is only applicable to remote images.

horizontalMotionEffect#

extended

Type: MinMaxOptions

Adds a horizontal parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator.
To clear all motion effects, use the Titanium.UI.clearMotionEffects method.

horizontalWrap#

extended

Type: Boolean

Determines whether the layout has wrapping behavior.

For more information, see the discussion of horizontal layout mode in the description of
the layout property.

id#

extended

Type: String

View's identifier.

The id property of the Ti.UI.View represents the view's identifier. The identifier string does
not have to be unique. You can use this property with Titanium.UI.View.getViewById method.

image#

Type: String, Titanium.Blob, Titanium.Filesystem.File

Image to display.

Image to display, defined using a local filesystem path, a File object, a remote URL,
or a Blob object containing image data.

For Android, if there is a redirect and change in protocol, it will not follow. For example,
from http to https and vice versa. See Java Bug Database
for more information.

images#

Type: Array<String>, Array<Titanium.Blob>, Array<Titanium.Filesystem.File>

Array of images to animate, defined using local filesystem paths, File objects,
remote URLs (Android only), or Blob objects containing image data.

When using this property, an initial start() needs to be called upon the ImageView before any image will show in this imageview.

Related properties/methods to look at: start, stop, pause, reverse, resume and repeatCount

imageTouchFeedback#

Type: Boolean

Enables a ripple effect when the foreground image is touched.

Note that the touchFeedback property applies a ripple effect to the
view's background. If the image is opaque and completely covers the view (such as a photo),
then the background's ripple won't be visible. In this case, you should use this imageTouchFeedback
property to apply a ripple effect to the foreground image assigned via the image property.

imageTouchFeedbackColor#

Type: String

Optional touch feedback ripple color. This has no effect unless imageTouchFeedback is true.

Defaults to provided theme color.

keepHardwareMode#

extended

Type: Boolean

A value indicating the render mode of the View

Set to true to keep hardware mode when using a border and transparent backgrounds.

keepScreenOn#

extended

Type: Boolean

Determines whether to keep the device screen on.

When true the screen will not power down. Note: enabling this feature will use more
power, thereby adversely affecting run time when on battery.
For iOS look at Titanium.App.idleTimerDisabled.

layout#

extended

Type: String

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

<table class="doc-table">
<thead>
<tr>
<th>Scenario</th>
<th>Behavior</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>height</code> & <code>top</code> specified</td>
<td>
Child positioned <code>top</code> unit from parent's top, using specified <code>height</code>;
any <code>center.y</code> and <code>bottom</code> values are ignored.
</td>
</tr>
<tr>
<td><code>height</code> & <code>center.y</code> specified</td>
<td>
Child positioned with center at <code>center.y</code>, using specified <code>height</code>;
any <code>bottom</code> value is ignored.
</td>
</tr>
<tr>
<td><code>height</code> & <code>bottom</code> specified</td>
<td>Child positioned <code>bottom</code> units from parent's bottom, using specified <code>height</code>.</td>
</tr>
<tr>
<td><code>top</code> & <code>center.y</code> specified</td>
<td>
Child positioned with top edge <code>top</code> units from parent's top and center at
<code>center.y</code>. Height is determined implicitly; any <code>bottom</code> value is ignored.
</td>
</tr>
<tr>
<td><code>top</code> & <code>bottom</code> specified</td>
<td>
Child positioned with top edge <code>top</code> units from parent's top and bottom edge
<code>bottom</code> units from parent's bottom. Height is determined implicitly.
</td>
</tr>
<tr>
<td>Only <code>top</code> specified</td>
<td>
Child positioned <code>top</code> units from parent's top, and uses the default height
calculation for the view type.
</td>
</tr>
<tr>
<td><code>center.y</code> and <code>bottom</code> specified</td>
<td>
Child positioned with center at <code>center.y</code> and bottom edge <code>bottom</code>
units from parent's bottom. Height is determined implicitly.
</td>
</tr>
<tr>
<td>Only <code>center.y</code> specified</td>
<td>Child positioned with center at <code>center.y</code>, and uses the default height calculation for the view type.</td>
</tr>
<tr>
<td>Only <code>bottom</code> specified</td>
<td>Child positioned with bottom edge <code>bottom</code> units from parent's bottom, and uses the default height calculation for the view type.</td>
</tr>
<tr>
<td><code>height</code>, <code>top</code>, <code>center.y</code>, and <code>bottom</code> unspecified</td>
<td>Child entered vertically in the parent and uses the default height calculation for the child view type.</td>
</tr>
</tbody>
</table>

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

Defaults to Composite layout.

left#

extended

Type: Number, String

View's left position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the
parent view's layout property. Can be either a float value or
a dimension string (for example, '50%' or '10px').

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

Defaults to undefined.

lifecycleContainer#

extended

Type: Titanium.UI.Window, Titanium.UI.TabGroup

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.

opacity#

extended

Type: Number

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

overrideCurrentAnimation#

extendedcreation only

Type: Boolean

When on, animate call overrides current animation if applicable.

If this property is set to false, the animate call is ignored if the view is currently being animated.

Defaults to undefined but behaves as false

paused#

Type: Boolean

Indicates whether the animation is paused.

preventDefaultImage#

Type: Boolean

Prevent the default image from being displayed while loading a remote image. This property
is ignored when the defaultImage property is set.

previewContext#

extended

Type: Titanium.UI.iOS.PreviewContext

The preview context used in the 3D-Touch feature "Peek and Pop".

Preview context to present the "Peek and Pop" of a view. Use an configured instance
of Titanium.UI.iOS.PreviewContext here.

Note: This property can only be used on devices running iOS 9 or later and supporting 3D-Touch.
It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.

pullBackgroundColor#

extended

Type: String, Titanium.UI.Color

Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.

Defaults to undefined. Results in a light grey background color on the wrapper view.

rect#

extended

Type: DimensionWithAbsolutes

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.

repeatCount#

Type: Number

Number of times to repeat the image animation.

reverse#

Type: Boolean

Run the animation in reverse.

right#

extended

Type: Number, String

View's right position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the
parent view's layout property. Can be either a float value or
a dimension string (for example, '50%' or '10px').

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

Defaults to undefined.

rotation#

extended

Type: Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

rotationX#

extended

Type: Number

Clockwise rotation of the view in degrees (x-axis).

Translation values are applied to the static post layout value.

rotationY#

extended

Type: Number

Clockwise rotation of the view in degrees (y-axis).

Translation values are applied to the static post layout value.

scaleX#

extended

Type: Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

scaleY#

extended

Type: Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

scalingMode#

Type: Number

Determines how the image is scaled within the view.

size#

extended

Type: Dimension

The size of the view in system units.

Although property returns a <Dimension> dictionary, only the width and height
properties are valid. The position properties--x and y--are always 0.

To find the position and size of the view, use the rect
property instead.

The correct values will only be available when layout is complete.
To determine when layout is complete, add a listener for the
postlayout event.

softKeyboardOnFocus#

extended

Type: Number

Determines keyboard behavior when this view is focused. Defaults to Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS.

tintColor#

Type: String, Titanium.UI.Color

The view's tintColor. Android does not support setting instances of Titanium.UI.Color

extended

Type: String

The default text to display in the control's tooltip.

Assigning a value to this property causes the tool tip to be displayed for the view.
Setting the property to null cancels the display of the tool tip for the view.
Note: This property is only used for apps targeting macOS Catalyst.

top#

extended

Type: Number, String

The view's top position.

This position is relative to the view's parent. Exact interpretation depends on the
parent view's layout property. Can be either a float value or
a dimension string (for example, '50%' or '10px').

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

touchEnabled#

extended

Type: Boolean

Determines whether view should receive touch events.

If false, will forward the events to peers.

touchFeedback#

extended

Type: Boolean

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Touch feedback is only applied to a view's background. It is never applied to the view's foreground content
such as a Titanium.UI.ImageView's image.

For Titanium versions older than 9.1.0, touch feedback only works if you set the
Titanium.UI.View.backgroundColor property to a non-transparent color.

touchFeedbackColor#

extended

Type: String

Optional touch feedback ripple color. This has no effect unless touchFeedback is true.

Defaults to provided theme color.

transform#

extended

Type: Titanium.UI.Matrix2D, Titanium.UI.Matrix3D

Transformation matrix to apply to the view.

Android only supports Matrix2D transforms.

transitionName#

extended

Type: String

A name to identify this view in activity transition.

Name should be unique in the View hierarchy.

translationX#

extended

Type: Number

Horizontal location of the view relative to its left position in pixels.

Translation values are applied to the static post layout value.

translationY#

extended

Type: Number

Vertical location of the view relative to its top position in pixels.

Translation values are applied to the static post layout value.

translationZ#

extended

Type: Number

Depth of the view relative to its elevation in pixels.

Translation values are applied to the static post layout value.

verticalMotionEffect#

extended

Type: MinMaxOptions

Adds a vertical parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator.
To clear all motion effects, use the Titanium.UI.clearMotionEffects method.

viewShadowColor#

extended

Type: String, Titanium.UI.Color

Determines the color of the shadow.

iOS Defaults to undefined. Behaves as if transparent. Android default is black.
On Android you can set <item name="android:ambientShadowAlpha">0.5</item> and
<item name="android:spotShadowAlpha">0.5</item> in your theme to change the
opacity.

viewShadowOffset#

extended

Type: Point

Determines the offset for the shadow of the view.

Defaults to undefined. Behaves as if set to (0,-3)

viewShadowRadius#

extended

Type: Number, String

Determines the blur radius used to create the shadow.

Defaults to undefined. Behaves as if set to 3. Accepts density units as of 10.0.1.

visible#

extended

Type: Boolean

Determines whether the view is visible.

width#

extended

Type: Number, String

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.

zIndex#

extended

Type: Number

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.

Defaults to undefined.

Methods #

addEventListener #

extended

Adds the specified callback as an event listener for the named event.

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to invoke when the event is fired.	No

addSymbolEffect #

Adds a symbol effect to the image view with specified options, animation, and callback.

Parameters:

Name	Type	Summary	Optional
`symbolEffect`	`String`	The symbol effect to add. One of `pulse`, `bounce`, `appear`, `disappear`, `variableColor` or `scale`.	No
`options`	`String`	The options for the symbol effect. One of `repeating`, `nonRepeating`, `repeatCount` or `speed`.	No
`animated`	`Boolean`	A Boolean value that indicates whether to animate the addition of a `scale`, `appear`, or `disappear` effect.	No
`callback`	`Callback`	A callback the system calls after the effect’s addition is complete.	No

animate #

extended

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 on SDKs older than 9.1.0 - 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.

As of SDK 9.1.0, the final values of the animation will be set on the view just before the complete event and/or the callback is fired.

The rect property can be used to determine the actual size and
position of the view.

Parameters:

Name	Type	Summary	Optional
`animation`	`Titanium.UI.Animation, Dictionary<Titanium.UI.Animation>`	Either a dictionary of animation properties or an Animation object.	No
`callback`	`Callback<Object>`	Function to be invoked upon completion of the animation.	Yes

applyProperties #

extended

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.

Parameters:

Name	Type	Summary	Optional
`props`	`Dictionary`	A dictionary of properties to apply.	No

clearMotionEffects #

extended

Removes all previously added motion effects.

Use this method together with Titanium.UI.horizontalMotionEffect and Titanium.UI.verticalMotionEffect.

convertPointToView #

extended

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.

Parameters:

Name	Type	Summary	Optional
`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.	No
`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.	No

Returns: Point

fireEvent #

extended

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`event`	`Dictionary`	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

getViewById #

extended

Returns the matching view of a given view ID.

Parameters:

Name	Type	Summary	Optional
`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.	No

Returns: Titanium.UI.View

hide #

extended

Hides this view.

Parameters:

Name	Type	Summary	Optional
`options`	`AnimatedOptions`	Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`	Yes

insertAt #

extended

Inserts a view at the specified position in the children array.

Useful if the layout property is set to horizontal or vertical.

Parameters:

Name	Type	Summary	Optional
`params`	`ViewPositionOptions`	Pass an object that specifies the view to insert and optionally at which position (defaults to end)	No

pause #

Pauses a running animation. Use resume method to continue.

This method only works if multiple images are specified.

removeEventListener #

extended

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	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to remove. Must be the same function passed to `addEventListener`.	No

resume #

Resumes an animation from a pause state.

This method only works if multiple images are specified.

show #

extended

Makes this view visible.

Parameters:

Name	Type	Summary	Optional
`options`	`AnimatedOptions`	Animation options for Android only. Since SDK 5.1.0 and only used on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`	Yes

start #

Starts the image animation. On Android, also resets index to the first image.

This method only works if multiple images are specified.

stop #

Stops a running animation. On iOS, also resets index to the first image.

This method only works if multiple images are specified.

stopAnimation #

extended

Stops a running animation.

Stops a running view Animation.

toBlob #

Returns the image as a Blob object.

Returns: Titanium.Blob

toImage #

extended

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

The honorScaleFactor argument is only supported on iOS.

Parameters:

Name	Type	Summary	Optional
`callback`	`Callback<Titanium.Blob>`	Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.	Yes
`honorScaleFactor`	`Boolean`	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.	Yes

Returns: Titanium.Blob

Events #

change #

Fired for each frame change during an animation.

Event Properties:

Name	Type	Summary
`index`	`Number`	Index of the image frame being displayed.

click #

extended

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.

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the click passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

dblclick #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the double click passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

doubletap #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the double tap passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

error #

Fired when an image fails to load.

Event Properties:

Name	Type	Summary
`success`	`Boolean`	Indicates a successful operation. Returns `false`.
`error`	`String`	Error message, if any returned. May be undefined.
`code`	`Number`	Error code. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.
`image`	`String`	URL of the image that failed to load.

focus #

extended

Fired when the view element gains focus.

This event only fires when using the trackball to navigate.

keypressed #

extended

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.

Event Properties:

Name	Type	Summary
`keyCode`	`Number`	The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.

load #

Fired when either the initial image and/or all of the images in an animation are loaded.

Event Properties:

Name	Type	Summary
`state`	`String`	Set to `image` when the image defined in the image property is loaded. Set to `images`, when the series of images defined in the images property are loaded.

longclick #

extended

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.

longpress #

extended

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.

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the long press passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

pause #

Fired when the animation pauses.

pinch #

extended

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.

Event Properties:

Name	Type	Summary
`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.
`time`	`Number`	The event time of the current event being processed.
`timeDelta`	`Number`	The time difference in milliseconds between the previous accepted scaling event and the current scaling event.
`currentSpan`	`Number`	The average distance between each of the pointers forming the gesture in progress through the focal point.
`currentSpanX`	`Number`	The average X distance between each of the pointers forming the gesture in progress through the focal point.
`currentSpanY`	`Number`	The average Y distance between each of the pointers forming the gesture in progress through the focal point.
`previousSpan`	`Number`	The previous average distance between each of the pointers forming the gesture in progress through the focal point.
`previousSpanX`	`Number`	The previous average X distance between each of the pointers forming the gesture in progress through the focal point.
`previousSpanY`	`Number`	The previous average Y distance between each of the pointers forming the gesture in progress through the focal point.
`focusX`	`Number`	The X coordinate of the current gesture's focal point.
`focusY`	`Number`	The Y coordinate of the current gesture's focal point.
`inProgress`	`Boolean`	Returns `true` if a scale gesture is in progress, `false` otherwise.

postlayout #

extended

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.

rotate #

extended

Fired when the device detects a two finger rotation.

This event is fired when doing a two finger rotation and returning the angle.
The event occurs continuously until a finger is lifted again.

Event Properties:

Name	Type	Summary
`rotate`	`Number`	Rotation in degrees.

singletap #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the single tap passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

start #

Fired when the animation starts.

stop #

Fired when the animation stops.

swipe #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the swipe passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

touchcancel #

extended

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.

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the touch passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

touchend #

extended

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.

Event Properties:

Name	Type	Summary
`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 Penciland are 9.1 or later.
`obscured`	`Boolean`	Returns `true` if the touch passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

touchmove #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the touch passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

touchstart #

extended

Fired as soon as the device detects a touch gesture.

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the touch passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

twofingertap #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the tap passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

Examples #

Basic Image View

In this example, we create a simple image view:

Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow();
var image = Ti.UI.createImageView({
  image:'/images/myimage.png'
});
win.add(image);
win.open();

Button with Nine-patch Background Image

Create a button with a nine-patch image background, that swaps with another image when selected, and generates a message in the console when clicked. Note that images are referenced in the code without the `.9` part of the filename, and that the project should be cleaned to ensure that the files are correctly copied to the project.

var win = Ti.UI.createWindow({
    backgroundColor: 'white',
    exitOnClose: true,
    fullscreen: false,
    title: 'Click button to test'
});

var button = Ti.UI.createButton({
    backgroundImage: '/images/custom-slider-right.png',
    backgroundSelectedImage:'/images/custom-slider-left.png',
    title: 'Click me!',
    top: 10,
    width: 300,
    height: 200
});
button.addEventListener('click',function(e){
    Ti.API.info("You clicked the button");
});
win.add(button);
win.open();

Alloy XML Markup

Previous basic image view example as an Alloy view.

<Alloy>
    <Window id="win" backgroundColor="white">
        <ImageView id="image" image="/images/myimage.png" />
    </Window>
</Alloy>

Notificationchannels

Launchoptionstype

Notificationparams

Usernotificationattachment

Usernotificationsettings

Mediascannerresponse

Clipboarditemstype

Systemimageparameters

Titanium.UI.ImageView ​

Remote Images ​

Android 9-Patch Scaled Images ​

Properties #

accessibilityDisableLongPress#

accessibilityHidden#

accessibilityHint#

accessibilityLabel#

accessibilityValue#

anchorPoint#

animatedCenter#

animating#

apiName#

autorotate#

backgroundColor#

backgroundDisabledColor#

backgroundDisabledImage#

backgroundFocusedColor#

backgroundFocusedImage#

backgroundGradient#

backgroundImage#

backgroundLeftCap#

backgroundRepeat#

backgroundSelectedColor#

backgroundSelectedImage#

backgroundTopCap#

borderColor#

borderRadius#

borderWidth#

bottom#

bubbleParent#

center#

clipMode#

decodeRetries#

defaultImage#

duration#

Titanium.UI.ImageView

Remote Images

Android 9-Patch Scaled Images