Skip to content

RenderOptions Type documentation

Properties
component?: Type<any>
map?: Map
mapPoints: (MapPointMetaData | MapPointMetaData[])

Types Documentation

import
imported from ol
Properties
Marker description, can be simple string or HTML as string
description: string
Extra properties to be passed along (click function consumes it)
extraProperties?: any
If you want your point to be clustered by it's group, you need to set the group id here for this point Color with the same id will be assigned. Must be higher than 0
group?: number
Marker style
marker?: MarkerOptions
Marker name
name: string
Methods
(extraProperties: any) => void
Click functionality, do any extra staff when clicking on the point, just create needed logic for click functionality
Parameters
extraProperties?: any
Properties
Color of the marker, HEX or css compliant color value. Only use when a semantic status isn't working for the use-case.
color?: string
Icon options
icon?: IconMarkerOptions
Semantic status for coloring. This is also theme-aware.
status?: MarkerStatusType
Visual representation of marker
type: ("status" | "icon" | "dot")
Properties
Scale value for marker
scale?: number
Path to the icon image
src?: string
("success" | "info" | "warning" | "danger" | "caution" | "critical" | "default" | "unknown")

Except where otherwise noted, content on this site is licensed under MIT License.