Marker

Marker class

google.maps.Marker class

This class extends MVCObject.

Constructor
`Marker`	`Marker([opts])` Parameters: `opts`: `MarkerOptions optional` Creates a marker with the options specified. If a map is specified, the marker is added to the map upon construction. Note that the position must be set for the marker to display.

Methods
`getAnimation`	`getAnimation()` Parameters: None Return Value: `Animation optional`
`getClickable`	`getClickable()` Parameters: None Return Value: `boolean`
`getCursor`	`getCursor()` Parameters: None Return Value: `string`
`getDraggable`	`getDraggable()` Parameters: None Return Value: `boolean`
`getIcon`	`getIcon()` Parameters: None Return Value: `string\|Icon\|Symbol`
`getLabel`	`getLabel()` Parameters: None Return Value: `MarkerLabel`
`getMap`	`getMap()` Parameters: None Return Value: `Map\|StreetViewPanorama`
`getOpacity`	`getOpacity()` Parameters: None Return Value: `number`
`getPosition`	`getPosition()` Parameters: None Return Value: `LatLng optional`
`getShape`	`getShape()` Parameters: None Return Value: `MarkerShape`
`getTitle`	`getTitle()` Parameters: None Return Value: `string`
`getVisible`	`getVisible()` Parameters: None Return Value: `boolean`
`getZIndex`	`getZIndex()` Parameters: None Return Value: `number`
`setAnimation`	`setAnimation(animation)` Parameters: `animation`: `Animation optional` Return Value: None Start an animation. Any ongoing animation will be cancelled. Currently supported animations are: BOUNCE, DROP. Passing in `null` will cause any animation to stop.
`setClickable`	`setClickable(flag)` Parameters: `flag`: `boolean` Return Value: None
`setCursor`	`setCursor(cursor)` Parameters: `cursor`: `string` Return Value: None
`setDraggable`	`setDraggable(flag)` Parameters: `flag`: `boolean optional` Return Value: None
`setIcon`	`setIcon(icon)` Parameters: `icon`: `string\|Icon\|Symbol` Return Value: None
`setLabel`	`setLabel(label)` Parameters: `label`: `string\|MarkerLabel` Return Value: None
`setMap`	`setMap(map)` Parameters: `map`: `Map\|StreetViewPanorama` Return Value: None Renders the marker on the specified map or panorama. If map is set to null, the marker will be removed.
`setOpacity`	`setOpacity(opacity)` Parameters: `opacity`: `number` Return Value: None
`setOptions`	`setOptions(options)` Parameters: `options`: `MarkerOptions` Return Value: None
`setPosition`	`setPosition(latlng)` Parameters: `latlng`: `LatLng\|LatLngLiteral optional` Return Value: None
`setShape`	`setShape(shape)` Parameters: `shape`: `MarkerShape` Return Value: None
`setTitle`	`setTitle(title)` Parameters: `title`: `string` Return Value: None
`setVisible`	`setVisible(visible)` Parameters: `visible`: `boolean` Return Value: None
`setZIndex`	`setZIndex(zIndex)` Parameters: `zIndex`: `number` Return Value: None
Inherited: `addListener`, `bindTo`, `get`, `notify`, `set`, `setValues`, `unbind`, `unbindAll`

Constants
`MAX_ZINDEX`	The maximum default z-index that the API will assign to a marker. You may set a higher z-index to bring a marker to the front.

Events
`animation_changed`	`function()` Arguments: None This event is fired when the marker's animation property changes.
`click`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the marker icon was clicked.
`clickable_changed`	`function()` Arguments: None This event is fired when the marker's clickable property changes.
`cursor_changed`	`function()` Arguments: None This event is fired when the marker's cursor property changes.
`dblclick`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the marker icon was double clicked.
`drag`	`function(event)` Arguments: `event`: `MouseEvent` This event is repeatedly fired while the user drags the marker.
`dragend`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the user stops dragging the marker.
`draggable_changed`	`function()` Arguments: None This event is fired when the marker's draggable property changes.
`dragstart`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the user starts dragging the marker.
`flat_changed`	`function()` Arguments: None This event is fired when the marker's flat property changes.
`icon_changed`	`function()` Arguments: None This event is fired when the marker icon property changes.
`mousedown`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired for a mousedown on the marker.
`mouseout`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the mouse leaves the area of the marker icon.
`mouseover`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the mouse enters the area of the marker icon.
`mouseup`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired for a mouseup on the marker.
`position_changed`	`function()` Arguments: None This event is fired when the marker position property changes.
`rightclick`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired for a rightclick on the marker.
`shape_changed`	`function()` Arguments: None This event is fired when the marker's shape property changes.
`title_changed`	`function()` Arguments: None This event is fired when the marker title property changes.
`visible_changed`	`function()` Arguments: None This event is fired when the marker's visible property changes.
`zindex_changed`	`function()` Arguments: None This event is fired when the marker's zIndex property changes.

MarkerOptions interface

google.maps.MarkerOptions interface

MarkerOptions object used to define the properties that can be set on a Marker.

Properties
`anchorPoint optional`	Type: `Point optional` The offset from the marker's position to the tip of an InfoWindow that has been opened with the marker as anchor.
`animation optional`	Type: `Animation optional` Which animation to play when marker is added to a map.
`clickable optional`	Type: `boolean optional` If true, the marker receives mouse and touch events. Default value is true.
`crossOnDrag optional`	Type: `boolean optional` If false, disables cross that appears beneath the marker when dragging. This option is `true` by default.
`cursor optional`	Type: `string optional` Mouse cursor to show on hover
`draggable optional`	Type: `boolean optional` If true, the marker can be dragged. Default value is false.
`icon optional`	Type: `string\|Icon\|Symbol optional` Icon for the foreground. If a string is provided, it is treated as though it were an `Icon` with the string as `url`.
`label optional`	Type: `string\|MarkerLabel optional` Adds a label to the marker. The label can either be a string, or a `MarkerLabel` object. If provided and `MarkerOptions.title` is not provided, an accessibility text (e.g. for use with screen readers) will be added to the marker with the provided label's text. Please note that the `label` is currently only used for accessibility text for non-optimized markers.
`map optional`	Type: `Map\|StreetViewPanorama optional` Map on which to display Marker.
`opacity optional`	Type: `number optional` The marker's opacity between 0.0 and 1.0.
`optimized optional`	Type: `boolean optional` Optimization renders many markers as a single static element. Optimized rendering is enabled by default. Disable optimized rendering for animated GIFs or PNGs, or when each marker must be rendered as a separate DOM element (advanced usage only).
`position optional`	Type: `LatLng\|LatLngLiteral optional` Marker position. Required in order to display the marker.
`shape optional`	Type: `MarkerShape optional` Image map region definition used for drag/click.
`title optional`	Type: `string optional` Rollover text. If provided, an accessibility text (e.g. for use with screen readers) will be added to the marker with the provided value. Please note that the `title` is currently only used for accessibility text for non-optimized markers.
`visible optional`	Type: `boolean optional` If true, the marker is visible
`zIndex optional`	Type: `number optional` All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values. By default, markers are displayed according to their vertical position on screen, with lower markers appearing in front of markers further up the screen.

Icon interface

google.maps.Icon interface

A structure representing a Marker icon image.

Properties
`url`	Type: `string` The URL of the image or sprite sheet.
`anchor optional`	Type: `Point optional` The position at which to anchor an image in correspondence to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image.
`labelOrigin optional`	Type: `Point optional` The origin of the label relative to the top-left corner of the icon image, if a label is supplied by the marker. By default, the origin is located in the center point of the image.
`origin optional`	Type: `Point optional` The position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image `(0, 0)`.
`scaledSize optional`	Type: `Size optional` The size of the entire image after scaling, if any. Use this property to stretch/shrink an image or a sprite.
`size optional`	Type: `Size optional` The display size of the sprite or image. When using sprites, you must specify the sprite size. If the size is not provided, it will be set when the image loads.

These options specify the appearance of a marker label. A marker label is a string (often a single character) which will appear inside the marker. If you are using it with a custom marker, you can reposition it with the labelOrigin property in the Icon class.

Properties
`text`	Type: `string` The text to be displayed in the label.
`className optional`	Type: `string optional` The className property of the label's element (equivalent to the element's class attribute). Multiple space-separated CSS classes can be added. Default is no CSS class (an empty string). The font color, size, weight, and family can only be set via the other properties of `MarkerLabel`. CSS classes should not be used to change the position nor orientation of the label (e.g. using translations and rotations) if also using marker collision management.
`color optional`	Type: `string optional` The color of the label text. Default color is black.
`fontFamily optional`	Type: `string optional` The font family of the label text (equivalent to the CSS font-family property).
`fontSize optional`	Type: `string optional` The font size of the label text (equivalent to the CSS font-size property). Default size is 14px.
`fontWeight optional`	Type: `string optional` The font weight of the label text (equivalent to the CSS font-weight property).

MarkerShape interface

google.maps.MarkerShape interface

This object defines the clickable region of a marker image. The shape consists of two properties — type and coord — which define the non-transparent region of an image.

Properties

Properties
`coords`	Type: `Array<number>` The format of this attribute depends on the value of the `type` and follows the w3 AREA `coords` specification found at http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords. The `coords` attribute is an array of integers that specify the pixel position of the shape relative to the top-left corner of the target image. The coordinates depend on the value of `type` as follows: - `circle`: coords is `[x1,y1,r]` where x1,y2 are the coordinates of the center of the circle, and r is the radius of the circle. - `poly`: coords is `[x1,y1,x2,y2...xn,yn]` where each x,y pair contains the coordinates of one vertex of the polygon. - `rect`: coords is `[x1,y1,x2,y2]` where x1,y1 are the coordinates of the upper-left corner of the rectangle and x2,y2 are the coordinates of the lower-right coordinates of the rectangle.
`type`	Type: `string` Describes the shape's type and can be `circle`, `poly` or `rect`.

coords

Type: Array<number>

The format of this attribute depends on the value of the type and follows the w3 AREA coords specification found at http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords.
The coords attribute is an array of integers that specify the pixel position of the shape relative to the top-left corner of the target image. The coordinates depend on the value of type as follows:
  - circle: coords is [x1,y1,r] where x1,y2 are the coordinates of the center of the circle, and r is the radius of the circle.
  - poly: coords is [x1,y1,x2,y2...xn,yn] where each x,y pair contains the coordinates of one vertex of the polygon.
  - rect: coords is [x1,y1,x2,y2] where x1,y1 are the coordinates of the upper-left corner of the rectangle and x2,y2 are the coordinates of the lower-right coordinates of the rectangle.

type

Type: string

Describes the shape's type and can be circle, poly or rect.

Symbol interface

google.maps.Symbol interface

Describes a symbol, which consists of a vector path with styling. A symbol can be used as the icon of a marker, or placed on a polyline.

Properties
`path`	Type: `SymbolPath\|string` The symbol's path, which is a built-in symbol path, or a custom path expressed using SVG path notation. Required.
`anchor optional`	Type: `Point optional` The position of the symbol relative to the marker or polyline. The coordinates of the symbol's path are translated left and up by the anchor's x and y coordinates respectively. By default, a symbol is anchored at `(0, 0)`. The position is expressed in the same coordinate system as the symbol's path.
`fillColor optional`	Type: `string optional` The symbol's fill color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on polylines, this defaults to the stroke color of the corresponding polyline.
`fillOpacity optional`	Type: `number optional` The symbol's fill opacity. Defaults to 0.
`labelOrigin optional`	Type: `Point optional` The origin of the label relative to the origin of the path, if label is supplied by the marker. By default, the origin is located at `(0, 0)`. The origin is expressed in the same coordinate system as the symbol's path. This property is unused for symbols on polylines.
`rotation optional`	Type: `number optional` The angle by which to rotate the symbol, expressed clockwise in degrees. Defaults to 0. A symbol in an `IconSequence` where `fixedRotation` is `false` is rotated relative to the angle of the edge on which it lies.
`scale optional`	Type: `number optional` The amount by which the symbol is scaled in size. For symbol markers, this defaults to 1; after scaling, the symbol may be of any size. For symbols on a polyline, this defaults to the stroke weight of the polyline; after scaling, the symbol must lie inside a square 22 pixels in size centered at the symbol's anchor.
`strokeColor optional`	Type: `string optional` The symbol's stroke color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on a polyline, this defaults to the stroke color of the polyline.
`strokeOpacity optional`	Type: `number optional` The symbol's stroke opacity. For symbol markers, this defaults to 1. For symbols on a polyline, this defaults to the stroke opacity of the polyline.
`strokeWeight optional`	Type: `number optional` The symbol's stroke weight. Defaults to the `scale` of the symbol.

SymbolPath constants

google.maps.SymbolPath constants

Built-in symbol paths.

Constants
`BACKWARD_CLOSED_ARROW`	A backward-pointing closed arrow.
`BACKWARD_OPEN_ARROW`	A backward-pointing open arrow.
`CIRCLE`	A circle.
`FORWARD_CLOSED_ARROW`	A forward-pointing closed arrow.
`FORWARD_OPEN_ARROW`	A forward-pointing open arrow.

Animation constants

google.maps.Animation constants

Animations that can be played on a marker. Use the setAnimation method on Marker or the animation option to play an animation.

Constants
`BOUNCE`	Marker bounces until animation is stopped.
`DROP`	Marker falls from the top of the map ending with a small bounce.