Interface MPRouteMarkerDisplayRuleParams

Parameter interface for MPRouteMarkerDisplayRule.

Export

MPRouteMarkerDisplayRuleParams

Hierarchy

  • MPRouteMarkerDisplayRuleParams

Properties

iconSize? iconUrl? iconVisible? label? labelHaloColor? labelHaloWidth? labelTextColor? labelTextSize? labelVisible? zoomFrom? zoomTo?

Properties

Optional iconSize

iconSize?: default

The on screen size of the icon, in density independent units - points on iOS, dp on Android. Not raw pixels: the SDKs scale by the screen's density, so the same value is the same physical size on a 2x or 3x screen. Defaults to the icon's intrinsic size.

Optional iconUrl

iconUrl?: string

Media library URL of the marker icon, which the SDK downloads and caches.

Optional iconVisible

iconVisible?: boolean

Whether the icon is shown. Shown by default when an iconUrl is set.

Optional label

label?: string

The text drawn with the marker.

Optional labelHaloColor

labelHaloColor?: string

The label's halo (outline) color, given as a hex string (e.g. "#FFFFFF").

Optional labelHaloWidth

labelHaloWidth?: number

The label's halo (outline) width, in density independent units - points on iOS, dp on Android.

Optional labelTextColor

labelTextColor?: string

The label's text color, given as a hex string (e.g. "#3071D9").

Optional labelTextSize

labelTextSize?: number

The label's text size, in density independent units - points on iOS, dp on Android.

Optional labelVisible

labelVisible?: boolean

Whether the label is shown. Shown by default when a label is set.

Optional zoomFrom

zoomFrom?: number

The lowest zoom level at which the marker is shown.

Optional zoomTo

zoomTo?: number

The highest zoom level at which the marker is shown.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc