Class GeomodelLabelsLayer<T>

Type Parameters

T extends SurfaceData

Hierarchy

CanvasLayer<T>
- GeomodelLabelsLayer

Index

Constructors

Properties

_options areasWithAvgTopDepth canvas ctx defaultFont defaultMargins defaultMaxFontSize defaultMinFontSize defaultTextColor elm isLabelsOnLeftSide isXFlipped maxFontSizeInWorldCoordinates rescaleEvent

Accessors

data element id interactive isLoading isVisible opacity options order referenceSystem

Constructors

constructor

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

Properties

`Protected` _options

_options: LayerOptions<T>

areasWithAvgTopDepth

areasWithAvgTopDepth: SurfaceAreaWithAvgTopDepth[] = null

canvas

canvas: HTMLCanvasElement

ctx

ctx: CanvasRenderingContext2D

defaultFont

defaultFont: string = DEFAULT_FONT

defaultMargins

defaultMargins: number = DEFAULT_MARGINS

defaultMaxFontSize

defaultMaxFontSize: number = DEFAULT_MAX_FONT_SIZE

defaultMinFontSize

defaultMinFontSize: number = DEFAULT_MIN_FONT_SIZE

defaultTextColor

defaultTextColor: string = DEFAULT_TEXT_COLOR

elm

elm: HTMLElement

isLabelsOnLeftSide

isLabelsOnLeftSide: boolean = true

isXFlipped

isXFlipped: boolean = false

maxFontSizeInWorldCoordinates

maxFontSizeInWorldCoordinates: number = MAX_FONT_SIZE_IN_WORLD_COORDINATES

rescaleEvent

rescaleEvent: OnRescaleEvent

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(): GeomodelLayerLabelsOptions<T>
Returns GeomodelLayerLabelsOptions<T>
Overrides CanvasLayer.options
- Defined in layers/GeomodelLabelsLayer.ts:51

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

calcAreaDir

calcAreaDir(top: number[][], bottom: number[][], offset: number, count: number, step: number, initalVector?: default, topLimit?: number, bottomLimit?: number, minReductionAngle?: number, maxReductionAngle?: number, angleReductionExponent?: number, alternativeSurfaceBottomData?: number[][], surfaces?: SurfaceArea[], currentSurfaceIndex?: number): number
Parameters
- top: number[][]
- bottom: number[][]
- offset: number
- count: number
- step: number
- initalVector: default = Vector2.left
- topLimit: number = null
- bottomLimit: number = null
- minReductionAngle: number = 0
- maxReductionAngle: number = ...
- angleReductionExponent: number = 4
- alternativeSurfaceBottomData: number[][] = null
- surfaces: SurfaceArea[] = null
- currentSurfaceIndex: number = null
Returns number
- Defined in layers/GeomodelLabelsLayer.ts:447

calcLineDir

calcLineDir(data: number[][], offset: number, count: number, step: number, zFactor: number, initalVector?: default, topLimit?: number, bottomLimit?: number): default
Parameters
- data: number[][]
- offset: number
- count: number
- step: number
- zFactor: number
- initalVector: default = Vector2.left
- topLimit: number = null
- bottomLimit: number = null
Returns default
- Defined in layers/GeomodelLabelsLayer.ts:415

calcPos

calcPos(data: number[][], offset: number, count: number, step: number, topLimit?: number, bottomLimit?: number, alternativeSurfaceData?: number[][], surfaces?: SurfaceArea[], currentSurfaceIndex?: number): default
Parameters
- data: number[][]
- offset: number
- count: number
- step: number
- topLimit: number = null
- bottomLimit: number = null
- alternativeSurfaceData: number[][] = null
- surfaces: SurfaceArea[] = null
- currentSurfaceIndex: number = null
Returns default
- Defined in layers/GeomodelLabelsLayer.ts:354

checkDrawLabelsOnLeftSide

checkDrawLabelsOnLeftSide(): boolean
Returns boolean
- Defined in layers/GeomodelLabelsLayer.ts:568

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/GeomodelLabelsLayer.ts:343

drawAreaLabel

drawAreaLabel(surfaceArea: SurfaceArea, nextSurfaceArea: SurfaceArea, surfaces: SurfaceArea[], i: number): void
Parameters
- surfaceArea: SurfaceArea
- nextSurfaceArea: SurfaceArea
- surfaces: SurfaceArea[]
- i: number
Returns void
- Defined in layers/GeomodelLabelsLayer.ts:157

drawAreaLabels

drawAreaLabels(): void
Returns void
- Defined in layers/GeomodelLabelsLayer.ts:130

drawLineLabel

drawLineLabel(s: SurfaceLine): void
Parameters
- s: SurfaceLine
Returns void
- Defined in layers/GeomodelLabelsLayer.ts:289

drawLineLabels

drawLineLabels(): void
Returns void
- Defined in layers/GeomodelLabelsLayer.ts:153

generateSurfacesWithAvgDepth

generateSurfacesWithAvgDepth(): void
Returns void
- Defined in layers/GeomodelLabelsLayer.ts:60

getAlternativeYValueIfAvailable

getAlternativeYValueIfAvailable(x: number, topLimit: number, bottomLimit: number, alternativeSurfaceData: number[][], surfaces: SurfaceArea[], currentSurfaceIndex: number): number
Parameters
- x: number
- topLimit: number
- bottomLimit: number
- alternativeSurfaceData: number[][]
- surfaces: SurfaceArea[]
- currentSurfaceIndex: number
Returns number
- Defined in layers/GeomodelLabelsLayer.ts:386

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

getMarginsInWorldCoordinates

getMarginsInWorldCoordinates(): number
Returns number
- Defined in layers/GeomodelLabelsLayer.ts:517

getSurfacesAreaEdges

getSurfacesAreaEdges(): number[]
Returns number[]
- Defined in layers/GeomodelLabelsLayer.ts:524

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/GeomodelLabelsLayer.ts:93

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/GeomodelLabelsLayer.ts:102

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/GeomodelLabelsLayer.ts:97

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/GeomodelLabelsLayer.ts:109

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
Overrides CanvasLayer.setData
- Defined in layers/GeomodelLabelsLayer.ts:55

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

updateXFlipped

updateXFlipped(): void
Returns void
- Defined in layers/GeomodelLabelsLayer.ts:512

Class GeomodelLabelsLayer<T>

Type Parameters

T extends SurfaceData

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends SurfaceData

Parameters

Optional id: string

Optional options: GeomodelLayerLabelsOptions<T>

Returns GeomodelLabelsLayer<T>

Properties

Protected _options

areasWithAvgTopDepth

canvas

ctx

defaultFont

defaultMargins

defaultMaxFontSize

defaultMinFontSize

defaultTextColor

elm

isLabelsOnLeftSide

isXFlipped

maxFontSizeInWorldCoordinates

rescaleEvent

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 GeomodelLayerLabelsOptions<T>

order

Returns number

Parameters

order: number

Returns void

referenceSystem

Returns IntersectionReferenceSystem

Parameters

referenceSystem: IntersectionReferenceSystem

Returns void

Methods

calcAreaDir

Parameters

top: number[][]

bottom: number[][]

offset: number

count: number

step: number

initalVector: default = Vector2.left

`Optional` id: string

`Optional` options: GeomodelLayerLabelsOptions<T>

`Protected` _options