@aics/vole-app 3.3.0 → 3.4.0

package/type-declarations/aics-image-viewer/components/useVolume.d.ts

@@ -11,7 +11,7 @@ export type UseVolumeOptions = {
     /** Callback for when a single channel of the volume has loaded. */
     onChannelLoaded?: (image: Volume, channelIndex: number, isInitialLoad: boolean) => void;
     /** Callback for when image loading encounters an error. */
-    onError?: (error: unknown) => void;
+    onError?: (error: unknown, image?: Volume) => void;
     /** The name of a channel which should be treated as a mask rather than as viewable data. */
     maskChannelName?: string;
 };

package/type-declarations/aics-image-viewer/shared/constants.d.ts

@@ -10,7 +10,7 @@ export declare const TFEDITOR_DEFAULT_COLOR: ColorArray;
 export declare const TFEDITOR_MAX_BIN = 255;
 export declare const CACHE_MAX_SIZE = 1000000000;
 export declare const QUEUE_MAX_SIZE = 10;
-export declare const QUEUE_MAX_LOW_PRIORITY_SIZE = 4;
+export declare const QUEUE_MAX_LOW_PRIORITY_SIZE = 6;
 /** Maps an axis the user can "play" through to the direction to prefetch while playing that axis */
 export declare const AXIS_TO_LOADER_PRIORITY: Record<AxisName | "t", PrefetchDirection>;
 /** Maps channel data types to their minimum and maximum values */

package/type-declarations/aics-image-viewer/shared/utils/camera.d.ts

@@ -0,0 +1,19 @@
+import type { CameraState, View3d } from "@aics/vole-core";
+import { mat3 } from "gl-matrix";
+/** Multiply every vector in `state` by `matrix` */
+export declare const applyMatrix: (state: CameraState, matrix: mat3) => CameraState;
+/** Creates a XYZ rotation matrix with the given angles */
+export declare const rotationMatrix: (x: number, y: number, z: number) => mat3;
+/** Extract Tait-Bryan angles from a `CameraState` */
+export declare const getRotationAngles: (state: CameraState) => {
+    x: number;
+    y: number;
+    z: number;
+};
+/**
+ * Constructs a new `CameraState` equivalent to rotating `state` about the origin such that the camera returns to its
+ * default *orientation* (looking towards -Z, +Y up), though not necessarily its default *position*.
+ */
+export declare const defaultOrientedCamera: (state: CameraState) => CameraState;
+/** Creates a callback that performs some action on the camera, by applying `transform` to the current camera state. */
+export declare const useCameraCallback: <T extends any[]>(transform: (state: CameraState, ...args: T) => Partial<CameraState>, view3d: View3d) => ((...args: T) => CameraState);

package/type-declarations/aics-image-viewer/shared/utils/playControls.d.ts

@@ -5,6 +5,7 @@ export default class PlayControls {
     playWaitingForLoad: boolean;
     playHolding: boolean;
     playTimeoutId: number;
+    private lastStepTime;
     getVolumeIsLoaded?: () => boolean;
     stepAxis?: (axis: PlayAxisName) => void;
     onPlayingAxisChanged?: (axis: PlayAxisName | null) => void;

package/type-declarations/aics-image-viewer/shared/utils/sceneStore.d.ts

@@ -1,4 +1,4 @@
-import type { LoadSpec, PrefetchDirection, RawArrayLoaderOptions, Volume, VolumeLoaderContext } from "@aics/vole-core";
+import type { LoadSpec, PrefetchDirection, RawArrayLoaderOptions, Volume, VolumeLoaderContext, ZarrLoaderFetchOptions } from "@aics/vole-core";
 import type { ThreadableVolumeLoader } from "@aics/vole-core/es/types/loaders/IVolumeLoader";
 export type LoadSceneOptions = {
     onCreateScene?: (volume: Volume, sceneIndex: number, loadSpec: LoadSpec) => void;
@@ -18,4 +18,5 @@ export default class SceneStore {
     createVolume(scene: number, loadSpec: LoadSpec, onChannelLoaded?: (volume: Volume, channelIndex: number) => void): Promise<Volume>;
     syncMultichannelLoading(sync: boolean): void;
     setPrefetchPriority(priority: PrefetchDirection[]): void;
+    updateFetchOptions(fetchOptions: Partial<ZarrLoaderFetchOptions>): void;
 }

package/type-declarations/aics-image-viewer/shared/utils/urlParsing.d.ts

@@ -1,178 +1,8 @@
-import type { CameraState } from "@aics/vole-core";
 import type { FirebaseFirestore } from "@firebase/firestore-types";
 import type { AppProps } from "../../components/App/types";
 import type { ViewerStore } from "../../state/store";
-import type { ChannelState, ViewerState } from "../../state/types";
-import { ViewMode } from "../enums";
+import { type ViewerState, ViewerStateParams } from "../../state/types";
 import type { MetadataRecord } from "../types";
-import type { ColorArray } from "./colorRepresentations";
-import type { ViewerChannelSetting } from "./viewerChannelSettings";
-export declare const ENCODED_COMMA_REGEX: RegExp;
-export declare const ENCODED_COLON_REGEX: RegExp;
-/**
- * LEGACY: Matches a COMMA-separated list of control points, where each control point is represented
- * by a triplet of `{x}:{opacity}:{hex color}`.
- * The hex color can be replaced with `1` to represent white (`ffffff`).
- */
-export declare const LEGACY_CONTROL_POINTS_REGEX: RegExp;
-/**
- * Matches a COLON-separated list of control points, where each control point is
- * represented by a triplet of `{x}:{opacity}:{hex color}`.
- * - `x` is a value that will either be parsed as a histogram bin index (legacy,
- *   for `ControlPointsLegacy`) or intensity value (for `ControlPoints`),
- *   depending on on which field is being parsed.
- * - Opacity is a float in the [0, 1] range.
- * - The hex color is a 6-digit hex color (e.g. `ffeecc`), and can be replaced
- *   with `1` to represent white (`ffffff`).
- */
-export declare const CONTROL_POINTS_REGEX: RegExp;
-/**
- * Enum keys for URL parameters. These are stored as enums for better readability,
- * and are mapped to types in `ViewerStateParams`.
- */
-export declare enum ViewerStateKeys {
-    View = "view",
-    Mode = "mode",
-    Mask = "mask",
-    Image = "image",
-    Axes = "axes",
-    BoundingBox = "bb",
-    BoundingBoxColor = "bbcol",
-    BackgroundColor = "bgcol",
-    Autorotate = "rot",
-    Brightness = "bright",
-    Density = "dens",
-    Levels = "lvl",
-    Interpolation = "interp",
-    Region = "reg",
-    Slice = "slice",
-    Time = "t",
-    Scene = "scene",
-    CameraState = "cam",
-    SingleChannelMode = "scm",
-    SingleChannelIndex = "sci",
-    UseExactScaleLevel = "esl",
-    ScaleLevelIndex = "scl"
-}
-export declare enum CameraTransformKeys {
-    /** Camera position in 3D coordinates. */
-    Position = "pos",
-    /** Target position of the trackball controls in 3D coordinates. */
-    Target = "tar",
-    /** The up vector of the camera. Will be normalized to magnitude of 1. */
-    Up = "up",
-    /** Scale factor for orthographic cameras. */
-    OrthoScale = "ort",
-    /** Vertical FOV of the camera view frustum, from top to bottom, in degrees. */
-    Fov = "fov"
-}
-/**
- * Mapped to types in `ViewerChannelSettingParams`
- */
-export declare enum ViewerChannelSettingKeys {
-    Color = "col",
-    Colorize = "clz",
-    ColorizeAlpha = "cza",
-    IsosurfaceAlpha = "isa",
-    Lut = "lut",
-    ControlPoints = "cpt",
-    ControlPointsLegacy = "cps",
-    Ramp = "ram",
-    RampLegacy = "rmp",
-    ControlPointsEnabled = "cpe",
-    VolumeEnabled = "ven",
-    SurfaceEnabled = "sen",
-    IsosurfaceValue = "isv",
-    KeepRange = "pin"
-}
-/**
- * The serialized form of a ViewerChannelSetting, as a dictionary object.
- */
-export declare class ViewerChannelSettingParams {
-    /** Color, as a 6-digit hex color.  */
-    [ViewerChannelSettingKeys.Color]?: string;
-    /** Colorize. "1" is enabled. Disabled by default. */
-    [ViewerChannelSettingKeys.Colorize]?: "1" | "0";
-    /** Colorize alpha, in the [0, 1] range. Set to `1.0` by default. */
-    [ViewerChannelSettingKeys.ColorizeAlpha]?: string;
-    /** Isosurface alpha, in the [0, 1 range]. Set to `1.0` by default.*/
-    [ViewerChannelSettingKeys.IsosurfaceAlpha]?: string;
-    /**
-     * Lookup table (LUT) to map from volume intensity to opacity. Should be two
-     * alphanumeric values separated by a colon, where the first value is the
-     * minimum and the second is the maximum. Defaults to [0, 255].
-     *
-     * Min and max values are determined as following:
-     * - Plain numbers are indices of histogram bins, typically in the range [0,
-     *   255].
-     * - `v{n}` represents a raw intensity value, where `n` is a number.
-     * - `p{n}` represents a percentile, where `n` is a percentile in the [0, 100]
-     *   range.
-     * - `m{n}` represents the median multiplied by `n / 100`.
-     * - `autoij` in either the min or max fields will use the "auto" algorithm
-     *   from ImageJ to select the min and max.
-     *
-     * Values will be used to determine the initial control points and ramp if
-     * those fields are not provided.
-     *
-     * @example
-     * ```
-     * "0:255"    // min: intensity 0, max: intensity 255.
-     * "p50:p90"  // min: 50th percentile, max: 90th percentile.
-     * "m1:p75"   // min: median, max: 75th percentile.
-     * "autoij:0" // use Auto-IJ to calculate min and max.
-     * ```
-     */
-    [ViewerChannelSettingKeys.Lut]?: string;
-    /**
-     * Legacy specifier for control points for the transfer function as a list of
-     * `x:opacity:color` triplets, separated by colon. Uses histogram bin indices
-     * instead of intensity values.
-     * - `x` is a histogram bin index in the [0, 255] range.
-     * - `opacity` is a float in the [0, 1] range.
-     * - `color` is a 6-digit hex color, e.g. `ff0000`.
-     *
-     * Will be overridden by the ControlPoints field (`cpt`) if provided.
-     */
-    [ViewerChannelSettingKeys.ControlPointsLegacy]?: string;
-    /**
-     * Control points for the transfer function, formatted as a list of
-     * `x:opacity:color` triplets, separated by colons.
-     * - `x` is a numeric intensity value.
-     * - `opacity` is a float in the [0, 1] range.
-     * - `color` is a 6-digit hex color, e.g. `ff0000`.
-     *
-     * If provided, overrides the `lut` field when calculating the control points.
-     */
-    [ViewerChannelSettingKeys.ControlPoints]?: string;
-    /**
-     * Whether to show advanced mode, which will show control points instead of
-     * ramp values defined by the LUT. "1" is enabled, disabled by default.
-     */
-    [ViewerChannelSettingKeys.ControlPointsEnabled]?: "1" | "0";
-    /**
-     * Legacy specifier for the transfer function ramp which uses histogram bin
-     * indices instead of intensity values, formatted as `min:max`. Will be
-     * overridden by the Ramp field (`ram`) if provided.
-     */
-    [ViewerChannelSettingKeys.RampLegacy]?: string;
-    /**
-     * Ramp min and max intensity values (`min:max`). If provided, overrides the
-     * `lut` field when calculating the ramp.
-     */
-    [ViewerChannelSettingKeys.Ramp]?: string;
-    /** Volume enabled. "1" is enabled. Disabled by default. */
-    [ViewerChannelSettingKeys.VolumeEnabled]?: "1" | "0";
-    /** Isosurface enabled. "1" is enabled. Disabled by default. */
-    [ViewerChannelSettingKeys.SurfaceEnabled]?: "1" | "0";
-    /** Isosurface value, in the [0, 255] range. Set to `128` by default. */
-    [ViewerChannelSettingKeys.IsosurfaceValue]?: string;
-    /**
-     * Whether to keep the current contrast settings when loading a new volume.
-     * "1" is enabled. Disabled by default.
-     */
-    [ViewerChannelSettingKeys.KeepRange]?: "1" | "0";
-}
 /**
  * Channels, matching the pattern `c0`, `c1`, etc. corresponding to the index of the channel being configured.
  * The channel parameter should have a value that is a comma-separated list of `key:value` pairs, with keys
@@ -181,75 +11,6 @@ export declare class ViewerChannelSettingParams {
 type ChannelParams = {
     [_ in `c${number}`]?: string;
 };
-/** Serialized version of `ViewerState`. */
-export declare class ViewerStateParams {
-    /** Axis to view. Valid values are "3D", "X", "Y", and "Z". Defaults to "3D". */
-    [ViewerStateKeys.View]?: string;
-    /**
-     * Render mode. Valid values are "volumetric", "maxproject", and "pathtrace".
-     * Defaults to "volumetric".
-     */
-    [ViewerStateKeys.Mode]?: string;
-    /** The opacity of the mask channel, an integer in the range [0, 100]. Defaults to 50. */
-    [ViewerStateKeys.Mask]?: string;
-    /** The type of image to display. Valid values are "cell" and "fov". Defaults to "cell". */
-    [ViewerStateKeys.Image]?: string;
-    /** Whether to show the axes helper. "1" is enabled. Disabled by default. */
-    [ViewerStateKeys.Axes]?: string;
-    /** Whether to show the bounding box. "1" is enabled. Disabled by default. */
-    [ViewerStateKeys.BoundingBox]?: string;
-    /** Whether single-channel mode is active. "1" is active. Inactive by default. */
-    [ViewerStateKeys.SingleChannelMode]?: string;
-    /** If single-channel mode is active, which channel index is shown. Defaults to 0. */
-    [ViewerStateKeys.SingleChannelIndex]?: string;
-    /** The color of the bounding box, as a 6-digit hex color. */
-    [ViewerStateKeys.BoundingBoxColor]?: string;
-    /** The background color, as a 6-digit hex color. */
-    [ViewerStateKeys.BackgroundColor]?: string;
-    /** Whether to autorotate the view. "1" is enabled. Disabled by default. */
-    [ViewerStateKeys.Autorotate]?: string;
-    /** The brightness of the image, an float in the range [0, 100]. Defaults to 70. */
-    [ViewerStateKeys.Brightness]?: string;
-    /** Density, a float in the range [0, 100]. Defaults to 50. */
-    [ViewerStateKeys.Density]?: string;
-    /**
-     * Levels for image intensity adjustment. Should be three numeric values separated
-     * by commas, representing the low, middle, and high values in a [0, 255] range.
-     * Values will be sorted in ascending order; empty values will be parsed as 0.
-     */
-    [ViewerStateKeys.Levels]?: string;
-    /** Whether to enable interpolation. "1" is enabled. Enabled by default. */
-    [ViewerStateKeys.Interpolation]?: string;
-    /** Subregions per axis, as min:max pairs separated by commas.
-     * Defaults to full range (`0:1`) for each axis.
-     */
-    [ViewerStateKeys.Region]?: string;
-    /** Slice position per X, Y, and Z axes, as a list of comma-separated floats.
-     * 0.5 for all axes by default (e.g. `0.5,0.5,0.5`)
-     */
-    [ViewerStateKeys.Slice]?: string;
-    /** Frame number, for time-series volumes. 0 by default. */
-    [ViewerStateKeys.Time]?: string;
-    /** Scene number, for multiscene images. 0 by default. */
-    [ViewerStateKeys.Scene]?: string;
-    /** Whether to use an exact scale level index. 0 by default. */
-    [ViewerStateKeys.UseExactScaleLevel]?: string;
-    /** The exact scale level index to use, if `UseExactScaleLevel` is 1. 0 by default. */
-    [ViewerStateKeys.ScaleLevelIndex]?: string;
-    /**
-     * Camera transform settings, as a list of `key:value` pairs separated by commas.
-     * Valid keys are defined in `CameraTransformKeys`:
-     * - `pos`: position
-     * - `tar`: target
-     * - `up`: up
-     * - `rot`: rotation
-     * - `ort`: orthographic scales
-     *
-     * All values are an array of three floats, separated by commas and
-     * encoded using `encodeURIComponent`.
-     */
-    [ViewerStateKeys.CameraState]?: string;
-}
 /** URL parameters that define data sources when loading volumes. */
 declare class DataParams {
     /**
@@ -321,73 +82,6 @@ type ViewerMessage = {
 export declare function getAllowedParams(searchParams: URLSearchParams): AppParams;
 /** Parses the `url` query param into a 2D URL array: one or more scenes, with one or more sources per scene. */
 export declare const parseImageURLParam: (urlParam: string) => string[][];
-/**
- * Parse a string list of comma-separated key:value pairs into
- * a key-value object.
- *
- * @param data The string to parse. Expected to be in the format
- * "key1:value1,key2:value2,...". Commas in keys or values
- * must be encoded using `encodeURIComponent`.
- * @returns An object with the parsed key-value pairs. Key and value strings
- *  will be decoded using `decodeURIComponent`.
- */
-export declare function parseKeyValueList(data: string): Record<string, string>;
-export declare function objectToKeyValueList(obj: Record<string, string | undefined>): string;
-/**
- * Parses a string to a float and clamps the result to the [min, max] range.
- * Returns `undefined` if the string is undefined or NaN.
- * @param value String to parse as a float. Will be parsed with `Number.parseFloat`.
- * @param min Minimum value, inclusive.
- * @param max Maximum value, inclusive.
- * @returns
- * - The parsed number, clamped to the [min, max] range.
- * - `undefined` if the string is undefined or NaN.
- */
-export declare function parseStringFloat(value: string | undefined, min: number, max: number): number | undefined;
-/**
- * Parses a string to an integer and clamps the result to the [min, max] range.
- * @param value String to parse as a float. Assumes base 10, parses with `Number.parseInt(value, 10)`.
- * @param min Minimum value, inclusive.
- * @param max Maximum value, inclusive.
- * @returns
- * - The parsed number, clamped to the [min, max] range.
- * - `undefined` if the string is undefined or NaN.
- */
-export declare function parseStringInt(value: string | undefined, min: number, max: number): number | undefined;
-/**
- * Parses a string to an enum value; if the string is not in the enum, returns the default value.
- * @param value String to parse.
- * @param enumValues Enum. Cannot be a `const enum`, as these are removed at compile time.
- * @param defaultValue Default value to return if the string is not in the enum.
- * @returns A value from the enum or the default value. Note that the return type includes `undefined`
- * if the `defaultValue` is `undefined`.
- */
-export declare function parseStringEnum<E extends string, T extends E | undefined>(value: string | undefined, enumValues: Record<string | number | symbol, E>, defaultValue?: T): T;
-export declare function parseHexColorAsColorArray(hexColor: string | undefined): ColorArray | undefined;
-export declare function serializeCameraState(cameraState: Partial<CameraState>, removeDefaults: boolean, viewMode?: ViewMode): string | undefined;
-/**
- * Parses a ViewerChannelSetting from a JSON object.
- * @param channelIndex Index of the channel, to be turned into a `match` value.
- * @param jsonState The serialized ViewerChannelSetting to parse, as an object.
- * @returns A ViewerChannelSetting object.
- */
-export declare function deserializeViewerChannelSetting(channelIndex: number, jsonState: ViewerChannelSettingParams): ViewerChannelSetting;
-/**
- * Serializes a single viewer channel setting into a dictionary of URL parameters
- * (`ViewerChannelSettingParams`).
- * @param channelSetting The channel state object to serialize.
- * @param removeDefaults Whether to remove properties that match the output of `GET_DEFAULT_CHANNEL_STATE`.
- * @returns A `ViewerChannelSettingParams` object with the serialized parameters. Undefined values are removed.
- */
-export declare function serializeViewerChannelSetting(channelSetting: Partial<ChannelState>, removeDefaults: boolean): Partial<ViewerChannelSettingParams>;
-export declare function deserializeViewerState(params: ViewerStateParams): Partial<ViewerState>;
-/**
- * Serializes a ViewerState object into a dictionary of URL parameters.
- * @param state The ViewerState to serialize.
- * @param removeDefaults If true, remove properties that match the output of `GET_DEFAULT_VIEWER_STATE`.
- * @returns A `ViewerStateParams` object with the serialized parameters. Undefined values are removed.
- */
-export declare function serializeViewerState(state: Partial<ViewerState>, removeDefaults: boolean): ViewerStateParams;
 export declare function loadFromManifest(manifestUrl: string): Promise<{
     scenes: (string | string[])[];
     metadata?: MetadataRecord[];

package/type-declarations/aics-image-viewer/state/deserialize.d.ts

@@ -0,0 +1,70 @@
+import type { ColorArray } from "../shared/utils/colorRepresentations";
+import type { ViewerChannelSetting } from "../shared/utils/viewerChannelSettings";
+import { type ViewerChannelStateParams, type ViewerState, type ViewerStateParams } from "./types";
+/**
+ * LEGACY: Matches a COMMA-separated list of control points, where each control point is represented
+ * by a triplet of `{x}:{opacity}:{hex color}`.
+ * The hex color can be replaced with `1` to represent white (`ffffff`).
+ */
+export declare const LEGACY_CONTROL_POINTS_REGEX: RegExp;
+/**
+ * Matches a COLON-separated list of control points, where each control point is
+ * represented by a triplet of `{x}:{opacity}:{hex color}`.
+ * - `x` is a value that will either be parsed as a histogram bin index (legacy,
+ *   for `ControlPointsLegacy`) or intensity value (for `ControlPoints`),
+ *   depending on on which field is being parsed.
+ * - Opacity is a float in the [0, 1] range.
+ * - The hex color is a 6-digit hex color (e.g. `ffeecc`), and can be replaced
+ *   with `1` to represent white (`ffffff`).
+ */
+export declare const CONTROL_POINTS_REGEX: RegExp;
+/**
+ * Parse a string list of comma-separated key:value pairs into
+ * a key-value object.
+ *
+ * @param data The string to parse. Expected to be in the format
+ * "key1:value1,key2:value2,...". Commas in keys or values
+ * must be encoded using `encodeURIComponent`.
+ * @returns An object with the parsed key-value pairs. Key and value strings
+ *  will be decoded using `decodeURIComponent`.
+ */
+export declare function parseKeyValueList(data: string): Record<string, string>;
+/**
+ * Parses a string to a float and clamps the result to the [min, max] range.
+ * Returns `undefined` if the string is undefined or NaN.
+ * @param value String to parse as a float. Will be parsed with `Number.parseFloat`.
+ * @param min Minimum value, inclusive.
+ * @param max Maximum value, inclusive.
+ * @returns
+ * - The parsed number, clamped to the [min, max] range.
+ * - `undefined` if the string is undefined or NaN.
+ */
+export declare function parseStringFloat(value: string | undefined, min: number, max: number): number | undefined;
+/**
+ * Parses a string to an integer and clamps the result to the [min, max] range.
+ * @param value String to parse as a float. Assumes base 10, parses with `Number.parseInt(value, 10)`.
+ * @param min Minimum value, inclusive.
+ * @param max Maximum value, inclusive.
+ * @returns
+ * - The parsed number, clamped to the [min, max] range.
+ * - `undefined` if the string is undefined or NaN.
+ */
+export declare function parseStringInt(value: string | undefined, min: number, max: number): number | undefined;
+/**
+ * Parses a string to an enum value; if the string is not in the enum, returns the default value.
+ * @param value String to parse.
+ * @param enumValues Enum. Cannot be a `const enum`, as these are removed at compile time.
+ * @param defaultValue Default value to return if the string is not in the enum.
+ * @returns A value from the enum or the default value. Note that the return type includes `undefined`
+ * if the `defaultValue` is `undefined`.
+ */
+export declare function parseStringEnum<E extends string, T extends E | undefined>(value: string | undefined, enumValues: Record<string | number | symbol, E>, defaultValue?: T): T;
+export declare function parseHexColorAsColorArray(hexColor: string | undefined): ColorArray | undefined;
+export declare function deserializeViewerState(params: ViewerStateParams): Partial<ViewerState>;
+/**
+ * Parses a ViewerChannelSetting from a JSON object.
+ * @param channelIndex Index of the channel, to be turned into a `match` value.
+ * @param jsonState The serialized ViewerChannelSetting to parse, as an object.
+ * @returns A ViewerChannelSetting object.
+ */
+export declare function deserializeViewerChannelSetting(channelIndex: number, jsonState: ViewerChannelStateParams): ViewerChannelSetting;

package/type-declarations/aics-image-viewer/state/serialize.d.ts

@@ -0,0 +1,20 @@
+import type { CameraState } from "@aics/vole-core";
+import { ViewMode } from "../shared/enums";
+import type { ChannelState, ViewerChannelStateParams, ViewerState, ViewerStateParams } from "./types";
+export declare function objectToKeyValueList(obj: Record<string, string | undefined>): string;
+export declare function serializeCameraState(cameraState: Partial<CameraState>, removeDefaults: boolean, viewMode?: ViewMode): string | undefined;
+/**
+ * Serializes a single viewer channel setting into a dictionary of URL parameters
+ * (`ViewerChannelStateParams`).
+ * @param channelSetting The channel state object to serialize.
+ * @param removeDefaults Whether to remove properties that match the output of `getDefaultChannelState`.
+ * @returns A `ViewerChannelSettingParams` object with the serialized parameters. Undefined values are removed.
+ */
+export declare function serializeViewerChannelSetting(channelSetting: Partial<ChannelState>, removeDefaults: boolean): Partial<ViewerChannelStateParams>;
+/**
+ * Serializes a `ViewerState` object into a dictionary of URL parameters.
+ * @param state The `ViewerState` to serialize.
+ * @param removeDefaults If true, remove properties that match the output of `getDefaultViewerState`.
+ * @returns A `ViewerStateParams` object with the serialized parameters. Undefined values are removed.
+ */
+export declare function serializeViewerState(state: Partial<ViewerState>, removeDefaults: boolean): ViewerStateParams;