galavi / BaseOverlay

Class: abstract BaseOverlay

Defined in: overlay/base.ts:39

Constructors

new BaseOverlay()

new BaseOverlay(): BaseOverlay

Returns

BaseOverlay

Properties

root?

protected optional root: HTMLDivElement

Defined in: overlay/base.ts:40

Methods

bindView()

bindView(binding): void

Defined in: overlay/base.ts:47

Parameters

binding

OverlayBinding

Returns

void

---

mount()

mount(parent): void

Defined in: overlay/base.ts:51

Parameters

parent

HTMLElement

Returns

void

---

unmount()

unmount(): void

Defined in: overlay/base.ts:71

Returns

void

---

render()

render(state): void

Defined in: overlay/base.ts:78

Parameters

state

State

Returns

void

---

setOptions()

setOptions(opts?): void

Defined in: overlay/base.ts:95

Update view-local presentation options at runtime. Options not understood by the base overlay are forwarded to onOptionsChanged for subclasses.

Parameters

opts?

Record<string, unknown>

Returns

void

---

configureRoot()

protected configureRoot(_root): void

Defined in: overlay/base.ts:104

Parameters

_root

HTMLDivElement

Returns

void

---

onMount()

protected onMount(_root, _parent): void

Defined in: overlay/base.ts:106

Parameters

_root

HTMLDivElement

_parent

HTMLElement

Returns

void

---

onUnmount()

protected onUnmount(): void

Defined in: overlay/base.ts:108

Returns

void

---

onOptionsChanged()

protected onOptionsChanged(_opts): void

Defined in: overlay/base.ts:110

Parameters

_opts

Record<string, unknown>

Returns

void

---

onHidden()

protected onHidden(): void

Defined in: overlay/base.ts:112

Returns

void

---

onRender()

abstract protected onRender(state): void

Defined in: overlay/base.ts:114

Parameters

state

State

Returns

void

---

getDisplayMode()

protected getDisplayMode(): string

Defined in: overlay/base.ts:116

Returns

string

---

getHostElement()

protected getHostElement(): undefined | HTMLElement

Defined in: overlay/base.ts:120

Returns

undefined | HTMLElement

---

getCanvas()

protected getCanvas(): undefined | HTMLCanvasElement

Defined in: overlay/base.ts:124

Returns

undefined | HTMLCanvasElement

---

getViewType()

protected getViewType(): undefined | string

Defined in: overlay/base.ts:128

Returns

undefined | string

---

getLayerIds()

protected getLayerIds(): readonly string[]

Defined in: overlay/base.ts:132

Returns

readonly string[]

---

isViewActive()

protected isViewActive(): boolean

Defined in: overlay/base.ts:136

Returns

boolean

---

isVisible()

protected isVisible(_state?): boolean

Defined in: overlay/base.ts:147

Whether the overlay should currently render. The default honors the local visible and visibleWhenActive flags. Subclasses MAY override to derive visibility from state as well, but most overlays should treat visibility as view-local presentation and let the view's controller drive it via setOptions({ visible }).

Parameters

_state?

State

Returns

boolean

---

createLabel()

protected createLabel(variant, text): HTMLDivElement

Defined in: overlay/base.ts:151

Parameters

variant

OverlayLabelVariant

text

string = ""

Returns

HTMLDivElement

---

positionRoot()

protected positionRoot(position, marginPx): void

Defined in: overlay/base.ts:158

Parameters

position

OverlayCornerPosition

marginPx

number

Returns

void

---

applyCornerPosition()

protected applyCornerPosition(element, position, marginPx): void

Defined in: overlay/base.ts:163

Parameters

element

HTMLElement

position

OverlayCornerPosition

marginPx

number

Returns

void

---

applyLabelStyle()

protected applyLabelStyle(element, variant): void

Defined in: overlay/base.ts:191

Parameters

element

HTMLElement

variant

OverlayLabelVariant

Returns

void

---

measureElement()

protected measureElement(element): object

Defined in: overlay/base.ts:232

Parameters

element

HTMLElement

Returns

object

width

width: number

height

height: number

---

clampToCanvas()

protected clampToCanvas(left, top, width, height, canvas, margin): [number, number]

Defined in: overlay/base.ts:247

Parameters

left

number

top

number

width

number

height

number

canvas

HTMLCanvasElement

margin

number

Returns

[number, number]