MarkerSettingsModel

23 Sep 20253 minutes to read

Interface for a class MarkerSettings

Properties

animationDelay number

Gets or sets the delay time for the animation in marker.

animationDuration number

Gets or sets the duration time for animating the marker.

border BorderModel

Gets or sets the options for customizing the style properties of the border of the marker in maps.

clusterSettings MarkerClusterSettingsModel

Gets or sets the options for customizing the clustering of markers on the map.
This property is used to cluster markers based on the current marker settings, and it is applied only when the allowClustering property is enabled.

colorValuePath string

Gets or sets the field name from the marker data source based on which the color is applied for the marker.

dashArray string

Gets or sets the dash-array for the marker.

dataSource Object[]|DataManager

Gets or sets the data source for the marker.
The data source for the marker will contain latitude and longitude values to specify the location
of the marker.
The data source can contain data such as color, shape, and other details that can be bound to the color, shape,
and tooltip of the marker.

enableDrag boolean

Enables or disables marker drag and drop functionality at any location on the map.

fill string

Gets or sets the color for the marker in maps.

height number

Gets or sets the height of the marker in maps.

heightValuePath string

Gets or sets the field name from the data source that determines the marker height.

highlightSettings HighlightSettingsModel

Gets or sets the options to customize the marker when the mouse hovers over the markers in maps.

imageUrl string

Gets or sets the URL for rendering the marker as image. This property acts as image source for all the markers in a marker settings.

imageUrlValuePath string

Gets or sets the field name from the marker data source based on which the image source for the image type marker is got individually.

initialMarkerSelection InitialMarkerSelectionSettingsModel[]

Gets or sets the options to select the markers at the initial rendering time of the maps.
The initial selection of markers will be performed only when the selection functionality of marker is enabled.

latitudeValuePath string

Defines the field name from the marker data source for setting latitude for a set of markers.

legendText string

Gets or sets the field name from the marker data source to render legend item text for the marker legend.

longitudeValuePath string

Defines the field name from the marker data source for setting longitude for a set of markers.

offset Point

Gets or sets the offset value from which the marker must be rendered from the intended position.

opacity number

Gets or sets the opacity for the marker in maps.

query Query

Gets or sets the query to select particular data from the marker data source.
This property is applicable only when the data source is created by data manager.

selectionSettings SelectionSettingsModel

Gets or sets the options to customize the marker while selecting the marker in maps.

shape MarkerType

Gets or sets the shape of the marker in maps.

shapeValuePath string

Gets or sets the field name from the marker data source based on which the shape for individual markers are set.

template string|Function

Gets or sets the template for the marker to render custom elements.

tooltipSettings TooltipSettingsModel

Gets or sets the options to customize the tooltip of the marker in maps.

visible boolean

Enables or disables the visibility of the markers in maps.

width number

Gets or sets the width of the marker in maps.

widthValuePath string

Gets or sets the field name from the data source that determines the marker width.