Skip to main content

publicScaleOverlayTool

@memberof

Tools

@classdesc

Tool for displaying a scale overlay on the image.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_throttledCalculateCachedStats

_throttledCalculateCachedStats: any

publicconfiguration

configuration: Record<string, any>

editData

editData: { annotation: ScaleOverlayAnnotation; renderingEngine: any; viewport: any } = ...

Type declaration

  • annotation: ScaleOverlayAnnotation
  • renderingEngine: any
  • viewport: 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

_getTextLines

  • _getTextLines(scaleSize: number): string[]

  • Parameters

    • scaleSize: number

    Returns string[]

_init

  • _init(): void

  • Returns void

publicapplyActiveStrategy

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

  • 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

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

computeCanvasScaleCoordinates

  • computeCanvasScaleCoordinates(canvasSize: any, canvasCoordinates: any, vscaleBounds: any, hscaleBounds: any, location: any): any

  • Computes the centered canvas coordinates for scale

    Parameters

    • canvasSize: any
    • canvasCoordinates: any
    • vscaleBounds: any
    • hscaleBounds: any
    • location: any

    Returns any

    scaleCanvasCoordinates

computeEndScaleTicks

  • computeEndScaleTicks(canvasCoordinates: any, location: any): { endTick1: any[][]; endTick2: any[][] }

  • calculates scale ticks for ends of the scale

    Parameters

    • canvasCoordinates: any
    • location: any

    Returns { endTick1: any[][]; endTick2: any[][] }

    leftTick, rightTick

    • endTick1: any[][]
    • endTick2: any[][]

computeInnerScaleTicks

  • computeInnerScaleTicks(scaleSize: number, location: string, annotationUID: string, leftTick: any[][], rightTick: any[][]): { tickCoordinates: any[]; tickIds: any[]; tickUIDs: any[] }

  • Parameters

    • scaleSize: number
    • location: string
    • annotationUID: string
    • leftTick: any[][]
    • rightTick: any[][]

    Returns { tickCoordinates: any[]; tickIds: any[]; tickUIDs: any[] }

    • tickCoordinates: any[]
    • tickIds: any[]
    • tickUIDs: any[]

computeScaleBounds

  • computeScaleBounds(canvasSize: any, horizontalReduction: any, verticalReduction: any, location: any): { height: any; width: any }

  • Computes the max bound for scales on the image

    Parameters

    • canvasSize: any
    • horizontalReduction: any
    • verticalReduction: any
    • location: any

    Returns { height: any; width: any }

    • height: any
    • width: any

computeScaleSize

  • computeScaleSize(worldWidthViewport: number, worldHeightViewport: number, location: any): any

  • Parameters

    • worldWidthViewport: number
    • worldHeightViewport: number
    • location: any

    Returns any

    currentScaleSize

computeWorldScaleCoordinates

  • computeWorldScaleCoordinates(scaleSize: any, location: any, pointSet: any): any

  • Parameters

    • scaleSize: any
    • location: any
    • pointSet: any

    Returns any

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

  • 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

  • Returns the name of the tool

    Returns string

    The name of the tool.

onCameraModified

  • onCameraModified(evt: CameraModifiedEvent): void

  • Parameters

    • evt: CameraModifiedEvent

    Returns void

publiconImageSpacingCalibrated

  • onImageSpacingCalibrated(evt: ImageSpacingCalibratedEvent): void

  • 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

onSetToolEnabled

  • onSetToolEnabled(): void

  • Returns void

renderAnnotation

  • Used to draw the scale annotation in each request animation frame.

    Parameters

    • enabledElement: IEnabledElement

      The Cornerstone’s enabledElement.

    • svgDrawingHelper: SVGDrawingHelper

      The svgDrawingHelper providing the context for drawing.

    Returns boolean

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