Class MPDisplayRule

Readonly id

getBadgeFillColor

• getBadgeFillColor(): Promise<string>

• Returns Promise<string>

getBadgePosition

• getBadgePosition(): Promise<MPBadgePosition>

• Returns Promise<MPBadgePosition>

getBadgeRadius

• getBadgeRadius(): Promise<number>

• Returns Promise<number>

getBadgeScale

• getBadgeScale(): Promise<number>

• Returns Promise<number>

getBadgeStrokeColor

• getBadgeStrokeColor(): Promise<string>

• Returns Promise<string>

getBadgeStrokeWidth

• getBadgeStrokeWidth(): Promise<number>

• Returns Promise<number>

getBadgeZoomFrom

• getBadgeZoomFrom(): Promise<number>

• Returns Promise<number>

getBadgeZoomTo

• getBadgeZoomTo(): Promise<number>

• Returns Promise<number>

getExtrusionColor

• getExtrusionColor(): Promise<string>

• Get the extrusion's color value.

  Returns Promise<string>

  Async

getExtrusionHeight

• getExtrusionHeight(): Promise<number>

• Get the extrusion's height value.

  Returns Promise<number>

  Async

getExtrusionLightnessFactor

• getExtrusionLightnessFactor(): Promise<number>

• Returns Promise<number>

getExtrusionZoomFrom

• getExtrusionZoomFrom(): Promise<number>

• Get the extrusion's zoom from value.

  Returns Promise<number>

  Async

getExtrusionZoomTo

• getExtrusionZoomTo(): Promise<number>

• Get the extrusion's zoom to value.

  Returns Promise<number>

  Async

getIconPlacement

• getIconPlacement(): Promise<MPIconPlacement>

• Returns Promise<MPIconPlacement>

getIconScale

• getIconScale(): Promise<number>

• Returns Promise<number>

getIconSize

• getIconSize(): Promise<MPIconSize>

• Get the icon's size.

  Returns Promise<MPIconSize>

  Async

getIconUrl

• getIconUrl(): Promise<string>

• Get the icon's URL.

  Returns Promise<string>

  Async

getLabel

• getLabel(): Promise<string>

• Get the label string.

  Returns Promise<string>

  Async

getLabelMaxWidth

• getLabelMaxWidth(): Promise<number>

• Get the label's max width value.

  Returns Promise<number>

  Async

getLabelStyleBearing

• getLabelStyleBearing(): Promise<number>

• Returns Promise<number>

getLabelStyleHaloBlur

• getLabelStyleHaloBlur(): Promise<number>

• Returns Promise<number>

getLabelStyleHaloColor

• getLabelStyleHaloColor(): Promise<string>

• Returns Promise<string>

getLabelStyleHaloWidth

• getLabelStyleHaloWidth(): Promise<number>

• Returns Promise<number>

getLabelStyleTextColor

• getLabelStyleTextColor(): Promise<string>

• Returns Promise<string>

getLabelStyleTextOpacity

• getLabelStyleTextOpacity(): Promise<number>

• Returns Promise<number>

getLabelStyleTextSize

• getLabelStyleTextSize(): Promise<number>

• Returns Promise<number>

getLabelType

• getLabelType(): Promise<MPLabelType>

• Returns Promise<MPLabelType>

getLabelZoomFrom

• getLabelZoomFrom(): Promise<number>

• Get the label's zoom from value.

  Returns Promise<number>

  Async

getLabelZoomTo

• getLabelZoomTo(): Promise<number>

• Get the label's zoom to value.

  Returns Promise<number>

  Async

getModel2DBearing

• getModel2DBearing(): Promise<number>

• Get the 2D model's bearing value.

  Returns Promise<number>

  Async

getModel2DHeightMeters

• getModel2DHeightMeters(): Promise<number>

• Get the 2D model's height in meters.

  Returns Promise<number>

  Async

getModel2DModel

• getModel2DModel(): Promise<string>

• Get the 2D model's URL.

  Returns Promise<string>

  Async

getModel2DWidthMeters

• getModel2DWidthMeters(): Promise<number>

• Get the 2D model's width in meters.

  Returns Promise<number>

  Async

getModel2DZoomFrom

• getModel2DZoomFrom(): Promise<number>

• Get the 2D model's zoom from value.

  Returns Promise<number>

  Async

getModel2DZoomTo

• getModel2DZoomTo(): Promise<number>

• Get the 2D model's zoom to value.

  Returns Promise<number>

  Async

getPolygonFillColor

• getPolygonFillColor(): Promise<string>

• Get the polygon's fill color value.

  Returns Promise<string>

  Async

getPolygonFillOpacity

• getPolygonFillOpacity(): Promise<number>

• Get the polygon's fill opacity value.

  Returns Promise<number>

  Async

getPolygonLightnessFactor

• getPolygonLightnessFactor(): Promise<number>

• Returns Promise<number>

getPolygonStrokeColor

• getPolygonStrokeColor(): Promise<string>

• Get the polygon's stroke color value.

  Returns Promise<string>

  Async

getPolygonStrokeOpacity

• getPolygonStrokeOpacity(): Promise<number>

• Get the polygon's stroke opacity value.

  Returns Promise<number>

  Async

getPolygonStrokeWidth

• getPolygonStrokeWidth(): Promise<number>

• Get the polygon's stroke width value.

  Returns Promise<number>

  Async

getPolygonZoomFrom

• getPolygonZoomFrom(): Promise<number>

• Get the plygon's zoom from value.

  Returns Promise<number>

  Async

getPolygonZoomTo

• getPolygonZoomTo(): Promise<number>

• Get the polygon's zoom to value.

  Returns Promise<number>

  Async

getWallColor

• getWallColor(): Promise<string>

• Get the wall's color value.

  Returns Promise<string>

  Async

getWallHeight

• getWallHeight(): Promise<number>

• Get the wall's height value.

  Returns Promise<number>

  Async

getWallLightnessFactor

• getWallLightnessFactor(): Promise<number>

• Returns Promise<number>

getWallZoomFrom

• getWallZoomFrom(): Promise<number>

• Get the wall's zoom from value.

  Returns Promise<number>

  Async

getWallZoomTo

• getWallZoomTo(): Promise<number>

• Get the wall's zoom to value.

  Returns Promise<number>

  Async

getZoomFrom

• getZoomFrom(): Promise<number>

• Get the general zoom from value.

  Returns Promise<number>

  Async

getZoomTo

• getZoomTo(): Promise<number>

• Get the general zoom to value.

  Returns Promise<number>

  Async

isBadgeVisible

• isBadgeVisible(): Promise<boolean>

• Returns Promise<boolean>

isExtrusionVisible

• isExtrusionVisible(): Promise<boolean>

• Get the extrusion's visibility value.

  Returns Promise<boolean>

  Async

isIconVisible

• isIconVisible(): Promise<boolean>

• Get the icon's visibility value.

  Returns Promise<boolean>

  Async

isLabelVisible

• isLabelVisible(): Promise<boolean>

• Get the label's visibility value.

  Returns Promise<boolean>

  Async

isModel2DVisible

• isModel2DVisible(): Promise<boolean>

• Get the 2D model's visibility value.

  Returns Promise<boolean>

  Async

isPolygonVisible

• isPolygonVisible(): Promise<boolean>

• Get the polygon's visibility value.

  Returns Promise<boolean>

  Async

isVisible

• isVisible(): Promise<boolean>

• Get the general visibility value.

  Returns Promise<boolean>

  Async

isWallVisible

• isWallVisible(): Promise<boolean>

• Get the wall's visibility value.

  Returns Promise<boolean>

  Async

reset

• reset(): Promise<void>

• Resets the display rule to its default state.

  Returns Promise<void>

  Async

setBadgeFillColor

• setBadgeFillColor(fillColor): Promise<void>

• Parameters

  • fillColor: string

  Returns Promise<void>

setBadgePosition

• setBadgePosition(badgePosition): Promise<void>

• Parameters

  • badgePosition: MPBadgePosition

  Returns Promise<void>

setBadgeRadius

• setBadgeRadius(radius): Promise<void>

• Parameters

  • radius: number

  Returns Promise<void>

setBadgeScale

• setBadgeScale(badgeScale): Promise<void>

• Parameters

  • badgeScale: number

  Returns Promise<void>

setBadgeStrokeColor

• setBadgeStrokeColor(strokeColor): Promise<void>

• Parameters

  • strokeColor: string

  Returns Promise<void>

setBadgeStrokeWidth

• setBadgeStrokeWidth(strokeWidth): Promise<void>

• Parameters

  • strokeWidth: number

  Returns Promise<void>

setBadgeVisible

• setBadgeVisible(visible): Promise<void>

• Parameters

  • visible: boolean

  Returns Promise<void>

setBadgeZoomFrom

• setBadgeZoomFrom(zoomFrom): Promise<void>

• Parameters

  • zoomFrom: number

  Returns Promise<void>

setBadgeZoomTo

• setBadgeZoomTo(zoomTo): Promise<void>

• Parameters

  • zoomTo: number

  Returns Promise<void>

setExtrusionColor

• setExtrusionColor(extrusionColor): Promise<void>

• Set the extrusion's color value.

  Parameters

  • extrusionColor: string

  Returns Promise<void>

  Async

setExtrusionHeight

• setExtrusionHeight(extrusionHeight): Promise<void>

• Set the extrusion's height value.

  Parameters

  • extrusionHeight: number

  Returns Promise<void>

  Async

setExtrusionLightnessFactor

• setExtrusionLightnessFactor(lightnessFactor): Promise<void>

• Parameters

  • lightnessFactor: number

  Returns Promise<void>

setExtrusionVisible

• setExtrusionVisible(extrusionVisible): Promise<void>

• Set the extrusion's visibility value.

  Parameters

  • extrusionVisible: boolean

  Returns Promise<void>

  Async

setExtrusionZoomFrom

• setExtrusionZoomFrom(extrusionZoomFrom): Promise<void>

• Set the extrusion's zoom from value.

  Parameters

  • extrusionZoomFrom: number

  Returns Promise<void>

  Async

setExtrusionZoomTo

• setExtrusionZoomTo(extrusionZoomTo): Promise<void>

• Get the extrusion's zoom to value.

  Parameters

  • extrusionZoomTo: number

  Returns Promise<void>

  Async

setIcon

• setIcon(iconUrl): Promise<void>

• Set the icon's URL.

  Parameters

  • iconUrl: string

  Returns Promise<void>

  Async

setIconPlacement

• setIconPlacement(iconPlacement): Promise<void>

• Parameters

  • iconPlacement: MPIconPlacement

  Returns Promise<void>

setIconScale

• setIconScale(iconScale): Promise<void>

• Parameters

  • iconScale: number

  Returns Promise<void>

setIconSize

• setIconSize(iconSize): Promise<void>

• Set the icon's size.

  Parameters

  • iconSize: MPIconSize

  Returns Promise<void>

  Async

setIconVisible

• setIconVisible(iconVisible): Promise<void>

• Set the icon's visibility value.

  Parameters

  • iconVisible: boolean

  Returns Promise<void>

  Async

setLabel

• setLabel(label): Promise<void>

• Set the label string.

  Parameters

  • label: string

  Returns Promise<void>

  Async

setLabelMaxWidth

• setLabelMaxWidth(labelMaxWidth): Promise<void>

• Set the label's max width value.

  Parameters

  • labelMaxWidth: number

  Returns Promise<void>

  Async

setLabelStyleBearing

• setLabelStyleBearing(bearing): Promise<void>

• Parameters

  • bearing: number

  Returns Promise<void>

setLabelStyleHaloBlur

• setLabelStyleHaloBlur(haloBlur): Promise<void>

• Parameters

  • haloBlur: number

  Returns Promise<void>

setLabelStyleHaloColor

• setLabelStyleHaloColor(color): Promise<void>

• Parameters

  • color: string

  Returns Promise<void>

setLabelStyleHaloWidth

• setLabelStyleHaloWidth(haloWidth): Promise<void>

• Parameters

  • haloWidth: number

  Returns Promise<void>

setLabelStyleTextColor

• setLabelStyleTextColor(textColor): Promise<void>

• Parameters

  • textColor: String

  Returns Promise<void>

setLabelStyleTextOpacity

• setLabelStyleTextOpacity(textOpacity): Promise<void>

• Parameters

  • textOpacity: number

  Returns Promise<void>

setLabelStyleTextSize

• setLabelStyleTextSize(textSize): Promise<void>

• Parameters

  • textSize: number

  Returns Promise<void>

setLabelType

• setLabelType(labelType): Promise<void>

• Parameters

  • labelType: MPLabelType

  Returns Promise<void>

setLabelVisible

• setLabelVisible(labelVisible): Promise<void>

• Set the label's visibility value.

  Parameters

  • labelVisible: boolean

  Returns Promise<void>

  Async

setLabelZoomFrom

• setLabelZoomFrom(zoomFrom): Promise<void>

• Set the label's zoom from value.

  Parameters

  • zoomFrom: number

  Returns Promise<void>

  Async

setLabelZoomTo

• setLabelZoomTo(zoomTo): Promise<void>

• Set the label's zoom to value.

  Parameters

  • zoomTo: number

  Returns Promise<void>

  Async

setModel2DBearing

• setModel2DBearing(bearing): Promise<void>

• Get the 2D model's bearing value.

  Parameters

  • bearing: number

  Returns Promise<void>

  Async

setModel2DHeightMeters

• setModel2DHeightMeters(height): Promise<void>

• Set the 2D model's height in meters.

  Parameters

  • height: number

  Returns Promise<void>

  Async

setModel2DModel

• setModel2DModel(url): Promise<void>

• Set the 2D model's URL.

  Parameters

  • url: string

  Returns Promise<void>

  Async

setModel2DVisible

• setModel2DVisible(model2DVisible): Promise<void>

• Set the 2D model's visibility value.

  Parameters

  • model2DVisible: boolean

  Returns Promise<void>

  Async

setModel2DWidthMeters

• setModel2DWidthMeters(width): Promise<void>

• Set the 2D model's width in meters.

  Parameters

  • width: number

  Returns Promise<void>

  Async

setModel2DZoomFrom

• setModel2DZoomFrom(zoomFrom): Promise<void>

• Set the 2D model's zoom from value.

  Parameters

  • zoomFrom: number

  Returns Promise<void>

  Async

setModel2DZoomTo

• setModel2DZoomTo(zoomTo): Promise<void>

• Set the 2D model's zoom to value.

  Parameters

  • zoomTo: number

  Returns Promise<void>

  Async

setPolygonFillColor

• setPolygonFillColor(fillColor): Promise<void>

• Set the polygon's fill color value.

  Parameters

  • fillColor: string

  Returns Promise<void>

  Async

setPolygonFillOpacity

• setPolygonFillOpacity(fillOpacity): Promise<void>

• Set the polygon's fill opacity value.

  Parameters

  • fillOpacity: number

  Returns Promise<void>

  Async

setPolygonLightnessFactor

• setPolygonLightnessFactor(lightnessFactor): Promise<void>

• Parameters

  • lightnessFactor: number

  Returns Promise<void>

setPolygonStrokeColor

• setPolygonStrokeColor(strokeColor): Promise<void>

• Set the polygon's stroke color value.

  Parameters

  • strokeColor: string

  Returns Promise<void>

  Async

setPolygonStrokeOpacity

• setPolygonStrokeOpacity(strokeOpacity): Promise<void>

• Set the polygon's stroke opacity value.

  Parameters

  • strokeOpacity: number

  Returns Promise<void>

  Async

setPolygonStrokeWidth

• setPolygonStrokeWidth(strokeWidth): Promise<void>

• Set the polygon's stroke width value.

  Parameters

  • strokeWidth: number

  Returns Promise<void>

  Async

setPolygonVisible

• setPolygonVisible(polygonVisible): Promise<void>

• Set the polygon's visibility value.

  Parameters

  • polygonVisible: boolean

  Returns Promise<void>

  Async

setPolygonZoomFrom

• setPolygonZoomFrom(polygonZoomFrom): Promise<void>

• Get the plygon's zoom from value.

  Parameters

  • polygonZoomFrom: number

  Returns Promise<void>

  Async

setPolygonZoomTo

• setPolygonZoomTo(polygonZoomTo): Promise<void>

• Set the polygon's zoom to value.

  Parameters

  • polygonZoomTo: number

  Returns Promise<void>

  Async

setVisible

• setVisible(visible): Promise<void>

• Set the general visibility value.

  Parameters

  • visible: boolean

  Returns Promise<void>

  Async

setWallColor

• setWallColor(wallColor): Promise<void>

• Set the wall's color value.

  Parameters

  • wallColor: string

  Returns Promise<void>

  Async

setWallHeight

• setWallHeight(wallHeight): Promise<void>

• Set the wall's height value.

  Parameters

  • wallHeight: number

  Returns Promise<void>

  Async

setWallLightnessFactor

• setWallLightnessFactor(lightnessFactor): Promise<void>

• Parameters

  • lightnessFactor: number

  Returns Promise<void>

setWallVisible

• setWallVisible(wallVisible): Promise<void>

• Set the wall's visibility value.

  Parameters

  • wallVisible: boolean

  Returns Promise<void>

  Async

setWallZoomFrom

• setWallZoomFrom(wallZoomFrom): Promise<void>

• Set the wall's zoom from value.

  Parameters

  • wallZoomFrom: number

  Returns Promise<void>

  Async

setWallZoomTo

• setWallZoomTo(wallZoomTo): Promise<void>

• Set the wall's zoom to value.

  Parameters

  • wallZoomTo: number

  Returns Promise<void>

  Async

setZoomFrom

• setZoomFrom(zoomFrom): Promise<void>

• Set the general zoom from value.

  Parameters

  • zoomFrom: number

  Returns Promise<void>

  Async

setZoomTo

• setZoomTo(zoomTo): Promise<void>

• Set the general zoom to value.

  Parameters

  • zoomTo: number

  Returns Promise<void>

  Async

Static create

• create(object?): MPDisplayRule

• Creator for MPDisplayRule, used to decode JSON from the MapsIndoors SDK.

  This is primarily for internal use, and should not be used outside the SDK.

  Parameters

  • Optional object: any

  Returns MPDisplayRule

  Static