InteractionData

Interface InteractionData

Contains the properties of an interaction.

See

InteractionAPI.processInteractionInput

interface InteractionData {
    modifier?: InteractionModifier;
    origin?: any;
    originalEvent?: Event;
    pointerInfo?: PointerInfo;
    targetID: number;
    targetName?: string;
    type?: InteractionType;
}

Properties

modifier? origin? originalEvent? pointerInfo? targetID targetName? type?

Properties

Optionalmodifier

modifier?: InteractionModifier

The interaction modifier that is applied to the interaction.

Optionalorigin

origin?: any

Optional property storing information about where the interaction originated from (e.g. the DOM element that triggered the interaction).

OptionaloriginalEvent

originalEvent?: Event

The original event that triggered the interaction.

OptionalpointerInfo

pointerInfo?: PointerInfo

Pointer information related to the interaction.

targetID

targetID: number

The ID of the target node or node collection that the interaction is applied to.

See

CollectionAPI for node collections as targetID

OptionaltargetName

targetName?: string

Optional property for transporting the target's name to the interaction.

Optionaltype

type?: InteractionType

Whether the target was interacted with via picking or by ID.



Was this page helpful? Please leave a thumbs up or down.