InteractionAPI

• webVis API Reference
• InteractionAPI

Interface InteractionAPI

The InteractionAPI provides functionalities to control the current interaction behavior by switching between different predefined interaction modes.

Example

// Activate the predefined mode to perform a double measurement.
myContext.setInteractionMode(webvis.InteractionMode.MEASUREMENT_DOUBLE);

// Leave the double measurement mode and switch back to the default interaction behaviour.
myContext.setInteractionMode(webvis.InteractionMode.DEFAULT);

Hierarchy

• InteractionAPI
  • ContextAPI

Index

Methods

getInteractionMode isColorComparisonActive processInteractionInput resetInteractionMode setInteractionMode

Methods

getInteractionMode

• getInteractionMode(): InteractionMode

• Returns the current Interaction mode.

  Returns InteractionMode

  The current Interaction mode.

isColorComparisonActive

• isColorComparisonActive(): boolean

• Checks if the color comparison mode is active.

  Returns boolean

  true if the color comparison mode is active, otherwise false.

processInteractionInput

• processInteractionInput(interactionData: InteractionData): void

• Triggers an interaction on the current active interaction mode.

  Parameters

  • interactionData: InteractionData

    Definition of the triggered Interaction.

  Returns void

resetInteractionMode

• resetInteractionMode(keepColorCompareActive?: boolean): void

• Sets the current interaction mode back to the Default mode.

  Parameters

  • Optional keepColorCompareActive: boolean

    Specifies if the color comparison mode should stay active. (Default: false)

  Returns void

setInteractionMode

• setInteractionMode(mode: string | string[], keepColorCompareActive?: boolean): void

• Set the current interaction mode.

  Deprecated

  Calling setInteractionMode with the mode parameter of type string or string[] is deprecated, please use the InteractionMode enum instead.

  Parameters

  • mode: string | string[]

    Specifies the interaction mode you want set.

  • Optional keepColorCompareActive: boolean

    Specifies if the color comparison mode should stay active. (Default: false)

  Returns void

• setInteractionMode(mode: InteractionMode, keepColorCompareActive?: boolean): void

• Set the current interaction mode.

  Parameters

  • mode: InteractionMode

    Specifies the interaction mode you want set.

  • Optional keepColorCompareActive: boolean

    Specifies if the color comparison mode should stay active. (Default: false)

  Returns void