Documentation
    Preparing search index...

    Interface AnnotationMeasurementRenderPlugin

    Convenience interface for objects that are both an EventEmitter and an EventDispatcher.

    interface AnnotationMeasurementRenderPlugin {
        addEventListener<K extends keyof MeasurementEvents>(
            event: K,
            listener: (eventData: MeasurementEvents[K]) => void,
        ): EventHandle;
        cancelDeleteMeasurement(): void;
        commitDeleteMeasurement(): Promise<DeleteAnnotationResult>;
        commitEditMeasurement(
            options: { description?: string; name: string },
        ): Promise<UpdateAnnotationMeasurementResult>;
        commitInFlightMeasurement(
            options: { description?: string; name: string },
        ): Promise<CreateAnnotationMeasurementResult>;
        copyMeasurementLink(
            measurementId: AnnotationMeasurement.AnnotationMeasurementId,
        ): Promise<Result<void, void>>;
        copyMeasurementToClipboard(
            measurementId: AnnotationMeasurement.AnnotationMeasurementId,
            ucsTransformation: Transformation | null,
        ): Result<void, void>;
        discardInFlightMeasurement(): void;
        dispatchEvent<K extends keyof MeasurementEvents>(
            ...args: DispatchArgsOf<MeasurementEvents, K>,
        ): void;
        focusMeasurementInView(
            measurementId: AnnotationMeasurement.AnnotationMeasurementId,
            force: boolean,
        ): void;
        getDeclutterManager(): OverlayDeclutteringManager;
        getInFlightMeasurement(): Measurement<MeasurementSegment, {}> | undefined;
        getStore(): StoreApi;
        requestCreateMeasurement(): void;
        requestDeleteMeasurement(
            annotationId: AnnotationMeasurement.AnnotationMeasurementId,
        ): void;
        requestEditMeasurement(
            annotationId: AnnotationMeasurement.AnnotationMeasurementId,
        ): void;
        resetPlugin(): void;
        restartInFlightMeasurement(): void;
        selectMeasurement(
            measurementId:
                | AnnotationMeasurement.AnnotationMeasurementId
                | undefined,
        ): void;
        setAdvancedDetailsVisible(visible: boolean): void;
        setAllMeasurementsVisible(visible: boolean): void;
        setCreationType(type: AnnotationMeasurementType): void;
        setCreationTypePlanar(type: CreationTypePlanar): void;
        setCursorCoordinatesVisible(visible: boolean): void;
        setFilterQuery(query: string): void;
        setForcedMeasurementVisibility(visible: boolean): void;
        setHoveredMeasurement(
            measurementId:
                | AnnotationMeasurement.AnnotationMeasurementId
                | undefined,
        ): void;
        setMeasurementVisible(
            id: AnnotationMeasurement.AnnotationMeasurementId,
            visible: boolean,
        ): void;
        setUnitSystem(unitSystem: UnitSystem): void;
        toggleMeasurementVisibility(
            id: AnnotationMeasurement.AnnotationMeasurementId,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    addEventListener cancelDeleteMeasurement commitDeleteMeasurement commitEditMeasurement commitInFlightMeasurement copyMeasurementLink copyMeasurementToClipboard discardInFlightMeasurement dispatchEvent focusMeasurementInView getDeclutterManager getInFlightMeasurement getStore requestCreateMeasurement requestDeleteMeasurement requestEditMeasurement resetPlugin restartInFlightMeasurement selectMeasurement setAdvancedDetailsVisible setAllMeasurementsVisible setCreationType setCreationTypePlanar setCursorCoordinatesVisible setFilterQuery setForcedMeasurementVisibility setHoveredMeasurement setMeasurementVisible setUnitSystem toggleMeasurementVisibility

    Methods

    • The store used by the plugin.

      Returns StoreApi

      Do not use this directly in user-land code. Either:

      • In React code, use the useRendererPluginStore or useRendererPluginStoreLazy hook.
      • In non-React code, add methods to mutate the store to the plugin's API instead.

    Settings

    Member Visibility

    On This Page

    Methods