Class ZoomAcceptingUserInputState

Hierarchy (View Summary)

TemplateState<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- ZoomAcceptingUserInputState

Index

Constructors

constructor

new ZoomAcceptingUserInputState(): ZoomAcceptingUserInputState
Returns ZoomAcceptingUserInputState
Inherited from TemplateState.constructor

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        ZoomEventPayloadMapping,
        ZoomControlStates,
        ZoomContext,
        Guard<ZoomContext, string>,
    >,
> = {}

`Protected`_guards

_guards: Guard<ZoomContext> = {}

Accessors

eventGuards

get eventGuards(): Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Returns Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Inherited from TemplateState.eventGuards
- Defined in being/interfaces.ts:115

eventReactions

get eventReactions(): Partial<
EventAction<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>,
>
Returns Partial<EventAction<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>>
Overrides TemplateState.eventReactions
- Defined in control-center/zoom-control-state-machine.ts:57

guards

get guards(): Guard<Context>
Returns Guard<Context>
Inherited from TemplateState.guards
- Defined in being/interfaces.ts:111

Methods

handles

handles<K extends keyof ZoomEventPayloadMapping>(
    stateMachine: StateMachine<
        ZoomEventPayloadMapping,
        ZoomContext,
        ZoomControlStates,
    >,
    event: K,
    payload: ZoomEventPayloadMapping[K],
    context: ZoomContext,
): ZoomControlStates
Type Parameters
- K extends keyof ZoomEventPayloadMapping
Parameters
- stateMachine: StateMachine<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- event: K
- payload: ZoomEventPayloadMapping[K]
- context: ZoomContext
Returns ZoomControlStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:127

initiateTransition

initiateTransition(
    stateMachine: StateMachine<
        ZoomEventPayloadMapping,
        ZoomContext,
        ZoomControlStates,
    >,
    context: ZoomContext,
    payload: {},
): ZoomControlStates
Parameters
- stateMachine: StateMachine<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- context: ZoomContext
- payload: {}
Returns ZoomControlStates
- Defined in control-center/zoom-control-state-machine.ts:71

uponEnter

uponEnter(
    stateMachine: StateMachine<
        ZoomEventPayloadMapping,
        ZoomContext,
        ZoomControlStates,
    >,
    context: ZoomContext,
): void
Parameters
- stateMachine: StateMachine<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- context: ZoomContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:119

uponLeave

uponLeave(
    stateMachine: StateMachine<
        ZoomEventPayloadMapping,
        ZoomContext,
        ZoomControlStates,
    >,
    context: ZoomContext,
): void
Parameters
- stateMachine: StateMachine<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- context: ZoomContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:123

userZoomByAtInput

userZoomByAtInput(
    stateMachine: StateMachine<
        ZoomEventPayloadMapping,
        ZoomContext,
        ZoomControlStates,
    >,
    context: ZoomContext,
    payload: ZoomByAtInputPayload,
): ZoomControlStates
Parameters
- stateMachine: StateMachine<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- context: ZoomContext
- payload: ZoomByAtInputPayload
Returns ZoomControlStates
- Defined in control-center/zoom-control-state-machine.ts:61

userZoomToAtInput

userZoomToAtInput(
    stateMachine: StateMachine<
        ZoomEventPayloadMapping,
        ZoomContext,
        ZoomControlStates,
    >,
    context: ZoomContext,
    payload: ZoomToAtInputPayload,
): ZoomControlStates
Parameters
- stateMachine: StateMachine<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>
- context: ZoomContext
- payload: ZoomToAtInputPayload
Returns ZoomControlStates
- Defined in control-center/zoom-control-state-machine.ts:66

Class ZoomAcceptingUserInputState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ZoomAcceptingUserInputState

Properties

Protected_eventGuards

Protected_guards

Accessors

eventGuards

Returns Partial< EventGuards< EventPayloadMapping, States, Context, Guard<Context, string>, >,>

eventReactions

Returns Partial<EventAction<ZoomEventPayloadMapping, ZoomContext, ZoomControlStates>>

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns ZoomControlStates

initiateTransition

Parameters

Returns ZoomControlStates

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

userZoomByAtInput

Parameters

Returns ZoomControlStates

userZoomToAtInput

Parameters

Returns ZoomControlStates

Settings

On This Page

`Protected`_eventGuards

`Protected`_guards

Returns Partial<
EventGuards<
EventPayloadMapping,
States,
Context,
Guard<Context, string>,
>,
>