Skip to main content

Interface: ReactiveElementBase

Base interface for all reactive presentation elements on stage.

Extended by​

Properties​

PropertyTypeDescription
align?ReactiveProp<Align>-
domElementHTMLElement-
enterDelay?numberDelay in seconds before entering scene transition begins (defaults to 0).
enterDuration?numberDuration in seconds for entering scene transition (defaults to stage defaultDuration if undefined).
exitDelay?numberDelay in seconds before exiting scene transition begins (defaults to 0).
exitDuration?numberDuration in seconds for exiting scene transition (defaults to stage defaultDuration if undefined).
idstring-
isActive?boolean-
isMounted?boolean-
kindstring-
origin?ReactiveProp<ElementAnchor>Which point of the element sits on its coordinate (default: "top-left").
position?PositionUpdater | ReactiveProp<Position>-

Accessors​

blur​

Get Signature​

get blur(): number

Returns​

number

Set Signature​

set blur(value: ReactiveProp<number>): void

Parameters​
ParameterType
valueReactiveProp<number>
Returns​

void


brightness​

Get Signature​

get brightness(): number

Returns​

number

Set Signature​

set brightness(value: ReactiveProp<number>): void

Parameters​
ParameterType
valueReactiveProp<number>
Returns​

void


color​

Get Signature​

get color(): string | undefined

Returns​

string | undefined

Set Signature​

set color(value: ReactiveProp<string> | undefined): void

Parameters​
ParameterType
valueReactiveProp<string> | undefined
Returns​

void


height​

Get Signature​

get height(): Size | undefined

Returns​

Size | undefined

Set Signature​

set height(value: ReactiveProp<Size> | undefined): void

Parameters​
ParameterType
valueReactiveProp<Size> | undefined
Returns​

void


opacity​

Get Signature​

get opacity(): number

Returns​

number

Set Signature​

set opacity(value: ReactiveProp<number>): void

Parameters​
ParameterType
valueReactiveProp<number>
Returns​

void


rotation​

Get Signature​

get rotation(): number

Returns​

number

Set Signature​

set rotation(value: ReactiveProp<number>): void

Parameters​
ParameterType
valueReactiveProp<number>
Returns​

void


scale​

Get Signature​

get scale(): number

Returns​

number

Set Signature​

set scale(value: ReactiveProp<number>): void

Parameters​
ParameterType
valueReactiveProp<number>
Returns​

void


size​

Get Signature​

get size(): Size | undefined

Returns​

Size | undefined

Set Signature​

set size(value: ReactiveProp<Size> | undefined): void

Parameters​
ParameterType
valueReactiveProp<Size> | undefined
Returns​

void


width​

Get Signature​

get width(): Size | undefined

Returns​

Size | undefined

Set Signature​

set width(value: ReactiveProp<Size> | undefined): void

Parameters​
ParameterType
valueReactiveProp<Size> | undefined
Returns​

void


x​

Get Signature​

get x(): number

Returns​

number

Set Signature​

set x(value: CoordProp): void

Parameters​
ParameterType
valueCoordProp
Returns​

void


y​

Get Signature​

get y(): number

Returns​

number

Set Signature​

set y(value: CoordProp): void

Parameters​
ParameterType
valueCoordProp
Returns​

void


zIndex​

Get Signature​

get zIndex(): string | number | undefined

Returns​

string | number | undefined

Set Signature​

set zIndex(value: ReactiveProp<string | number> | undefined): void

Parameters​
ParameterType
valueReactiveProp<string | number> | undefined
Returns​

void

Methods​

onActivate()?​

optional onActivate(fn: () => void): () => void

Parameters​

ParameterType
fn() => void

Returns​

() => void


onClick()?​

optional onClick(handler: (event: MouseEvent) => unknown): this

Parameters​

ParameterType
handler(event: MouseEvent) => unknown

Returns​

this


onDeactivate()?​

optional onDeactivate(fn: () => void): () => void

Parameters​

ParameterType
fn() => void

Returns​

() => void


onMount()?​

optional onMount(fn: () => void): () => void

Parameters​

ParameterType
fn() => void

Returns​

() => void


onUnmount()?​

optional onUnmount(fn: () => void): () => void

Parameters​

ParameterType
fn() => void

Returns​

() => void


onUpdate()?​

optional onUpdate(fn: (progress: number) => void): () => void

Parameters​

ParameterType
fn(progress: number) => void

Returns​

() => void