Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StringStyleAnimator<V>

Type parameters

Hierarchy

Callable

  • StringStyleAnimator(): undefined | string
  • StringStyleAnimator(newState: undefined | string, precedenceOrTiming: undefined | number | boolean | AnyTiming): V
  • StringStyleAnimator(newState: undefined | string, timing?: boolean | AnyTiming, precedence?: number): V

  • Returns undefined | string

  • Parameters

    • newState: undefined | string
    • precedenceOrTiming: undefined | number | boolean | AnyTiming

    Returns V

  • Parameters

    • newState: undefined | string
    • Optional timing: boolean | AnyTiming
    • Optional precedence: number

    Returns V

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    Parameters

    • owner: V
    • animatorName: string

    Returns StringStyleAnimator<V>

Properties

Readonly animatorFlags

animatorFlags: number

Readonly interpolator

interpolator: null | Interpolator<undefined | string>

Readonly name

name: string

Readonly node

node: null | Node

Readonly ownLook

ownLook: null | Look<undefined | string, never>

Readonly ownState

ownState: undefined | string

Readonly ownValue

ownValue: undefined | string

Readonly owner

owner: V

Readonly precedence

precedence: number

Readonly priority

priority: undefined | string

Readonly propertyNames

propertyNames: string | readonly string[]

Readonly propertyValue

propertyValue: undefined | string

Readonly timing

timing: null | Timing

Optional updateFlags

updateFlags: number

Accessors

look

  • get look(): null | Look<T, never>

  • Returns null | Look<T, never>

state

  • get state(): T

  • Returns T

updatedValue

  • get updatedValue(): undefined | T

  • Returns undefined | T

value

  • get value(): T

  • Returns T

Methods

applyLook

  • applyLook(look: Look<undefined | string, never>, timing: boolean | Timing): void

  • Parameters

    • look: Look<undefined | string, never>
    • timing: boolean | Timing

    Returns void

applyTheme

  • Parameters

    Returns void

didMount

  • didMount(): void

  • Returns void

didSetLook

  • didSetLook(newLook: null | Look<undefined | string, never>, oldLook: null | Look<undefined | string, never>, timing: boolean | Timing): void

  • Parameters

    • newLook: null | Look<undefined | string, never>
    • oldLook: null | Look<undefined | string, never>
    • timing: boolean | Timing

    Returns void

didSetPrecedence

  • didSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

Protected didSetState

  • didSetState(newState: undefined | string, oldState: undefined | string): void

  • Parameters

    • newState: undefined | string
    • oldState: undefined | string

    Returns void

didSetValue

  • didSetValue(newValue: undefined | string, oldValue: undefined | string): void

  • Parameters

    • newValue: undefined | string
    • oldValue: undefined | string

    Returns void

didStartAnimating

  • didStartAnimating(): void

  • Returns void

didStopAnimating

  • didStopAnimating(): void

  • Returns void

didUnmount

  • didUnmount(): void

  • Returns void

equalState

  • equalState(newState: undefined | string, oldState: undefined | string): boolean

  • Parameters

    • newState: undefined | string
    • oldState: undefined | string

    Returns boolean

fromAny

  • fromAny(value: string): undefined | string

  • Parameters

    • value: string

    Returns undefined | string

fromCssValue

  • fromCssValue(value: CSSStyleValue): undefined | string

  • Parameters

    • value: CSSStyleValue

    Returns undefined | string

getState

  • getState(): string

  • Returns string

getStateOr

  • getStateOr<E>(elseState: E): string | E

  • Type parameters

    • E

    Parameters

    • elseState: E

    Returns string | E

getValue

  • getValue(): string

  • Returns string

getValueOr

  • getValueOr<E>(elseValue: E): string | E

  • Type parameters

    • E

    Parameters

    • elseValue: E

    Returns string | E

isAnimating

  • isAnimating(): boolean

  • Returns boolean

isDefined

  • isDefined(value: undefined | string): boolean

  • Parameters

    • value: undefined | string

    Returns boolean

isMounted

  • isMounted(): boolean

  • Returns boolean

isUpdated

  • isUpdated(): boolean

  • Returns boolean

mount

  • mount(): void

  • Returns void

onAnimate

  • onAnimate(t: number): void

  • Parameters

    • t: number

    Returns void

onBegin

  • onBegin(value: undefined | string): void

  • Parameters

    • value: undefined | string

    Returns void

onEnd

  • onEnd(value: undefined | string): void

  • Parameters

    • value: undefined | string

    Returns void

onInterrupt

  • onInterrupt(value: undefined | string): void

  • Parameters

    • value: undefined | string

    Returns void

onMount

  • onMount(): void

  • Returns void

onSetLook

  • onSetLook(newLook: null | Look<undefined | string, never>, oldLook: null | Look<undefined | string, never>, timing: boolean | Timing): void

  • Parameters

    • newLook: null | Look<undefined | string, never>
    • oldLook: null | Look<undefined | string, never>
    • timing: boolean | Timing

    Returns void

onSetPrecedence

  • onSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

Protected onSetState

  • onSetState(newState: undefined | string, oldState: undefined | string): void

  • Parameters

    • newState: undefined | string
    • oldState: undefined | string

    Returns void

onSetValue

  • onSetValue(newValue: undefined | string, oldValue: undefined | string): void

  • Parameters

    • newValue: undefined | string
    • oldValue: undefined | string

    Returns void

onStartAnimating

  • onStartAnimating(): void

  • Returns void

onStopAnimating

  • onStopAnimating(): void

  • Returns void

onUnmount

  • onUnmount(): void

  • Returns void

parse

  • parse(value: string): undefined | string

  • Parameters

    • value: string

    Returns undefined | string

setAnimatedState

  • setAnimatedState(newState: undefined | string, oldState: undefined | string, timing: Timing): void

  • Parameters

    • newState: undefined | string
    • oldState: undefined | string
    • timing: Timing

    Returns void

setAnimatorFlags

  • setAnimatorFlags(animatorFlags: number): void

  • Parameters

    • animatorFlags: number

    Returns void

setImmediateState

  • setImmediateState(newState: undefined | string, oldState: undefined | string): void

  • Parameters

    • newState: undefined | string
    • oldState: undefined | string

    Returns void

setIntermediateValue

  • setIntermediateValue(newValue: undefined | string, newState?: string): void

  • Parameters

    • newValue: undefined | string
    • Optional newState: string

    Returns void

setLook

  • setLook(newLook: null | Look<undefined | string, never>, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
  • setLook(newLook: null | Look<undefined | string, never>, timing?: boolean | AnyTiming, precedence?: number): void

  • Parameters

    • newLook: null | Look<undefined | string, never>
    • precedenceOrTiming: undefined | number | boolean | AnyTiming

    Returns void

  • Parameters

    • newLook: null | Look<undefined | string, never>
    • Optional timing: boolean | AnyTiming
    • Optional precedence: number

    Returns void

setOwnLook

  • setOwnLook(newLook: null | Look<undefined | string, never>, timing?: boolean | AnyTiming): void

  • Parameters

    • newLook: null | Look<undefined | string, never>
    • Optional timing: boolean | AnyTiming

    Returns void

setOwnState

  • setOwnState(newState: undefined | string, timing?: boolean | AnyTiming): void

  • Parameters

    • newState: undefined | string
    • Optional timing: boolean | AnyTiming

    Returns void

setPrecedence

  • setPrecedence(newPrecedence: number): void

  • Parameters

    • newPrecedence: number

    Returns void

setPriority

  • setPriority(priority: undefined | string): void

  • Parameters

    • priority: undefined | string

    Returns void

setState

  • setState(newState: undefined | string, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
  • setState(newState: undefined | string, timing?: boolean | AnyTiming, precedence?: number): void

  • Parameters

    • newState: undefined | string
    • precedenceOrTiming: undefined | number | boolean | AnyTiming

    Returns void

  • Parameters

    • newState: undefined | string
    • Optional timing: boolean | AnyTiming
    • Optional precedence: number

    Returns void

setValue

  • setValue(newValue: undefined | string, oldValue?: string): void

  • Parameters

    • newValue: undefined | string
    • Optional oldValue: string

    Returns void

Protected startAnimating

  • startAnimating(): void

  • Returns void

Protected stopAnimating

  • stopAnimating(): void

  • Returns void

takeUpdatedValue

  • takeUpdatedValue(): undefined | string

  • Returns undefined | string

takeValue

  • takeValue(): undefined | string

  • Returns undefined | string

takesPrecedence

  • takesPrecedence(precedence: number): boolean

  • Parameters

    • precedence: number

    Returns boolean

toString

  • toString(): string

  • Returns string

unmount

  • unmount(): void

  • Returns void

willMount

  • willMount(): void

  • Returns void

willSetLook

  • willSetLook(newLook: null | Look<undefined | string, never>, oldLook: null | Look<undefined | string, never>, timing: boolean | Timing): void

  • Parameters

    • newLook: null | Look<undefined | string, never>
    • oldLook: null | Look<undefined | string, never>
    • timing: boolean | Timing

    Returns void

willSetPrecedence

  • willSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

Protected willSetState

  • willSetState(newState: undefined | string, oldState: undefined | string): void

  • Parameters

    • newState: undefined | string
    • oldState: undefined | string

    Returns void

willSetValue

  • willSetValue(newValue: undefined | string, oldValue: undefined | string): void

  • Parameters

    • newValue: undefined | string
    • oldValue: undefined | string

    Returns void

willStartAnimating

  • willStartAnimating(): void

  • Returns void

willStopAnimating

  • willStopAnimating(): void

  • Returns void

willUnmount

  • willUnmount(): void

  • Returns void

Static define

  • Type parameters

    Parameters

    Returns StyleAnimatorConstructor<V_11, T_11, U_11, I_1>

  • Type parameters

    Parameters

    Returns StyleAnimatorConstructor<V_12, T_12, U_12, {}>

Static getClass

  • Parameters

    • type: unknown

    Returns null | StyleAnimatorClass

Generated using TypeDoc