MapsIndoorsSDK/com.mapsindoors.core/MPDisplayRuleOptions

MPDisplayRuleOptions

open class MPDisplayRuleOptions

A collection of settings that can be applied to a MPDisplayRule

Can be used with MPDisplayRule to create a custom DisplayRule with these options

Alternatively, use applyOptions to update an existing DisplayRule with these options

Constructors

Link copied to clipboard
open fun MPDisplayRuleOptions()
Create a new MPDisplayRuleOptions that can be used to bulk edit fields on a MPDisplayRule

Functions

Link copied to clipboard
@NonNull
open fun setBadgeFillColor(@NonNull fillColor: String): MPDisplayRuleOptions
Set badge fillColor
Link copied to clipboard
@NonNull
open fun setBadgePosition(@NonNull badgePosition: MPBadgePosition): MPDisplayRuleOptions
Set badge position
Link copied to clipboard
@NonNull
open fun setBadgeRadius(radius: Int): MPDisplayRuleOptions
Set badge radius
Link copied to clipboard
@NonNull
open fun setBadgeScale(scale: Float): MPDisplayRuleOptions
Set badge scale
Link copied to clipboard
@NonNull
open fun setBadgeStrokeColor(@NonNull strokeColor: String): MPDisplayRuleOptions
Set badge stroke color
Link copied to clipboard
@NonNull
open fun setBadgeStrokeWidth(strokeWidth: Float): MPDisplayRuleOptions
Set badge stroke width
Link copied to clipboard
@NonNull
open fun setBadgeVisible(visible: Boolean): MPDisplayRuleOptions
Set badge visibility
Link copied to clipboard
@NonNull
open fun setBadgeZoomFrom(zoom: Float): MPDisplayRuleOptions
Set badge zoomFrom
Link copied to clipboard
@NonNull
open fun setBadgeZoomTo(zoom: Float): MPDisplayRuleOptions
Set badge zoomTo
Link copied to clipboard
@NonNull
open fun setExtrusionColor(@ColorInt color: Int): MPDisplayRuleOptions
Set extrusion color
@NonNull
open fun setExtrusionColor(@NonNull color: String): MPDisplayRuleOptions
Set extrusion color (hex color code e.g.
Link copied to clipboard
@NonNull
open fun setExtrusionHeight(height: Float): MPDisplayRuleOptions
Set extrusion height in meters
Link copied to clipboard
@NonNull
open fun setExtrusionLightnessFactor(@FloatRange(from = "-1.0", to = 1.0) lightnessFactor: Float): MPDisplayRuleOptions
Set Extrusion Lightness Factor (-1.0 = Dark, 0.0 no lighting added, 1.
Link copied to clipboard
@NonNull
open fun setExtrusionVisible(visible: Boolean): MPDisplayRuleOptions
Set extrusion visibility
Link copied to clipboard
@NonNull
open fun setExtrusionZoomFrom(zoom: Float): MPDisplayRuleOptions
Set extrusion "zoom from" value, dictating from which zoom level the extrusion should stop being shown
Link copied to clipboard
@NonNull
open fun setExtrusionZoomTo(zoom: Float): MPDisplayRuleOptions
Set extrusion "zoom to" value, dictating from which zoom level the extrusion should stop being shown
Link copied to clipboard
@NonNull
open fun setIcon(@NonNull bitmap: Bitmap): MPDisplayRuleOptions
Set icon from bitmap
@NonNull
open fun setIcon(@NonNull drawable: Drawable): MPDisplayRuleOptions
@NonNull
open fun setIcon(@NonNull drawable: Drawable, @ColorInt tint: Int): MPDisplayRuleOptions
@NonNull
open fun setIcon(@NonNull drawable: Drawable, @NonNull tint: String): MPDisplayRuleOptions
Set icon from drawable
@NonNull
open fun setIcon(@DrawableRes resId: Int): MPDisplayRuleOptions
@NonNull
open fun setIcon(@DrawableRes resId: Int, @ColorInt tint: Int): MPDisplayRuleOptions
@NonNull
open fun setIcon(@DrawableRes resId: Int, @NonNull tint: String): MPDisplayRuleOptions
Set icon from resource ID
@NonNull
open fun setIcon(@NonNull url: String): MPDisplayRuleOptions
Set icon URL (will be used to download the icon asset)
Link copied to clipboard
@NonNull
open fun setIconPlacement(@NonNull iconPlacement: MPIconPlacement): MPDisplayRuleOptions
Set icon placement in relation to the anchor.
Link copied to clipboard
@NonNull
open fun setIconScale(scale: Float): MPDisplayRuleOptions
Set icon scale
Link copied to clipboard
@NonNull
open fun setIconSize(width: Int, height: Int): MPDisplayRuleOptions
Set icon size (dp)
Link copied to clipboard
@NonNull
open fun setIconVisible(visible: Boolean): MPDisplayRuleOptions
Set icon visibility
Link copied to clipboard
@NonNull
open fun setLabel(@NonNull label: String): MPDisplayRuleOptions
Set label text
Link copied to clipboard
@NonNull
open fun setLabelMaxWidth(width: Int): MPDisplayRuleOptions
Set the max width for label text (in dp).
Link copied to clipboard
@NonNull
open fun setLabelStyleBearing(bearing: Float): MPDisplayRuleOptions
Set the bearing value for the label, this value will only be applied when the MPLabelType is FLAT
Link copied to clipboard
@NonNull
open fun setLabelStyleGraphic(@NonNull graphic: MPLabelGraphic): MPDisplayRuleOptions
Set the graphic label object for the label, this value will only be applied when the MPLabelType is GRAPHIC
Link copied to clipboard
@NonNull
open fun setLabelStyleHaloBlur(blur: Int): MPDisplayRuleOptions
Set the blur value of the label halo (in pixels) Blur is the halo's fadeout distance
Link copied to clipboard
@NonNull
open fun setLabelStyleHaloColor(@NonNull color: String): MPDisplayRuleOptions
Set the color of the label halo (hex color code e.g.
Link copied to clipboard
@NonNull
open fun setLabelStyleHaloWidth(width: Int): MPDisplayRuleOptions
Set the width of the label halo (in pixels)
Link copied to clipboard
@NonNull
open fun setLabelStyleTextColor(@NonNull color: String): MPDisplayRuleOptions
Set the color of the label text (hex color code e.g.
Link copied to clipboard
@NonNull
open fun setLabelStyleTextOpacity(opacity: Float): MPDisplayRuleOptions
Set the opacity of the label text to a value between 0.0 and 1.
Link copied to clipboard
@NonNull
open fun setLabelStyleTextSize(size: Int): MPDisplayRuleOptions
Set the size of the label characters (in pixels)
Link copied to clipboard
@NonNull
open fun setLabelType(@NonNull type: MPLabelType): MPDisplayRuleOptions
Set how the label should be rendered on the map
Link copied to clipboard
@NonNull
open fun setLabelVisible(visible: Boolean): MPDisplayRuleOptions
Set label visibility
Link copied to clipboard
@NonNull
open fun setLabelZoomFrom(zoom: Float): MPDisplayRuleOptions
Set the label "zoom from" value, dictating from which zoom level the label should start being shown
Link copied to clipboard
@NonNull
open fun setLabelZoomTo(zoom: Float): MPDisplayRuleOptions
Set the label "zoom to" value, dictating from which zoom level the label should stop being shown
Link copied to clipboard
@NonNull
open fun setModel2DBearing(bearing: Double): MPDisplayRuleOptions
Set 2D model bearing (rotation in degrees)
Link copied to clipboard
@NonNull
open fun setModel2DHeightMeters(height: Double): MPDisplayRuleOptions
Set 2D model height in meters
Link copied to clipboard
@NonNull
open fun setModel2DModel(@NonNull model: String): MPDisplayRuleOptions
Set 2D model URL
Link copied to clipboard
@NonNull
open fun setModel2DVisible(visible: Boolean): MPDisplayRuleOptions
Set 2D model visibility
Link copied to clipboard
@NonNull
open fun setModel2DWidthMeters(width: Double): MPDisplayRuleOptions
Set 2D model width in meters
Link copied to clipboard
@NonNull
open fun setModel2DZoomFrom(zoom: Float): MPDisplayRuleOptions
Set 2D model "zoom from" value, dictating from which zoom level the model should start being shown
Link copied to clipboard
@NonNull
open fun setModel2DZoomTo(zoom: Float): MPDisplayRuleOptions
Set 2D model "zoom to" value, dictating from which zoom level the model should stop being shown
Link copied to clipboard
@NonNull
open fun setModel3DModel(@Nullable model: String): MPDisplayRuleOptions
Set 3D model URL
Link copied to clipboard
@NonNull
open fun setModel3DRotationX(x: Float): MPDisplayRuleOptions
Set 3D model rotation around the X-axis in degrees
Link copied to clipboard
@NonNull
open fun setModel3DRotationY(y: Float): MPDisplayRuleOptions
Set 3D model rotation around the Y-axis in degrees
Link copied to clipboard
@NonNull
open fun setModel3DRotationZ(z: Float): MPDisplayRuleOptions
Set 3D model rotation around the Z-axis in degrees
Link copied to clipboard
@NonNull
open fun setModel3DScale(@FloatRange(from = 0.0) scale: Float): MPDisplayRuleOptions
Set 3D model scale as a multiple of its original size (1 is original size, 2 is double that, etc.
Link copied to clipboard
@NonNull
open fun setModel3DVisible(visible: Boolean): MPDisplayRuleOptions
Set 3D model visibility
Link copied to clipboard
@NonNull
open fun setModel3DZoomFrom(zoom: Float): MPDisplayRuleOptions
Set 3D model "zoom from" value, dictating from which zoom level the 3D model should start being shown
Link copied to clipboard
@NonNull
open fun setModel3DZoomTo(zoom: Float): MPDisplayRuleOptions
Set 3D model "zoom to" value, dictating from which zoom level the 3D model should stop being shown
Link copied to clipboard
@NonNull
open fun setPolygonFillColor(@ColorInt color: Int): MPDisplayRuleOptions
Set polygon fill color
@NonNull
open fun setPolygonFillColor(@NonNull color: String): MPDisplayRuleOptions
Set polygon fill color (hex color code e.g.
Link copied to clipboard
@NonNull
open fun setPolygonFillOpacity(@FloatRange(from = 0.0, to = 1.0) opacity: Float): MPDisplayRuleOptions
Set polygon fill opacity (0.0 = invisible, 1.
Link copied to clipboard
@NonNull
open fun setPolygonLightnessFactor(@FloatRange(from = "-1.0", to = 1.0) lightnessFactor: Float): MPDisplayRuleOptions
Set polygon Lightness Factor (-1.0 = Dark, 0.0 no lighting added, 1.
Link copied to clipboard
@NonNull
open fun setPolygonStrokeColor(@ColorInt color: Int): MPDisplayRuleOptions
Set polygon stroke color
@NonNull
open fun setPolygonStrokeColor(@NonNull color: String): MPDisplayRuleOptions
Set polygon stroke color (hex color code e.g.
Link copied to clipboard
@NonNull
open fun setPolygonStrokeOpacity(@FloatRange(from = 0.0, to = 1.0) opacity: Float): MPDisplayRuleOptions
Set polygon stroke opacity (0.0 = invisible, 1.
Link copied to clipboard
@NonNull
open fun setPolygonStrokeWidth(width: Float): MPDisplayRuleOptions
Set polygon stroke width
Link copied to clipboard
@NonNull
open fun setPolygonVisible(visible: Boolean): MPDisplayRuleOptions
Set polygon visibility
Link copied to clipboard
@NonNull
open fun setPolygonZoomFrom(zoom: Float): MPDisplayRuleOptions
Set the polygon "zoom from" value, dictating from which zoom level the polygon should start being shown
Link copied to clipboard
@NonNull
open fun setPolygonZoomTo(zoom: Float): MPDisplayRuleOptions
Get the polygon "zoom to" value, dictating from which zoom level the polygon should stop being shown
Link copied to clipboard
@NonNull
open fun setVisible(visible: Boolean): MPDisplayRuleOptions
Set general visibility value
Link copied to clipboard
@NonNull
open fun setWallColor(@ColorInt color: Int): MPDisplayRuleOptions
Set wall color
@NonNull
open fun setWallColor(@NonNull color: String): MPDisplayRuleOptions
Set wall color (hex color code e.g.
Link copied to clipboard
@NonNull
open fun setWallHeight(height: Float): MPDisplayRuleOptions
Set wall height in meters
Link copied to clipboard
@NonNull
open fun setWallLightnessFactor(@FloatRange(from = "-1.0", to = 1.0) lightnessFactor: Float): MPDisplayRuleOptions
Set Wall Lightness Factor (-1.0 = Dark, 0.0 no lighting added, 1.
Link copied to clipboard
@NonNull
open fun setWallVisible(visible: Boolean): MPDisplayRuleOptions
Set wall visibility
Link copied to clipboard
@NonNull
open fun setWallZoomFrom(zoom: Float): MPDisplayRuleOptions
Set wall "zoom from" value, dictating from which zoom level the wall should start being shown
Link copied to clipboard
@NonNull
open fun setWallZoomTo(zoom: Float): MPDisplayRuleOptions
Set wall "zoom to" value, dictating from which zoom level the wall should stop being shown
Link copied to clipboard
@NonNull
open fun setZoomFrom(zoom: Float): MPDisplayRuleOptions
Set the "zoom from" value.
Link copied to clipboard
@NonNull
open fun setZoomTo(zoom: Float): MPDisplayRuleOptions
Set the "zoom to" value.