larvitar 3.0.0-beta.4 → 3.0.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,8 +7,8 @@ import type { ToolConfig, ToolSettings, ToolStyle } from "./types";
7
7
  /**
8
8
  * Initialize cornerstone tools with default configuration (extended with custom configuration)
9
9
  * @function initializeCSTools
10
- * @param {Object} settings - the settings object (see tools/default.js)
11
- * @param {Object} settings - the style object (see tools/default.js)
10
+ * @param {ToolSettings} settings - the settings object (see tools/default.js)
11
+ * @param {ToolStyle} style - the style object (see tools/default.js)
12
12
  * @example larvitar.initializeCSTools({showSVGCursors:false}, {color: "0000FF"});
13
13
  */
14
14
  declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) => void;
@@ -65,7 +65,7 @@ declare const setToolDisabled: (toolName: string, viewports?: string[], resetCur
65
65
  */
66
66
  declare const setToolEnabled: (toolName: string, viewports?: string[], resetCursor?: boolean) => void;
67
67
  /**
68
- * Set Tool "enabled" on all elements (ie, rendered and manipulable passively) & refresh cornerstone elements
68
+ * Set Tool "passive" on all elements (ie, rendered and manipulable passively) & refresh cornerstone elements
69
69
  * @function setToolPassive
70
70
  * @param {String} toolName - The tool name.
71
71
  * @param {Array} viewports - The hmtl element id to be used for tool initialization.
@@ -37,7 +37,7 @@ export declare function initSegmentationModule(customConfig: SegmentationConfig)
37
37
  export declare function addSegmentationMask(props: MaskProperties, data: TypedArray, elementId: string | HTMLElement): Promise<void>;
38
38
  /**
39
39
  * Set a new mask slice into the labelmap buffer
40
- * @param {String} elementId - The target html element Id or its DOM HTMLElement
40
+ * @param {string | HTMLElement} elementId - The target html element Id or its DOM HTMLElement
41
41
  * @param {Number} sliceIndex - the index of the new mask slice
42
42
  * @param {ArrayBuffer} pixelData - the pixelData array
43
43
  */