Class ReferenceLineLayer

Hierarchy

CanvasLayer<ReferenceLine[]>
- ReferenceLineLayer

Constructors

constructor

new ReferenceLineLayer(id?: string, options?: LayerOptions<ReferenceLine[]>): ReferenceLineLayer
Parameters
- Optional id: string
- Optional options: LayerOptions<ReferenceLine[]>
Returns ReferenceLineLayer
Inherited from CanvasLayer.constructor
- Defined in layers/base/Layer.ts:36

Properties

`Protected` _options

_options: LayerOptions<ReferenceLine[]>

canvas

canvas: HTMLCanvasElement

ctx

ctx: CanvasRenderingContext2D

elm

elm: HTMLElement

xScale

xScale: ScaleLinear<number, number, never> = null

yScale

yScale: ScaleLinear<number, number, never> = null

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

`Private` drawDashed

drawDashed(dashed: ReferenceLine): void
Parameters
- dashed: ReferenceLine
Returns void
- Defined in layers/ReferenceLineLayer.ts:66

`Private` drawSolid

drawSolid(solid: ReferenceLine): void
Parameters
- solid: ReferenceLine
Returns void
- Defined in layers/ReferenceLineLayer.ts:84

`Private` drawText

drawText(ctx: CanvasRenderingContext2D, refLine: ReferenceLine, x: number, y: number): void
Parameters
- ctx: CanvasRenderingContext2D
- refLine: ReferenceLine
- x: number
- y: number
Returns void
- Defined in layers/ReferenceLineLayer.ts:128

`Private` drawWavy

drawWavy(wavy: ReferenceLine): void
Parameters
- wavy: ReferenceLine
Returns void
- Defined in layers/ReferenceLineLayer.ts:102

getData

getData(): ReferenceLine[]
Returns ReferenceLine[]
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
Overrides CanvasLayer.onMount
- Defined in layers/ReferenceLineLayer.ts:48

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/ReferenceLineLayer.ts:58

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<ReferenceLine[]>): void
Parameters
- event: OnUpdateEvent<ReferenceLine[]>
Returns void
Overrides CanvasLayer.onUpdate
- Defined in layers/ReferenceLineLayer.ts:52

optionsRescale

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

`Private` render

render(): void
Returns void
- Defined in layers/ReferenceLineLayer.ts:165

resetTransform

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

`Private` setCtxLineStyle

setCtxLineStyle(ctx: CanvasRenderingContext2D, refLine: ReferenceLine): void
Parameters
- ctx: CanvasRenderingContext2D
- refLine: ReferenceLine
Returns void
- Defined in layers/ReferenceLineLayer.ts:141

`Private` setCtxLineWidth

setCtxLineWidth(ctx: CanvasRenderingContext2D, refLine: ReferenceLine): void
Parameters
- ctx: CanvasRenderingContext2D
- refLine: ReferenceLine
Returns void
- Defined in layers/ReferenceLineLayer.ts:160

setData

setData(data: ReferenceLine[]): void
Parameters
- data: ReferenceLine[]
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

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