larvitar 3.2.1 → 3.3.0

package/dist/imaging/imageRendering.d.ts

@@ -3,7 +3,7 @@
  *         rendering images in html canvas using cornerstone
  */
 import cornerstone from "cornerstone-core";
-import { Series, StoreViewport, StoreViewportOptions, Viewport } from "./types";
+import { RenderProps, Series, StoreViewport, Viewport } from "./types";
 /**
  * Purge the cornestone internal cache
  * If seriesId is passed as argument only imageIds of the series are purged from internal cache
@@ -92,13 +92,10 @@ export declare const resizeViewport: (elementId: string | HTMLElement) => void;
  * @function renderImage
  * @param {Object} seriesStack - The original series data object
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
- * @param {Object | undefined} options - Optional properties
+ * @param {RenderProps | undefined} options - Optional properties
  * @return {Promise} Return a promise which will resolve when image is displayed
  */
-export declare const renderImage: (seriesStack: Series, elementId: string | HTMLElement, options?: {
-    defaultProps?: StoreViewportOptions;
-    cached?: boolean;
-}) => Promise<true>;
+export declare const renderImage: (seriesStack: Series, elementId: string | HTMLElement, options?: RenderProps) => Promise<true>;
 /**
  * Redraw the cornerstone image
  * @instance
@@ -191,9 +188,9 @@ export declare const updateTemporalViewportData: (seriesStack: Series, elementId
  * Get series metadata from default props and series' metadata
  * @instance
  * @function getSeriesData
- * @param {Object} series - The parsed data series
- * @param {Object} defaultProps - Optional default properties
+ * @param {Series} series - The parsed data series
+ * @param {RenderProps} renderOptions - Optional default properties
  * @return {StoreViewport} data - A data dictionary with parsed tags' values
  */
-declare const getSeriesData: (series: Series, defaultProps: StoreViewportOptions) => StoreViewport;
+declare const getSeriesData: (series: Series, renderOptions: RenderProps) => StoreViewport;
 export {};

package/dist/imaging/tools/main.d.ts

@@ -16,10 +16,10 @@ declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) =>
  * Create stack object to sync stack tools
  * @function csToolsCreateStack
  * @param {HTMLElement} element - The target html element.
- * @param {Array?} imageIds - Stack image ids.
+ * @param {Array} imageIds - Stack image ids.
  * @param {number?} currentImageIndex - The current image id.
  */
-declare const csToolsCreateStack: (element: HTMLElement, imageIds?: string[], currentImageIndex?: number) => void;
+declare const csToolsCreateStack: (element: HTMLElement, imageIds: string[], currentImageIndex?: number) => void;
 /**
  * Update stack object to sync stack tools
  * @function csToolsUpdateImageIds