InteractionAPIΒΆ
Interface InteractionAPI
Hierarchy
- InteractionAPI
Methods
get Interaction Mode
- get
Interaction Mode(): InteractionMode -
Returns the current Interaction mode.
Returns InteractionMode
The current Interaction mode.
is Color Comparison Active
process Interaction Input
- process
Interaction Input(interactionData): void -
Triggers an interaction on the current active interaction mode.
Parameters
-
interactionData: InteractionData
Definition of the triggered Interaction.
Returns void
-
reset Interaction Mode
set Interaction Mode
- set
Interaction Mode(mode, keepColorCompareActive?): void -
Set the current interaction mode.
Parameters
-
mode: string | string[]
Specifies the interaction mode you want set.
-
Optional
keepColorCompareActive: booleanSpecifies if the color comparison mode should stay active. (Default: false)
Returns void
Deprecated
Calling setInteractionMode with the mode parameter of type string or string[] is deprecated, please use the InteractionMode enum instead.
-
- set
Interaction Mode(mode, keepColorCompareActive?): void -
Set the current interaction mode.
Parameters
-
mode: InteractionMode
Specifies the interaction mode you want set.
-
Optional
keepColorCompareActive: booleanSpecifies if the color comparison mode should stay active. (Default: false)
Returns void
-
The InteractionAPI provides functionalities to control the current interaction behavior by switching between different predefined interaction modes.
Example