MapsIndoorsSDK/com.mapsindoors.mapssdk/LocationDisplayRule

LocationDisplayRule

class LocationDisplayRule

Location display rules. Not to be confused with DisplayRule objects that come from the server.

Constructors

LocationDisplayRule

open fun LocationDisplayRule(@NonNull name: String, @NonNull srcLocationDisplayRule: LocationDisplayRule)

Creates a new LocationDisplayRule given another one

Types

Builder

class Builder

Functions

getIcon

@Nullable

fun getIcon(): Bitmap

Get the icon bitmap for this rule.

getIconAnchorU

fun getIconAnchorU(): Float

Get icon's anchor U value

getIconAnchorV

fun getIconAnchorV(): Float

Get icon's anchor V value

getIconHeight

fun getIconHeight(): Int

The icon (if any) target height in pixels

getIconResourceId

fun getIconResourceId(): Int

getIconTintColor

fun getIconTintColor(): Int

Returns the tint color

getIconWidth

fun getIconWidth(): Int

The icon (if any) target width in pixels

getLabelContent

@Nullable

open fun getLabelContent(@Nullable location: MPLocation): String

Get the label content for a given location.

getLabelZoomLevelOff

fun getLabelZoomLevelOff(): Float

Gets the zoom level where the label is visible to

getLabelZoomLevelOn

fun getLabelZoomLevelOn(): Float

Gets the zoom level where the label is visible from

getShowLabel

fun getShowLabel(): Boolean

Get whether or not to show the marker as a label.

getZoomLevelOff

fun getZoomLevelOff(): Float

Gets the zoom level where the icon is visible to

getZoomLevelOn

fun getZoomLevelOn(): Float

Gets the zoom level where the icon is visible from

hasIconSizeSet

fun hasIconSizeSet(): Boolean

True if a custom size (uniform or not) has been set

isIconADrawable

fun isIconADrawable(): Boolean

Whether the icon, if available, was set using a Drawable resource (Bitmap or Vector)

isIconAVectorDrawable

fun isIconAVectorDrawable(): Boolean

Whether the icon, if available, was set using a Vector Drawable

isShowLabel

fun isShowLabel(): Boolean

Get the show label flag.

isVisible

fun isVisible(): Boolean

Get whether or not to show the marker.

setVisible

fun setVisible(show: Boolean): Boolean

Sets this Location Display Rule to be visible (based on the zoom on/off values) or not (marker icon not shown)

toString

@NonNull

open fun toString(): String

Properties

DEFAULT_ICON_SCALE

val DEFAULT_ICON_SCALE: Float

DEFAULT_ICON_UNIFORM_SIZE_IN_DP

val DEFAULT_ICON_UNIFORM_SIZE_IN_DP: Int

Default icon uniform size in dp

DEFAULT_LABEL_MAX_ZOOM

val DEFAULT_LABEL_MAX_ZOOM: Float

DEFAULT_LABEL_MIN_ZOOM

val DEFAULT_LABEL_MIN_ZOOM: Float

DEFAULT_MARKER_ICON_ANCHOR_U

val DEFAULT_MARKER_ICON_ANCHOR_U: Float

DEFAULT_MARKER_ICON_ANCHOR_V

val DEFAULT_MARKER_ICON_ANCHOR_V: Float

DEFAULT_MARKER_LABEL_ANCHOR_U

val DEFAULT_MARKER_LABEL_ANCHOR_U: Float

DEFAULT_MARKER_LABEL_ANCHOR_V

val DEFAULT_MARKER_LABEL_ANCHOR_V: Float

DEFAULT_MARKER_LABEL_LENGTH_NO_CAP

val DEFAULT_MARKER_LABEL_LENGTH_NO_CAP: Int

DEFAULT_MARKER_LABEL_MAX_WIDTH

val DEFAULT_MARKER_LABEL_MAX_WIDTH: Int

DEFAULT_MAX_ZOOM

val DEFAULT_MAX_ZOOM: Float

DEFAULT_MIN_ZOOM

val DEFAULT_MIN_ZOOM: Float

DEFAULT_POI_LABEL_TEMPLATE

@NonNull

val DEFAULT_POI_LABEL_TEMPLATE: String

The default label template is to use the location name.

labelMaxCharLength

open val labelMaxCharLength: Int

Defaults to 0 (no cap)

labelMaxWidth

private open var labelMaxWidth: Int

labelZoomFrom

open var labelZoomFrom: Float

labelZoomTo

open var labelZoomTo: Float

name

@NonNull

@get:NonNull

open val name: String

poiTypeDisplayRuleLabel

@get:Nullable

open val poiTypeDisplayRuleLabel: String

A copy of POIType->displayRule->label

polygonDisplayRule

@Nullable

open var polygonDisplayRule: PolygonDisplayRule

zoomFrom

open var zoomFrom: Float

zoomTo

open var zoomTo: Float