Class MPDisplayRule

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

Export

Constructors

constructor

Properties

id

Methods

getExtrusionColor getExtrusionHeight getExtrusionZoomFrom getExtrusionZoomTo getIconSize getIconUrl getLabel getLabelMaxWidth getLabelZoomFrom getLabelZoomTo getModel2DBearing getModel2DHeightMeters getModel2DModel getModel2DWidthMeters getModel2DZoomFrom getModel2DZoomTo getPolygonFillColor getPolygonFillOpacity getPolygonStrokeColor getPolygonStrokeOpacity getPolygonStrokeWidth getPolygonZoomFrom getPolygonZoomTo getWallColor getWallHeight getWallZoomFrom getWallZoomTo getZoomFrom getZoomTo isExtrusionVisible isIconVisible isLabelVisible isModel2DVisible isPolygonVisible isVisible isWallVisible reset setExtrusionColor setExtrusionHeight setExtrusionVisible setExtrusionZoomFrom setExtrusionZoomTo setIcon setIconSize setIconVisible setLabel setLabelMaxWidth setLabelVisible setLabelZoomFrom setLabelZoomTo setModel2DBearing setModel2DHeightMeters setModel2DModel setModel2DVisible setModel2DWidthMeters setModel2DZoomFrom setModel2DZoomTo setPolygonFillColor setPolygonFillOpacity setPolygonStrokeColor setPolygonStrokeOpacity setPolygonStrokeWidth setPolygonVisible setPolygonZoomFrom setPolygonZoomTo setVisible setWallColor setWallHeight setWallVisible setWallZoomFrom setWallZoomTo setZoomFrom setZoomTo create

Constructors

Private constructor

  • new MPDisplayRule(id): MPDisplayRule
  • Private

    Creates an instance of MPDisplayRule.

    Parameters

    • id: string

    Returns MPDisplayRule

Properties

Readonly id

id: string

Methods

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

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

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

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

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

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

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

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

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

setIconSize

  • setIconSize(iconSize): Promise<void>

  • Set the icon's size.

    Parameters

    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

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

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

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc