@aics/vole-app 3.2.3 → 3.3.1

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

@@ -1,11 +1,10 @@
 import React from "react";
 import type { MetadataRecord } from "../../shared/types";
-import ChannelsWidget from "../ChannelsWidget";
-import CustomizeWidget, { type CustomizeWidgetProps } from "../CustomizeWidget";
-import GlobalVolumeControls, { type GlobalVolumeControlsProps } from "../GlobalVolumeControls";
+import { type ChannelsWidgetProps } from "../ChannelsWidget";
+import { type CustomizeWidgetProps } from "../CustomizeWidget";
+import { type GlobalVolumeControlsProps } from "../GlobalVolumeControls";
 import "./styles.css";
-type PropsOf<T> = T extends React.ComponentType<infer P> ? P : never;
-interface ControlPanelProps extends PropsOf<typeof ChannelsWidget>, PropsOf<typeof GlobalVolumeControls>, PropsOf<typeof CustomizeWidget> {
+interface ControlPanelProps extends ChannelsWidgetProps, GlobalVolumeControlsProps, CustomizeWidgetProps {
     hasImage: boolean;
     visibleControls: GlobalVolumeControlsProps["visibleControls"] & CustomizeWidgetProps["visibleControls"] & {
         colorPresetsDropdown: boolean;

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

@@ -1,16 +1,19 @@
+import { type Volume } from "@aics/vole-core";
 import React from "react";
 import "./styles.css";
 export type ErrorAlertDescription = {
     title: string;
     description: React.ReactNode;
 };
+type ErrorInfo = {
+    error: unknown;
+    count: number;
+    dims?: [number, number, number, number, number];
+};
 export type ErrorAlertProps = {
-    errors: unknown;
-    /** The number of times we've seen an error of the type that is currently being displayed before */
-    firstErrorCount?: number;
+    errors: ErrorInfo[];
     afterClose?: () => void;
-    onSkipError?: () => void;
 };
 declare const ErrorAlert: React.FC<ErrorAlertProps>;
-export declare const useErrorAlert: () => [React.ReactNode, (error: unknown) => void];
+export declare const useErrorAlert: () => [React.ReactNode, (error: unknown, image?: Volume) => void];
 export default ErrorAlert;

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

@@ -1,3 +1,4 @@
+import type { VolumeDims } from "@aics/vole-core";
 import React from "react";
 import "./styles.css";
 type ToolbarProps = {
@@ -6,6 +7,8 @@ type ToolbarProps = {
     hasCellId: boolean;
     hasParentImage: boolean;
     canPathTrace: boolean;
+    multiscaleDims?: VolumeDims[];
+    multiscaleIndex?: number;
     resetCamera: () => void;
     downloadScreenshot: () => void;
     resetToSavedViewerState: () => void;
@@ -16,6 +19,7 @@ type ToolbarProps = {
         resetCameraButton: boolean;
         showAxesButton: boolean;
         showBoundingBoxButton: boolean;
+        scaleLevelControls: boolean;
     };
 };
 declare const Toolbar: React.FC<ToolbarProps>;

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

@@ -1,4 +1,4 @@
-import { type RawArrayLoaderOptions, type View3d, type Volume } from "@aics/vole-core";
+import { LoadSpec, type RawArrayLoaderOptions, type View3d, type Volume } from "@aics/vole-core";
 import type { AxisName } from "../shared/types";
 import PlayControls from "../shared/utils/playControls";
 import type { ChannelGrouping, ViewerChannelSettings } from "../shared/utils/viewerChannelSettings";
@@ -7,11 +7,11 @@ export type UseVolumeOptions = {
     /** Callback called just once when the volume is created. */
     onCreateImage?: (image: Volume) => void;
     /** Callback called on any scene change, including the initial image load. */
-    onChangeScene?: (image: Volume, sceneIndex: number) => void;
+    onChangeScene?: (image: Volume, sceneIndex: number, loadSpec: LoadSpec) => void;
     /** 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/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,7 +1,7 @@
-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) => void;
+    onCreateScene?: (volume: Volume, sceneIndex: number, loadSpec: LoadSpec) => void;
     onChannelLoaded?: (volume: Volume, channelIndex: number) => void;
 };
 export default class SceneStore {
@@ -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

@@ -50,7 +50,9 @@ export declare enum ViewerStateKeys {
     Scene = "scene",
     CameraState = "cam",
     SingleChannelMode = "scm",
-    SingleChannelIndex = "sci"
+    SingleChannelIndex = "sci",
+    UseExactScaleLevel = "esl",
+    ScaleLevelIndex = "scl"
 }
 export declare enum CameraTransformKeys {
     /** Camera position in 3D coordinates. */
@@ -230,6 +232,10 @@ export declare class ViewerStateParams {
     [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`:

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

@@ -1,4 +1,5 @@
 import type { ColorArray } from "../shared/utils/colorRepresentations";
+import type { ViewerChannelSettings } from "../shared/utils/viewerChannelSettings";
 import { type ResetStateSlice } from "./reset";
 import type { ChannelState, ViewerState } from "./types";
 export type ViewerStateActions = {
@@ -8,6 +9,7 @@ export type ViewerStateActions = {
     }>) => void;
     changeChannelSetting: <K extends keyof ChannelState>(index: number | number[], value: Partial<Record<K, ChannelState[K]>>) => void;
     replaceAllChannelSettings: (channelSettings: ChannelState[]) => void;
+    initChannelSettings: (names: string[], settings?: ViewerChannelSettings) => ChannelState[];
     applyColorPresets: (colors: ColorArray[]) => void;
 };
 export type ViewerStore = ViewerState & ViewerStateActions & ResetStateSlice & {

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

@@ -24,6 +24,8 @@ export type ViewerState = {
     cameraState: Partial<CameraState> | undefined;
     singleChannelMode: boolean;
     singleChannelIndex: number;
+    useExactScaleLevel: boolean;
+    scaleLevelIndex: number;
 };
 export type ChannelState = {
     name: string;

package/LICENSE.txt

@@ -1,26 +0,0 @@
-Allen Institute Software License – This software license is the 2-clause BSD license 
-plus clause a third clause that prohibits redistribution for commercial purposes without further permission.
-
-Copyright © 2017. Allen Institute. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
-following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the 
-following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 
-following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Redistributions for commercial purposes are not permitted without the Allen Institute’s written permission.
-For purposes of this license, commercial purposes is the incorporation of the Allen Institute's software into
-anything for which you will charge fees or other compensation. Contact terms@alleninstitute.org for commercial
-licensing opportunities.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
-USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.