Skip to main content

StackScrollMouseWheelTool

The StackScrollMouseWheelTool is a tool that allows the user to scroll through a stack of images using the mouse wheel

Hierarchy

Index

Constructors

constructor

  • new StackScrollMouseWheelTool(toolProps?: {}, defaultToolProps?: { configuration: { debounceIfNotLoaded: boolean; invert: boolean }; supportedInteractionTypes: string[] }): default
  • Parameters

    • toolProps: {} = {}
    • defaultToolProps: { configuration: { debounceIfNotLoaded: boolean; invert: boolean }; supportedInteractionTypes: string[] } = ...

    Returns default

Properties

_configuration

_configuration: any

publicconfiguration

configuration: Record<string, any>

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: Mouse[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

statictoolName

toolName: string = 'StackScrollMouseWheel'

Methods

publicapplyActiveStrategy

  • applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any
  • It applies the active strategy to the enabled element.


    Parameters

    • enabledElement: IEnabledElement

      The element that is being operated on.

    • operationData: unknown

      The data that needs to be passed to the strategy.

    Returns any

    The result of the strategy.

publicgetToolName

  • getToolName(): string
  • Returns the name of the tool


    Returns string

    The name of the tool.

mouseWheelCallback

  • mouseWheelCallback(evt: MouseWheelEventType): void
  • Parameters

    • evt: MouseWheelEventType

    Returns void

publicsetActiveStrategy

  • setActiveStrategy(strategyName: string): void
  • Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.


    Parameters

    • strategyName: string

      name of the strategy to be set as active

    Returns void

publicsetConfiguration

  • setConfiguration(newConfiguration: Record<string, any>): void
  • merges the new configuration with the tool configuration


    Parameters

    • newConfiguration: Record<string, any>

    Returns void