Map view is used for embedding native mapping capabilities as a view in your application.
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 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 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
or
NSLocationAlwaysUsageDescription
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>
Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.
Requires: Android 4.0 and later iOS 5.0 and later
On iOS this is a direct analog of the accessibilityElementsHidden property defined in the
UIAccessibility
Protocol.
The native property is only available in iOS 5.0 and later; if
accessibilityHidden is specified on earlier versions of iOS, it is ignored.
On Android, setting accessibilityHidden calls the native
View.setImportantForAccessibility
method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and
later; if this property is specified on earlier versions of Android, it is ignored.
Default: false
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:
A succint label identifying the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityLabel property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityValue and accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: Title or label of the control.
A string describing the value (if any) of the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityValue property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: State or value of the control.
Coordinate of the view about which to pivot an animation.
Used on iOS only. For Android, use Titanium.UI.Animation.anchorPoint.
Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at
the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right
corner.
See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration.
Default: Center of this view.
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
Current position of the view during an animation.
Current position of the view during an animation.
An array of annotations to add to the map.
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.
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
Background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Transparent
Disabled background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view.
Disabled background image for the view, specified as a local file path or URL.
Default: If `backgroundDisabledImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is disabled.
Focused background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
For normal views, the focused color is only used if focusable is true.
Default: Same as the normal background color of this view.
Focused background image for the view, specified as a local file path or URL.
For normal views, the focused background is only used if focusable is true.
Default: If `backgroundFocusedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is focused.
A background gradient for the view.
A gradient can be defined as either linear or radial. A linear gradient varies continuously
along a line between the startPoint and endPoint.
A radial gradient is interpolated between two circles, defined by startPoint and
startRadius and endPoint and endRadius respectively.
The start and end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:
{ x: 30, y: 30 }
Or: { x: '50%', y: '50%' }
When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]
Android's linear gradients ignores backfillStart and backfillEnd, treating them as if
they are true. Android's radial gradients ignore the endPoint property.
The following code excerpt creates two views, one with a linear gradient and one with a radial gradient.
var win1 = Titanium.UI.createWindow({
title:'Tab 1',
backgroundColor:'#fff',
layout: 'vertical'
});
var radialGradient = Ti.UI.createView({
top: 10,
width: 100,
height: 100,
backgroundGradient: {
type: 'radial',
startPoint: { x: 50, y: 50 },
endPoint: { x: 50, y: 50 },
colors: [ 'red', 'blue'],
startRadius: 50,
endRadius: 0,
backfillStart: true
}
});
var linearGradient = Ti.UI.createView({
top: 10,
width: 100,
height: 100,
backgroundGradient: {
type: 'linear',
startPoint: { x: '0%', y: '50%' },
endPoint: { x: '100%', y: '50%' },
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],
}
});
win1.add(radialGradient);
win1.add(linearGradient);
win1.open();
Default: No gradient
Background image for the view, specified as a local file path or URL.
Default: Default behavior when `backgroundImage` is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, text fields, and so on), platform-specific default images are used.
Size of the left end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
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
Selected background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
focusable must be true for normal views.
Default: Background color of this view.
Selected background image url for the view, specified as a local file path or URL.
For normal views, the selected background is only used if focusable is true.
Default: If `backgroundSelectedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is selected.
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
Border color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view (Android), black (iOS).
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Default: 0
Border width of the view.
If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.
Default: 0
View's bottom position, in platform-specific units.
View's bottom position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
The camera used for determining the appearance of the map.
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.
View's center position, in the parent view's coordinates.
View's center position, in the parent view's coordinates.
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Array of this view's child views.
Array of this view's child views.
View's clipping behavior.
Setting this to Titanium.UI.iOS.CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to Titanium.UI.iOS.CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to Titanium.UI.iOS.CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.
Default: Undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.
Enable or disables the compass button.
Requires: iOS 9.0 and later
Default: true
Base elevation of the view relative to its parent in pixels.
Requires: Android 5 and later
The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.
Note: The elevation property only works on Titanium.UI.View objects.
Many Android components have a default elevation that cannot be modified.
For more information, see
Google design guidelines: Elevation and shadows.
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
Whether view should be focusable while navigating with the trackball.
Default: false
View height, in platform-specific units.
View height, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
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:
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
Determines whether to keep the device screen on.
When true the screen will not power down. Note: enabling this feature will use more
power, thereby adversely affecting run time when on battery.
Default: false
Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.
There are three layout options:
composite (or absolute). Default layout. A child view is positioned based on its
positioning properties or "pins" (top, bottom, left, right and center).
If no positioning properties are specified, the child is centered.
The child is always sized based on its width and height properties, if these are
specified. If the child's height or width is not specified explicitly, it may be
calculated implicitly from the positioning properties. For example, if both left and
center.x are specified, they can be used to calculate the width of the child control.
Because the size and position properties can conflict, there is a specific precedence
order for the layout properties. For vertical positioning, the precedence
order is: height, top, center.y, bottom.
The following table summarizes the various combinations of properties that can
be used for vertical positioning, in order from highest precedence to lowest.
(For example, if height, center.y and bottom are all specified, the
height and center.y values take precedence.)
| Scenario | Behavior |
|---|---|
| `height` & `top` specified | Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored. |
| `height` & `center.y` specified | Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored. |
| `height` & `bottom` specified | Child positioned `bottom` units from parent's bottom, using specified `height`. |
| `top` & `center.y` specified | Child positioned with top edge `top` units from parent's top and center at `center.y`. Height is determined implicitly; any `bottom` value is ignored. |
| `top` & `bottom` specified | Child positioned with top edge `top` units from parent's top and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. |
| Only `top` specified | Child positioned `top` units from parent's top, and uses the default height calculation for the view type. |
| `center.y` and `bottom` specified | Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. |
| Only `center.y` specified | Child positioned with center at `center.y`, and uses the default height calculation for the view type. |
| Only `bottom` specified | Child positioned with bottom edge `bottom` units from parent's bottom, and uses the default height calculation for the view type. |
| `height`, `top`, `center.y`, and `bottom` unspecified | Child centered vertically in the parent and uses the default height calculation for the child view type. |
Horizontal positioning works like vertical positioning, except that the
precedence is width, left, center.x, right.
For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.
vertical. Children are laid out vertically from top to bottom. The first child
is laid out top units from its parent's bounding box. Each subsequent child is
laid out below the previous child. The space between children is equal to the
upper child's bottom value plus the lower child's top value.Each child is positioned horizontally as in the composite layout mode.
horizontal. Horizontal layouts have different behavior depending on whether wrapping
is enabled. Wrapping is enabled by default (the horizontalWrap property is true).With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.
Wrapping behavior is available on iOS and Android (Release 2.1.0 and later).
When the horizontalWrap property is set to true, the first row is placed at the top of the
parent view, and successive rows are placed below the first row. Each child is
positioned vertically within its row somewhat like composite layout mode.
In particular:
top or bottom is specified, the child is centered in the
row.top or bottom is specified, the child is aligned to either
the top or bottom of the row, with the specified amount of padding.top and bottom is specified for a given child, the properties
are both treated as padding.If the horizontalWrap property is false, the behavior is more equivalent to a vertical layout.
Children are laid or horizontally from left to right in a single row. The left and
right properties are used as padding between the children, and the top and bottom
properties are used to position the children vertically.
On Android and iOS prior to Release
2.1.0, the horizontal layout always wraps and the horizontalWrap property is not supported.
Default: Composite layout
View's left position, in platform-specific units.
View's left position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
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.
Enable or disables the map toolbar.
Default: true
Map type constant, either Modules.Map.NORMAL_TYPE, Modules.Map.SATELLITE_TYPE, Modules.Map.TERRAIN_TYPE, Modules.Map.HYBRID_TYPE, Modules.Map.HYBRID_FLYOVER_TYPE or Modules.Map.SATELLITE_FLYOVER_TYPE.
Default: NORMAL_TYPE
Returns the maximum zoom level available at the current camera position.
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.
Returns the minimum zoom level available at the current camera position.
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 of this view, from 0.0 (transparent) to 1.0 (opaque).
Default: 1.0 (opaque)
When on, animate call overrides current animation if applicable.
If this property is set to false, the animate call is ignored if the view is currently being animated.
Default: undefined but behaves as false
Sets the distance between each edges of the view to the map controls.
Sets the distance between each edges of the view to the map controls.
The map view controls may be obscured by other elements.
A Boolean value indicating whether the map camera's pitch information is used.
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.
The preview context used in the 3D-Touch feature "Peek and Pop".
Requires: iOS 9.0 and later
Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.
Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.
Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.
Default: Undefined. Results in a light grey background color on the wrapper view.
The bounding box of the view relative to its parent, in system units.
The bounding box of the view relative to its parent, in system units.
The view's bounding box is defined by its size and position.
The view's size is rect.width x rect.height. The view's top-left position relative to
its parent is (rect.x , rect.y).
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.
A dictionary specifying the location and zoom level of the map.
Default: latitude 0, longitude 0
View's right position, in platform-specific units.
View's right position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
A Boolean value indicating whether the map camera's heading information is used.
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.
Clockwise 2D rotation of the view in degrees.
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (x-axis).
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (y-axis).
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
Scaling of the view in x-axis in pixels.
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
Scaling of the view in y-axis in pixels.
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
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
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 Modules.Map.NORMAL_TYPE for extruded buildings to be displayed.
Default: true
A Boolean indicating whether the map displays a compass control.
deprecated
6.1.0 Please use <Modules.Map.View.compassEnabled> for parity instead.
Requires: iOS 9.0 and later
When this property is set to true, the map displays the control that lets users change the heading
orientation of the map.
Default: true
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
A Boolean indicating whether the map shows scale information.
Requires: iOS 9.0 and later
When this property is set to true, the map displays the scale information.
Default: false
A Boolean value indicating whether the map displays traffic information.
Requires: iOS 9.0 and later
The mapType property must be set to Modules.Map.NORMAL_TYPE or Modules.Map.HYBRID_TYPE for traffic information to be shown.
Default: false
The size of the view in system units.
The size of the view in system units.
Although property returns a Dimension dictionary, only the width and height
properties are valid. The position properties--x and y--are always 0.
To find the position and size of the view, use the rect property instead.
The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.
Determines keyboard behavior when this view is focused.
This API can be assigned the following constants:
Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
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
The view's tintColor. This property is applicable on iOS 7 and greater.
Requires: iOS 7.0 and later
This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.
Default:
The view's top position.
The view's top position.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
Determines whether view should receive touch events.
If false, will forward the events to peers.
Default: true
A material design visual construct that provides an instantaneous visual confirmation of touch point.
Requires: Android 5.0 and later
This is an opt-in feature available from Android Lollipop. Touch feedback is applied only if the backgroundColor is a solid color.
Default: false
Optional touch feedback ripple color. This has no effect unless touchFeedback is true.
Requires: Android 5.0 and later
Default: Theme provided color.
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
Transformation matrix to apply to the view.
Android only supports 2DMatrix transforms.
Default: Identity matrix
A name to identify this view in activity transition.
Requires: Android 5 and later
Name should be unique in the View hierarchy.
Horizontal location of the view relative to its left position in pixels.
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
Vertical location of the view relative to its top position in pixels.
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
Depth of the view relative to its elevation in pixels.
Requires: Android 5 and later
Translation values are applied to the static post layout value.
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
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
Determines the color of the shadow.
Default: Undefined. Behaves as if transparent.
Determines the offset for the shadow of the view.
Default: Undefined. Behaves as if set to (0,-3)
Determines the blur radius used to create the shadow.
Default: Undefined. Behaves as if set to 3.
Determines whether the view is visible.
Default: true
View's width, in platform-specific units.
View's width, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
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:
Z-index stack order position, relative to other sibling views.
Z-index stack order position, relative to other sibling views.
A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.
Controls wether the map view's surface is placed on top of its window.
Please refer to zOrderOnTop for more details.
Default: false
Returns the current zoom level from the current camera position.
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.
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
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:
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.
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:
ButtonBar and 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.
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.
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.
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.
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.
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.iPad.SplitWindow, Titanium.UI.iOS.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.iOS.NavigationWindow,
Titanium.UI.iPad.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.
View to add to this view's hierarchy.
You may pass an array of views, e.g. view.add([subview1, subview2].
Adds a new annotation to the map.
a Modules.Map.Annotation instance.
Adds one or more new annotations to the map.
Array of Annotation objects
Adds a new circle to the map.
a Modules.Map.Circle instance.
Adds one or more new circles to the map.
Array of Circle objects
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Adds a new image overlay to the map.
A Modules.Map.ImageOverlay instance.
Adds one or more new image overlays to the map.
Array of ImageOverlay objects
Adds a new polygon to the map.
a Modules.Map.Polygon instance.
Adds one or more new polygons to the map.
Array of Polygons objects
Adds a new polylines to the map.
a Modules.Map.Polyline instance.
Adds one or more new polylines to the map.
Array of Polyline objects
Animates this view.
The Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.
Note that if you use animate to move a view, the view's actual position is changed, but
its layout properties, such as top, left, center and so on are not changed--these
reflect the original values set by the user, not the actual position of the view.
The rect property can be used to determine the actual size and position of the view.
Either a dictionary of animation properties or an Animation object.
Function to be invoked upon completion of the animation.
Changes the camera used for determining the map's viewing parameters and animates the change.
Properties for controlling the camera animation. The property camera is required.
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.
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.
A dictionary of properties to apply.
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.
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.
View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.
Deselects the specified annotation, so the main annotation is hidden and only a pin image is shown.
Annotation to deselect, identified by an annotation title or a Modules.Map.Annotation reference.
Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
Since the layout pass scheduled is asynchronous, the rect
and size values may not be available immediately after
finishLayout is called.
To be notified when the layout pass completes, add a listener for the postlayout event.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Gets the value of the showsCompass property.
deprecated since 6.1.0
Please use <Modules.Map.View.compassEnabled> for parity instead.
Returns the matching view of a given view ID.
The ID of the view that should be returned. Use the id property in your views to
enable it for indexing in this method.
Hides this view.
Animation options for Android. Since Release 5.1.0.
Inserts a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
Pass an object with the following key-value pairs:
view (Titanium.UI.View): View to insertposition (Number): Position in the children array to
insert the view. If omitted, inserts the view to the end of the array.Removes a child view from this view's hierarchy.
View to remove from this view's hierarchy.
Removes all child views from this view's hierarchy.
Remove all image overlays from the map.
Removes an existing annotation from the map.
Annotation to remove, identified by an annotation title or a Modules.Map.Annotation reference.
Removes one or more existing annotations from the map.
Annotations can be identified by title or by a Modules.Map.Annotation reference.
Array of annotations to remove.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Remove an image overlay from the map.
An ImageOverlay object
Remove a polyline from the map.
An Polyline object
Remove a previously added route.
An instance of Modules.Map.Route
Replaces a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
Pass an object with the following key-value pairs:
view (Titanium.UI.View): View to insertposition (Number): Position in the children array of
the view elment to replace.Selects the annotation, showing the full annotation.
Annotation to show, identified by an annotation title or a Modules.Map.Annotation reference.
Sets the value of the accessibilityHidden property.
New value for the property.
Sets the value of the accessibilityHint property.
New value for the property.
Sets the value of the accessibilityLabel property.
New value for the property.
Sets the value of the accessibilityValue property.
New value for the property.
Sets the value of the anchorPoint property.
New value for the property.
Sets the value of the animate property.
New value for the property.
Sets the value of the annotations property.
New value for the property.
Sets the value of the backgroundColor property.
New value for the property.
Sets the value of the backgroundDisabledColor property.
New value for the property.
Sets the value of the backgroundDisabledImage property.
New value for the property.
Sets the value of the backgroundFocusedColor property.
New value for the property.
Sets the value of the backgroundFocusedImage property.
New value for the property.
Sets the value of the backgroundGradient property.
New value for the property.
Sets the value of the backgroundImage property.
New value for the property.
Sets the value of the backgroundLeftCap property.
New value for the property.
Sets the value of the backgroundRepeat property.
New value for the property.
Sets the value of the backgroundSelectedColor property.
New value for the property.
Sets the value of the backgroundSelectedImage property.
New value for the property.
Sets the value of the backgroundTopCap property.
New value for the property.
Sets the value of the borderColor property.
New value for the property.
Sets the value of the borderRadius property.
New value for the property.
Sets the value of the borderWidth property.
New value for the property.
Sets the value of the bottom property.
New value for the property.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the camera property.
New value for the property.
Sets the value of the clipMode property.
New value for the property.
Set new cluster annotation for the clustered annotation.
Requires: iOS 11.0 and later
This method should be called inside the clusterstart event.
See the example "Map Example With Marker Annotation and Clustering".
Properties for creating cluster annotation.
Sets the value of the compassEnabled property.
New value for the property.
Sets the value of the elevation property.
New value for the property.
Sets the value of the enableZoomControls property.
New value for the property.
Sets the value of the focusable property.
New value for the property.
Sets the value of the height property.
New value for the property.
Sets the value of the hiddenBehavior property.
New value for the property.
Sets the value of the horizontalWrap property.
New value for the property.
Sets the value of the keepScreenOn property.
New value for the property.
Sets the value of the layout property.
New value for the property.
Sets the value of the left property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
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});
Dictionary specifying the location and the zoom level for the map.
Sets the value of the mapToolbarEnabled property.
New value for the property.
Sets the value of the mapType property.
New value for the property.
Sets the value of the opacity property.
New value for the property.
Sets the value of the overrideCurrentAnimation property.
New value for the property.
Sets the value of the padding property.
New value for the property.
Sets the value of the pitchEnabled property.
New value for the property.
Sets the value of the previewContext property.
New value for the property.
Sets the value of the pullBackgroundColor property.
New value for the property.
Sets the value of the region property.
New value for the property.
Sets the value of the right property.
New value for the property.
Sets the value of the rotateEnabled property.
New value for the property.
Sets the value of the rotation property.
New value for the property.
Sets the value of the rotationX property.
New value for the property.
Sets the value of the rotationY property.
New value for the property.
Sets the value of the scaleX property.
New value for the property.
Sets the value of the scaleY property.
New value for the property.
Sets the value of the scrollEnabled property.
New value for the property.
Sets the value of the showsBuildings property.
New value for the property.
Sets the value of the showsCompass property.
deprecated since 6.1.0
Please use <Modules.Map.View.compassEnabled> for parity instead.
New value for the property.
Sets the value of the showsPointsOfInterest property.
New value for the property.
Sets the value of the showsScale property.
New value for the property.
Sets the value of the showsTraffic property.
New value for the property.
Sets the value of the softKeyboardOnFocus property.
New value for the property.
Sets the value of the style property.
New value for the property.
Sets the value of the tintColor property.
New value for the property.
Sets the value of the top property.
New value for the property.
Sets the value of the touchEnabled property.
New value for the property.
Sets the value of the touchFeedback property.
New value for the property.
Sets the value of the touchFeedbackColor property.
New value for the property.
Sets the value of the traffic property.
New value for the property.
Sets the value of the transform property.
New value for the property.
Sets the value of the transitionName property.
New value for the property.
Sets the value of the translationX property.
New value for the property.
Sets the value of the translationY property.
New value for the property.
Sets the value of the translationZ property.
New value for the property.
Sets the value of the userLocation property.
New value for the property.
Sets the value of the userLocationButton property.
New value for the property.
Sets the value of the viewShadowColor property.
New value for the property.
Sets the value of the viewShadowOffset property.
New value for the property.
Sets the value of the viewShadowRadius property.
New value for the property.
Sets the value of the visible property.
New value for the property.
Sets the value of the width property.
New value for the property.
Sets the value of the zIndex property.
New value for the property.
Sets the value of the zOrderOnTop property.
New value for the property.
Sets the value of the zoomEnabled property.
New value for the property.
Makes this view visible.
Animation options for Android. Since Release 5.1.0.
Sets the visible region so that the map displays the specified annotations. If no array is passed annotations on the map will be shown.
An array of Modules.Map.Annotation to display.
Takes a snapshot of the map
Takes a snapshot of the current map and returns the image via onsnapshotready event.
Starts a batch update of this view's layout properties.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
To prevent a layout pass each time a property is modified, call startLayout before
changing any properties that may change this view's layout. This initiates a batch update
mode where layout changes are deferred.
Call finishLayout to end batch update mode and trigger a layout pass. For example:
view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();
Note that any property changes made during the batch update may be deferred until
finishLayout is called. This may vary somewhat by platform. For example, changing the
text of a label may trigger a layout pass. In iOS, updating the label text is
deferred.
See also: updateLayout, finishLayout, postlayout event.
Returns an image of the rendered view, as a Blob.
The honorScaleFactor method is only supported on iOS.
Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
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.
Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
This is another way to perform a batch update. The updateLayout method is called with a
dictionary of layout properties to perform the batch update. For example:
view.updateLayout({top:50, left:50});
This is equivalent to the following:
view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();
See also: startLayout, finishLayout, postlayout event.
Layout properties to be updated.
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.
Relative zoom level (positive to zoom in, negative to zoom out).
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:
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.
Title of the annotation.
Subtitle of the annotation.
The map view instance.
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 source object.
Latitude of the clicked annotation or the point clicked in the polygon, polyline and circle.
Longitude of the clicked annotation or the point clicked in the polygon, polyline and circle.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.click
Fired when a collision between annotations occures.
Array of annotations participating in clustering.
This map view.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the map completes loading.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the view element gains focus.
This event only fires when using the trackball to navigate.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a hardware key is pressed in the view.
A keypressed event is generated by pressing a hardware key. On Android, this event can only be fired when the property focusable is set to true. On iOS the event is generated only when using Ti.UI.TextArea, Ti.UI.TextField and Ti.UI.SearchBar.
The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
latitude of the point on the ground that was pressed.
longitude of the point on the ground that was pressed.
The map view instance.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.longclick
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.
The map view instance.
Latitude of the clicked position.
Longitude of the clicked position.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the snapshot is ready after snapshot is invoked.
snapshot of the current map
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the user interacts with a draggable annotation.
Annotation being dragged.
This map view.
Annotation title.
New drag state for the annotation, one of ANNOTATION_DRAG_STATE_NONE, ANNOTATION_DRAG_STATE_START, ANNOTATION_DRAG_STATE_DRAG, ANNOTATION_DRAG_STATE_CANCEL or ANNOTATION_DRAG_STATE_END.
Previous drag state for the annotation, one of ANNOTATION_DRAG_STATE_NONE, ANNOTATION_DRAG_STATE_START, ANNOTATION_DRAG_STATE_DRAG, ANNOTATION_DRAG_STATE_CANCEL or ANNOTATION_DRAG_STATE_END.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a layout cycle is finished.
This event is fired when the view and its ancestors have been laid out. The rect and size values should be usable when this event is fired.
This event is typically triggered by either changing layout properties or by changing the orientation of the device. Note that changing the layout of child views or ancestors can also trigger a relayout of this view.
Note that altering any properties that affect layout from the postlayout callback
may result in an endless loop.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the mapping region finished changing.
Longitude value for the center point of the map, in decimal degrees.
Latitude value for the center point of the map, in decimal degrees.
The amount of east-to-west distance displayed on the map, measured in decimal degrees.
The amount of north-to-south distance displayed on the map, measured in decimal degrees.
The regionchanged event was caused by an animation, such as a animating the camera.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the mapping region will change.
Longitude value for the center point of the map, in decimal degrees.
Latitude value for the center point of the map, in decimal degrees.
The amount of east-to-west distance displayed on the map, measured in decimal degrees.
The amount of north-to-south distance displayed on the map, measured in decimal degrees.
The regionwillchange event was caused by an animation, such as a animating the camera.
The reason for the camera change, either Modules.Map.REASON_API_ANIMATION, Modules.Map.REASON_DEVELOPER_ANIMATION or Modules.Map.REASON_GESTURE.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.