A collection of settings that dictate how MapsIndoors entities are displayed on the map.

Export

Hierarchy

  • MPDisplayRule

Properties

Methods

getBadgeFillColor getBadgePosition getBadgeRadius getBadgeScale getBadgeStrokeColor getBadgeStrokeWidth getBadgeZoomFrom getBadgeZoomTo getExtrusionColor getExtrusionHeight getExtrusionLightnessFactor getExtrusionZoomFrom getExtrusionZoomTo getIconPlacement getIconScale getIconSize getIconUrl getLabel getLabelMaxWidth getLabelStyleBearing getLabelStyleGraphic getLabelStyleHaloBlur getLabelStyleHaloColor getLabelStyleHaloWidth getLabelStyleTextColor getLabelStyleTextOpacity getLabelStyleTextSize getLabelType getLabelZoomFrom getLabelZoomTo getModel2DBearing getModel2DHeightMeters getModel2DModel getModel2DWidthMeters getModel2DZoomFrom getModel2DZoomTo getModel3DModel getModel3DRotationX getModel3DRotationY getModel3DRotationZ getModel3DScale getModel3DZoomFrom getModel3DZoomTo getPolygonFillColor getPolygonFillOpacity getPolygonLightnessFactor getPolygonStrokeColor getPolygonStrokeOpacity getPolygonStrokeWidth getPolygonZoomFrom getPolygonZoomTo getWallColor getWallHeight getWallLightnessFactor getWallZoomFrom getWallZoomTo getZoomFrom getZoomTo isBadgeVisible isExtrusionVisible isIconVisible isLabelVisible isModel2DVisible isModel3DVisible isPolygonVisible isVisible isWallVisible reset setBadgeFillColor setBadgePosition setBadgeRadius setBadgeScale setBadgeStrokeColor setBadgeStrokeWidth setBadgeVisible setBadgeZoomFrom setBadgeZoomTo setExtrusionColor setExtrusionHeight setExtrusionLightnessFactor setExtrusionVisible setExtrusionZoomFrom setExtrusionZoomTo setIcon setIconPlacement setIconScale setIconSize setIconVisible setLabel setLabelMaxWidth setLabelStyleBearing setLabelStyleGraphic setLabelStyleHaloBlur setLabelStyleHaloColor setLabelStyleHaloWidth setLabelStyleTextColor setLabelStyleTextOpacity setLabelStyleTextSize setLabelType setLabelVisible setLabelZoomFrom setLabelZoomTo setModel2DBearing setModel2DHeightMeters setModel2DModel setModel2DVisible setModel2DWidthMeters setModel2DZoomFrom setModel2DZoomTo setModel3DModel setModel3DRotationX setModel3DRotationY setModel3DRotationZ setModel3DScale setModel3DVisible setModel3DZoomFrom setModel3DZoomTo setPolygonFillColor setPolygonFillOpacity setPolygonLightnessFactor setPolygonStrokeColor setPolygonStrokeOpacity setPolygonStrokeWidth setPolygonVisible setPolygonZoomFrom setPolygonZoomTo setVisible setWallColor setWallHeight setWallLightnessFactor setWallVisible setWallZoomFrom setWallZoomTo setZoomFrom setZoomTo create

Constructors

  • Private

    Creates an instance of MPDisplayRule.

    Parameters

    • id: string

    Returns MPDisplayRule

Properties

id: string

Methods

  • Get the badge's fill color.

    Returns Promise<string>

    Promise

  • Get the badge's position.

    Returns Promise<MPBadgePosition>

    Promise

  • Get the badge's radius.

    Returns Promise<number>

    Promise

  • Get the badge's scale.

    Returns Promise<number>

    Promise

  • Get the badge's stroke color.

    Returns Promise<string>

    Promise

  • Get the badge's stroke width.

    Returns Promise<number>

    Promise

  • Get the badge's Zoom From value.

    Returns Promise<number>

    Promise

  • Get the badge's Zoom To value.

    Returns Promise<number>

    Promise

  • Get the extrusion's color value.

    Returns Promise<string>

    Async

  • Get the extrusion's height value.

    Returns Promise<number>

    Async

  • Get the extrusion's lightness factor.

    Returns Promise<number>

    Promise

  • Get the extrusion's zoom from value.

    Returns Promise<number>

    Async

  • Get the extrusion's zoom to value.

    Returns Promise<number>

    Async

  • Get the icon's anchor value.

    Returns Promise<MPIconPlacement>

    Promise

  • Get the scale value of the icon.

    Returns Promise<number>

    Promise

  • Get the icon's size.

    Returns Promise<MPIconSize>

    Async

  • Get the icon's URL.

    Returns Promise<string>

    Async

  • Get the label string.

    Returns Promise<string>

    Async

  • Get the label's max width value.

    Returns Promise<number>

    Async

  • Get the label's bearing

    Returns Promise<number>

    Promise

  • Get the label's Graphic style

    Returns Promise<MPLabelGraphic>

    Promise

  • Get the label's halo blur

    Returns Promise<number>

    Promise

  • Get the label's halo color

    Returns Promise<string>

    Promise

  • Get the label's halo width

    Returns Promise<number>

    Promise

  • Get the label's text color

    Returns Promise<string>

    Promise

  • Get the label's text opacity

    Returns Promise<number>

    Promise

  • Get the label's text size.

    Returns Promise<number>

    Promise

  • Get the type of the label.

    Returns Promise<MPLabelType>

    Promise

  • Get the label's zoom from value.

    Returns Promise<number>

    Async

  • Get the label's zoom to value.

    Returns Promise<number>

    Async

  • Get the 2D model's bearing value.

    Returns Promise<number>

    Async

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

    Returns Promise<number>

    Async

  • Get the 2D model's URL.

    Returns Promise<string>

    Async

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

    Returns Promise<number>

    Async

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

    Returns Promise<number>

    Async

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

    Returns Promise<number>

    Async

  • Get the 3D model's URL.

    Returns Promise<string>

    Promise

  • Get the 3D model's rotation X.

    Returns Promise<number>

    Promise

  • Get the 3D model's rotation Y.

    Returns Promise<number>

    Promise

  • Get the 3D model's rotation Z.

    Returns Promise<number>

    Promise

  • Get the 3D model's scale.

    Returns Promise<number>

    Promise

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

    Returns Promise<number>

    Promise

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

    Returns Promise<number>

    Promise

  • Get the polygon's fill color value.

    Returns Promise<string>

    Async

  • Get the polygon's fill opacity value.

    Returns Promise<number>

    Async

  • Get the polygon's lightness factor.

    Returns Promise<number>

    Promise

  • Get the polygon's stroke color value.

    Returns Promise<string>

    Async

  • Get the polygon's stroke opacity value.

    Returns Promise<number>

    Async

  • Get the polygon's stroke width value.

    Returns Promise<number>

    Async

  • Get the plygon's zoom from value.

    Returns Promise<number>

    Async

  • Get the polygon's zoom to value.

    Returns Promise<number>

    Async

  • Get the wall's color value.

    Returns Promise<string>

    Async

  • Get the wall's height value.

    Returns Promise<number>

    Async

  • Get the wall's lightness factor.

    Returns Promise<number>

    Promise

  • Get the wall's zoom from value.

    Returns Promise<number>

    Async

  • Get the wall's zoom to value.

    Returns Promise<number>

    Async

  • Get the general zoom from value.

    Returns Promise<number>

    Async

  • Get the general zoom to value.

    Returns Promise<number>

    Async

  • Get the badge's visibility.

    Returns Promise<boolean>

    Promise

  • Get the extrusion's visibility value.

    Returns Promise<boolean>

    Async

  • Get the icon's visibility value.

    Returns Promise<boolean>

    Async

  • Get the label's visibility value.

    Returns Promise<boolean>

    Async

  • Get the 2D model's visibility value.

    Returns Promise<boolean>

    Async

  • Get the 3D model's visibility.

    Returns Promise<boolean>

    Promise

  • Get the polygon's visibility value.

    Returns Promise<boolean>

    Async

  • Get the general visibility value.

    Returns Promise<boolean>

    Async

  • Get the wall's visibility value.

    Returns Promise<boolean>

    Async

  • Resets the display rule to its default state.

    Returns Promise<void>

    Async

  • Set the badge's fill color.

    Parameters

    • fillColor: string

    Returns Promise<void>

    Promise

  • Set the badge's position.

    Parameters

    Returns Promise<void>

    Promise

  • Set the badge's radius.

    Parameters

    • radius: number

    Returns Promise<void>

    Promise

  • Set the badge's scale.

    Parameters

    • badgeScale: number

    Returns Promise<void>

    Promise

  • Set the badge's stroke color.

    Parameters

    • strokeColor: string

    Returns Promise<void>

    Promise

  • Set the badge's stroke width.

    Parameters

    • strokeWidth: number

    Returns Promise<void>

    Promise

  • Set the badge's visibility.

    Parameters

    • visible: boolean

    Returns Promise<void>

    Promise

  • Set the badge's Zoom From value.

    Parameters

    • zoomFrom: number

    Returns Promise<void>

    Promise

  • Set the badge's Zoom To value.

    Parameters

    • zoomTo: number

    Returns Promise<void>

    Promise

  • Set the extrusion's color value.

    Parameters

    • extrusionColor: string

    Returns Promise<void>

    Async

  • Set the extrusion's height value.

    Parameters

    • extrusionHeight: number

    Returns Promise<void>

    Async

  • Set the extrusion's lightness factor.

    Parameters

    • lightnessFactor: number

    Returns Promise<void>

    Promise

  • Set the extrusion's visibility value.

    Parameters

    • extrusionVisible: boolean

    Returns Promise<void>

    Async

  • Set the extrusion's zoom from value.

    Parameters

    • extrusionZoomFrom: number

    Returns Promise<void>

    Async

  • Get the extrusion's zoom to value.

    Parameters

    • extrusionZoomTo: number

    Returns Promise<void>

    Async

  • Set the icon's URL.

    Parameters

    • iconUrl: string

    Returns Promise<void>

    Async

  • Set the icon's anchor value.

    Parameters

    Returns Promise<void>

    Promise

  • Set the scale value of the icon.

    Parameters

    • iconScale: number

    Returns Promise<void>

    Promise

  • Set the icon's size.

    Parameters

    Returns Promise<void>

    Async

  • Set the icon's visibility value.

    Parameters

    • iconVisible: boolean

    Returns Promise<void>

    Async

  • Set the label string.

    Parameters

    • label: string

    Returns Promise<void>

    Async

  • Set the label's max width value.

    Parameters

    • labelMaxWidth: number

    Returns Promise<void>

    Async

  • Set the label's bearing

    Parameters

    • bearing: number

    Returns Promise<void>

    Promise

  • Set the label's Graphic style

    Parameters

    Returns Promise<void>

    Promise

  • Set the label's halo blur

    Parameters

    • haloBlur: number

    Returns Promise<void>

    Promise

  • Set the label's halo color

    Parameters

    • color: string

    Returns Promise<void>

    Promise

  • Set the label's halo width

    Parameters

    • haloWidth: number

    Returns Promise<void>

    Promise

  • Set the label's text color

    Parameters

    • textColor: String

    Returns Promise<void>

    Promise

  • Set the label's text opacity

    Parameters

    • textOpacity: number

    Returns Promise<void>

    Promise

  • Set the label's text size.

    Parameters

    • textSize: number

    Returns Promise<void>

    Promise

  • Set the type of the label.

    Parameters

    Returns Promise<void>

    Promise

  • Set the label's visibility value.

    Parameters

    • labelVisible: boolean

    Returns Promise<void>

    Async

  • Set the label's zoom from value.

    Parameters

    • zoomFrom: number

    Returns Promise<void>

    Async

  • Set the label's zoom to value.

    Parameters

    • zoomTo: number

    Returns Promise<void>

    Async

  • Get the 2D model's bearing value.

    Parameters

    • bearing: number

    Returns Promise<void>

    Async

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

    Parameters

    • height: number

    Returns Promise<void>

    Async

  • Set the 2D model's URL.

    Parameters

    • url: string

    Returns Promise<void>

    Async

  • Set the 2D model's visibility value.

    Parameters

    • model2DVisible: boolean

    Returns Promise<void>

    Async

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

    Parameters

    • width: number

    Returns Promise<void>

    Async

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

    Parameters

    • zoomFrom: number

    Returns Promise<void>

    Async

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

    Parameters

    • zoomTo: number

    Returns Promise<void>

    Async

  • Set the 3D model's URL.

    Parameters

    • url: string

      string

    Returns Promise<void>

    Promise

  • Set the 3D model's rotation X.

    Parameters

    • rotationX: number

      number

    Returns Promise<void>

    Promise

  • Set the 3D model's rotation Y.

    Parameters

    • rotationY: number

      number

    Returns Promise<void>

    Promise

  • Set the 3D model's rotation Z.

    Parameters

    • rotationZ: number

      number

    Returns Promise<void>

    Promise

  • Set the 3D model's scale.

    Parameters

    • scale: number

      number

    Returns Promise<void>

    Promise

  • Set the 3D model's visibility.

    Parameters

    • visible: boolean

      boolean

    Returns Promise<void>

    Promise

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

    Parameters

    • zoomFrom: number

      number

    Returns Promise<void>

    Promise

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

    Parameters

    • zoomTo: number

      number

    Returns Promise<void>

    Promise

  • Set the polygon's fill color value.

    Parameters

    • fillColor: string

    Returns Promise<void>

    Async

  • Set the polygon's fill opacity value.

    Parameters

    • fillOpacity: number

    Returns Promise<void>

    Async

  • Set the polygon's lightness factor.

    Parameters

    • lightnessFactor: number

    Returns Promise<void>

    Promise

  • Set the polygon's stroke color value.

    Parameters

    • strokeColor: string

    Returns Promise<void>

    Async

  • Set the polygon's stroke opacity value.

    Parameters

    • strokeOpacity: number

    Returns Promise<void>

    Async

  • Set the polygon's stroke width value.

    Parameters

    • strokeWidth: number

    Returns Promise<void>

    Async

  • Set the polygon's visibility value.

    Parameters

    • polygonVisible: boolean

    Returns Promise<void>

    Async

  • Get the plygon's zoom from value.

    Parameters

    • polygonZoomFrom: number

    Returns Promise<void>

    Async

  • Set the polygon's zoom to value.

    Parameters

    • polygonZoomTo: number

    Returns Promise<void>

    Async

  • Set the general visibility value.

    Parameters

    • visible: boolean

    Returns Promise<void>

    Async

  • Set the wall's color value.

    Parameters

    • wallColor: string

    Returns Promise<void>

    Async

  • Set the wall's height value.

    Parameters

    • wallHeight: number

    Returns Promise<void>

    Async

  • Set the wall's lightness factor.

    Parameters

    • lightnessFactor: number

    Returns Promise<void>

    Promise

  • Set the wall's visibility value.

    Parameters

    • wallVisible: boolean

    Returns Promise<void>

    Async

  • Set the wall's zoom from value.

    Parameters

    • wallZoomFrom: number

    Returns Promise<void>

    Async

  • Set the wall's zoom to value.

    Parameters

    • wallZoomTo: number

    Returns Promise<void>

    Async

  • Set the general zoom from value.

    Parameters

    • zoomFrom: number

    Returns Promise<void>

    Async

  • Set the general zoom to value.

    Parameters

    • zoomTo: number

    Returns Promise<void>

    Async

  • 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

Generated using TypeDoc