BooleanAttributeAnimator

Type parameters

V: ElementView

Hierarchy

AttributeAnimator<V, boolean | undefined, string>
- BooleanAttributeAnimator

Callable

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

- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:50
Returns undefined | boolean
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:51
Parameters
- newState: undefined | string | boolean
- 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: undefined | string | boolean
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns V

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Inherited from AttributeAnimator<V, boolean | undefined, string>.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 BooleanAttributeAnimator<V>

Properties

Readonly animatorFlags

animatorFlags: number

Readonly attributeName

attributeName: string

Readonly attributeValue

attributeValue: undefined | boolean

Readonly interpolator

interpolator: null | Interpolator<undefined | boolean>

Readonly name

name: string

Readonly node

node: Node

Readonly ownLook

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

Readonly ownState

ownState: undefined | boolean

Readonly ownValue

ownValue: undefined | boolean

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<undefined | boolean, 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<undefined | boolean, 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<undefined | boolean, never>, oldLook: null | Look<undefined | boolean, 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<undefined | boolean, never>
- oldLook: null | Look<undefined | boolean, 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: undefined | boolean, oldState: undefined | boolean): void

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

didSetValue

didSetValue(newValue: undefined | boolean, oldValue: undefined | boolean): void

Inherited from AttributeAnimator.didSetValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:16
Parameters
- newValue: undefined | boolean
- oldValue: undefined | boolean
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: undefined | boolean, oldState: undefined | boolean): boolean

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

fromAny

fromAny(value: string | boolean): undefined | boolean

Overrides AttributeAnimator.fromAny
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/BooleanAttributeAnimator.d.ts:5
Parameters
- value: string | boolean
Returns undefined | boolean

getState

getState(): boolean

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

getStateOr

getStateOr<E>(elseState: E): boolean | 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 boolean | E

getValue

getValue(): boolean

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

getValueOr

getValueOr<E>(elseValue: E): boolean | 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 boolean | 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: undefined | boolean): boolean

Inherited from AttributeAnimator.isDefined
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:8
Parameters
- value: undefined | boolean
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: undefined | boolean): void

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

onEnd

onEnd(value: undefined | boolean): void

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

onInterrupt

onInterrupt(value: undefined | boolean): void

Inherited from AttributeAnimator.onInterrupt
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:64
Parameters
- value: undefined | boolean
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<undefined | boolean, never>, oldLook: null | Look<undefined | boolean, 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<undefined | boolean, never>
- oldLook: null | Look<undefined | boolean, 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: undefined | boolean, oldState: undefined | boolean): void

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

onSetValue

onSetValue(newValue: undefined | boolean, oldValue: undefined | boolean): void

Inherited from AttributeAnimator.onSetValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:60
Parameters
- newValue: undefined | boolean
- oldValue: undefined | boolean
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): undefined | boolean

Overrides AttributeAnimator.parse
- Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/BooleanAttributeAnimator.d.ts:4
Parameters
- value: string
Returns undefined | boolean

setAnimatedState

setAnimatedState(newState: undefined | boolean, oldState: undefined | boolean, 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: undefined | boolean
- oldState: undefined | boolean
- 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: undefined | boolean, oldState: undefined | boolean): void

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

setIntermediateValue

setIntermediateValue(newValue: undefined | boolean, newState?: boolean): void

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

setLook

setLook(newLook: null | Look<undefined | boolean, never>, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
setLook(newLook: null | Look<undefined | boolean, 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<undefined | boolean, 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<undefined | boolean, never>
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns void

setOwnLook

setOwnLook(newLook: null | Look<undefined | boolean, 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<undefined | boolean, never>
- Optional timing: boolean | AnyTiming
Returns void

setOwnState

setOwnState(newState: undefined | string | boolean, 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: undefined | string | boolean
- 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: undefined | string | boolean, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
setState(newState: undefined | string | boolean, 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: undefined | string | boolean
- 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: undefined | string | boolean
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns void

setValue

setValue(newValue: undefined | boolean, oldValue?: boolean): void

Inherited from AttributeAnimator.setValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:13
Parameters
- newValue: undefined | boolean
- Optional oldValue: boolean
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 | boolean

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

takeValue

takeValue(): undefined | boolean

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

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<undefined | boolean, never>, oldLook: null | Look<undefined | boolean, 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<undefined | boolean, never>
- oldLook: null | Look<undefined | boolean, 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: undefined | boolean, oldState: undefined | boolean): void

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

willSetValue

willSetValue(newValue: undefined | boolean, oldValue: undefined | boolean): void

Inherited from AttributeAnimator.willSetValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/Animator.d.ts:14
Parameters
- newValue: undefined | boolean
- oldValue: undefined | boolean
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

Type parameters

V: ElementView

Hierarchy

Callable

Returns undefined | boolean

Parameters

newState: undefined | string | boolean

precedenceOrTiming: undefined | number | boolean | AnyTiming

Returns V

Parameters

newState: undefined | string | boolean

Optional timing: boolean | AnyTiming

Optional precedence: number

Returns V

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

V: ElementView<V>

Parameters

owner: V

animatorName: string

Returns BooleanAttributeAnimator<V>

Properties

Readonly animatorFlags

Readonly attributeName

Readonly attributeValue

Readonly interpolator

Readonly name

Readonly node

Readonly ownLook

Readonly ownState

Readonly ownValue

Readonly owner

Readonly precedence

Readonly timing

Optional updateFlags

Accessors

look

Returns null | Look<T, never>

state

Returns T

updatedValue

Returns undefined | T

value

Returns T

Methods

applyLook

Parameters

look: Look<undefined | boolean, never>

timing: boolean | Timing

Returns void

applyTheme

Parameters

theme: ThemeMatrix

mood: MoodVector<Feel>

timing: boolean | Timing

Returns void

didMount

Returns void

didSetLook

Parameters

newLook: null | Look<undefined | boolean, never>

oldLook: null | Look<undefined | boolean, never>

timing: boolean | Timing

Returns void

didSetPrecedence

Parameters

newPrecedence: number

oldPrecedence: number

Returns void

Protected didSetState

Parameters

newState: undefined | boolean

oldState: undefined | boolean

Returns void