Interface: ViewerStateInfo

Defined in: src/display/ViewerStateInfo.ts:8

Properties

currentCoord

readonly currentCoord: number[];

Defined in: src/display/ViewerStateInfo.ts:13

Current 3D coordinate position in the volume. This is typically the focal point or crosshair position.

---

mouseState

readonly mouseState: object;

Defined in: src/display/ViewerStateInfo.ts:20

Information about the current mouse position and related coordinates. Contains details about which view the mouse is over and coordinates in both 2D (image) and 3D (volume) space.

viewName

viewName: string | null;

imageCoordinate

imageCoordinate: 
  | {
  x: number;
  y: number;
}
  | null;

volumeCoordinate

volumeCoordinate: number[] | null;

worldCoordinate

worldCoordinate: number[] | null;

---

sliceIndices

readonly sliceIndices: Record<string, number>;

Defined in: src/display/ViewerStateInfo.ts:32

Information about current slice indices in different orientations. For single-slice viewers, this may have only one relevant property. For orthogonal viewers, it has properties for each orientation.

---

totalSlices?

readonly optional totalSlices?: Record<string, number>;

Defined in: src/display/ViewerStateInfo.ts:39

Information about the total number of slices available in each view. For single-slice viewers, this may have only one property. For orthogonal viewers, it has properties for each orientation.

---

viewOrientation?

readonly optional viewOrientation?: 
  | AxisSet3D
  | Record<string, AxisSet3D>;

Defined in: src/display/ViewerStateInfo.ts:46

The axis orientation(s) currently being displayed. For SliceViewer, this is a single AxisSet3D. For OrthogonalImageViewer, this could be a record of orientations by view name.

---

scale?

readonly optional scale?: number | Record<string, number>;

Defined in: src/display/ViewerStateInfo.ts:53

The current scaling/zoom level of the viewer(s). For single-slice viewers, this is a single value. For orthogonal viewers, it may have multiple values by view name.

---

viewerType

readonly viewerType: string;

Defined in: src/display/ViewerStateInfo.ts:59

Identifies the type of viewer. Useful for UI components that need to adapt based on viewer type.

---

visibleLayers?

readonly optional visibleLayers?: object[];

Defined in: src/display/ViewerStateInfo.ts:65

Information about which layers are currently visible/active. This can include layer IDs, opacity values, etc.

id

id: string;

visible

visible: boolean;

opacity?

optional opacity?: number;