Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AreaOfInterestMaskConfig

Configuration properties for the AreaOfInterestMask.

Hierarchy

  • AreaOfInterestMaskConfig

Index

Properties

Properties

Optional boundaryColor

boundaryColor: string | number[]

The color of the AOI outline.

Optional boundaryStyle

boundaryStyle: string

The style of the AOI outline ("null", "solid", "dash", "dot").

Optional boundaryWidth

boundaryWidth: number

The thickness of the AOI otuline.

Optional enabled

enabled: boolean

Whether the mask should be actually shown or not when the show() method is called. If disabled, it will not be shown, even if show() is called.

Optional fillColor

fillColor: string | number[]

The color of the mask.

Optional layerId

layerId: string

The layer id to use for map graphics.

Optional 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.