Class Layer<T>`Abstract`

Type Parameters

T

Hierarchy

Layer

Index

Constructors

constructor

new Layer<T>(id?: string, options?: LayerOptions<T>): Layer<T>
Type Parameters
- T
Parameters
- Optional id: string
- Optional options: LayerOptions<T>
Returns Layer<T>
- Defined in layers/base/Layer.ts:36

Properties

`Private` `Optional` _data

_data?: T

`Private` `Optional` _element

_element?: HTMLElement

`Private` _id

_id: string

`Private` _interactive

_interactive: boolean = false

`Private` _opacity

_opacity: number

`Protected` _options

_options: LayerOptions<T>

`Private` _order

_order: number

`Private` `Optional` _referenceSystem

_referenceSystem?: IntersectionReferenceSystem = null

`Private` _visible

_visible: boolean

`Private` loading

loading: boolean

Accessors

data

get data(): T
Returns T
- Defined in layers/base/Layer.ts:123
set data(data: T): void
Parameters
- data: T
Returns void
- Defined in layers/base/Layer.ts:127

element

get element(): HTMLElement
Returns HTMLElement
- Defined in layers/base/Layer.ts:68

id

get id(): string
Returns string
- Defined in layers/base/Layer.ts:64

interactive

get interactive(): boolean
Returns boolean
- Defined in layers/base/Layer.ts:111
set interactive(shouldBeInteractive: boolean): void
Parameters
- shouldBeInteractive: boolean
Returns void
- Defined in layers/base/Layer.ts:106

isLoading

get isLoading(): boolean
Returns boolean
- Defined in layers/base/Layer.ts:84
set isLoading(loading: boolean): void
Parameters
- loading: boolean
Returns void
- Defined in layers/base/Layer.ts:80

isVisible

get isVisible(): boolean
Returns boolean
- Defined in layers/base/Layer.ts:131

opacity

get opacity(): number
Returns number
- Defined in layers/base/Layer.ts:93
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in layers/base/Layer.ts:88

options

get options(): LayerOptions<T>
Returns LayerOptions<T>
- Defined in layers/base/Layer.ts:72
set options(options: LayerOptions<T>): void
Parameters
- options: LayerOptions<T>
Returns void
- Defined in layers/base/Layer.ts:76

order

get order(): number
Returns number
- Defined in layers/base/Layer.ts:102
set order(order: number): void
Parameters
- order: number
Returns void
- Defined in layers/base/Layer.ts:97

referenceSystem

get referenceSystem(): IntersectionReferenceSystem
Returns IntersectionReferenceSystem
- Defined in layers/base/Layer.ts:115
set referenceSystem(referenceSystem: IntersectionReferenceSystem): void
Parameters
- referenceSystem: IntersectionReferenceSystem
Returns void
- Defined in layers/base/Layer.ts:119

Methods

clearData

clearData(includeReferenceSystem?: boolean): void
Clears data and (optionally) the reference system
Parameters
- includeReferenceSystem: boolean = true
  
  (optional) if true also removes reference system, default is true
Returns void
- Defined in layers/base/Layer.ts:151

getData

getData(): T
Returns T
- Defined in layers/base/Layer.ts:135

getInternalLayerIds

getInternalLayerIds(): string[]
Some layers might be built up of several internal layers that should individually be visibility-togglable. Reasons for having multiple internal layers might be tightly related data between layers or need for sharing render context

Returns
list of internal layer ids

Returns string[]
- Defined in layers/base/Layer.ts:214

`Abstract` onInteractivityChanged

onInteractivityChanged(interactive: boolean): void
Parameters
- interactive: boolean
Returns void
- Defined in layers/base/Layer.ts:205

onMount

onMount(event: OnMountEvent): void
Parameters
- event: OnMountEvent
Returns void
- Defined in layers/base/Layer.ts:163

`Abstract` onOpacityChanged

onOpacityChanged(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in layers/base/Layer.ts:201

`Abstract` onOrderChanged

onOrderChanged(order: number): void
Parameters
- order: number
Returns void
- Defined in layers/base/Layer.ts:203

onRescale

onRescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
- Defined in layers/base/Layer.ts:191

onResize

onResize(event: OnResizeEvent): void
Parameters
- event: OnResizeEvent
Returns void
- Defined in layers/base/Layer.ts:176

onUnmount

onUnmount(event?: OnUnmountEvent): void
Parameters
- Optional event: OnUnmountEvent
Returns void
- Defined in layers/base/Layer.ts:170

onUpdate

onUpdate(event: OnUpdateEvent<T>): void
Parameters
- event: OnUpdateEvent<T>
Returns void
- Defined in layers/base/Layer.ts:182

optionsRescale

optionsRescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
- Defined in layers/base/Layer.ts:195

setData

setData(data: T): void
Parameters
- data: T
Returns void
- Defined in layers/base/Layer.ts:139

setVisibility

setVisibility(visible: boolean, _layerId?: string): void
Parameters
- visible: boolean
- Optional _layerId: string
Returns void
- Defined in layers/base/Layer.ts:159

Generated using TypeDoc