Skip to main content

publicOverlayGridTool

Hierarchy

AnnotationDisplayTool
- OverlayGridTool

Constructors

constructor

new OverlayGridTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): OverlayGridTool

Overrides AnnotationDisplayTool.constructor
Parameters
- toolProps: PublicToolProps = {}
- defaultToolProps: SharedToolProp = ...
Returns OverlayGridTool

Properties

_throttledCalculateCachedStats

_throttledCalculateCachedStats: any

publicconfiguration

configuration: Record<string, any>

isDrawing

isDrawing: boolean

isHandleOutsideImage

isHandleOutsideImage: boolean

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

publicmouseDragCallback

mouseDragCallback: any

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

publictouchDragCallback

touchDragCallback: any

statictoolName

toolName: any

Methods

_init

_init(): void

Returns void

publicapplyActiveStrategy

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

Inherited from AnnotationDisplayTool.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 AnnotationDisplayTool.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.

calculateImageIdPointSets

calculateImageIdPointSets(imageId: string): { pointSet1: Point3[]; pointSet2: Point3[] }

Calculates the point sets based on the image corners relative to an imageId
Parameters
- imageId: string
  The imageId to calculate the point sets for
Returns { pointSet1: Point3[]; pointSet2: Point3[] }
- pointSet1: Point3[]
- pointSet2: Point3[]

filterInteractableAnnotationsForElement

filterInteractableAnnotationsForElement(element: HTMLDivElement, annotations: Annotations): Annotations

Inherited from AnnotationDisplayTool.filterInteractableAnnotationsForElement
Given the element and annotations which is an array of annotation, it filters the annotations array to only include the annotation based on the viewportType. If the viewport is StackViewport, it filters based on the current imageId of the viewport, if the viewport is volumeViewport, it only returns those that are within the same slice as the current rendered slice in the volume viewport. imageId as the enabledElement.
Parameters
- element: HTMLDivElement
  The HTML element
- annotations: Annotations
  The annotations to filter (array of annotation)
Returns Annotations
The filtered annotations

publicgetStyle

getStyle(property: string, specifications: StyleSpecifier, annotation?: Annotation): unknown

Inherited from AnnotationDisplayTool.getStyle
It takes the property (color, lineDash, etc.) and based on the state of the annotation (selected, highlighted etc.) it returns the appropriate value based on the central toolStyle settings for each level of specification.
Parameters
- property: string
  The name of the style property to get.
- specifications: StyleSpecifier
- optionalannotation: Annotation
  The annotation for the tool that is currently active.
Returns unknown
The value of the property.

publicgetToolName

getToolName(): string

Inherited from AnnotationDisplayTool.getToolName
Returns the name of the tool
Returns string
The name of the tool.

publiconImageSpacingCalibrated

onImageSpacingCalibrated(evt: ImageSpacingCalibratedEvent): void

Inherited from AnnotationDisplayTool.onImageSpacingCalibrated
On Image Calibration, take all the annotation from the AnnotationState manager, and invalidate them to force them to be re-rendered and their stats to be recalculated. Then use the old and new imageData (non-calibrated and calibrated) to calculate the new position for the annotations in the space of the new imageData.
Parameters
- evt: ImageSpacingCalibratedEvent
  The calibration event
Returns void

onSetToolActive

onSetToolActive(): void

Returns void

onSetToolEnabled

onSetToolEnabled(): void

Returns void

renderAnnotation

renderAnnotation(enabledElement: IEnabledElement, svgDrawingHelper: SVGDrawingHelper): boolean

Overrides AnnotationDisplayTool.renderAnnotation
it is used to draw the length annotation in each request animation frame. It calculates the updated cached statistics if data is invalidated and cache it.
Parameters
- enabledElement: IEnabledElement
  The Cornerstone’s enabledElement.
- svgDrawingHelper: SVGDrawingHelper
  The svgDrawingHelper providing the context for drawing.
Returns boolean

publicsetActiveStrategy

setActiveStrategy(strategyName: string): void

Inherited from AnnotationDisplayTool.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 AnnotationDisplayTool.setConfiguration
merges the new configuration with the tool configuration
Parameters
- newConfiguration: Record<string, any>
Returns void