Class LayerSwitcher

Methods for interacting with LayerSwitcher.

Index

Methods

addLayerCheckbox getWMELayerVisibility isLayerCheckboxChecked removeLayerCheckbox setClosuresLayerCheckboxChecked setHazardsLayerCheckboxChecked setJunctionBoxesLayerCheckboxChecked setLayerCheckboxChecked setPathsLayerCheckboxChecked setPlacesLayerCheckboxChecked setRoadsLayerCheckboxChecked setWMELayerVisibility

Methods

addLayerCheckbox

addLayerCheckbox(__namedParameters: { isChecked?: boolean; name: string }): void
Add a new checkbox to the SDK Layer checkboxes list
Parameters
- __namedParameters: { isChecked?: boolean; name: string }
  - OptionalisChecked?: boolean
    Optional. Initial checked state of the checkbox. Defaults to false.
  - name: string
    The name of the checkbox to add.
Returns void
Throws
InvalidStateError if the checkbox with the specified name already exists for this script

getWMELayerVisibility

getWMELayerVisibility(args: { layerName: WmeLayerName }): boolean
Get visibility state of a default WME layer.
Parameters
- args: { layerName: WmeLayerName }
  - layerName: WmeLayerName
    The name of the WME layer.
Returns boolean
true if the layer is visible, or false otherwise.

isLayerCheckboxChecked

isLayerCheckboxChecked(args: { name: string }): boolean
Get checked state of the SDK Layers checkbox
Parameters
- args: { name: string }
  - name: string
    The name of the checkbox to get checked state.
Returns boolean
value of the checkbox

Throws
InvalidStateError if a checkbox with the specified name does not exist for this script

removeLayerCheckbox

removeLayerCheckbox(args: { name: string }): void
Remove the checkbox from the SDK Layers checkboxes
Parameters
- args: { name: string }
  - name: string
    The name of the checkbox to remove.
Returns void
Throws
InvalidStateError if a checkbox with the specified name does not exist for this script

setClosuresLayerCheckboxChecked

setClosuresLayerCheckboxChecked(args: { isChecked: boolean }): void
Set checked state for the default WME Closures layer checkbox
Parameters
- args: { isChecked: boolean }
  - isChecked: boolean
    The checked state to set to checkbox.
Returns void

setHazardsLayerCheckboxChecked

setHazardsLayerCheckboxChecked(args: { isChecked: boolean }): void
Set checked state for the default WME Hazards layer checkbox
Parameters
- args: { isChecked: boolean }
  - isChecked: boolean
    The checked state to set to checkbox.
Returns void

setJunctionBoxesLayerCheckboxChecked

setJunctionBoxesLayerCheckboxChecked(args: { isChecked: boolean }): void
Set checked state for the default WME Junction Boxes layer checkbox
Parameters
- args: { isChecked: boolean }
  - isChecked: boolean
    The checked state to set to checkbox.
Returns void

setLayerCheckboxChecked

setLayerCheckboxChecked(args: { isChecked: boolean; name: string }): void
Set checked state for the SDK Layers checkbox
Parameters
- args: { isChecked: boolean; name: string }
  - isChecked: boolean
    The checked state to set to checkbox.
  - name: string
    The name of the checkbox to set checked state.
Returns void
Throws
InvalidStateError if a checkbox with the specified name does not exist for this script

setPathsLayerCheckboxChecked

setPathsLayerCheckboxChecked(args: { isChecked: boolean }): void
Set checked state for the default WME Paths layer checkbox
Parameters
- args: { isChecked: boolean }
  - isChecked: boolean
    The checked state to set to checkbox.
Returns void

setPlacesLayerCheckboxChecked

setPlacesLayerCheckboxChecked(args: { isChecked: boolean }): void
Set checked state for the default WME Venues layer checkbox
Parameters
- args: { isChecked: boolean }
  - isChecked: boolean
    The checked state to set to checkbox.
Returns void

setRoadsLayerCheckboxChecked

setRoadsLayerCheckboxChecked(args: { isChecked: boolean }): void
Set checked state for the default WME Roads layer checkbox
Parameters
- args: { isChecked: boolean }
  - isChecked: boolean
    The checked state to set to checkbox.
Returns void

setWMELayerVisibility

setWMELayerVisibility(
args: { isVisible: boolean; layerName: WmeLayerName },
): void
Set visibility for a default WME layer. This updates both the map display and the Layer Switcher sidebar checkbox.
Parameters
- args: { isVisible: boolean; layerName: WmeLayerName }
  - isVisible: boolean
    Set to true to show the layer, or false to hide it.
  - layerName: WmeLayerName
    The name of the WME layer.
Returns void

Class LayerSwitcher

Index

Methods

Methods

addLayerCheckbox

Parameters

OptionalisChecked?: boolean

name: string

Returns void

Throws

getWMELayerVisibility

Parameters

layerName: WmeLayerName

Returns boolean

isLayerCheckboxChecked

Parameters

name: string

Returns boolean

Throws

removeLayerCheckbox

Parameters

name: string

Returns void

Throws

setClosuresLayerCheckboxChecked

Parameters

isChecked: boolean

Returns void

setHazardsLayerCheckboxChecked

Parameters

isChecked: boolean

Returns void

setJunctionBoxesLayerCheckboxChecked

Parameters

isChecked: boolean

Returns void

setLayerCheckboxChecked

Parameters

isChecked: boolean

name: string

Returns void

Throws

setPathsLayerCheckboxChecked

Parameters

isChecked: boolean

Returns void

setPlacesLayerCheckboxChecked

Parameters

isChecked: boolean

Returns void

setRoadsLayerCheckboxChecked

Parameters

isChecked: boolean

Returns void

setWMELayerVisibility

Parameters

isVisible: boolean

layerName: WmeLayerName

Returns void

Settings

On This Page

`Optional`isChecked?: boolean