EraserTool

Abstract base class from which all tools derive. Deals with cleanly merging custom and default configuration, and strategy application.

Hierarchy

• BaseTool
  • EraserTool

Index

Constructors

• constructor

Properties

• configuration
• mode
• supportedInteractionTypes
• toolGroupId
• toolName

Methods

• _deleteNearbyAnnotations
• applyActiveStrategy
• applyActiveStrategyCallback
• getToolName
• preMouseDownCallback
• preTouchStartCallback
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new EraserTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): AnnotationEraserTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: PublicToolProps = {}

  • defaultToolProps: SharedToolProp = ...

  Returns AnnotationEraserTool

Properties

publicconfiguration

configuration: Record<string, any>

Inherited from BaseTool.configuration

publicmode

mode: ToolModes

Inherited from BaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Inherited from BaseTool.supportedInteractionTypes

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

Inherited from BaseTool.toolGroupId

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Overrides BaseTool.toolName

Methods

_deleteNearbyAnnotations

• _deleteNearbyAnnotations(evt: InteractionEventType, interactionType: string): boolean

• Parameters

  • evt: InteractionEventType

  • interactionType: string

  Returns boolean

publicapplyActiveStrategy

• applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any

• Inherited from BaseTool.applyActiveStrategy

  Applies the active strategy function to the enabled element with the specified operation data.

  ---

  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.

publicapplyActiveStrategyCallback

• applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): any

• Inherited from BaseTool.applyActiveStrategyCallback

  Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.

  ---

  Parameters

  • enabledElement: IEnabledElement

    The element that is being operated on.

  • operationData: unknown

    The data that needs to be passed to the strategy.

  • callbackType: string

    the type of the callback

  Returns any

  The result of the strategy.

publicgetToolName

• getToolName(): string

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

preMouseDownCallback

• preMouseDownCallback(evt: InteractionEventType): boolean

• Parameters

  • evt: InteractionEventType

  Returns boolean

preTouchStartCallback

• preTouchStartCallback(evt: InteractionEventType): boolean

• Parameters

  • evt: InteractionEventType

  Returns boolean

publicsetActiveStrategy

• setActiveStrategy(strategyName: string): void

• Inherited from BaseTool.setActiveStrategy

  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

• Inherited from BaseTool.setConfiguration

  merges the new configuration with the tool configuration

  ---

  Parameters

  • newConfiguration: Record<string, any>

  Returns void