Titanium SDK

# Modules.Map.View

Map view is used for embedding native mapping capabilities as a view in your application.

Availability
3.1.0
3.2.0
9.2.0
Extends
Titanium.UI.View

# Overview

With native maps, you can control the mapping location, the type of map, the zoom level and you can add custom annotations and routes directly to the map. Once the map view is displayed, the user can pan, zoom and tilt the map using the native control gestures.

Use the Modules.Map.createView method to create a map view.

In Alloy, use the <Module> element with the module attribute set to ti.map and method attribute set to createView to create a map view in XML markup:

<Module module="ti.map" method="createView" />

All latitude and longitude values are specified in decimal degrees. Values in degrees, minutes and seconds (DMS) must be converted to decimal degrees before being passed to the map view.

You can add Modules.Map.Annotation objects to the map to mark points of interest. An annotation has two states: selected and deselected. A deselected annotation is marked by a pin image. When selected, the full annotation is displayed, typically including a title and an optional subtitle.

You can add Modules.Map.Route objects to the map to create paths between two or more points of interest.

To use the userLocation property in iOS 8 and later, add either the NSLocationWhenInUseUsageDescription (opens new window) or NSLocationAlwaysUsageDescription (opens new window) key to the iOS plist section of the project's tiapp.xml file.

<ti:app>
    <ios>
        <plist>
            <dict>
                <key>NSLocationAlwaysUsageDescription</key>
                <string>
                    Specify the reason for accessing the user's location information.
                    This appears in the alert dialog when asking the user for permission to
                    access their location.
                </string>
            </dict>
        </plist>
    </ios>
</ti:app>

# Properties

# accessibilityDisableLongPress CREATION ONLY

Availability
12.4.0
accessibilityDisableLongPress :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.

Default: true

# accessibilityHidden

Availability
3.1.0
3.2.0
9.2.0
accessibilityHidden :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.

Default: false

# accessibilityHint

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

Default: null

# accessibilityLabel

Availability
3.1.0
3.2.0
9.2.0
accessibilityLabel :String

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

On iOS this is a direct analog of the accessibilityLabel property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityValue and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method. Defaults to Title or label of the control.

# accessibilityValue

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

# anchorPoint

Availability
7.5.0
3.2.0
9.2.0
anchorPoint :Point

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use 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.

# animate

Availability
3.1.0
3.2.0
9.2.0
animate :Boolean

Indicates if changes to the mapping region should be animated.

Setting this to 'false' will not stop the animation from clicking the My Location button, since that is native Android behavior.

Default: false

# animatedCenter READONLY

Availability
3.2.0
9.2.0
animatedCenter :Point

Current position of the view during an animation.

# annotations

Availability
3.1.0
3.2.0
9.2.0
annotations :Array<Modules.Map.Annotation>

An array of annotations to add to the map.

There is no guarantee that the order of elements in the annotations property will be maintained when creating, adding or deleting annotations from the Ti.Map.View object. If the application depends on the annotations being in a set order, it should keep references to all of the annotations in a separate array.

# apiName READONLY

Availability
3.2.0
3.2.0
9.2.0
apiName :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, Titanium.UI.Button returns Ti.UI.Button.

# backgroundColor

Availability
3.1.0
3.2.0
9.2.0
backgroundColor :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

Availability
3.1.0
backgroundDisabledColor :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

Availability
3.1.0
backgroundDisabledImage :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

Availability
3.1.0
backgroundFocusedColor :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

Availability
3.1.0
backgroundFocusedImage :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

Availability
3.1.0
3.2.0
9.2.0
backgroundGradient :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

Availability
3.1.0
3.2.0
9.2.0
backgroundImage :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

Availability
3.2.0
9.2.0
backgroundLeftCap :Number

Size of the left end cap.

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

Default: 0

# backgroundRepeat

Availability
3.1.0
3.2.0
9.2.0
backgroundRepeat :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:

Default: false

# backgroundSelectedColor

Availability
3.1.0
backgroundSelectedColor :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.

focusable must be true for normal views.

Defaults to background color of this view.

# backgroundSelectedImage

Availability
3.1.0
backgroundSelectedImage :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

Availability
3.2.0
9.2.0
backgroundTopCap :Number

Size of the top end cap.

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

Default: 0

# borderColor

Availability
3.1.0
3.2.0
9.2.0
borderColor :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

Availability
3.1.0
3.2.0
9.2.0
borderRadius :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)".

Default: 0

# borderWidth

Availability
3.1.0
3.2.0
9.2.0
borderWidth :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.

Default: 0

# bottom

Availability
3.1.0
3.2.0
9.2.0
bottom :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

Availability
3.1.0
3.2.0
9.2.0
bubbleParent :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.

Default: true

# camera

Availability
9.1.0
3.2.0
9.2.0
camera :Modules.Map.Camera

The camera used for determining the appearance of the map.

A camera object defines a point above the map's surface from which to view the map. Applying a camera to a map has the effect of giving the map a 3D-like appearance. You can use a camera to rotate the map so that it is oriented to match the user's heading or to apply a pitch angle to tilt the plane of the map.

Assigning a new camera to this property updates the map immediately and without animating the change. If you want to animate changes in camera position, use the animateCamera method instead.

You must not set this property to null. To restore the map to a flat appearance, apply a camera with a pitch angle of 0, which yields a camera looking straight down onto the map surface.

# center

Availability
3.1.0
3.2.0
9.2.0
center :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.

# children READONLY

Availability
3.1.0
3.2.0
9.2.0
children :Array<Titanium.UI.View>

Array of this view's child views.

# clipMode

Availability
3.3.0
9.2.0
clipMode :Number

View's clipping behavior.

Setting this to CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.

Defaults to undefined. Behaves as if set to CLIP_MODE_DEFAULT.

# compassEnabled

Availability
3.2.3
6.1.0
9.2.0
compassEnabled :Boolean

Enable or disables the compass button.

Default: true

# elevation

Availability
5.0.0
elevation :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

Availability
3.1.0
enableZoomControls :Boolean

Enables or disables the built-in zoom controls.

If enabled, the zoom controls are a pair of buttons (one for zooming in, one for zooming out) that appear on the screen. When pressed, they cause the camera to zoom in (or out) by one zoom level. If disabled, the zoom controls are not shown.

Default: true

# filterTouchesWhenObscured

Availability
9.3.0
filterTouchesWhenObscured :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.

Default: false

# focusable

Availability
3.1.0
focusable :Boolean

Whether view should be focusable while navigating with the trackball.

Default: false

# height

Availability
3.1.0
3.2.0
9.2.0
height :Number | String

View height, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • SIZE. The view should size itself to fit its contents.
  • FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

# hiddenBehavior

Availability
6.1.0
hiddenBehavior :Number

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

If setting hiddenBehavior to HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied. For example: in a vertical layout the views below the object will move up when you hide an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE.

Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.

This API can be assigned the following constants:

# horizontalMotionEffect

Availability
7.3.0
9.2.0
horizontalMotionEffect :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

Availability
3.1.0
3.2.0
9.2.0
horizontalWrap :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.

Default: true

# id

Availability
3.1.0
3.2.0
9.2.0
id :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 getViewById method.

# indoorEnabled

Availability
7.5.0
indoorEnabled :Boolean

A Boolean value indicating whether the indoor mapping is enabled.

This property is used to enabled/disable the indoor mapping feature of Google Maps. Changing the value after the MapView is drawn can cause flickering. You can read more at: Google Indoor Maps

Default: true

# keepScreenOn

Availability
3.1.0
keepScreenOn :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 idleTimerDisabled.

Default: false

# layout

Availability
3.1.0
3.2.0
9.2.0
layout :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.)

    Scenario Behavior
    height & top specified Child positioned top unit from parent's top, using specified height; any center.y and bottom values are ignored.
    height & center.y specified Child positioned with center at center.y, using specified height; any bottom value is ignored.
    height & bottom specified Child positioned bottom units from parent's bottom, using specified height.
    top & center.y specified Child positioned with top edge top units from parent's top and center at center.y. Height is determined implicitly; any bottom value is ignored.
    top & bottom specified Child positioned with top edge top units from parent's top and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only top specified Child positioned top units from parent's top, and uses the default height calculation for the view type.
    center.y and bottom specified Child positioned with center at center.y and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only center.y specified Child positioned with center at center.y, and uses the default height calculation for the view type.
    Only bottom specified Child positioned with bottom edge bottom units from parent's bottom, and uses the default height calculation for the view type.
    height, top, center.y, and bottom unspecified Child entered vertically in the parent and uses the default height calculation for the child view type.

    Horizontal positioning works like vertical positioning, except that the precedence is width, left, center.x, right.

    For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.

  • vertical. Children are laid out vertically from top to bottom. The first child is laid out top units from its parent's bounding box. Each subsequent child is laid out below the previous child. The space between children is equal to the upper child's bottom value plus the lower child's top value.

    Each child is positioned horizontally as in the composite layout mode.

  • horizontal. Horizontal layouts have different behavior depending on whether wrapping is enabled. Wrapping is enabled by default (the horizontalWrap property is true).

    With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.

    Wrapping behavior is available on iOS and Android. 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

Availability
3.1.0
3.2.0
9.2.0
left :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

Availability
3.6.0
lifecycleContainer :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.

# liteMode CREATION ONLY

Availability
5.0.3
liteMode :Boolean

Create a liteMode map version

When the liteMode is switched on the map will be displayed as a bitmap with limited interaction. Please refer to Google developers documentation for more details.

Default: false

# mapToolbarEnabled

Availability
6.1.0
mapToolbarEnabled :Boolean

Enable or disables the map toolbar.

Default: true

# mapType

Availability
3.1.0
3.2.0
9.2.0
mapType :Number

Map type constant, either NORMAL_TYPE, SATELLITE_TYPE, TERRAIN_TYPE, HYBRID_TYPE, HYBRID_FLYOVER_TYPE or SATELLITE_FLYOVER_TYPE.

Default: NORMAL_TYPE

# maxZoomLevel READONLY

Availability
3.2.3
maxZoomLevel :Number

Returns the maximum zoom level available at the current camera position.

Returns the maximum zoom level for the current camera position. This takes into account what map type is currently being used. For example, satellite or terrain may have a lower max zoom level than the base map tiles.

This will only give the correct value after the 'complete' event is fired.

# minClusterSize

Availability
5.2.0
minClusterSize :Number

Sets the minium size of a cluster.

The minium cluster size is the smallest number of annotations that are merged together and (minClusterSize + 1) is the smallest number that will appear on the cluster.

Default: 4

# minZoomLevel READONLY

Availability
3.2.3
minZoomLevel :Number

Returns the minimum zoom level available at the current camera position.

Returns the minimum zoom level. This is the same for every location (unlike the maximum zoom level) but may vary between devices and map sizes.

This will only give the correct value after the 'complete' event is fired.

# opacity

Availability
3.1.0
3.2.0
9.2.0
opacity :Number

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

# overrideCurrentAnimation CREATION ONLY

Availability
3.3.0
overrideCurrentAnimation :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

# padding

Availability
7.4.0
7.4.0
9.2.0
padding :MapViewPadding

Sets the distance between each edges of the view to the map controls.

The map view controls may be obscured by other elements.

# pitchEnabled

Availability
3.2.0
9.2.0
pitchEnabled :Boolean

A Boolean value indicating whether the map camera's pitch information is used.

When this property is set to true and a valid camera is associated with the map, the camera's pitch angle is used to tilt the plane of the map. When this property is set to false, the camera's pitch angle is ignored and the map is always displayed as if the user is looking straight down onto it.

# previewContext

Availability
5.1.0
previewContext :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 iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using forceTouchSupported.

# pullBackgroundColor

Availability
3.3.0
9.2.0
pullBackgroundColor :String | Titanium.UI.Color

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

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

# rect READONLY

Availability
3.1.0
3.2.0
9.2.0
rect :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.

# region

Availability
3.1.0
3.2.0
9.2.0
region :MapRegionTypev2

A dictionary specifying the location and zoom level of the map.

Default: latitude 0, longitude 0

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

# rotateEnabled

Availability
3.2.0
9.2.0
rotateEnabled :Boolean

A Boolean value indicating whether the map camera's heading information is used.

When this property is set to true and a valid camera is associated with the map, the camera's heading angle is used to rotate the plane of the map around its center point. When this property is set to false, the camera's heading angle is ignored and the map is always oriented so that true north is situated at the top of the map view.

# rotation

Availability
5.4.0
12.3.0
rotation :Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

# rotationX

Availability
5.4.0
rotationX :Number

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

Translation values are applied to the static post layout value.

# rotationY

Availability
5.4.0
rotationY :Number

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

Translation values are applied to the static post layout value.

# scaleX

Availability
5.4.0
scaleX :Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

# scaleY

Availability
5.4.0
scaleY :Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

# scrollEnabled

Availability
8.0.0
7.2.0
9.2.0
scrollEnabled :Boolean

A Boolean value indicating whether the map can be scrolled by dragging gesture.

When this property is set to true the a map view can be panned or scrolled by dragging the map view.

Default: true

# showsBuildings

Availability
3.2.0
9.2.0
showsBuildings :Boolean

A Boolean indicating whether the map displays extruded building information.

When this property is set to true and the camera has a pitch angle greater than zero, the map extrudes buildings so that they extend above the map plane, creating a 3D effect. The mapType property must be set to NORMAL_TYPE for extruded buildings to be displayed.

Default: true

# showsCompass DEPRECATED

Availability
5.2.0
9.2.0
showsCompass :Boolean

DEPRECATED SINCE 6.1.0

Please use compassEnabled for parity instead.

A Boolean indicating whether the map displays a compass control.

When this property is set to true, the map displays the control that lets users change the heading orientation of the map.

Default: true

# showsPointsOfInterest

Availability
3.2.0
9.2.0
showsPointsOfInterest :Boolean

A Boolean indicating whether the map displays point-of-interest information.

When this property is set to true, the map displays icons and labels for restaurants, schools, and other relevant points of interest.

Default: true

# showsScale

Availability
5.2.0
9.2.0
showsScale :Boolean

A Boolean indicating whether the map shows scale information.

When this property is set to true, the map displays the scale information.

Default: false

# showsTraffic

Availability
5.2.0
9.2.0
showsTraffic :Boolean

A Boolean value indicating whether the map displays traffic information.

The mapType property must be set to NORMAL_TYPE or HYBRID_TYPE for traffic information to be shown.

Default: false

# size READONLY

Availability
3.1.0
3.2.0
9.2.0
size :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

Availability
3.1.0
softKeyboardOnFocus :Number

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

This API can be assigned the following constants:

# style

Availability
6.1.0
style :String

JSON String to style the Map.

This property will change the look (colors, roads, labels) of the map. A valid JSON can be created at Google Maps Styling Wizard

Default: false

# tintColor

Availability
3.2.0
9.2.0
tintColor :String | Titanium.UI.Color

The view's tintColor

This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.

Default: null

# tooltip

Availability
12.1.0
12.1.0
12.1.0
tooltip :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

Availability
3.1.0
3.2.0
9.2.0
top :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

Availability
3.1.0
3.2.0
9.2.0
touchEnabled :Boolean

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

# touchFeedback

Availability
6.1.0
touchFeedback :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 backgroundColor property to a non-transparent color.

Default: false

# touchFeedbackColor

Availability
6.1.0
touchFeedbackColor :String

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

Defaults to provided theme color.

# traffic

Availability
3.1.0
traffic :Boolean

Toggles the traffic layer on or off.

Set to true to display the traffic layer or false to hide it. This is subject to the availability of traffic data.

Default: false

# transform

Availability
3.1.0
3.2.0
9.2.0
transform :Titanium.UI.Matrix2D | Titanium.UI.Matrix3D

Transformation matrix to apply to the view.

Android only supports Matrix2D transforms.

Default: Identity matrix

# transitionName

Availability
5.0.2
transitionName :String

A name to identify this view in activity transition.

Name should be unique in the View hierarchy.

# translationX

Availability
5.0.0
translationX :Number

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

Translation values are applied to the static post layout value.

# translationY

Availability
5.0.0
translationY :Number

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

Translation values are applied to the static post layout value.

# translationZ

Availability
5.0.0
translationZ :Number

Depth of the view relative to its elevation in pixels.

Translation values are applied to the static post layout value.

# userLocation

Availability
3.1.0
3.2.0
9.2.0
userLocation :Boolean

Boolean indicating if the user's current device location should be shown on the map.

If true, the user's location is marked with a pin, and the My Location button will appear in the top right corner of the screen. Starting in iOS 8, permissions must be added to tiapp.xml. Details in description.

Default: false

# userLocationButton

Availability
3.1.1
userLocationButton :Boolean

Enable or disables the My Location button. If the button is enabled, it is only shown when userLocation is enabled.

If true, the My Location button is enabled.

Default: true

# verticalMotionEffect

Availability
7.3.0
9.2.0
verticalMotionEffect :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

Availability
11.1.0
3.3.0
9.2.0
viewShadowColor :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

Availability
3.3.0
9.2.0
viewShadowOffset :Point

Determines the offset for the shadow of the view.

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

# viewShadowRadius

Availability
3.3.0
9.2.0
viewShadowRadius :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

Availability
3.1.0
3.2.0
9.2.0
visible :Boolean

Determines whether the view is visible.

Default: true

# width

Availability
3.1.0
3.2.0
9.2.0
width :Number | String

View's width, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • SIZE. The view should size itself to fit its contents.
  • FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

# zIndex

Availability
3.1.0
3.2.0
9.2.0
zIndex :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.

# zoom READONLY

Availability
7.1.0
zoom :Number

Returns the current zoom level from the current camera position.

Returns the current zoom level from the current camera position. Note: This will only return the correct value once the complete event is fired.

# zoomEnabled

Availability
8.0.0
7.2.0
9.2.0
zoomEnabled :Boolean

A Boolean value indicating whether the map can be zoomed by pinching or tapping.

When this property is set to true the a map view can be zoomed by pinching inwards to zoom out and reverse to zoom in. Zooming in can also be accoplished by double-tapping the map view. Zooming out can also be accomplished by two-finger tapping the map view.

Default: true

# zOrderOnTop CREATION ONLY

Availability
3.1.0
3.2.0
9.2.0
zOrderOnTop :Boolean

Controls wether the map view's surface is placed on top of its window.

Please refer to zOrderOnTop for more details.

Default: false

# Methods

# add

Availability
3.1.0
3.2.0
9.2.0
add(view) → void

Adds a child to this view's hierarchy.

The child view is added as the last child in this view's hierarchy.

Although all views inherit from Titanium.UI.View, not all views are capable of containing other views. In particular:

  • Some views are not designed to be containers at all.
  • Some views are special-purpose containers that can only contain certain other views.
  • Some views are top-level containers that cannot (or should not) be added to other views.

# Non-Container Views

The following views are not intended to act as containers that can hold other views:

Adding children to the these views may be supported on some platforms, but is not guaranteed to work across platforms. Where it is supported, it may not work as expected.

For maximum portability, these views should be treated as if they do not support children. Instead of adding children to these views, applications can positon other views as siblings. For example, instead of adding a button as a child of a WebView, you can add the button to the web view's parent such that it appears on top of the web view.

# Special-Purpose Containers

A few view objects act as special-purpose containers--that is, they only manage certain types of children, and many of them support a special means of adding these children, instead of the general add method. These containers include:

  • Titanium.UI.ButtonBar and Titanium.UI.iOS.TabbedBar are designed to hold their own internally-created buttons, assigned by adding strings to the "labels" array. Views added using the add method are displayed on top of these buttons.

  • Titanium.UI.Picker. Can only hold PickerRows and PickerColumns, which are added using the add method. Adding other types of views to a Picker is not supported.

  • Titanium.UI.TableView is a specialized container for TableViewSection and TableViewRow objects. These objects must be added using the properties and methods that TableView provides for adding and removing sectons and rows.

    On some platforms, it is possible to add arbitrary child views to a table view using the add method. However, this is not guaranteed to work on all platforms, and in general, should be avoided.

  • Titanium.UI.TableViewSection is a specialized container for TableViewRow objects, which are added using the add method. The add method on TableViewSection can only be used to add TableViewRow objects.

  • Titanium.UI.iOS.Toolbar is designed to hold buttons and certain other controls, added to its items array. Views added using the add method are displayed on top of the controls in the items array.

  • The Tab, TabGroup, NavigationWindow and SplitWindow objects are special containers that manage windows. These are discussed in the "Top-Level Containers" section.

# Top-Level Containers

There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Titanium.UI.Window, Titanium.UI.iOS.SplitWindow, Titanium.UI.NavigationWindow, and Titanium.UI.TabGroup. Other types of views must be added to a top-level container in order to be displayed on screen.

The special containers Titanium.UI.NavigationWindow, Titanium.UI.iOS.SplitWindow, Titanium.UI.Tab, and Titanium.UI.TabGroup manage windows. These managed windows may be referred to as children of the container, but they are not added using the add method.

Tab is another kind of special container: it is not itself a top-level container, but can only be used within a TabGroup. You cannot add a Tab to an arbitrary container.

Parameters

Name Type Description
view Titanium.UI.View | Array<Titanium.UI.View>

View to add to this view's hierarchy.

You may pass an array of views, e.g. view.add([subview1, subview2].

Returns

Type
void

# addAnnotation

Availability
3.1.0
3.2.0
9.2.0
addAnnotation(annotation) → void

Adds a new annotation to the map.

Parameters

Name Type Description
annotation Modules.Map.Annotation

Returns

Type
void

# addAnnotations

Availability
3.1.0
3.2.0
9.2.0
addAnnotations(annotations) → void

Adds one or more new annotations to the map.

Parameters

Name Type Description
annotations Array<Modules.Map.Annotation>

Array of Modules.Map.Annotation objects

Returns

Type
void

# addCircle

Availability
3.1.0
3.2.0
9.2.0
addCircle(circle) → void

Adds a new circle to the map.

Parameters

Name Type Description
circle Modules.Map.Circle

a Modules.Map.Circle instance.

Returns

Type
void

# addCircles

Availability
3.2.0
9.2.0
addCircles(circles) → void

Adds one or more new circles to the map.

Parameters

Name Type Description
circles Array<Modules.Map.Circle>

Array of Modules.Map.Circle objects

Returns

Type
void

# addEventListener

Availability
3.1.0
3.2.0
9.2.0
addEventListener(name, callback) → void

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

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# addHeatmap

Availability
10.1.0
addHeatmap(coordinates) → void

Adds a heatmap to the map.

A heatmap is defined by an array of coordinates.

Parameters

Name Type Description
coordinates MapPointType

An array of coordinates

Returns

Type
void

# addImageOverlay

Availability
7.4.0
7.2.0
9.2.0
addImageOverlay(imageOverlay) → void

Adds a new image overlay to the map.

Parameters

Name Type Description
imageOverlay Modules.Map.ImageOverlay

Returns

Type
void

# addImageOverlays

Availability
7.4.0
7.2.0
9.2.0
addImageOverlays(imageOverlays) → void

Adds one or more new image overlays to the map.

Parameters

Name Type Description
imageOverlays Array<Modules.Map.ImageOverlay>

Array of Modules.Map.ImageOverlay objects

Returns

Type
void

# addPolygon

Availability
3.1.0
3.2.0
9.2.0
addPolygon(polygon) → void

Adds a new polygon to the map.

Parameters

Name Type Description
polygon Modules.Map.Polygon

a Modules.Map.Polygon instance.

Returns

Type
void

# addPolygons

Availability
3.1.0
3.2.0
9.2.0
addPolygons(polygons) → void

Adds one or more new polygons to the map.

Parameters

Name Type Description
polygons Array<Modules.Map.Polygon>

Array of Modules.Map.Polygon objects

Returns

Type
void

# addPolyline

Availability
3.1.0
3.2.0
9.2.0
addPolyline(polygon) → void

Adds a new polylines to the map.

Parameters

Name Type Description
polygon Modules.Map.Polyline

Returns

Type
void

# addPolylines

Availability
3.1.0
3.2.0
9.2.0
addPolylines(polylines) → void

Adds one or more new polylines to the map.

Parameters

Name Type Description
polylines Array<Modules.Map.Polyline>

Array of Modules.Map.Polyline objects

Returns

Type
void

# addRoute

Availability
3.1.0
3.2.0
9.2.0
addRoute(route) → void

Adds a route to the map.

Parameters

Name Type Description
route Modules.Map.Route

Modules.Map.Route

Returns

Type
void

# animate

Availability
3.1.0
3.2.0
9.2.0
animate(animation[, callback]) → void

Animates this view.

The Titanium.UI.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 Description
animation Titanium.UI.Animation | Dictionary<Titanium.UI.Animation>

Either a dictionary of animation properties or an Titanium.UI.Animation object.

callback Callback<Object>

Function to be invoked upon completion of the animation.

Returns

Type
void

# animateCamera

Availability
9.1.0
3.2.0
9.2.0
animateCamera(animationParams, callback) → void

Changes the camera used for determining the map's viewing parameters and animates the change.

Parameters

Name Type Description
animationParams CameraAnimationParams

Properties for controlling the camera animation. The property camera is required.

callback Callback<Object>

A method that will be called when the camera animation completes. Optionally, the completion of camera animations can be captured by listening for a regionchanged event with animated set to true.

Returns

Type
void

# applyProperties

Availability
3.1.0
3.2.0
9.2.0
applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# clearMotionEffects

Availability
8.2.0
9.2.0
clearMotionEffects() → void

Removes all previously added motion effects.

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

Returns

Type
void

# containsCoordinate

Availability
10.1.0
10.1.0
10.1.0
containsCoordinate(coordinate) → Boolean

Validated whether or not a given coordinate is currently visible in the map rect.

Parameters

Name Type Description
coordinate MapPointType

The latitude and longitude pair represented by an Object.

Returns

Returns true if given coordinate is within the displayed map view.

Type
Boolean

# convertPointToView

Availability
3.1.0
3.2.0
9.2.0
convertPointToView(point, destinationView) → Point

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

Type
Point

# deselectAnnotation

Availability
3.1.0
3.2.0
9.2.0
deselectAnnotation(annotation) → void

Deselects the specified annotation, so the main annotation is hidden and only a pin image is shown.

Parameters

Name Type Description
annotation String | Modules.Map.Annotation

Annotation to deselect, identified by an annotation title or a Modules.Map.Annotation reference.

Returns

Type
void

# fireEvent

Availability
3.1.0
3.2.0
9.2.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
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

Type
void

# getViewById

Availability
6.1.0
6.1.0
9.2.0
getViewById(id) → Titanium.UI.View

Returns the matching view of a given view ID.

Parameters

Name Type Description
id String

The ID of the view that should be returned. Use the id property in your views to enable it for indexing in this method.

Returns

Type
Titanium.UI.View

# hide

Availability
3.1.0
3.2.0
9.2.0
hide([options]) → void

Hides this view.

Parameters

Name Type Description
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 }

Returns

Type
void

# insertAt

Availability
3.3.0
3.3.0
9.2.0
insertAt(params) → void

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 Description
params ViewPositionOptions

Pass an object that specifies the view to insert and optionally at which position (defaults to end)

Returns

Type
void

# remove

Availability
3.1.0
3.2.0
9.2.0
remove(view) → void

Removes a child view from this view's hierarchy.

Parameters

Name Type Description
view Titanium.UI.View

View to remove from this view's hierarchy.

Returns

Type
void

# removeAllAnnotations

Availability
3.1.0
3.2.0
9.2.0
removeAllAnnotations() → void

Removes all annotations from the map.

Returns

Type
void

# removeAllChildren

Availability
3.1.0
3.2.0
9.2.0
removeAllChildren() → void

Removes all child views from this view's hierarchy.

Returns

Type
void

# removeAllCircles

Availability
3.1.0
3.2.0
9.2.0
removeAllCircles() → void

Remove all circles from the map.

Returns

Type
void

# removeAllImageOverlays

Availability
7.4.0
7.2.0
9.2.0
removeAllImageOverlays() → void

Remove all image overlays from the map.

Returns

Type
void

# removeAllPolygons

Availability
3.1.0
3.2.0
9.2.0
removeAllPolygons() → void

Remove all polygons from the map.

Returns

Type
void

# removeAllPolylines

Availability
3.1.0
3.2.0
9.2.0
removeAllPolylines() → void

Remove all polylines from the map.

Returns

Type
void

# removeAnnotation

Availability
3.1.0
3.2.0
9.2.0
removeAnnotation(annotation) → void

Removes an existing annotation from the map.

Parameters

Name Type Description
annotation String | Modules.Map.Annotation

Annotation to remove, identified by an annotation title or a Modules.Map.Annotation reference.

Returns

Type
void

# removeAnnotations

Availability
3.1.0
3.2.0
9.2.0
removeAnnotations(annotations) → void

Removes one or more existing annotations from the map.

Annotations can be identified by title or by a Modules.Map.Annotation reference.

Parameters

Name Type Description
annotations Array<String> | Array<Modules.Map.Annotation>

Array of annotations to remove.

Returns

Type
void

# removeCircle

Availability
3.1.0
3.2.0
9.2.0
removeCircle(circle) → void

Remove a circle from the map.

Parameters

Name Type Description
circle Modules.Map.Circle

Returns

Type
void

# removeEventListener

Availability
3.1.0
3.2.0
9.2.0
removeEventListener(name, callback) → void

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

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

# removeImageOverlay

Availability
7.4.0
7.2.0
9.2.0
removeImageOverlay(imageOverlay) → void

Remove an image overlay from the map.

Parameters

Name Type Description
imageOverlay Modules.Map.ImageOverlay

Returns

Type
void

# removePolygon

Availability
3.1.0
3.2.0
9.2.0
removePolygon(polygon) → void

Remove a polygon from the map.

Parameters

Name Type Description
polygon Modules.Map.Polygon

Returns

Type
void

# removePolyline

Availability
3.1.0
3.2.0
9.2.0
removePolyline(polyline) → void

Remove a polyline from the map.

Parameters

Name Type Description
polyline Modules.Map.Polyline

Returns

Type
void

# removeRoute

Availability
3.1.0
3.2.0
9.2.0
removeRoute(route) → void

Remove a previously added route.

Parameters

Name Type Description
route Modules.Map.Route

An instance of Modules.Map.Route

Returns

Type
void

# replaceAt

Availability
3.3.0
3.3.0
9.2.0
replaceAt(params) → void

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

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

Parameters

Name Type Description
params ViewPositionOptions

Pass an object with the view to insert and the position of the view to replace. In this case the position property is required.

Returns

Type
void

# selectAnnotation

Availability
3.1.0
3.2.0
9.2.0
selectAnnotation(annotation) → void

Selects the annotation, showing the full annotation.

Parameters

Name Type Description
annotation String | Modules.Map.Annotation

Annotation to show, identified by an annotation title or a Modules.Map.Annotation reference.

Returns

Type
void

# setClusterAnnotation

Availability
7.4.0
6.3.0
9.2.0
setClusterAnnotation(clusterAnnotationParam) → void

Set new cluster annotation for the clustered annotation.

This method should be called inside the clusterstart event. See the example "Map Example With Marker Annotation and Clustering".

Parameters

Name Type Description
clusterAnnotationParam ClusterAnnotationParams

Properties for creating cluster annotation.

Returns

Type
void

# setLocation

Availability
3.1.0
3.2.0
9.2.0
setLocation(location) → void

Sets the map location and zoom level.

The location is set using a simple dictionary object, described in MapLocationTypeV2. If latitudeDelta and longitudeDelta are set, these specified parameters bound the area of interest, which is centered and displayed at the greatest possible zoom level. This method can only be called after the map completes loading. Before that, use region to set the map location. For example:

myMapView.setLocation({
  latitude: 37.337681,
  longitude: -122.038193,
  animate: true,
  latitudeDelta: 0.04,
  longitudeDelta: 0.04
});

Parameters

Name Type Description
location MapLocationTypeV2

Dictionary specifying the location and the zoom level for the map.

Returns

Type
void

# setMapType

Availability
3.1.0
3.2.0
9.2.0
setMapType(mapType) → void

Sets the type of map (satellite, normal, or terrain).

Parameters

Name Type Description
mapType Number

Returns

Type
void

# show

Availability
3.1.0
3.2.0
9.2.0
show([options]) → void

Makes this view visible.

Parameters

Name Type Description
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 }

Returns

Type
void

# showAnnotations

Availability
8.0.0
3.2.0
9.2.0
showAnnotations([annotations]) → void

Sets the visible region so that the map displays the specified annotations. If no array is passed annotations on the map will be shown. The default padding of 20px is applied and can be changed by using the padding property.

Parameters

Name Type Description
annotations Array<Modules.Map.Annotation>

An array of Modules.Map.Annotation to display.

Returns

Type
void

# snapshot

Availability
3.2.3
snapshot() → void

Takes a snapshot of the map

Takes a snapshot of the current map and returns the image via onsnapshotready event.

Returns

Type
void

# stopAnimation

Availability
12.1.0
stopAnimation() → void

Stops a running animation.

Stops a running view Titanium.UI.Animation.

Returns

Type
void

# toImage

Availability
3.1.0
3.2.0
9.2.0
toImage([callback[, honorScaleFactor]]) → Titanium.Blob

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

The honorScaleFactor argument is only supported on iOS.

Parameters

Name Type Description
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.

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.

Returns

Type
Titanium.Blob

# zoom

Availability
3.1.0
3.2.0
9.2.0
zoom(level) → void

Zooms in or out of the map.

Zooms in or out by specifying a relative zoom level. A positive value increases the current zoom level and a negative value decreases the zoom level.

Each increase in zoom level increases the magnification by a factor of two.

Parameters

Name Type Description
level Number

Relative zoom level (positive to zoom in, negative to zoom out).

Returns

Type
void

# Events

# click

Availability
3.1.0
3.2.0
9.2.0

Fired when the user selects or deselects an annotation, a polygon, a polyline or a circle.

Note that the click event is not fired every time the user clicks on the map. It is fired in two circumstances:

  • The user clicks on the annotation. This will select the annotation.
  • The user deselects an annotation either by clicking on the map or another annotation.
  • The user clicks on a polygon, a polyline or a circle.

Note that only one annotation can be selected at any given time.

The click event includes a value, clicksource, which describes the part of the annotation that was clicked. The clicksource can be one of pin, infoWindow, leftButton or rightButton on iOS and pin, title, subtitle, leftPane, rightPane, infoWindow or null on Android. If the user deselects an annotation by clicking on the pin, clicksource is pin. If the user deselects the annotation by clicking elsewhere in the map view, clicksource is map.

For polygon, polyline or circle, The click event includes the following values. clicksource is a string describing the shape type. map is the map view instance. latitude and longtitude is the corresponding coordinates on the map where the user clicked in the shape.

Properties

Name Type Description
title String

Title of the annotation.

subtitle String

Subtitle of the annotation.

map Modules.Map.View

The map view instance.

clicksource String

Source of the click event. Can be one of pin, leftPane, rightPane, infoWindow or null. If it's a shape, it can be one of polygon, polyline, or circle. On Android, this also applies for title and subtitle.

annotation Modules.Map.Annotation

Annotation source object.

latitude Number

Latitude of the clicked annotation or the point clicked in the polygon, polyline and circle.

longitude Number

Longitude of the clicked annotation or the point clicked in the polygon, polyline and circle.

deselected Boolean

Will show if the annotation was selected (false) or deselected (true)

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# focus

Availability
3.1.0

Fired when the view element gains focus.

This event only fires when using the trackball to navigate.

# keypressed

Availability
3.1.0
5.4.0
9.2.0

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 Titanium.UI.TextArea, Titanium.UI.TextField and Titanium.UI.SearchBar.

Properties

Name Type Description
keyCode Number

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

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# longclick

Availability
3.2.0

Fired when the user makes a long-press gesture on the map.

A long press is generated by touching and holding on the touch screen.

The event occurs before the finger/button is lifted.

The longclick event returns longitude and latitude of the point on the ground that was pressed.

Properties

Name Type Description
latitude Number

latitude of the point on the ground that was pressed.

longitude Number

longitude of the point on the ground that was pressed.

map Modules.Map.View

The map view instance.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# postlayout

Availability
3.1.0
3.2.0
9.2.0

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.

# clusterstart

Availability
6.3.0
9.2.0

Fired when a collision between annotations occures.

Properties

Name Type Description
memberAnnotations Array<Modules.Map.Annotation>

Array of annotations participating in clustering.

map Modules.Map.View

This map view.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# onsnapshotready

Availability
3.2.3

Fired when the snapshot is ready after snapshot is invoked.

Properties

Name Type Description
snapshot Titanium.Blob

snapshot of the current map

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# pinchangedragstate

Availability
3.1.0
3.2.0
9.2.0

Fired when the user interacts with a draggable annotation.

Properties

Name Type Description
annotation Modules.Map.Annotation

Annotation being dragged.

map Modules.Map.View

This map view.

title String

Annotation title.

newState Number
oldState Number
source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# complete

Availability
3.1.0
3.2.0
9.2.0

Fired when the map completes loading.

# mapclick

Availability
6.2.0
6.2.0
9.2.0

Fired when the user clicks on the map

The mapclick event is fired when the user clicks on the map and returns the longitude/latitude of that position.

Properties

Name Type Description
map Modules.Map.View

The map view instance.

latitude Number

Latitude of the clicked position.

longitude Number

Longitude of the clicked position.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# regionwillchange

Availability
6.2.0
6.0.0
9.2.0

Fired when the mapping region will change.

Properties

Name Type Description
longitude Number

Longitude value for the center point of the map, in decimal degrees.

latitude Number

Latitude value for the center point of the map, in decimal degrees.

longitudeDelta Number

The amount of east-to-west distance displayed on the map, measured in decimal degrees.

latitudeDelta Number

The amount of north-to-south distance displayed on the map, measured in decimal degrees.

animated Boolean

The regionwillchange event was caused by an animation, such as a animating the camera.

reason Number

The reason for the camera change, either REASON_API_ANIMATION, REASON_DEVELOPER_ANIMATION or REASON_GESTURE.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# regionchanged

Availability
3.1.0
3.2.0
9.2.0

Fired when the mapping region finished changing.

Properties

Name Type Description
longitude Number

Longitude value for the center point of the map, in decimal degrees.

latitude Number

Latitude value for the center point of the map, in decimal degrees.

longitudeDelta Number

The amount of east-to-west distance displayed on the map, measured in decimal degrees.

latitudeDelta Number

The amount of north-to-south distance displayed on the map, measured in decimal degrees.

animated Boolean

The regionchanged event was caused by an animation, such as a animating the camera.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# userLocation

Availability
7.3.0
3.2.0
9.2.0

Fired when the user changes on the map.

When the user location is available or changes at the map it will fire the event.

Properties

Name Type Description
latitude Number

Latitude of the point on the ground that was pressed.

longitude Number

Longitude of the point on the ground that was pressed.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

# poideselect

Availability
12.2.0
12.2.0

Fired when the user deselects a Point of Interest (e.g. restaurant or hotel).

# poiclick

Availability
12.0.0
12.0.0

Fired when the user selects a Point of Interest (e.g. restaurant or hotel).

Make sure to use the <Modules.Map.View.selectableMapFeatures> property to define annotations tha should be selectable. Available in iOS 16+

Properties

Name Type Description
name String

The descriptive name associated with the map item.

featureType Number

The type of map feature this annotation represents. See the Apple docs for all possible enum values.

pointOfInterestCategory Number

The point-of-interest category for the map item. See the Apple docs for all possible enum values.

phoneNumber String

The phone number associated with a business at the specified location.

url String

The URL associated with the specified location.

place Object

The placemark object containing the location information.

latitude Number

Latitude of the annotation that was selected.

longitude Number

Longitude of the annotation that was selected.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

Contents