MapsIndoorsSDK/com.mapsindoors.mapssdk/LocationDisplayRule/Builder

Builder

Constructors

open fun Builder(@NonNull name: String)

LocationDisplayRule builder Default values are:

Marker visible
No icon
Label visibility: shown
Label template: "{{name}}" (the value of DEFAULT_POI_LABEL_TEMPLATE)

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

Functions

addLabelEllipsis

@NonNull

fun addLabelEllipsis(addLabelEllipsis: Boolean): LocationDisplayRule.Builder

@NonNull

fun build(): LocationDisplayRule

setBitmapDrawableIcon

@NonNull

fun setBitmapDrawableIcon(@DrawableRes bitmapDrawableResId: Int): LocationDisplayRule.Builder

Sets the icon for this rule using a android.graphics.drawable.BitmapDrawable resource Note that the size of the icon will be set to the default one set by setDisplayRuleDefaultIconSize

@NonNull

fun setBitmapDrawableIcon( @DrawableRes bitmapDrawableResId: Int, width: Int, height: Int): LocationDisplayRule.Builder

Sets the icon for this rule using a android.graphics.drawable.BitmapDrawable resource

@NonNull

fun setBitmapIcon(@NonNull bitmap: Bitmap): LocationDisplayRule.Builder

Sets the icon for this rule using a android.graphics.BitmapNote that the size of the icon will be set to the default one set by setDisplayRuleDefaultIconSize

@NonNull

fun setBitmapIcon( @NonNull bitmap: Bitmap, width: Int, height: Int): LocationDisplayRule.Builder

Sets the icon for this rule using a android.graphics.Bitmap

@NonNull

fun setEllipsize(@Nullable ellipsize: TextUtils.TruncateAt): LocationDisplayRule.Builder

@NonNull

fun setIconAnchor(anchorU: Float, anchorV: Float): LocationDisplayRule.Builder

Sets the anchor point for the marker

@NonNull

fun setLabel(@Nullable label: String): LocationDisplayRule.Builder

Sets a label to be rendered along with a location's icon (or alone if an icon hasn't been set) The label can be:

null to not show a label
A literal string
A template to render the location's name ("{{name}}"), the externalId ("{{externalId}}") or both ("{{externalId}} {{name}}")

Note that the default is to show the Location's name ("{{name}}") as its label

setLabelZoomLevelOff

@NonNull

fun setLabelZoomLevelOff(zOff: Float): LocationDisplayRule.Builder

Sets the zoom off/to value for the label The value is in the same range as zoomThe POI will be visible if zOn <= zoom

setLabelZoomLevelOn

@NonNull

fun setLabelZoomLevelOn(zOn: Float): LocationDisplayRule.Builder

Sets the zoom on/from value for the label The value is in the same range as zoomThe POI will be visible if zOn <= zoom

setLocationClusterId

@NonNull

fun setLocationClusterId(clusterId: Int): LocationDisplayRule.Builder

Sets display rule's clustering id

@NonNull

fun setTint(tintColor: Int): LocationDisplayRule.Builder

Sets the icon tint color

setVectorDrawableIcon

@NonNull

fun setVectorDrawableIcon(@DrawableRes vectorDrawableResId: Int): LocationDisplayRule.Builder

Sets the icon for this rule using a android.graphics.drawable.VectorDrawable resource Note that the size of the icon will be set to the default one set by setDisplayRuleDefaultIconSize

@NonNull

fun setVectorDrawableIcon( @DrawableRes vectorDrawableResId: Int, width: Int, height: Int): LocationDisplayRule.Builder

Sets the icon for this rule using a android.graphics.drawable.VectorDrawable resource

@NonNull

fun setVisible(isVisible: Boolean): LocationDisplayRule.Builder

Visibility defaults to true

setZoomLevelOff

@NonNull

fun setZoomLevelOff(zOff: Float): LocationDisplayRule.Builder

Sets the zoom off/to value for the icon The value is in the same range as zoomThe POI will be visible if zOn <= zoom

@NonNull

fun setZoomLevelOn(zOn: Float): LocationDisplayRule.Builder

Sets the zoom on/from value for the icon The value is in the same range as zoomThe POI will be visible if zOn <= zoom

@NonNull

open fun toString(): String

Properties

@set:NonNull

open var displayRank: Int

labelMaxCharLength

@set:NonNull

open var labelMaxCharLength: Int

@set:NonNull

open var labelMaxWidth: Int

polygonDisplayRule

@set:NonNull

open var polygonDisplayRule: PolygonDisplayRule

@set:NonNull

open var showIcon: Boolean

@set:NonNull

open var showLabel: Boolean