InteractionAPI

Interface InteractionAPI

InteractionAPI

Overview

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

Quick Start

Example

// Get the webvis default context
const myContext = webvis.getContext();

// Switch to another interaction mode
myContext.setInteractionMode(webvis.InteractionMode.MEASUREMENT_DOUBLE);

// Get the current interaction mode
const activeInteractionMode = myContext.getInteractionMode();

// Leave the double measurement mode and switch back to the default interaction behaviour.
myContext.resetInteractionMode();

Events

The InteractionAPI emits the following events:

interface InteractionAPI {
    getInteractionMode(): InteractionMode;
    isColorComparisonActive(): boolean;
    processInteractionInput(interactionData: InteractionData): void;
    resetInteractionMode(keepColorCompareActive?: boolean): void;
    setInteractionMode(
        mode: string | string[],
        keepColorCompareActive?: boolean,
    ): void;
    setInteractionMode(
        mode: InteractionMode,
        keepColorCompareActive?: boolean,
    ): void;
}

Hierarchy (View Summary)

Methods

getInteractionMode isColorComparisonActive processInteractionInput resetInteractionMode setInteractionMode

Methods

getInteractionMode

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

    Returns void

resetInteractionMode

  • resetInteractionMode(keepColorCompareActive?: boolean): void

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

    Parameters

    • OptionalkeepColorCompareActive: boolean

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

    Returns void

    See

    isColorComparisonActive

setInteractionMode

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

  • Set the current interaction mode.

    Parameters

    • mode: string | string[]

      Specifies the interaction mode you want set.

    • OptionalkeepColorCompareActive: boolean

      Specifies 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.

    See

    isColorComparisonActive

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

  • Set the current interaction mode.

    Parameters

    • mode: InteractionMode

      Specifies the interaction mode you want set.

    • OptionalkeepColorCompareActive: boolean

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

    Returns void

    See

    isColorComparisonActive



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