Class Events

Enhance the relevant events for rawPosition attribute.

Hierarchy (view full)

Constructors

constructor

Properties

currentPosition$Changed currentPosition$Changing eventNames initialPress? interactionBegin interactionEnd longPress? longRelease? multiPressComplete? multiPressMax$Changed multiPressMax$Changing multiPressOngoing? numberOfPositions$Changed numberOfPositions$Changing rawPosition$Changed rawPosition$Changing shortRelease? switchLatched?

Methods

[dispose] addListener emit removeListener

Constructors

constructor

  • new Events(): Events

  • Returns Events

Properties

currentPosition$Changed

currentPosition$Changed: ClusterEvents.AttributeObservable<Attribute<number, any>>

currentPosition$Changing

currentPosition$Changing: ClusterEvents.AttributeObservable<Attribute<number, any>>

eventNames

eventNames: string[]

Optional ReadonlyinitialPress

initialPress?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    newPosition: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitch: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

interactionBegin

interactionBegin: Observable<[], void>

Emitted when state associated with this behavior is first mutated by a specific interaction.

interactionEnd

interactionEnd: AsyncObservable<[], void>

Emitted when a mutating interaction completes.

Optional ReadonlylongPress

longPress?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    newPosition: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchLongPress: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

Optional ReadonlylongRelease

longRelease?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    previousPosition: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchLongPress: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

Optional ReadonlymultiPressComplete

multiPressComplete?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    previousPosition: FieldType<number>;
    totalNumberOfPressesCounted: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchMultiPress: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

multiPressMax$Changed

multiPressMax$Changed: undefined | ClusterEvents.AttributeObservable<FixedAttribute<number, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchMultiPress: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

multiPressMax$Changing

multiPressMax$Changing: undefined | ClusterEvents.AttributeObservable<FixedAttribute<number, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchMultiPress: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

Optional ReadonlymultiPressOngoing

multiPressOngoing?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    currentNumberOfPressesCounted: FieldType<number>;
    newPosition: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchMultiPress: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

numberOfPositions$Changed

numberOfPositions$Changed: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>

numberOfPositions$Changing

numberOfPositions$Changing: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>

rawPosition$Changed

rawPosition$Changed: Observable<[value: number, oldValue: number, context?: ActionContext], void>

rawPosition$Changing

rawPosition$Changing: Observable<[value: number, oldValue: number, context?: ActionContext], void>

Optional ReadonlyshortRelease

shortRelease?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    previousPosition: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        momentarySwitchRelease: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

Optional ReadonlyswitchLatched

switchLatched?: ClusterEvents.EventObservable<Event<TypeFromFields<{
    newPosition: FieldType<number>;
}>, any> & {
    isConditional: true;
    mandatoryIf: [] | [{
        latchingSwitch: boolean;
    }];
    optional: true;
    optionalIf: [] | ConditionalFeatureList<BitSchema>;
}>

Methods

[dispose]

  • [dispose](): void

  • Returns void

addListener

  • addListener<This, N>(this, name, handler): void

  • Type Parameters

    • This
    • N extends string

    Parameters

    Returns void

emit

  • emit<This, N>(this, name, ...payload): void

  • Type Parameters

    • This
    • N extends string

    Parameters

    Returns void

removeListener

  • removeListener<This, N>(this, name, handler): void

  • Type Parameters

    • This
    • N extends string

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods