Class ModuleInterface`Abstract`

Class with common functions shared by all layers.

Hierarchy (View Summary)

ModuleInterface

Index

Constructors

Properties

pixiOverlay root visibility

Methods

destroy onAdd onRemove resize setVisibility toggle

Constructors

constructor

new ModuleInterface(): ModuleInterface
Common constructor for all map layers.

Returns ModuleInterface
- Defined in ModuleInterface.ts:20

Properties

pixiOverlay

pixiOverlay: pixiOverlayBase

Function for pixi overlay.

root

root: Container

Root container for layer.

visibility

visibility: boolean = true

True if layer is currently visible.

Methods

destroy

destroy(): void
Returns void
- Defined in ModuleInterface.ts:25

onAdd

onAdd(_map: Map): void
Parameters
- _map: Map
Returns void
- Defined in ModuleInterface.ts:50

onRemove

onRemove(_map: Map): void
Parameters
- _map: Map
Returns void
- Defined in ModuleInterface.ts:52

resize

resize(_zoom: number): void
Parameters
- _zoom: number
Returns void
- Defined in ModuleInterface.ts:54

setVisibility

setVisibility(visible: boolean): boolean
Set visibility of the root PIXI container to a given value.
Parameters
- visible: boolean
  Should layer be visible?
Returns boolean
True if new visibility was set
- Defined in ModuleInterface.ts:41

toggle

toggle(): void
Toggle the visibility of the root PIXI container.

Returns void
- Defined in ModuleInterface.ts:31