Class GeomodelCanvasLayer<T>

Type Parameters

T extends SurfaceData

Hierarchy

CanvasLayer<T>
- GeomodelCanvasLayer

Constructors

constructor

new GeomodelCanvasLayer<T>(id?: string, options?: LayerOptions<T>): GeomodelCanvasLayer<T>
Type Parameters
- T extends SurfaceData
Parameters
- Optional id: string
- Optional options: LayerOptions<T>
Returns GeomodelCanvasLayer<T>
Overrides CanvasLayer.constructor
- Defined in layers/GeomodelCanvasLayer.ts:23

Properties

`Protected` _options

_options: LayerOptions<T>

canvas

canvas: HTMLCanvasElement

ctx

ctx: CanvasRenderingContext2D

elm

elm: HTMLElement

maxDepth

maxDepth: number = DEFAULT_MAX_DEPTH

rescaleEvent

rescaleEvent: OnRescaleEvent

surfaceAreasPaths

surfaceAreasPaths: SurfacePaths[] = []

surfaceLinesPaths

surfaceLinesPaths: SurfacePaths[] = []

Accessors

data

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

element

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

id

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

interactive

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

isLoading

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

isVisible

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

opacity

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

options

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

order

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

referenceSystem

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

Methods

clearCanvas

clearCanvas(): void
Returns void
Inherited from CanvasLayer.clearCanvas
- Defined in layers/base/CanvasLayer.ts:95

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

colorToCSSColor

colorToCSSColor(color: string | number): string
Parameters
- color: string | number
Returns string
- Defined in layers/GeomodelCanvasLayer.ts:67

createPolygons

createPolygons(data: number[][]): number[][]
Parameters
- data: number[][]
Returns number[][]
- Defined in layers/GeomodelCanvasLayer.ts:104

drawLinePath

drawLinePath(color: string, path: Path2D): void
Parameters
- color: string
- path: Path2D
Returns void
- Defined in layers/GeomodelCanvasLayer.ts:98

drawPolygonPath

drawPolygonPath(color: string, path: Path2D): void
Parameters
- color: string
- path: Path2D
Returns void
- Defined in layers/GeomodelCanvasLayer.ts:92

generateLinePaths

generateLinePaths(s: SurfaceLine): Path2D[]
Parameters
- s: SurfaceLine
Returns Path2D[]
- Defined in layers/GeomodelCanvasLayer.ts:150

generatePolygonPath

generatePolygonPath(polygon: number[]): Path2D
Parameters
- polygon: number[]
Returns Path2D
- Defined in layers/GeomodelCanvasLayer.ts:138

generateSurfaceAreasPaths

generateSurfaceAreasPaths(): void
Returns void
- Defined in layers/GeomodelCanvasLayer.ts:71

generateSurfaceLinesPaths

generateSurfaceLinesPaths(): void
Returns void
- Defined in layers/GeomodelCanvasLayer.ts:83

getData

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

onInteractivityChanged

onInteractivityChanged(_interactive: boolean): void
Parameters
- _interactive: boolean
Returns void
Inherited from CanvasLayer.onInteractivityChanged
- Defined in layers/base/CanvasLayer.ts:22

onMount

onMount(event: OnMountEvent): void
Parameters
- event: OnMountEvent
Returns void
Inherited from CanvasLayer.onMount
- Defined in layers/base/CanvasLayer.ts:45

onOpacityChanged

onOpacityChanged(_opacity: number): void
Parameters
- _opacity: number
Returns void
Inherited from CanvasLayer.onOpacityChanged
- Defined in layers/base/CanvasLayer.ts:10

onOrderChanged

onOrderChanged(_order: number): void
Parameters
- _order: number
Returns void
Inherited from CanvasLayer.onOrderChanged
- Defined in layers/base/CanvasLayer.ts:16

onRescale

onRescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
Overrides CanvasLayer.onRescale
- Defined in layers/GeomodelCanvasLayer.ts:39

onResize

onResize(event: OnResizeEvent): void
Parameters
- event: OnResizeEvent
Returns void
Inherited from CanvasLayer.onResize
- Defined in layers/base/CanvasLayer.ts:71

onUnmount

onUnmount(): void
Returns void
Inherited from CanvasLayer.onUnmount
- Defined in layers/base/CanvasLayer.ts:65

onUpdate

onUpdate(event: OnUpdateEvent<T>): void
Parameters
- event: OnUpdateEvent<T>
Returns void
Overrides CanvasLayer.onUpdate
- Defined in layers/GeomodelCanvasLayer.ts:33

optionsRescale

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

render

render(): void
Returns void
- Defined in layers/GeomodelCanvasLayer.ts:55

resetTransform

resetTransform(): void
Returns void
Inherited from CanvasLayer.resetTransform
- Defined in layers/base/CanvasLayer.ts:83

setData

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

setTransform

setTransform(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
Inherited from CanvasLayer.setTransform
- Defined in layers/base/CanvasLayer.ts:87

setVisibility

setVisibility(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from CanvasLayer.setVisibility
- Defined in layers/base/CanvasLayer.ts:28

updatePaths

updatePaths(): void
Returns void
- Defined in layers/GeomodelCanvasLayer.ts:45

updateStyle

updateStyle(visible?: boolean): void
Parameters
- Optional visible: boolean
Returns void
Inherited from CanvasLayer.updateStyle
- Defined in layers/base/CanvasLayer.ts:35

Generated using TypeDoc