Class Marker

Access by calling const {Marker} = await google.maps.importLibrary("marker"). See https://developers.google.com/maps/documentation/javascript/libraries.

deprecated: As of February 21st, 2024, google.maps.Marker is deprecated. Please use google.maps.marker.AdvancedMarkerElement instead. At this time, google.maps.Marker is not scheduled to be discontinued, but google.maps.marker.AdvancedMarkerElement is recommended over google.maps.Marker. While google.maps.Marker will continue to receive bug fixes for any major regressions, existing bugs in google.maps.Marker will not be addressed. At least 12 months notice will be given before support is discontinued. Please see https://developers.google.com/maps/deprecations for additional details and https://developers.google.com/maps/documentation/javascript/advanced-markers/migration for the migration guide.

Hierarchy

MVCObject
- Marker

Constructors

constructor

new Marker(opts?: null | MarkerOptions): Marker

Overrides MVCObject.constructor

Access by calling const {Marker} = await google.maps.importLibrary("marker"). See https://developers.google.com/maps/documentation/javascript/libraries.

deprecated
As of February 21st, 2024, google.maps.Marker is deprecated. Please use google.maps.marker.AdvancedMarkerElement instead. At this time, google.maps.Marker is not scheduled to be discontinued, but google.maps.marker.AdvancedMarkerElement is recommended over google.maps.Marker. While google.maps.Marker will continue to receive bug fixes for any major regressions, existing bugs in google.maps.Marker will not be addressed. At least 12 months notice will be given before support is discontinued. Please see https://developers.google.com/maps/deprecations for additional details and https://developers.google.com/maps/documentation/javascript/advanced-markers/migration for the migration guide.

Parameters
- Optional opts: null | MarkerOptions
  
  Named optional arguments
Returns Marker

Properties

Static Readonly MAX_ZINDEX

MAX_ZINDEX: number

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.

Methods

addListener

addListener(eventName: string, handler: Function): MapsEventListener

Inherited from MVCObject.addListener

Adds the given listener function to the given event name. Returns an identifier for this listener that can be used with google.maps.event.removeListener.

Parameters
- eventName: string
- handler: Function
Returns MapsEventListener

bindTo

bindTo(key: string, target: MVCObject, targetKey?: null | string, noNotify?: boolean): void

Inherited from MVCObject.bindTo

Binds a View to a Model.

Parameters
- key: string
- target: MVCObject
- Optional targetKey: null | string
- Optional noNotify: boolean
Returns void

get

get(key: string): any

Inherited from MVCObject.get

Gets a value.

Parameters
- key: string
Returns any

getAnimation

getAnimation(): undefined | null | google.maps.Animation

Get the currently running animation.

Returns undefined | null | google.maps.Animation

getClickable

getClickable(): boolean

Get the clickable status of the google.maps.Marker.

Returns boolean

getCursor

getCursor(): undefined | null | string

Get the mouse cursor type shown on hover.

Returns undefined | null | string

getDraggable

getDraggable(): boolean

Get the draggable status of the google.maps.Marker.

Returns boolean

getIcon

getIcon(): undefined | null | string | Icon | Symbol

Get the icon of the google.maps.Marker. See google.maps.MarkerOptions.icon.

Returns undefined | null | string | Icon | Symbol

getLabel

getLabel(): undefined | null | string | MarkerLabel

Get the label of the google.maps.Marker. See google.maps.MarkerOptions.label.

Returns undefined | null | string | MarkerLabel

getMap

getMap(): null | Map | StreetViewPanorama

Get the map or panaroama the google.maps.Marker is rendered on.

Returns null | Map | StreetViewPanorama

getOpacity

getOpacity(): undefined | null | number

Get the opacity of the google.maps.Marker.

Returns undefined | null | number

getPosition

getPosition(): undefined | null | LatLng

Get the position of the google.maps.Marker.

Returns undefined | null | LatLng

getShape

getShape(): undefined | null | MarkerShape

Get the shape of the google.maps.Marker used for interaction. See google.maps.MarkerOptions.shape and google.maps.MarkerShape.

Returns undefined | null | MarkerShape

getTitle

getTitle(): undefined | null | string

Get the title of the google.maps.Marker tooltip. See google.maps.MarkerOptions.title.

Returns undefined | null | string

getVisible

getVisible(): boolean

Get the visibility of the google.maps.Marker.

Returns boolean

getZIndex

getZIndex(): undefined | null | number

Get the zIndex of the google.maps.Marker. See google.maps.MarkerOptions.zIndex.

Returns undefined | null | number

notify

notify(key: string): void

Inherited from MVCObject.notify

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Parameters
- key: string
Returns void

set

set(key: string, value: unknown): void

Inherited from MVCObject.set

Sets a value.

Parameters
- key: string
- value: unknown
Returns void

setAnimation

setAnimation(animation?: null | google.maps.Animation): void

Start an animation. Any ongoing animation will be cancelled. Currently supported animations are: google.maps.Animation.BOUNCE, google.maps.Animation.DROP. Passing in null will cause any animation to stop.

Parameters
- Optional animation: null | google.maps.Animation
  
  The animation to play.
Returns void

setClickable

setClickable(flag: boolean): void

Set if the google.maps.Marker is clickable.

Parameters
- flag: boolean
  
  If true, the Marker can be clicked.
Returns void

setCursor

setCursor(cursor?: null | string): void

Set the mouse cursor type shown on hover.

Parameters
- Optional cursor: null | string
  
  Mouse cursor type.
Returns void

setDraggable

setDraggable(flag: null | boolean): void

Set if the google.maps.Marker is draggable.

Parameters
- flag: null | boolean
  
  If true, the Marker can be dragged.
Returns void

setIcon

setIcon(icon?: null | string | Icon | Symbol): void

Set the icon for the google.maps.Marker. See google.maps.MarkerOptions.icon.

Parameters
- Optional icon: null | string | Icon | Symbol
Returns void

setLabel

setLabel(label?: null | string | MarkerLabel): void

Set the label for the google.maps.Marker. See google.maps.MarkerOptions.label.

Parameters
- Optional label: null | string | MarkerLabel
  
  The label can either be a character string or a google.maps.MarkerLabel object.
Returns void

setMap

setMap(map: null | Map | StreetViewPanorama): void

Renders the google.maps.Marker on the specified map or panorama. If map is set to null, the marker will be removed.

Parameters
- map: null | Map | StreetViewPanorama
Returns void

setOpacity

setOpacity(opacity?: null | number): void

Set the opacity of the google.maps.Marker.

Parameters
- Optional opacity: null | number
  
  A number between 0.0, transparent, and 1.0, opaque.
Returns void

setOptions

setOptions(options: null | MarkerOptions): void

Set the options for the google.maps.Marker.

Parameters
- options: null | MarkerOptions
Returns void

setPosition

setPosition(latlng?: null | LatLng | LatLngLiteral): void

Set the postition for the google.maps.Marker.

Parameters
- Optional latlng: null | LatLng | LatLngLiteral
  
  The new position.
Returns void

setShape

setShape(shape?: null | MarkerShape): void

Set the shape of the google.maps.Marker used for interaction. See google.maps.MarkerOptions.shape and google.maps.MarkerShape.

Parameters
- Optional shape: null | MarkerShape
Returns void

setTitle

setTitle(title?: null | string): void

Set the title of the google.maps.Marker tooltip. See google.maps.MarkerOptions.title.

Parameters
- Optional title: null | string
Returns void

setValues

setValues(values?: null | object): void

Inherited from MVCObject.setValues

Sets a collection of key-value pairs.

Parameters
- Optional values: null | object
Returns void

setVisible

setVisible(visible: boolean): void

Set if the google.maps.Marker is visible.

Parameters
- visible: boolean
  
  If true, the Marker is visible
Returns void

setZIndex

setZIndex(zIndex?: null | number): void

Set the zIndex of the google.maps.Marker. See google.maps.MarkerOptions.zIndex.

Parameters
- Optional zIndex: null | number
Returns void

unbind

unbind(key: string): void

Inherited from MVCObject.unbind

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Parameters
- key: string
Returns void

unbindAll

unbindAll(): void

Inherited from MVCObject.unbindAll

Removes all bindings.

Returns void

Generated using TypeDoc