Class PixiLayer<T>`Abstract`

Type Parameters

T

Hierarchy

Layer<T>
- PixiLayer
  - GeomodelLayerV2
  - SchematicLayer

Constructors

constructor

new PixiLayer<T>(ctx: PixiRenderApplication | Application<HTMLCanvasElement>, id?: string, options?: LayerOptions<T>): PixiLayer<T>
Type Parameters
- T
Parameters
- ctx: PixiRenderApplication | Application<HTMLCanvasElement>
- Optional id: string
- Optional options: LayerOptions<T>
Returns PixiLayer<T>
Overrides Layer.constructor
- Defined in layers/base/PixiLayer.ts:71

Properties

`Protected` _options

_options: LayerOptions<T>

`Private` container

container: Container<DisplayObject>

`Private` ctx

ctx: PixiRenderApplication

`Private` pixiViewContainer

pixiViewContainer: HTMLElement

Accessors

data

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

element

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

id

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

interactive

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

isLoading

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

isVisible

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

opacity

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

options

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

order

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

referenceSystem

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

Methods

addChild

addChild(child: DisplayObject): void
Parameters
- child: DisplayObject
Returns void
- Defined in layers/base/PixiLayer.ts:84

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
Inherited from Layer.clearData
- Defined in layers/base/Layer.ts:151

clearLayer

clearLayer(): void
Returns void
- Defined in layers/base/PixiLayer.ts:88

getData

getData(): T
Returns T
Inherited from Layer.getData
- 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[]
Inherited from Layer.getInternalLayerIds
- Defined in layers/base/Layer.ts:214

onInteractivityChanged

onInteractivityChanged(_interactive: boolean): void
Parameters
- _interactive: boolean
Returns void
Overrides Layer.onInteractivityChanged
- Defined in layers/base/PixiLayer.ts:181

onMount

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

onOpacityChanged

onOpacityChanged(_opacity: number): void
Parameters
- _opacity: number
Returns void
Overrides Layer.onOpacityChanged
- Defined in layers/base/PixiLayer.ts:169

onOrderChanged

onOrderChanged(_order: number): void
Parameters
- _order: number
Returns void
Overrides Layer.onOrderChanged
- Defined in layers/base/PixiLayer.ts:175

onRescale

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

onResize

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

onUnmount

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

onUpdate

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

optionsRescale

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

render

render(): void
Returns void
- Defined in layers/base/PixiLayer.ts:80

renderType

renderType(): RENDERER_TYPE
Returns RENDERER_TYPE
- Defined in layers/base/PixiLayer.ts:187

`Protected` setContainerPosition

setContainerPosition(x?: number, y?: number): void
Parameters
- Optional x: number
- Optional y: number
Returns void
- Defined in layers/base/PixiLayer.ts:137

`Protected` setContainerScale

setContainerScale(x?: number, y?: number): void
Parameters
- Optional x: number
- Optional y: number
Returns void
- Defined in layers/base/PixiLayer.ts:141

setData

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

setVisibility

setVisibility(visible: boolean, layerId?: string): void
Parameters
- visible: boolean
- Optional layerId: string
Returns void
Overrides Layer.setVisibility
- Defined in layers/base/PixiLayer.ts:162

updateStyle

updateStyle(visible?: boolean): void
Parameters
- Optional visible: boolean
Returns void
- Defined in layers/base/PixiLayer.ts:145

Generated using TypeDoc