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

Export

Constructors

  • Private

    Creates an instance of MPDisplayRule.

    Parameters

    • id: string

    Returns MPDisplayRule

Properties

id: string

Methods

  • Get the extrusion's color value.

    Returns Promise<string>

    Async

  • Get the extrusion's height value.

    Returns Promise<number>

    Async

  • 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 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 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 polygon's fill color value.

    Returns Promise<string>

    Async

  • Get the polygon's fill opacity value.

    Returns Promise<number>

    Async

  • 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 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 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 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 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 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 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 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 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 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 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