Documentation
    Preparing search index...

    Interface Store

    Store interface combining all base state slices. This represents the raw, mutable state managed by Zustand.

    interface Store {
        _forceVisibility: boolean;
        _measurements: ObserveAnnotationMeasurementResult;
        _setAdvancedDetails: (visible: boolean) => void;
        _setCreationType: (type: AnnotationMeasurementType) => void;
        _setCreationTypePlanar: (type: CreationTypePlanar) => void;
        _setCursorCoordinates: (visible: boolean) => void;
        _setDraftMeasurement: (draft: AnnotationMeasurementPending) => void;
        _setDraftTargetOrientation: (
            orientation: TargetOrientation<
                Vector3Geocentric
                | Vector3NonReferenced,
            >,
        ) => void;
        _setDraftThumbnail: (blob: Blob | undefined) => void;
        _setEnoughDepthDataLoaded: (enough: boolean) => void;
        _setForceVisibility: (visible: boolean) => void;
        _setHoveredMeasurement: (
            id: AnnotationMeasurement.AnnotationMeasurementId | undefined,
        ) => void;
        _setMeasurementToDelete: (
            id: AnnotationMeasurement.AnnotationMeasurementId | undefined,
        ) => void;
        _setMeasurementVisible: (
            id: AnnotationMeasurement.AnnotationMeasurementId,
            visible: boolean,
        ) => void;
        _setSelectedMeasurement: (
            id: AnnotationMeasurement.AnnotationMeasurementId | undefined,
        ) => void;
        _setUnitSystem: (unitSystem: UnitSystem) => void;
        _startListMode: () => void;
        _startMeasurementCreation: () => void;
        _startMeasurementEdit: (
            id: AnnotationMeasurement.AnnotationMeasurementId,
        ) => void;
        _ui: UIModeInternal;
        _updateDraftMeasurementPoints: (
            points: (Vector3Geocentric | Vector3NonReferenced)[],
            attributes: MeasurementAttributes,
        ) => void;
        _visibleMeasurementIds: AnnotationMeasurement.AnnotationMeasurementId[];
        advancedDetails: boolean;
        creationType: AnnotationMeasurementType;
        creationTypePlanar: CreationTypePlanar;
        cursorCoordinates: boolean;
        enoughDepthDataLoaded: boolean;
        filterQuery: string;
        setFilterQuery: (query: string) => void;
        unitSystem: UnitSystem;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _forceVisibility _measurements _setAdvancedDetails _setCreationType _setCreationTypePlanar _setCursorCoordinates _setDraftMeasurement _setDraftTargetOrientation _setDraftThumbnail _setEnoughDepthDataLoaded _setForceVisibility _setHoveredMeasurement _setMeasurementToDelete _setMeasurementVisible _setSelectedMeasurement _setUnitSystem _startListMode _startMeasurementCreation _startMeasurementEdit _ui _updateDraftMeasurementPoints _visibleMeasurementIds advancedDetails creationType creationTypePlanar cursorCoordinates enoughDepthDataLoaded filterQuery setFilterQuery unitSystem

    Properties

    _forceVisibility

    _forceVisibility: boolean

    Whether visibility is being forced for all measurements, overriding individual visibility settings.

    _measurements

    _measurements: ObserveAnnotationMeasurementResult

    All measurements loaded from the service, wrapped in a DeferredResult

    _setAdvancedDetails

    _setAdvancedDetails: (visible: boolean) => void

    _setCreationType

    _setCreationType: (type: AnnotationMeasurementType) => void

    _setCreationTypePlanar

    _setCreationTypePlanar: (type: CreationTypePlanar) => void

    _setCursorCoordinates

    _setCursorCoordinates: (visible: boolean) => void

    _setDraftMeasurement

    _setDraftMeasurement: (draft: AnnotationMeasurementPending) => void

    _setDraftTargetOrientation

    _setDraftTargetOrientation: (
        orientation: TargetOrientation<Vector3Geocentric | Vector3NonReferenced>,
    ) => void

    _setDraftThumbnail

    _setDraftThumbnail: (blob: Blob | undefined) => void

    _setEnoughDepthDataLoaded

    _setEnoughDepthDataLoaded: (enough: boolean) => void

    _setForceVisibility

    _setForceVisibility: (visible: boolean) => void

    Set whether visibility is being forced for all measurements.

    _setHoveredMeasurement

    _setHoveredMeasurement: (
        id: AnnotationMeasurement.AnnotationMeasurementId | undefined,
    ) => void

    Set the currently hovered measurement ID. Only works in 'view' and 'list' modes.

    _setMeasurementToDelete

    _setMeasurementToDelete: (
        id: AnnotationMeasurement.AnnotationMeasurementId | undefined,
    ) => void

    Set the measurement ID to delete. Only works in 'view' and 'list' modes. Will retain or switch modes as appropriate when setting or unsetting the ID.

    _setMeasurementVisible

    _setMeasurementVisible: (
        id: AnnotationMeasurement.AnnotationMeasurementId,
        visible: boolean,
    ) => void

    Set the visibility of a specific measurement by ID. Will only work for measurements that exist and pass the current search filter.

    _setSelectedMeasurement

    _setSelectedMeasurement: (
        id: AnnotationMeasurement.AnnotationMeasurementId | undefined,
    ) => void

    Set the currently selected measurement ID. Setting to undefined unselects any selection. On selection, switches to 'view' mode; on unselection, switches to 'list' mode.

    _setUnitSystem

    _setUnitSystem: (unitSystem: UnitSystem) => void

    _startListMode

    _startListMode: () => void

    Set the UI to list mode regardless of current mode.

    _startMeasurementCreation

    _startMeasurementCreation: () => void

    _startMeasurementEdit

    _startMeasurementEdit: (
        id: AnnotationMeasurement.AnnotationMeasurementId,
    ) => void

    Start editing the measurement with the given ID. Only works from 'view' or 'list' modes. Switches to 'edit' mode.

    _ui

    _ui: UIModeInternal

    _updateDraftMeasurementPoints

    _updateDraftMeasurementPoints: (
        points: (Vector3Geocentric | Vector3NonReferenced)[],
        attributes: MeasurementAttributes,
    ) => void

    _visibleMeasurementIds

    _visibleMeasurementIds: AnnotationMeasurement.AnnotationMeasurementId[]

    List of measurement IDs that are explicitly set to be visible.

    advancedDetails: boolean

    Whether advanced details are shown in the measurement UI.

    creationType: AnnotationMeasurementType

    The type of measurement being created (orthogonal, planar, etc.).

    creationTypePlanar: CreationTypePlanar

    The planar creation type for when creationType is planar (projection or raycast).

    cursorCoordinates: boolean

    Whether cursor coordinates are shown in the measurement UI.

    enoughDepthDataLoaded: boolean

    Whether enough depth data has been loaded to facilitate accurate measurement creation.

    filterQuery: string

    User's search/filter query string

    setFilterQuery: (query: string) => void

    Set the user's search/filter query string

    unitSystem: UnitSystem

    The unit system used for measurements (metric or imperial).

    Settings

    Member Visibility

    On This Page

    Properties