Options
All
  • Public
  • Public/Protected
  • All
Menu

These options specify the way a Feature should appear when displayed on a map.

Hierarchy

  • StyleOptions

Index

Properties

Optional animation

animation?: Animation

The animation to play when marker is added to a map. Only applies to point geometries.

Optional clickable

clickable?: boolean

If true, the marker receives mouse and touch events. Default value is true.

Optional cursor

cursor?: string

Mouse cursor to show on hover. Only applies to point geometries.

Optional draggable

draggable?: boolean

If true, the object can be dragged across the map and the underlying feature will have its geometry updated. Default value is false.

Optional editable

editable?: boolean

If true, the object can be edited by dragging control points and the underlying feature will have its geometry updated. Only applies to LineString and Polygon geometries. Default value is false.

Optional fillColor

fillColor?: string

The fill color. All CSS3 colors are supported except for extended named colors. Only applies to polygon geometries.

Optional fillOpacity

fillOpacity?: number

The fill opacity between 0.0 and 1.0. Only applies to polygon geometries.

Optional icon

icon?: string | Icon | Symbol

Icon for the foreground. If a string is provided, it is treated as though it were an Icon with the string as url. Only applies to point geometries.

Optional icons

icons?: IconSequence[]

The icons to be rendered along a polyline. Only applies to line geometries.

Optional label

label?: string | MarkerLabel

Adds a label to the marker. The label can either be a string, or a MarkerLabel object. Only applies to point geometries.

Optional opacity

opacity?: number

The marker's opacity between 0.0 and 1.0. Only applies to point geometries.

Optional shape

shape?: MarkerShape

Defines the image map used for hit detection. Only applies to point geometries.

Optional strokeColor

strokeColor?: string

The stroke color. All CSS3 colors are supported except for extended named colors. Only applies to line and polygon geometries.

Optional strokeOpacity

strokeOpacity?: number

The stroke opacity between 0.0 and 1.0. Only applies to line and polygon geometries.

Optional strokeWeight

strokeWeight?: number

The stroke width in pixels. Only applies to line and polygon geometries.

Optional title

title?: string

Rollover text. Only applies to point geometries.

Optional visible

visible?: boolean

Whether the feature is visible. Defaults to true.

Optional zIndex

zIndex?: number

All features are displayed on the map in order of their zIndex, with higher values displaying in front of features with lower values. Markers are always displayed in front of line-strings and polygons.

Generated using TypeDoc