com.distriqt.extension.nativemaps.objects.MapMarker

	Property	Defined By
		animatesDrop : Boolean = true Defines whether the marker animates in when dropped onto the map. Supported OS: iOS maps only, not available on Android	MapMarker
		colour : uint = 0 Defines the marker colour. See the MapMarkerColour class for available options and documentation.	MapMarker
		customIconId : String Defines an optional custom marker icon ID to be used when displaying this marker.	MapMarker
		draggable : Boolean = false Defines whether the marker is draggable by the user.	MapMarker
		hasCustomImage : Boolean [read-only] A boolean specifiying whether or not a custom icon image has been set for this marker.	MapMarker
		info : String Defines the info/subtitle for the marker used in an info window popup.	MapMarker
		infoWindowEnabled : Boolean = true Defines whether the marker will show it's info window popup when tapped by the user.	MapMarker
		latitude : Number The latitude of the marker, or 0 if no position is set.	MapMarker
		longitude : Number The longitude of the marker, or 0 if no position is set.	MapMarker
		name : String A custom name you may set for the marker to be used as a reference. This name is not used internally but simply provides a helpful way to identify markers. NOTE: Marker names should be unique, you are responsible for managing these.	MapMarker
		position : LatLng The position as a LatLng object representing the position of this marker object.	MapMarker
		showInfoWindowButton : Boolean = true Defines whether the info window callout shows a clickable blue arrow button.	MapMarker
		title : String Defines the title for the marker used in an info window popup.	MapMarker
		visible : Boolean = true Defines whether the marker is shown or hidden. You must call updateMarker() to apply changes to this value, or use the NativeMaps.service.showMarker(id, boolean) method to set and apply the value immediately. NOTE: This does not remove the marker, it will still be in memory.	MapMarker
		zIndex : Number = 0 The z-index specifies the stack order of this marker, relative to other markers on the map.	MapMarker

	Method	Defined By
		MapMarker(name:String, position:LatLng = null, title:String, info:String, colour:uint = 0, draggable:Boolean = false, infoWindowEnabled:Boolean = true, animatesDrop:Boolean = true, showInfoWindowButton:Boolean = true, customIconId:String) Constructor	MapMarker
		dispose():void	MapMarker
		setAnimatesDrop(animatesDrop:Boolean):MapMarker Sets whether the icon adding is through a drop animation	MapMarker
		setColour(colour:uint):MapMarker Sets the colour for the marker	MapMarker
		setCustomIconId(customIconId:String):MapMarker Set the customIconId value for this marker.	MapMarker
		setDraggable(draggable:Boolean):MapMarker Sets the draggable value for the marker	MapMarker
		setInfo(info:String):MapMarker Sets the info for the marker	MapMarker
		setInfoWindowEnabled(infoWindowEnabled:Boolean):MapMarker Sets the infoWindowEnabled value for the marker	MapMarker
		setName(name:String):MapMarker Sets the name of the marker	MapMarker
		setPosition(position:LatLng):MapMarker Sets the position of the marker.	MapMarker
		setShowInfoWindowButton(showInfoWindowButton:Boolean):MapMarker Sets the showInfoWindowButton for the marker	MapMarker
		setTitle(title:String):MapMarker Sets the title of the marker	MapMarker
		setVisible(visible:Boolean):MapMarker Sets the visible value for the marker	MapMarker
		setZIndex(zIndex:Number):MapMarker Set the zIndex value for this marker.	MapMarker

Property Detail

animatesDrop

property

public var animatesDrop:Boolean = true

Defines whether the marker animates in when dropped onto the map.

Supported OS: iOS maps only, not available on Android

colour

property

public var colour:uint = 0

Defines the marker colour.

See the MapMarkerColour class for available options and documentation.

draggable

property

public var draggable:Boolean = false

Defines whether the marker is draggable by the user.

hasCustomImage

property

hasCustomImage:Boolean [read-only]

A boolean specifiying whether or not a custom icon image has been set for this marker.

Implementation
public function get hasCustomImage():Boolean

info

property

public var info:String

Defines the info/subtitle for the marker used in an info window popup.

infoWindowEnabled

property

public var infoWindowEnabled:Boolean = true

Defines whether the marker will show it's info window popup when tapped by the user.

latitude

property

latitude:Number

The latitude of the marker, or 0 if no position is set.

Implementation
public function get latitude():Number
public function set latitude(value:Number):void

longitude

property

longitude:Number

The longitude of the marker, or 0 if no position is set.

Implementation
public function get longitude():Number
public function set longitude(value:Number):void

name

property

public var name:String

A custom name you may set for the marker to be used as a reference.

This name is not used internally but simply provides a helpful way to identify markers.

NOTE: Marker names should be unique, you are responsible for managing these.

position

property

public var position:LatLng

The position as a LatLng object representing the position of this marker object.

showInfoWindowButton

property

public var showInfoWindowButton:Boolean = true

Defines whether the info window callout shows a clickable blue arrow button. Defaults to true.

In order to receive the MARKER_INFO_WINDOW_TOUCHED event, this must be set to true on iOS.

Only for iOS, this is not implemented on Android.

title

property

public var title:String

Defines the title for the marker used in an info window popup.

visible

property

public var visible:Boolean = true

Defines whether the marker is shown or hidden.

You must call updateMarker() to apply changes to this value, or use the NativeMaps.service.showMarker(id, boolean) method to set and apply the value immediately.

NOTE: This does not remove the marker, it will still be in memory. Use removeMarker to remove an object.

zIndex

property

public var zIndex:Number = 0

The z-index specifies the stack order of this marker, relative to other markers on the map. A marker with a high z-index is drawn on top of markers with lower z-indexes. The default z-index value is 0.

Constructor Detail

MapMarker

()

Constructor

public function MapMarker(name:String, position:LatLng = null, title:String, info:String, colour:uint = 0, draggable:Boolean = false, infoWindowEnabled:Boolean = true, animatesDrop:Boolean = true, showInfoWindowButton:Boolean = true, customIconId:String)

Constructor

Parameters

	`name:String`

	`position:LatLng` (default = `null`)

	`title:String`

	`info:String`

	`colour:uint` (default = `0`)

	`draggable:Boolean` (default = `false`)

	`infoWindowEnabled:Boolean` (default = `true`)

	`animatesDrop:Boolean` (default = `true`)

	`showInfoWindowButton:Boolean` (default = `true`)

	`customIconId:String`

Method Detail

dispose

()

method

public function dispose():void

setAnimatesDrop

()

method

public function setAnimatesDrop(animatesDrop:Boolean):MapMarker

Sets whether the icon adding is through a drop animation

Parameters

animatesDrop:Boolean — The animates drop value

Returns

MapMarker — The MapMarker instance for chaining

setColour

()

method

public function setColour(colour:uint):MapMarker

Sets the colour for the marker

Parameters

colour:uint — The colour value

Returns

MapMarker — The MapMarker instance for chaining

setCustomIconId

()

method

public function setCustomIconId(customIconId:String):MapMarker

Set the customIconId value for this marker.

Parameters

customIconId:String — The customIconId value

Returns

MapMarker — The MapMarker instance for chaining

setDraggable

()

method

public function setDraggable(draggable:Boolean):MapMarker

Sets the draggable value for the marker

Parameters

draggable:Boolean — The draggable value

Returns

MapMarker — The MapMarker instance for chaining

setInfo

()

method

public function setInfo(info:String):MapMarker

Sets the info for the marker

Parameters

info:String — The info value

Returns

MapMarker — The MapMarker instance for chaining

setInfoWindowEnabled

()

method

public function setInfoWindowEnabled(infoWindowEnabled:Boolean):MapMarker

Sets the infoWindowEnabled value for the marker

Parameters

infoWindowEnabled:Boolean — The infoWindowEnabled value

Returns

MapMarker — The MapMarker instance for chaining

setName

()

method

public function setName(name:String):MapMarker

Sets the name of the marker

Parameters

name:String — The name value

Returns

MapMarker — The MapMarker instance for chaining

setPosition

()

method

public function setPosition(position:LatLng):MapMarker

Sets the position of the marker.

Parameters

position:LatLng — A LatLng object representing the position data.

Returns

MapMarker — The MapMarker instance for chaining

setShowInfoWindowButton

()

method

public function setShowInfoWindowButton(showInfoWindowButton:Boolean):MapMarker

Sets the showInfoWindowButton for the marker

Parameters

showInfoWindowButton:Boolean — The showInfoWindowButton value

Returns

MapMarker — The MapMarker instance for chaining

setTitle

()

method

public function setTitle(title:String):MapMarker

Sets the title of the marker

Parameters

title:String — The title value

Returns

MapMarker — The MapMarker instance for chaining

setVisible

()

method

public function setVisible(visible:Boolean):MapMarker

Sets the visible value for the marker

Parameters

visible:Boolean — The visible value

Returns

MapMarker — The MapMarker instance for chaining

setZIndex

()

method

public function setZIndex(zIndex:Number):MapMarker

Set the zIndex value for this marker.

Parameters

zIndex:Number — The zIndex value

Returns

MapMarker — The MapMarker instance for chaining

Thu Dec 19 2024, 12:16 PM +10:00

distriqt // NativeMaps Native Extension Documentation	All Packages \| All Classes \| Index \| Frames No Frames
MapMarker	Properties \| Methods

Package	com.distriqt.extension.nativemaps.objects
Class	public class MapMarker
Inheritance	MapMarker Object