Class LengthAttributeAnimator<V>

Type parameters

V: ElementView

Hierarchy

AttributeAnimator<V, Length | null, AnyLength | null>
- LengthAttributeAnimator

Callable

LengthAttributeAnimator(): null | Length
LengthAttributeAnimator(newState: null | AnyLength, precedenceOrTiming: undefined | number | boolean | AnyTiming): V
LengthAttributeAnimator(newState: null | AnyLength, timing?: boolean | AnyTiming, precedence?: number): V

- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:50
Returns null | Length
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:51
Parameters
- newState: null | AnyLength
- precedenceOrTiming: undefined | number | boolean | AnyTiming
Returns V
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:52
Parameters
- newState: null | AnyLength
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns V

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new LengthAttributeAnimator<V>(owner: V, animatorName: string): LengthAttributeAnimator<V>

Inherited from AttributeAnimator<V, Length | null, AnyLength | null>.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:107
Type parameters
- V: ElementView<V>
Parameters
- owner: V
- animatorName: string
Returns LengthAttributeAnimator<V>

Properties

Readonly animatorFlags

animatorFlags: number

Readonly attributeName

attributeName: string

Readonly attributeValue

attributeValue: undefined | null | Length

Readonly interpolator

interpolator: null | Interpolator<null | Length>

Readonly name

name: string

Readonly node

node: Node

Readonly ownLook

ownLook: null | Look<null | Length, never>

Readonly ownState

ownState: null | Length

Readonly ownValue

ownValue: null | Length

Readonly owner

owner: V

Readonly precedence

precedence: number

Readonly timing

timing: null | Timing

Optional updateFlags

updateFlags: number

Accessors

look

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

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:31
Returns null | Look<T, never>

state

get state(): T

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:19
Returns T

updatedValue

get updatedValue(): undefined | T

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:49
Returns undefined | T

value

get value(): T

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:10
Returns T

Methods

applyLook

applyLook(look: Look<null | Length, never>, timing: boolean | Timing): void

Inherited from AttributeAnimator.applyLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:66
Parameters
- look: Look<null | Length, never>
- timing: boolean | Timing
Returns void

applyTheme

applyTheme(theme: ThemeMatrix, mood: MoodVector<Feel>, timing: boolean | Timing): void

Inherited from AttributeAnimator.applyTheme
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:67
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void

didMount

didMount(): void

Inherited from AttributeAnimator.didMount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:79
Returns void

didSetLook

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

Inherited from AttributeAnimator.didSetLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:37
Parameters
- newLook: null | Look<null | Length, never>
- oldLook: null | Look<null | Length, never>
- timing: boolean | Timing
Returns void

didSetPrecedence

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

Inherited from AttributeAnimator.didSetPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:45
Parameters
- newPrecedence: number
- oldPrecedence: number
Returns void

Protected didSetState

didSetState(newState: null | Length, oldState: null | Length): void

Inherited from AttributeAnimator.didSetState
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:29
Parameters
- newState: null | Length
- oldState: null | Length
Returns void

didSetValue

didSetValue(newValue: null | Length, oldValue: null | Length): void

Inherited from AttributeAnimator.didSetValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:16
Parameters
- newValue: null | Length
- oldValue: null | Length
Returns void

didStartAnimating

didStartAnimating(): void

Inherited from AttributeAnimator.didStartAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:69
Returns void

didStopAnimating

didStopAnimating(): void

Inherited from AttributeAnimator.didStopAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:71
Returns void

didUnmount

didUnmount(): void

Inherited from AttributeAnimator.didUnmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:83
Returns void

equalState

equalState(newState: null | Length, oldState: undefined | null | Length): boolean

Inherited from AttributeAnimator.equalState
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:65
Parameters
- newState: null | Length
- oldState: undefined | null | Length
Returns boolean

fromAny

fromAny(value: AnyLength): null | Length

Overrides AttributeAnimator.fromAny
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/LengthAttributeAnimator.d.ts:6
Parameters
- value: AnyLength
Returns null | Length

getState

getState(): Length

Inherited from AttributeAnimator.getState
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:61
Returns Length

getStateOr

getStateOr<E>(elseState: E): Length | E

Inherited from AttributeAnimator.getStateOr
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:21
Type parameters
- E
Parameters
- elseState: E
Returns Length | E

getValue

getValue(): Length

Inherited from AttributeAnimator.getValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:59
Returns Length

getValueOr

getValueOr<E>(elseValue: E): Length | E

Inherited from AttributeAnimator.getValueOr
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:12
Type parameters
- E
Parameters
- elseValue: E
Returns Length | E

isAnimating

isAnimating(): boolean

Inherited from AttributeAnimator.isAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:52
Returns boolean

isDefined

isDefined(value: null | Length): boolean

Inherited from AttributeAnimator.isDefined
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:8
Parameters
- value: null | Length
Returns boolean

isMounted

isMounted(): boolean

Inherited from AttributeAnimator.isMounted
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:75
Returns boolean

isUpdated

isUpdated(): boolean

Inherited from AttributeAnimator.isUpdated
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:48
Returns boolean

mount

mount(): void

Inherited from AttributeAnimator.mount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:76
Returns void

onAnimate

onAnimate(t: number): void

Inherited from AttributeAnimator.onAnimate
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:61
Parameters
- t: number
Returns void

onBegin

onBegin(value: null | Length): void

Inherited from AttributeAnimator.onBegin
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:62
Parameters
- value: null | Length
Returns void

onEnd

onEnd(value: null | Length): void

Inherited from AttributeAnimator.onEnd
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:63
Parameters
- value: null | Length
Returns void

onInterrupt

onInterrupt(value: null | Length): void

Inherited from AttributeAnimator.onInterrupt
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:64
Parameters
- value: null | Length
Returns void

onMount

onMount(): void

Inherited from AttributeAnimator.onMount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:78
Returns void

onSetLook

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

Inherited from AttributeAnimator.onSetLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:65
Parameters
- newLook: null | Look<null | Length, never>
- oldLook: null | Look<null | Length, never>
- timing: boolean | Timing
Returns void

onSetPrecedence

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

Inherited from AttributeAnimator.onSetPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:44
Parameters
- newPrecedence: number
- oldPrecedence: number
Returns void

Protected onSetState

onSetState(newState: null | Length, oldState: null | Length): void

Inherited from AttributeAnimator.onSetState
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:28
Parameters
- newState: null | Length
- oldState: null | Length
Returns void

onSetValue

onSetValue(newValue: null | Length, oldValue: null | Length): void

Inherited from AttributeAnimator.onSetValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:60
Parameters
- newValue: null | Length
- oldValue: null | Length
Returns void

onStartAnimating

onStartAnimating(): void

Inherited from AttributeAnimator.onStartAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:55
Returns void

onStopAnimating

onStopAnimating(): void

Inherited from AttributeAnimator.onStopAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:59
Returns void

onUnmount

onUnmount(): void

Inherited from AttributeAnimator.onUnmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:82
Returns void

parse

parse(value: string): null | Length

Overrides AttributeAnimator.parse
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/LengthAttributeAnimator.d.ts:5
Parameters
- value: string
Returns null | Length

setAnimatedState

setAnimatedState(newState: null | Length, oldState: null | Length, timing: Timing): void

Inherited from AttributeAnimator.setAnimatedState
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:26
Parameters
- newState: null | Length
- oldState: null | Length
- timing: Timing
Returns void

setAnimatorFlags

setAnimatorFlags(animatorFlags: number): void

Inherited from AttributeAnimator.setAnimatorFlags
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:47
Parameters
- animatorFlags: number
Returns void

setImmediateState

setImmediateState(newState: null | Length, oldState: null | Length): void

Inherited from AttributeAnimator.setImmediateState
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:25
Parameters
- newState: null | Length
- oldState: null | Length
Returns void

setIntermediateValue

setIntermediateValue(newValue: null | Length, newState?: null | Length): void

Inherited from AttributeAnimator.setIntermediateValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:17
Parameters
- newValue: null | Length
- Optional newState: null | Length
Returns void

setLook

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

Inherited from AttributeAnimator.setLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:32
Parameters
- newLook: null | Look<null | Length, never>
- precedenceOrTiming: undefined | number | boolean | AnyTiming
Returns void
Inherited from AttributeAnimator.setLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:33
Parameters
- newLook: null | Look<null | Length, never>
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns void

setOwnLook

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

Inherited from AttributeAnimator.setOwnLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:34
Parameters
- newLook: null | Look<null | Length, never>
- Optional timing: boolean | AnyTiming
Returns void

setOwnState

setOwnState(newState: null | AnyLength, timing?: boolean | AnyTiming): void

Inherited from AttributeAnimator.setOwnState
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:64
Parameters
- newState: null | AnyLength
- Optional timing: boolean | AnyTiming
Returns void

setPrecedence

setPrecedence(newPrecedence: number): void

Inherited from AttributeAnimator.setPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:42
Parameters
- newPrecedence: number
Returns void

setState

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

Inherited from AttributeAnimator.setState
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:62
Parameters
- newState: null | AnyLength
- precedenceOrTiming: undefined | number | boolean | AnyTiming
Returns void
Inherited from AttributeAnimator.setState
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:63
Parameters
- newState: null | AnyLength
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns void

setValue

setValue(newValue: null | Length, oldValue?: null | Length): void

Inherited from AttributeAnimator.setValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:13
Parameters
- newValue: null | Length
- Optional oldValue: null | Length
Returns void

Protected startAnimating

startAnimating(): void

Inherited from AttributeAnimator.startAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:53
Returns void

Protected stopAnimating

stopAnimating(): void

Inherited from AttributeAnimator.stopAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:57
Returns void

takeUpdatedValue

takeUpdatedValue(): undefined | null | Length

Inherited from AttributeAnimator.takeUpdatedValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:50
Returns undefined | null | Length

takeValue

takeValue(): null | Length

Inherited from AttributeAnimator.takeValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:51
Returns null | Length

takesPrecedence

takesPrecedence(precedence: number): boolean

Inherited from AttributeAnimator.takesPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:40
Parameters
- precedence: number
Returns boolean

toString

toString(): string

Inherited from AttributeAnimator.toString
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:84
Returns string

unmount

unmount(): void

Inherited from AttributeAnimator.unmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:80
Returns void

willMount

willMount(): void

Inherited from AttributeAnimator.willMount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:77
Returns void

willSetLook

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

Inherited from AttributeAnimator.willSetLook
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:35
Parameters
- newLook: null | Look<null | Length, never>
- oldLook: null | Look<null | Length, never>
- timing: boolean | Timing
Returns void

willSetPrecedence

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

Inherited from AttributeAnimator.willSetPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:43
Parameters
- newPrecedence: number
- oldPrecedence: number
Returns void

Protected willSetState

willSetState(newState: null | Length, oldState: null | Length): void

Inherited from AttributeAnimator.willSetState
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:27
Parameters
- newState: null | Length
- oldState: null | Length
Returns void

willSetValue

willSetValue(newValue: null | Length, oldValue: null | Length): void

Inherited from AttributeAnimator.willSetValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:14
Parameters
- newValue: null | Length
- oldValue: null | Length
Returns void

willStartAnimating

willStartAnimating(): void

Inherited from AttributeAnimator.willStartAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:68
Returns void

willStopAnimating

willStopAnimating(): void

Inherited from AttributeAnimator.willStopAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:70
Returns void

willUnmount

willUnmount(): void

Inherited from AttributeAnimator.willUnmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:81
Returns void

Static define

define<V_10, T_10, U_10, I_2>(descriptor: AttributeAnimatorDescriptorExtends<V_10, T_10, U_10, I_2>): AttributeAnimatorConstructor<V_10, T_10, U_10, I_2>
define<V_11, T_11, U_11>(descriptor: AttributeAnimatorDescriptor<V_11, T_11, U_11, {}>): AttributeAnimatorConstructor<V_11, T_11, U_11, {}>

Inherited from AttributeAnimator.define
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:111
Type parameters
- V_10: ElementView<V_10>
- T_10
- U_10 = never
- I_2 = {}
Parameters
- descriptor: AttributeAnimatorDescriptorExtends<V_10, T_10, U_10, I_2>
Returns AttributeAnimatorConstructor<V_10, T_10, U_10, I_2>
Inherited from AttributeAnimator.define
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:112
Type parameters
- V_11: ElementView<V_11>
- T_11
- U_11 = never
Parameters
- descriptor: AttributeAnimatorDescriptor<V_11, T_11, U_11, {}>
Returns AttributeAnimatorConstructor<V_11, T_11, U_11, {}>

Static getClass

getClass(type: unknown): null | AttributeAnimatorClass

Inherited from AttributeAnimator.getClass
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:110
Parameters
- type: unknown
Returns null | AttributeAnimatorClass

Generated using TypeDoc