Class CalloutCanvasLayer<T>

Type Parameters

T extends Annotation[]

Hierarchy

CanvasLayer<T>
- CalloutCanvasLayer

Constructors

constructor

new CalloutCanvasLayer<T>(id?: string, options?: CalloutOptions<T>): CalloutCanvasLayer<T>
Type Parameters
- T extends Annotation[]
Parameters
- Optional id: string
- Optional options: CalloutOptions<T>
Returns CalloutCanvasLayer<T>
Overrides CanvasLayer.constructor
- Defined in layers/CalloutCanvasLayer.ts:61

Properties

`Protected` _options

_options: LayerOptions<T>

callouts

callouts: Callout[]

canvas

canvas: HTMLCanvasElement

ctx

ctx: CanvasRenderingContext2D

elm

elm: HTMLElement

fontSizeFactor

fontSizeFactor: number

groupFilter

groupFilter: string[] = null

maxFontSize

maxFontSize: number

minFontSize

minFontSize: number

offsetFactor

offsetFactor: number

offsetMax

offsetMax: number

offsetMin

offsetMin: number

rescaleEvent

rescaleEvent: OnRescaleEvent

xRatio

xRatio: number

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

adjustBottomPositions

adjustBottomPositions(bottom: Callout[]): void
Parameters
- bottom: Callout[]
Returns void
- Defined in layers/CalloutCanvasLayer.ts:325

adjustTopPositions

adjustTopPositions(top: Callout[]): void
Parameters
- top: Callout[]
Returns void
- Defined in layers/CalloutCanvasLayer.ts:311

chooseTopOrBottomPosition

chooseTopOrBottomPosition(nodes: Callout[], bottom: Callout[], top: Callout[]): void
Parameters
- nodes: Callout[]
- bottom: Callout[]
- top: Callout[]
Returns void
- Defined in layers/CalloutCanvasLayer.ts:293

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

getAnnotationBoundingBox

getAnnotationBoundingBox(title: string, label: string, pos: number[], xScale: ScaleLinear<number, number, never>, yScale: ScaleLinear<number, number, never>, height: number): {
    height: number;
    width: number;
    x: number;
    y: number;
}
Parameters
- title: string
- label: string
- pos: number[]
- xScale: ScaleLinear<number, number, never>
- yScale: ScaleLinear<number, number, never>
- height: number
Returns {
    height: number;
    width: number;
    x: number;
    y: number;
}
- height: number
- width: number
- x: number
- y: number
- Defined in layers/CalloutCanvasLayer.ts:268

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

`Private` getPosition

getPosition(boundingBox: BoundingBox, location: string): Point
Parameters
- boundingBox: BoundingBox
- location: string
Returns Point
- Defined in layers/CalloutCanvasLayer.ts:192

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/CalloutCanvasLayer.ts:85

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/CalloutCanvasLayer.ts:77

optionsRescale

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

positionCallouts

positionCallouts(annotations: Annotation[], isLeftToRight: boolean, xScale: ScaleLinear<number, number, never>, yScale: ScaleLinear<number, number, never>, _scale: number, fontSize: number, offset?: number): Callout[]
Parameters
- annotations: Annotation[]
- isLeftToRight: boolean
- xScale: ScaleLinear<number, number, never>
- yScale: ScaleLinear<number, number, never>
- _scale: number
- fontSize: number
- offset: number = 20
Returns Callout[]
- Defined in layers/CalloutCanvasLayer.ts:224

render

render(isPanning?: boolean): void
Parameters
- isPanning: boolean = false
Returns void
- Defined in layers/CalloutCanvasLayer.ts:93

`Private` renderAnnotation

renderAnnotation(title: string, label: string, x: number, y: number, fontSize: number, color: string): void
Parameters
- title: string
- label: string
- x: number
- y: number
- fontSize: number
- color: string
Returns void
- Defined in layers/CalloutCanvasLayer.ts:136

`Private` renderCallout

renderCallout(title: string, label: string, boundingBox: BoundingBox, color: string, location: string): void
Parameters
- title: string
- label: string
- boundingBox: BoundingBox
- color: string
- location: string
Returns void
- Defined in layers/CalloutCanvasLayer.ts:164

`Private` renderLine

renderLine(x: number, y: number, width: number, dotX: number, dotY: number, color: string, placeLeft?: boolean): void
Parameters
- x: number
- y: number
- width: number
- dotX: number
- dotY: number
- color: string
- placeLeft: boolean = true
Returns void
- Defined in layers/CalloutCanvasLayer.ts:175

`Private` renderPoint

renderPoint(x: number, y: number, radius?: number): void
Parameters
- x: number
- y: number
- radius: number = 3
Returns void
- Defined in layers/CalloutCanvasLayer.ts:156

`Private` renderText

renderText(title: string, x: number, y: number, fontSize: number, color: string, font?: string, fontStyle?: string): void
Parameters
- title: string
- x: number
- y: number
- fontSize: number
- color: string
- font: string = 'arial'
- fontStyle: string = 'normal'
Returns void
- Defined in layers/CalloutCanvasLayer.ts:141

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

setGroupFilter

setGroupFilter(filter: string[]): void
Parameters
- filter: string[]
Returns void
- Defined in layers/CalloutCanvasLayer.ts:71

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

Class CalloutCanvasLayer<T>

Type Parameters

T extends Annotation[]

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Annotation[]

Parameters

Optional id: string

Optional options: CalloutOptions<T>

Returns CalloutCanvasLayer<T>

Properties

Protected _options

callouts

canvas

ctx

elm

fontSizeFactor

groupFilter

maxFontSize

minFontSize

offsetFactor

offsetMax

offsetMin

rescaleEvent

xRatio

Accessors

data

Returns T

Parameters

data: T

Returns void

element

Returns HTMLElement

id

Returns string

interactive

Returns boolean

Parameters

shouldBeInteractive: boolean

Returns void

isLoading

Returns boolean

Parameters

loading: boolean

Returns void

isVisible

Returns boolean

opacity

Returns number

Parameters

opacity: number

Returns void

options

Returns LayerOptions<T>

Parameters

options: LayerOptions<T>

Returns void

order

Returns number

Parameters

order: number

Returns void

referenceSystem

Returns IntersectionReferenceSystem

Parameters

referenceSystem: IntersectionReferenceSystem

Returns void

Methods

adjustBottomPositions

Parameters

bottom: Callout[]

Returns void

adjustTopPositions

`Optional` id: string

`Optional` options: CalloutOptions<T>

`Protected` _options

Returns {
height: number;
width: number;
x: number;
y: number;
}

`Private` getPosition