Options
All
  • Public
  • Public/Protected
  • All
Menu

Masks everything outside of a certain area of interest (AOI).

Hierarchy

  • AreaOfInterestMask

Index

Constructors

constructor

Properties

app

boundaryColor

boundaryColor: Color

The color of the AOI outline.

boundaryStyle

boundaryStyle: any

The style of the AOI otuline.

boundaryWidth

boundaryWidth: number

The thickness of the AOI otuline.

fillColor

fillColor: any

The color of the mask.

layerId

layerId: string

The layer id to use for map graphics.

matchMapBackground

matchMapBackground: boolean

Whether to set the map background color to be the same as the fill color. This can be be useful because the mask may not reach all the way to the outer edges of the map. Setting this to true will ensure full coverage.

Methods

configure

  • Configures this AreaOfInterestMask to match the properties specified in the config. Any properties that are null or undefined will retain their existing values.

    Parameters

    Returns void

disable

  • disable(): void
  • Disables the mask. If show() is called while disabled, it will not actually be shown.

    Returns void

enable

  • enable(): void
  • Enables the mask. If it was not enabled while show() was called, this method will actually show the mask.

    Returns void

hide

  • hide(): void
  • Eliminates the mask.

    Returns void

show

  • show(areaOfInterest: Polygon): void
  • Shows the mask. Will not be shown if the mask is disabled.

    Parameters

    • areaOfInterest: Polygon

      The area of interest to to be visible. Everything outside of this will be hidden.

    Returns void