Skip to content

Commit

Permalink
Updated the API docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jbocce committed Jul 12, 2023
1 parent 79ef251 commit 43b0376
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 13 deletions.
22 changes: 10 additions & 12 deletions common/reviews/api/tools.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,7 @@ export class CircleROITool extends AnnotationTool {
// (undocumented)
addNewAnnotation: (evt: EventTypes_2.InteractionEventType) => CircleROIAnnotation;
// (undocumented)
_calculateCachedStats: (annotation: any, viewport: any, renderingEngine: any, enabledElement: any) => any;
_calculateCachedStats: (annotation: any, viewport: any, renderingEngine: any, enabledElement: any, modalityUnitOptions: ModalityUnitOptions) => any;
// (undocumented)
cancel: (element: HTMLDivElement) => any;
// (undocumented)
Expand All @@ -700,7 +700,7 @@ export class CircleROITool extends AnnotationTool {
// (undocumented)
_endCallback: (evt: EventTypes_2.InteractionEventType) => void;
// (undocumented)
_getTextLines: (data: any, targetId: string, isPreScaled: boolean, isSuvScaled: boolean) => string[];
_getTextLines: (data: any, targetId: string) => string[];
// (undocumented)
handleSelectedCallback: (evt: EventTypes_2.InteractionEventType, annotation: CircleROIAnnotation, handle: ToolHandle) => void;
// (undocumented)
Expand Down Expand Up @@ -1652,7 +1652,7 @@ export class EllipticalROITool extends AnnotationTool {
// (undocumented)
addNewAnnotation: (evt: EventTypes_2.InteractionEventType) => EllipticalROIAnnotation;
// (undocumented)
_calculateCachedStats: (annotation: any, viewport: any, renderingEngine: any, enabledElement: any) => any;
_calculateCachedStats: (annotation: any, viewport: any, renderingEngine: any, enabledElement: any, modalityUnitOptions: ModalityUnitOptions) => any;
// (undocumented)
cancel: (element: HTMLDivElement) => any;
// (undocumented)
Expand Down Expand Up @@ -1683,7 +1683,7 @@ export class EllipticalROITool extends AnnotationTool {
// (undocumented)
_getCanvasEllipseCenter(ellipseCanvasPoints: Types_2.Point2[]): Types_2.Point2;
// (undocumented)
_getTextLines: (data: any, targetId: string, isPreScaled: boolean, isSuvScaled: boolean) => string[];
_getTextLines: (data: any, targetId: string) => string[];
// (undocumented)
handleSelectedCallback: (evt: EventTypes_2.InteractionEventType, annotation: EllipticalROIAnnotation, handle: ToolHandle) => void;
// (undocumented)
Expand Down Expand Up @@ -3670,13 +3670,13 @@ export class PlanarFreehandROITool extends AnnotationTool {
// (undocumented)
addNewAnnotation: (evt: EventTypes_2.InteractionEventType) => PlanarFreehandROIAnnotation;
// (undocumented)
_calculateCachedStats: (annotation: any, viewport: any, renderingEngine: any, enabledElement: any) => any;
_calculateCachedStats: (annotation: any, viewport: any, renderingEngine: any, enabledElement: any, modalityUnitOptions: ModalityUnitOptions) => any;
// (undocumented)
cancel: (element: HTMLDivElement) => void;
// (undocumented)
filterInteractableAnnotationsForElement(element: HTMLDivElement, annotations: Annotations): Annotations | undefined;
// (undocumented)
_getTextLines: (data: any, targetId: string, isPreScaled: boolean, isSuvScaled: boolean) => string[];
_getTextLines: (data: any, targetId: string) => string[];
// (undocumented)
handleSelectedCallback: (evt: EventTypes_2.InteractionEventType, annotation: PlanarFreehandROIAnnotation, handle: ToolHandle) => void;
// (undocumented)
Expand Down Expand Up @@ -3822,7 +3822,7 @@ export class ProbeTool extends AnnotationTool {
// (undocumented)
addNewAnnotation: (evt: EventTypes_2.InteractionEventType) => ProbeAnnotation;
// (undocumented)
_calculateCachedStats(annotation: any, renderingEngine: any, enabledElement: any): any;
_calculateCachedStats(annotation: any, renderingEngine: any, enabledElement: any, modalityUnitOptions: ModalityUnitOptions): any;
// (undocumented)
cancel: (element: HTMLDivElement) => any;
// (undocumented)
Expand All @@ -3845,9 +3845,7 @@ export class ProbeTool extends AnnotationTool {
// (undocumented)
getHandleNearImagePoint(element: HTMLDivElement, annotation: ProbeAnnotation, canvasCoords: Types_2.Point2, proximity: number): ToolHandle | undefined;
// (undocumented)
_getTextLines(data: any, targetId: string, isPreScaled: boolean, isSuvScaled: boolean): string[] | undefined;
// (undocumented)
_getValueForModality(value: any, imageVolume: any, modality: any): {};
_getTextLines(data: any, targetId: string): string[] | undefined;
// (undocumented)
handleSelectedCallback(evt: EventTypes_2.InteractionEventType, annotation: ProbeAnnotation): void;
// (undocumented)
Expand Down Expand Up @@ -4108,7 +4106,7 @@ export class RectangleROITool extends AnnotationTool {
// (undocumented)
addNewAnnotation: (evt: EventTypes_2.InteractionEventType) => RectangleROIAnnotation;
// (undocumented)
_calculateCachedStats: (annotation: any, viewPlaneNormal: any, viewUp: any, renderingEngine: any, enabledElement: any) => any;
_calculateCachedStats: (annotation: any, viewPlaneNormal: any, viewUp: any, renderingEngine: any, enabledElement: any, modalityUnitOptions: any) => any;
// (undocumented)
cancel: (element: HTMLDivElement) => any;
// (undocumented)
Expand Down Expand Up @@ -4136,7 +4134,7 @@ export class RectangleROITool extends AnnotationTool {
height: number;
};
// (undocumented)
_getTextLines: (data: any, targetId: string, isPreScaled: boolean, isSuvScaled: boolean) => string[] | undefined;
_getTextLines: (data: any, targetId: string) => string[] | undefined;
// (undocumented)
handleSelectedCallback: (evt: EventTypes_2.InteractionEventType, annotation: RectangleROIAnnotation, handle: ToolHandle) => void;
// (undocumented)
Expand Down
1 change: 0 additions & 1 deletion packages/tools/src/tools/annotation/ProbeTool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ import {
getModalityUnit,
} from '../../utilities/getModalityUnit';
import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
import { annotation } from '@cornerstonejs/tools';

const { transformWorldToIndex } = csUtils;

Expand Down

0 comments on commit 43b0376

Please sign in to comment.