@idetik/core 0.40.0 → 0.40.2

package/dist/types/src/data/chunk_manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chunk_manager.d.ts","sourceRoot":"","sources":["../../../../src/data/chunk_manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,WAAW,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,OAAO,EAAuB,MAAM,6BAA6B,CAAC;AAG3E,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAKF,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoD;IAC5E,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IAEpC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAA6B;IAC9D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAe;IACpD,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAS;IAEjD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;gBAG5C,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,EAC1C,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,EAC3C,mBAAmB,GAAE,MAAM,MAAgB,EAC3C,gBAAgB,GAAE,MAAiB,EACnC,qBAAqB,GAAE,MAAwC,EAC/D,sBAAsB,GAAE,MAA2C;IAUrE,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAExC;IAED,IAAW,UAAU,IAAI,UAAU,CAKlC;IAED,IAAW,WAAW;;;MAErB;IAEM,OAAO,CACZ,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,iBAAiB,EACzB,IAAI,CAAC,EAAE,SAAS,GACf,cAAc;IASV,MAAM;IA8Bb,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,kBAAkB;IAe1B,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,mBAAmB;CAQ5B"}
+{"version":3,"file":"chunk_manager.d.ts","sourceRoot":"","sources":["../../../../src/data/chunk_manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,WAAW,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,OAAO,EAAuB,MAAM,6BAA6B,CAAC;AAG3E;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAKF,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoD;IAC5E,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IAEpC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAA6B;IAC9D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAe;IACpD,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAS;IAEjD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;gBAG5C,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,EAC1C,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,EAC3C,mBAAmB,GAAE,MAAM,MAAgB,EAC3C,gBAAgB,GAAE,MAAiB,EACnC,qBAAqB,GAAE,MAAwC,EAC/D,sBAAsB,GAAE,MAA2C;IAUrE,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAExC;IAED,IAAW,UAAU,IAAI,UAAU,CAKlC;IAED,IAAW,WAAW;;;MAErB;IAEM,OAAO,CACZ,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,iBAAiB,EACzB,IAAI,CAAC,EAAE,SAAS,GACf,cAAc;IASV,MAAM;IA8Bb,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,kBAAkB;IAe1B,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,mBAAmB;CAQ5B"}

package/dist/types/src/data/ome_zarr/image_source.d.ts

@@ -2,46 +2,89 @@ import { Location, Readable } from "zarrita";
 import { OmeZarrImageLoader } from "./image_loader";
 import { Version as OmeZarrVersion } from "./metadata_loaders";
 import { SourceDimensionMap } from "../chunk";
-type HttpOmeZarrImageSourceProps = {
+/**
+ * Input to {@link OmeZarrImageSource.fromHttp}.
+ */
+export type HttpOmeZarrImageSourceProps = {
+    /** URL of the OME-Zarr root group. */
     url: string;
+    /** OME-Zarr version. Detected from metadata when omitted. */
     version?: OmeZarrVersion;
 };
-type FileSystemOmeZarrImageSourceProps = {
+/**
+ * Input to {@link OmeZarrImageSource.fromFileSystem}.
+ */
+export type FileSystemOmeZarrImageSourceProps = {
+    /** Directory handle with read permission. */
     directory: FileSystemDirectoryHandle;
+    /** OME-Zarr version. Detected from metadata when omitted. */
     version?: OmeZarrVersion;
+    /** Image path within the directory. Defaults to the root. */
     path?: `/${string}`;
 };
 /**
- * Opens an OME-Zarr multiscale image Zarr group from either a URL or local directory.
+ * A multiscale image opened from an OME-Zarr store.
+ *
+ * Instances are created with {@link fromHttp} or {@link fromFileSystem}
+ * rather than the constructor. Both factories read the store's metadata up
+ * front so the returned source already knows its axes, resolution levels,
+ * and channel count. OME-Zarr versions `0.4` and `0.5` are supported and
+ * the version is detected from metadata when not given.
+ *
+ * A source is handed to a layer which streams chunks from it on demand.
+ *
+ * ```ts
+ * const source = await OmeZarrImageSource.fromHttp({
+ *   url: "https://example.com/image.ome.zarr",
+ * });
+ *
+ * const layer = new ImageLayer({
+ *   source,
+ *   sliceCoords: { t: 0, z: 0, c: [0] },
+ * });
+ * ```
  *
  * @group Data Loading
  */
 export declare class OmeZarrImageSource {
+    /** The zarr store location the image was opened from. */
     readonly location: Location<Readable>;
+    /** The OME-Zarr version passed at creation if any. */
     readonly version?: OmeZarrVersion;
     private readonly loader_;
     private constructor();
     private static openLoader;
+    /**
+     * Returns per-axis dimension metadata for the image.
+     *
+     * Each axis entry lists one record per level of detail with its size,
+     * chunk size, scale, and translation. Use these to convert between
+     * array indices and world coordinates, pick slice coordinates, and
+     * frame cameras around the image extent.
+     */
     getDimensions(): SourceDimensionMap;
+    /**
+     * Returns the number of channels in the image.
+     */
     getChannelCount(): number;
+    /** The chunk loader that streams this image's data. */
     get loader(): OmeZarrImageLoader;
     /**
-     * Creates and opens an OmeZarrImageSource from an HTTP(S) URL.
+     * Opens an OME-Zarr image over HTTP(S).
      *
-     * @param props.url URL of the Zarr root
-     * @param props.version OME-Zarr version
+     * @param props - The store url and optional version.
      */
     static fromHttp(props: HttpOmeZarrImageSourceProps): Promise<OmeZarrImageSource>;
     /**
-     * Creates and opens an OmeZarrImageSource from a local filesystem directory.
+     * Opens an OME-Zarr image from a local directory.
+     *
+     * Uses the File System Access API so it only works in Chromium-based
+     * browsers. Pass the handle returned by `window.showDirectoryPicker()`.
+     * The optional path lets an application ask once for root permission
+     * and open many images.
      *
-     * @param directory return value of `window.showDirectoryPicker()` which gives the browser
-     *    permission to access a directory (only works in Chrome/Edge)
-     * @param version OME-Zarr version
-     * @param path path to image, beginning with "/". This argument allows the application to only
-     *    ask the user once for permission to the root directory
+     * @param props - The directory handle, optional version, and path.
      */
     static fromFileSystem(props: FileSystemOmeZarrImageSourceProps): Promise<OmeZarrImageSource>;
 }
-export {};
 //# sourceMappingURL=image_source.d.ts.map

package/dist/types/src/data/ome_zarr/image_source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image_source.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/image_source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAc,MAAM,SAAS,CAAC;AAOzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAGL,OAAO,IAAI,cAAc,EAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAQ9C,KAAK,2BAA2B,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,KAAK,iCAAiC,GAAG;IACvC,SAAS,EAAE,yBAAyB,CAAC;IACrC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C,OAAO;mBAMc,UAAU;IAqCxB,aAAa,IAAI,kBAAkB;IAInC,eAAe,IAAI,MAAM;IAIhC,IAAW,MAAM,IAAI,kBAAkB,CAEtC;IAED;;;;;OAKG;WACiB,QAAQ,CAC1B,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAM9B;;;;;;;;OAQG;WACiB,cAAc,CAChC,KAAK,EAAE,iCAAiC,GACvC,OAAO,CAAC,kBAAkB,CAAC;CAQ/B"}
+{"version":3,"file":"image_source.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/image_source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAc,MAAM,SAAS,CAAC;AAOzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAGL,OAAO,IAAI,cAAc,EAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAQ9C;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,6DAA6D;IAC7D,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,6CAA6C;IAC7C,SAAS,EAAE,yBAAyB,CAAC;IACrC,6DAA6D;IAC7D,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,kBAAkB;IAC7B,yDAAyD;IACzD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,sDAAsD;IACtD,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C,OAAO;mBAMc,UAAU;IAqC/B;;;;;;;OAOG;IACI,aAAa,IAAI,kBAAkB;IAI1C;;OAEG;IACI,eAAe,IAAI,MAAM;IAIhC,uDAAuD;IACvD,IAAW,MAAM,IAAI,kBAAkB,CAEtC;IAED;;;;OAIG;WACiB,QAAQ,CAC1B,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAM9B;;;;;;;;;OASG;WACiB,cAAc,CAChC,KAAK,EAAE,iCAAiC,GACvC,OAAO,CAAC,kBAAkB,CAAC;CAQ/B"}

package/dist/types/src/data/ome_zarr/metadata_loaders.d.ts

@@ -9,15 +9,15 @@ type AdaptedOme<T> = T & {
     originalVersion: Version;
 };
 export declare function omeZarrToZarrVersion(omeVersion: Version | undefined): ZarrVersion | undefined;
-/** @group Data Loading */
+/** @hidden */
 export declare function loadOmeZarrPlate(url: string, version?: Version): Promise<AdaptedOme<Plate["ome"]>>;
-/** @group Data Loading */
+/** @hidden */
 export declare function loadOmeZarrWell(url: string, path: string, version?: Version): Promise<AdaptedOme<Well["ome"]>>;
 export type OmeroMetadata = NonNullable<Image["ome"]["omero"]>;
 export type OmeroChannel = OmeroMetadata["channels"][number];
-/** @group Data Loading */
+/** @hidden */
 export declare function loadOmeroChannels(source: OmeZarrImageSource): Promise<OmeroChannel[]>;
-/** @group Data Loading */
+/** @hidden */
 export declare function loadOmeroDefaults(source: OmeZarrImageSource): Promise<OmeroMetadata["rdefs"]>;
 export declare function parseOmeZarrImage(attrs: Record<string, unknown>): AdaptedOme<Image["ome"]>;
 export {};

package/dist/types/src/data/ome_zarr/metadata_loaders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metadata_loaders.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/metadata_loaders.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAa,MAAM,cAAc,CAAC;AAEjE,QAAA,MAAM,QAAQ,yBAA0B,CAAC;AAEzC,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhD,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG;IACvB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAqBF,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,WAAW,GAAG,SAAS,CAQzB;AAQD,0BAA0B;AAC1B,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAYnC;AA4DD,0BAA0B;AAC1B,wBAAsB,eAAe,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAalC;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/D,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,0BAA0B;AAC1B,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,YAAY,EAAE,CAAC,CAKzB;AAED,0BAA0B;AAC1B,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAKjC;AA4BD,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAM1B"}
+{"version":3,"file":"metadata_loaders.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/metadata_loaders.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAa,MAAM,cAAc,CAAC;AAEjE,QAAA,MAAM,QAAQ,yBAA0B,CAAC;AAEzC,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhD,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG;IACvB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAqBF,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,WAAW,GAAG,SAAS,CAQzB;AAQD,cAAc;AACd,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAYnC;AA4DD,cAAc;AACd,wBAAsB,eAAe,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAalC;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/D,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,cAAc;AACd,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,YAAY,EAAE,CAAC,CAKzB;AAED,cAAc;AACd,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAKjC;AA4BD,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAM1B"}

package/dist/types/src/idetik.d.ts

@@ -1,118 +1,188 @@
 import { ChunkManager } from "./data/chunk_manager";
 import { Viewport, ViewportProps } from "./core/viewport";
-/** @group Runtime */
+/**
+ * An object updated once per frame after all viewports have rendered.
+ *
+ * Overlays drive HUD elements that live outside the canvas such as scale
+ * bars, time indicators, or memory readouts.
+ *
+ * ```ts
+ * const chunkReadout: Overlay = {
+ *   update(idetik) {
+ *     div.textContent = `${idetik.memoryStats.cpuChunkCount} chunks`;
+ *   },
+ * };
+ *
+ * idetik.addOverlay(chunkReadout);
+ * ```
+ */
 export type Overlay = {
-    update(idetik: Idetik): void;
+    /** Called once per rendered frame. */
+    update: (idetik: Idetik) => void;
 };
-/** @inline */
-type IdetikProps = {
+/**
+ * Initialization properties for constructing an Idetik instance.
+ */
+export type IdetikProps = {
+    /** The canvas element to render into. */
     canvas: HTMLCanvasElement;
+    /** Viewport definitions to create at startup. */
     viewports?: ViewportProps[];
+    /** Overlays to run each frame. */
     overlays?: Overlay[];
+    /** Shows an FPS meter. Defaults to `false`. */
     showStats?: boolean;
+    /** Memory budget for chunk data. Defaults to `2048`. */
     memoryLimitMB?: number;
+    /** Max in-flight chunk requests. Defaults to `8`. */
     maxConcurrentRequests?: number;
+    /** Max GPU texture uploads per frame. Defaults to `4`. */
     maxGpuUploadsPerUpdate?: number;
 };
 export type IdetikContext = {
     chunkManager: ChunkManager;
 };
-/** @group Runtime */
+/**
+ * A snapshot of the runtime's memory usage.
+ */
 export type MemoryStats = {
+    /** Bytes of chunk data held in CPU memory. */
     cpuChunkBytes: number;
+    /** Number of chunks held in CPU memory. */
     cpuChunkCount: number;
+    /** Bytes of texture data resident on the GPU. */
     gpuTextureBytes: number;
+    /** Number of textures resident on the GPU. */
     gpuTextureCount: number;
+    /** Used JS heap in bytes. */
     jsHeapUsedBytes?: number;
+    /** JS heap size limit in bytes. */
     jsHeapLimitBytes?: number;
 };
 /**
- * The top-level entry point for an Idetik visualization.
+ * The entry point of an Idetik application.
+ *
+ * An Idetik instance owns the renderer and the chunk manager and drives the
+ * render loop for the viewports it is given. Each viewport pairs a camera
+ * and its controls with a stack of layers and draws into a region of the
+ * shared canvas. Layers in all viewports stream chunks through the same
+ * manager under a single memory budget.
+ *
+ * ```ts
+ * const source = await OmeZarrImageSource.fromHttp({ url });
  *
- * An `Idetik` instance owns the renderer, the shared chunk manager, and one or
- * more viewports. Each viewport pairs a camera, its controls, and a stack of
- * layers and draws into a region of the canvas. Call {@link Idetik.start} to
- * begin the render loop and {@link Idetik.stop} to halt it.
+ * const layer = new ImageLayer({
+ *   source,
+ *   sliceCoords: { t: 0, z: 0, c: [0] },
+ * });
+ *
+ * const camera = new OrthographicCamera({
+ *   left: 0,
+ *   right: 1024,
+ *   top: 0,
+ *   bottom: 1024,
+ * });
+ *
+ * const idetik = new Idetik({
+ *   canvas: document.querySelector('canvas')!,
+ *   viewports: [{
+ *     camera,
+ *     layers: [layer],
+ *     cameraControls: new PanZoomControls(camera),
+ *   }],
+ * });
+ *
+ * idetik.start();
+ * ```
  *
  * @see {@link Layer} for the data layers rendered within a viewport.
  *
- * @group Runtime
+ * @group Core
  */
 export declare class Idetik {
+    /** The canvas element the renderer draws into. */
+    readonly canvas: HTMLCanvasElement;
+    /** The registered overlays that update once per frame in order. */
+    readonly overlays: Overlay[];
     private readonly chunkManager_;
     private readonly context_;
     private readonly renderer_;
     private readonly viewports_;
-    readonly canvas: HTMLCanvasElement;
-    readonly overlays: Overlay[];
     private readonly stats_?;
     private readonly sizeObserver_;
     private lastAnimationId_?;
     private lastTimestamp_;
     /**
-     * Creates a new Idetik visualization runtime instance.
-     *
-     * @param params - Configuration parameters for the Idetik instance
-     * @param params.canvas - HTMLCanvasElement to render to
-     * @param params.viewports - Optional array of viewport configurations.
-     *   Each viewport renders with its own camera, layers, and controls.
-     *   The `element` property is optional and defaults to the canvas if not provided.
-     *   Elements must be unique across viewports.
-     *   The `id` property is optional but useful for referencing specific viewports later.
-     * @param params.overlays - Optional array of overlay objects that update each frame (e.g., for HUD elements)
-     * @param params.showStats - Optional flag to display performance statistics
-     *
-     * @example
-     * // Single viewport (element defaults to canvas)
-     * const camera = new OrthographicCamera({ left: 0, right: 1024, top: 0, bottom: 1024 });
-     * const idetik = new Idetik({
-     *   canvas: document.querySelector('canvas')!,
-     *   viewports: [{
-     *     camera: camera,
-     *     layers: [imageLayer],
-     *     cameraControls: new PanZoomControls(camera)
-     *   }]
-     * });
+     * Creates an Idetik runtime for the given canvas.
      *
-     * @example
-     * // Multiple viewports - one defaults to canvas, others use separate elements
-     * const idetik = new Idetik({
-     *   canvas: document.querySelector('canvas')!,
-     *   viewports: [
-     *     {
-     *       id: 'main',
-     *       // element omitted - defaults to canvas
-     *       camera: camera1,
-     *       layers: [layer1]
-     *     },
-     *     {
-     *       id: 'minimap',
-     *       element: document.querySelector('#minimap')!,
-     *       camera: camera2,
-     *       layers: [layer2]
-     *     }
-     *   ]
-     * });
-     *
-     * @throws {Error} If viewports have duplicate IDs or shared elements
+     * @param params - Initialization properties.
      */
     constructor(params: IdetikProps);
-    get chunkQueueStats(): import("./data/chunk_manager").QueueStats;
+    /** Counts of queued and in-flight chunk requests. */
+    get chunkQueueStats(): import(".").QueueStats;
+    /** A snapshot of current CPU/GPU/JS heap memory usage. */
     get memoryStats(): MemoryStats;
+    /** The number of objects drawn in the last rendered frame. */
     get renderedObjects(): number;
+    /** The width of the rendering surface in pixels. */
     get width(): number;
+    /** The height of the rendering surface in pixels. */
     get height(): number;
+    /** The viewports in render order. */
     get viewports(): readonly Viewport[];
+    /** Whether the render loop is running. */
     get running(): boolean;
+    /**
+     * Finds a viewport by its id.
+     *
+     * @param id - The id given in the viewport's definition.
+     * @returns The matching viewport or `undefined` if none matches.
+     */
     getViewport(id: string): Viewport | undefined;
+    /**
+     * Adds a viewport at runtime.
+     *
+     * @param props - The viewport definition. The `element` defaults to the
+     *   canvas and must be unique across viewports.
+     * @returns The created viewport.
+     */
     addViewport(props: ViewportProps): Viewport;
+    /**
+     * Removes a previously added viewport.
+     *
+     * @param viewport - The viewport to remove.
+     * @returns `true` if the viewport was found and removed.
+     */
     removeViewport(viewport: Viewport): boolean;
+    /**
+     * Registers an overlay that updates once per frame.
+     *
+     * @param overlay - The overlay to add.
+     */
     addOverlay(overlay: Overlay): void;
+    /**
+     * Removes a previously added overlay.
+     *
+     * @param overlay - The overlay to remove.
+     * @returns `true` if the overlay was found and removed.
+     */
     removeOverlay(overlay: Overlay): boolean;
+    /**
+     * Sets the memory budget for chunk data at runtime.
+     *
+     * @param memoryLimitMB - The new budget in megabytes.
+     */
     setMemoryLimitMB(memoryLimitMB: number): void;
+    /**
+     * Starts the render loop and connects input handlers.
+     *
+     * @returns The instance, for chaining.
+     */
     start(): this;
     private animate;
+    /**
+     * Stops the render loop and disconnects input handlers.
+     */
     stop(): void;
 }
-export {};
 //# sourceMappingURL=idetik.d.ts.map

package/dist/types/src/idetik.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"idetik.d.ts","sourceRoot":"","sources":["../../../src/idetik.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD,OAAO,EAGL,QAAQ,EACR,aAAa,EACd,MAAM,iBAAiB,CAAC;AAKzB,qBAAqB;AACrB,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF,cAAc;AACd,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAIF,qBAAqB;AACrB,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAC1C,SAAgB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoB;IAClD,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAGlC,OAAO,CAAC,cAAc,CAA0B;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;gBACS,MAAM,EAAE,WAAW;IA4C/B,IAAW,eAAe,8CAEzB;IAED,IAAW,WAAW,IAAI,WAAW,CAcpC;IAED,IAAW,eAAe,WAEzB;IAED,IAAW,KAAK,WAEf;IAED,IAAW,MAAM,WAEhB;IAED,IAAW,SAAS,IAAI,SAAS,QAAQ,EAAE,CAE1C;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEM,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAI7C,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,QAAQ;IAiB3C,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAuB3C,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAIlC,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAWxC,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAI7C,KAAK;IAkBZ,OAAO,CAAC,OAAO;IA0BR,IAAI;CAcZ"}
+{"version":3,"file":"idetik.d.ts","sourceRoot":"","sources":["../../../src/idetik.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD,OAAO,EAGL,QAAQ,EACR,aAAa,EACd,MAAM,iBAAiB,CAAC;AAKzB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,sCAAsC;IACtC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,yCAAyC;IACzC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,iDAAiD;IACjD,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;IAC5B,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,wDAAwD;IACxD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qDAAqD;IACrD,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,0DAA0D;IAC1D,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,eAAe,EAAE,MAAM,CAAC;IACxB,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAC;IACxB,6BAA6B;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,MAAM;IACjB,kDAAkD;IAClD,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAC1C,mEAAmE;IACnE,SAAgB,QAAQ,EAAE,OAAO,EAAE,CAAC;IAEpC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoB;IAElD,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAClC,OAAO,CAAC,cAAc,CAA0B;IAEhD;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IA4C/B,qDAAqD;IACrD,IAAW,eAAe,2BAEzB;IAED,0DAA0D;IAC1D,IAAW,WAAW,IAAI,WAAW,CAcpC;IAED,8DAA8D;IAC9D,IAAW,eAAe,WAEzB;IAED,oDAAoD;IACpD,IAAW,KAAK,WAEf;IAED,qDAAqD;IACrD,IAAW,MAAM,WAEhB;IAED,qCAAqC;IACrC,IAAW,SAAS,IAAI,SAAS,QAAQ,EAAE,CAE1C;IAED,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;;;;OAKG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAIpD;;;;;;OAMG;IACI,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,QAAQ;IAiBlD;;;;;OAKG;IACI,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAuBlD;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAIzC;;;;;OAKG;IACI,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAW/C;;;;OAIG;IACI,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAIpD;;;;OAIG;IACI,KAAK;IAkBZ,OAAO,CAAC,OAAO;IA0Bf;;OAEG;IACI,IAAI;CAcZ"}

package/dist/types/src/index.d.ts

@@ -1,33 +1,54 @@
 export { Idetik } from "./idetik";
+export { Viewport } from "./core/viewport";
+export type { ViewportProps } from "./core/viewport";
 export { OmeZarrImageSource } from "./data/ome_zarr/image_source";
+export type { FileSystemOmeZarrImageSourceProps, HttpOmeZarrImageSourceProps, } from "./data/ome_zarr/image_source";
+export type { SourceDimension, SourceDimensionLod, SourceDimensionMap, } from "./data/chunk";
 export { loadOmeroChannels, loadOmeroDefaults, loadOmeZarrPlate, loadOmeZarrWell, } from "./data/ome_zarr/metadata_loaders";
 export { Layer } from "./core/layer";
+export type { BlendMode, LayerProps, StateChangeCallback } from "./core/layer";
+export type { PointPickingResult } from "./layers/point_picking";
 export { AxesLayer } from "./layers/axes_layer";
+export type { AxesLayerProps } from "./layers/axes_layer";
 export { ImageLayer } from "./layers/image_layer";
+export type { ImageLayerProps } from "./layers/image_layer";
 export { VolumeLayer } from "./layers/volume_layer";
+export type { VolumeLayerProps } from "./layers/volume_layer";
 export { LabelLayer } from "./layers/label_layer";
+export type { LabelLayerProps } from "./layers/label_layer";
+export type { LabelColorMap, LabelColorMapProps, } from "./objects/renderable/label_image_renderable";
+export { RenderableObject } from "./core/renderable_object";
 export { ImageRenderable } from "./objects/renderable/image_renderable";
+export type { ImageRenderableProps } from "./objects/renderable/image_renderable";
 export { LabelImageRenderable } from "./objects/renderable/label_image_renderable";
+export type { LabelImageRenderableProps } from "./objects/renderable/label_image_renderable";
 export { PointsRenderable } from "./objects/renderable/points_renderable";
+export type { PointProps } from "./objects/renderable/points_renderable";
 export { ProjectedLineRenderable } from "./objects/renderable/projected_line_renderable";
+export type { ProjectedLineRenderableProps } from "./objects/renderable/projected_line_renderable";
 export { VolumeRenderable } from "./objects/renderable/volume_renderable";
+export type { VolumeRenderableProps } from "./objects/renderable/volume_renderable";
+export { Camera } from "./objects/cameras/camera";
+export type { CameraType } from "./objects/cameras/camera";
 export { OrbitControls } from "./objects/cameras/orbit_controls";
+export type { OrbitControlsProps } from "./objects/cameras/orbit_controls";
 export { OrthographicCamera } from "./objects/cameras/orthographic_camera";
+export type { OrthographicCameraFrame, OrthographicCameraProps, } from "./objects/cameras/orthographic_camera";
 export { PanZoomControls } from "./objects/cameras/controls";
+export type { CameraControls } from "./objects/cameras/controls";
 export { PerspectiveCamera } from "./objects/cameras/perspective_camera";
+export type { PerspectiveCameraProps } from "./objects/cameras/perspective_camera";
 export { createExplorationPolicy, createImageSourcePolicy, createNoPrefetchPolicy, createPlaybackPolicy, } from "./core/image_source_policy";
-import type { Image } from "./data/ome_zarr/0.4/image";
 export type { ChannelProps } from "./core/channel";
-/**
- * Parsed OME-Zarr (OME-NGFF 0.4) image metadata.
- *
- * @group Data Loading
- */
-export type OmeZarrImage = Image;
 export type { LayerState } from "./core/layer";
-export type { MemoryStats, Overlay } from "./idetik";
+export type { IdetikProps, MemoryStats, Overlay } from "./idetik";
+export type { QueueStats } from "./data/chunk_manager";
 export type { SliceCoordinates } from "./data/chunk";
 export type { SliceOrientation } from "./math/axes";
 export { Color } from "./math/color";
 export type { ColorLike } from "./math/color";
+export { Box2 } from "./math/box2";
+export { Box3 } from "./math/box3";
+export { Frustum } from "./math/frustum";
+export { TrsTransform } from "./math/transforms";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAElE,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,GAChB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,gDAAgD,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE1E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAEzE,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAEvD,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC;AACjC,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACrD,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,YAAY,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,YAAY,EACV,iCAAiC,EACjC,2BAA2B,GAC5B,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,eAAe,EACf,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,GAChB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC/E,YAAY,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EACV,aAAa,EACb,kBAAkB,GACnB,MAAM,6CAA6C,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,YAAY,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AACnF,YAAY,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,YAAY,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gDAAgD,CAAC;AACzF,YAAY,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,YAAY,EAAE,qBAAqB,EAAE,MAAM,wCAAwC,CAAC;AAEpF,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,YAAY,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,YAAY,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,YAAY,EACV,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,YAAY,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,YAAY,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAEnF,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAClE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,YAAY,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/types/src/layers/axes_layer.d.ts

@@ -1,11 +1,36 @@
 import { Layer } from "../core/layer";
-/** @group Layers */
+/**
+ * Initialization properties for constructing an axes layer.
+ */
+export type AxesLayerProps = {
+    /** Axis length in world units. */
+    length: number;
+    /** Line width in pixels. */
+    width: number;
+};
+/**
+ * A layer that draws the world coordinate axes as colored lines.
+ *
+ * Three lines start at the world origin: `x` in red, `y` in green, and
+ * `z` in blue, each with the given length and width. The layer is static
+ * and ready as soon as it is constructed.
+ *
+ * ```ts
+ * viewport.addLayer(new AxesLayer({ length: 100, width: 2 }));
+ * ```
+ *
+ * @group Layers
+ */
 export declare class AxesLayer extends Layer {
+    /** Identifies the layer type as `AxesLayer`. */
     readonly type = "AxesLayer";
-    constructor(params: {
-        length: number;
-        width: number;
-    });
+    /**
+     * Creates an axes layer with the given dimensions.
+     *
+     * @param props - Initialization properties.
+     */
+    constructor(props: AxesLayerProps);
+    /** Performs no per-frame work. The axes are built at construction. */
     update(): void;
 }
 //# sourceMappingURL=axes_layer.d.ts.map

package/dist/types/src/layers/axes_layer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"axes_layer.d.ts","sourceRoot":"","sources":["../../../../src/layers/axes_layer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAItC,oBAAoB;AACpB,qBAAa,SAAU,SAAQ,KAAK;IAClC,SAAgB,IAAI,eAAe;gBAEvB,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE;IA2B9C,MAAM;CACd"}
+{"version":3,"file":"axes_layer.d.ts","sourceRoot":"","sources":["../../../../src/layers/axes_layer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAItC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,gDAAgD;IAChD,SAAgB,IAAI,eAAe;IAEnC;;;;OAIG;gBACS,KAAK,EAAE,cAAc;IA2BjC,sEAAsE;IAC/D,MAAM;CACd"}