publicBrushTool

Hierarchy

• BaseTool
  • BrushTool

Index

Constructors

• constructor

Properties

• configuration
• mode
• supportedInteractionTypes
• toolGroupId
• toolName

Methods

• applyActiveStrategy
• getToolName
• invalidateBrushCursor
• mouseMoveCallback
• onSetToolDisabled
• onSetToolEnabled
• onSetToolPassive
• preMouseDownCallback
• renderAnnotation
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new BrushTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): BrushTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: PublicToolProps = {}

  • defaultToolProps: SharedToolProp = ...

  Returns BrushTool

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

publicapplyActiveStrategy

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

• Inherited from BaseTool.applyActiveStrategy

  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

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

publicinvalidateBrushCursor

• invalidateBrushCursor(): void

• Returns void

mouseMoveCallback

• mouseMoveCallback(evt: InteractionEventType): void

• Parameters

  • evt: InteractionEventType

  Returns void

onSetToolDisabled

• onSetToolDisabled(): void

• Returns void

onSetToolEnabled

• onSetToolEnabled(): void

• Returns void

onSetToolPassive

• onSetToolPassive(): void

• Returns void

preMouseDownCallback

• preMouseDownCallback(evt: MouseDownActivateEventType): boolean

• Parameters

  • evt: MouseDownActivateEventType

  Returns boolean

renderAnnotation

• renderAnnotation(enabledElement: IEnabledElement, svgDrawingHelper: SVGDrawingHelper): void

• Parameters

  • enabledElement: IEnabledElement

  • svgDrawingHelper: SVGDrawingHelper

  Returns void

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