@aics/vole-app 3.3.1 → 3.4.1

package/es/aics-image-viewer/state/deserialize.js

@@ -0,0 +1,437 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { ImageType, RenderMode, ViewMode } from "../shared/enums";
+import { removeUndefinedProperties } from "../shared/utils/datatypes";
+import { clamp } from "../shared/utils/math";
+import { CameraTransformKeys, ViewerChannelSettingKeys, ViewerStateKeys } from "./types";
+var DEFAULT_CONTROL_POINT_COLOR = [255, 255, 255];
+var DEFAULT_CONTROL_POINT_COLOR_CODE = "1";
+var FLOAT_REGEX = /-?[0-9]*\.?[0-9]+/;
+
+/** Match colon-separated pairs of alphanumeric strings */
+var LUT_REGEX = /^-?[a-z0-9.]*:[ ]*-?[a-z0-9.]*$/;
+
+/**
+ * Match colon-separated pairs of numeric strings, representing histogram bin
+ * indices or intensity values.
+ */
+var RAMP_REGEX = new RegExp("^".concat(FLOAT_REGEX.source, ":").concat(FLOAT_REGEX.source, "$"));
+
+/**
+ * Match comma-separated triplet of numeric strings.
+ */
+var SLICE_REGEX = new RegExp("^".concat(FLOAT_REGEX.source, ",").concat(FLOAT_REGEX.source, ",").concat(FLOAT_REGEX.source, "$"));
+
+/**
+ * Matches a sequence of three comma-separated min:max number pairs, representing
+ * the x, y, and z axes.
+ */
+var REGION_REGEX = new RegExp("^(".concat(FLOAT_REGEX.source, ":").concat(FLOAT_REGEX.source, ")(,").concat(FLOAT_REGEX.source, ":").concat(FLOAT_REGEX.source, "){2}$"));
+var HEX_COLOR_REGEX = new RegExp("(([0-9a-fA-F]{6})|".concat(DEFAULT_CONTROL_POINT_COLOR_CODE, ")"));
+
+/** Represents control points specified by bin indices. */
+var CONTROL_POINT_REGEX = new RegExp("(".concat(FLOAT_REGEX.source, ":").concat(FLOAT_REGEX.source, ":").concat(HEX_COLOR_REGEX.source, ")"));
+var HEX_COLOR_STR_REGEX = new RegExp("^".concat(HEX_COLOR_REGEX.source, "$"));
+
+/**
+ * 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 var LEGACY_CONTROL_POINTS_REGEX = new RegExp("^".concat(CONTROL_POINT_REGEX.source, "(,").concat(CONTROL_POINT_REGEX.source, ")*$"));
+
+/**
+ * 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 var CONTROL_POINTS_REGEX = new RegExp("^".concat(CONTROL_POINT_REGEX.source, "(:").concat(CONTROL_POINT_REGEX.source, ")*$"));
+
+/**
+ * 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 function parseKeyValueList(data) {
+  if (data === "") {
+    return {};
+  }
+  var result = {};
+  var keyValuePairs = data.split(",");
+  var _iterator = _createForOfIteratorHelper(keyValuePairs),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var pair = _step.value;
+      var splitIndex = pair.indexOf(":");
+      if (splitIndex === -1) {
+        continue;
+      }
+      var key = pair.slice(0, splitIndex);
+      var value = pair.slice(splitIndex + 1);
+      result[decodeURIComponent(key).trim()] = decodeURIComponent(value).trim();
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return result;
+}
+
+/**
+ * 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 function parseStringFloat(value, min, max) {
+  if (value === undefined) {
+    return undefined;
+  }
+  var number = Number.parseFloat(value);
+  return Number.isNaN(number) ? undefined : clamp(number, min, max);
+}
+
+/**
+ * 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 function parseStringInt(value, min, max) {
+  if (value === undefined) {
+    return undefined;
+  }
+  var number = Number.parseInt(value, 10);
+  if (Number.isNaN(number)) {
+    return undefined;
+  }
+  return clamp(number, min, max);
+}
+
+/**
+ * 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 function parseStringEnum(value, enumValues) {
+  var defaultValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
+  if (value === undefined || !Object.values(enumValues).includes(value)) {
+    return defaultValue;
+  }
+  return value;
+}
+
+/**
+ * Parses a string boolean value ("1" as true, "0" as false), and returns `undefined` if the value is `undefined`.
+ */
+function parseStringBoolean(value) {
+  if (value === undefined) {
+    return undefined;
+  }
+  return value === "1";
+}
+export function parseHexColorAsColorArray(hexColor) {
+  if (!hexColor || !HEX_COLOR_STR_REGEX.test(hexColor)) {
+    return undefined;
+  }
+  // if (hexColor in COLOR_CODES) {
+  //   return COLOR_CODES[hexColor];
+  // }
+  if (hexColor === DEFAULT_CONTROL_POINT_COLOR_CODE) {
+    return DEFAULT_CONTROL_POINT_COLOR;
+  }
+  var r = Number.parseInt(hexColor.slice(0, 2), 16);
+  var g = Number.parseInt(hexColor.slice(2, 4), 16);
+  var b = Number.parseInt(hexColor.slice(4, 6), 16);
+  return [r, g, b];
+}
+function parseStringSlice(region) {
+  if (!region || !SLICE_REGEX.test(region)) {
+    return undefined;
+  }
+  var _region$split$map = region.split(",").map(function (val) {
+      return parseStringFloat(val, 0, 1);
+    }),
+    _region$split$map2 = _slicedToArray(_region$split$map, 3),
+    x = _region$split$map2[0],
+    y = _region$split$map2[1],
+    z = _region$split$map2[2];
+  if (x === undefined || y === undefined || z === undefined) {
+    return undefined;
+  }
+  return {
+    x: x,
+    y: y,
+    z: z
+  };
+}
+
+/**
+ * Parses an array of three numbers from a string.
+ * @param stringArr The string to parse. Should be three numbers separated by a separator.
+ * @param options Optional parameters for parsing:
+ * - `min`: Minimum value for each number. Default is negative infinity.
+ * - `max`: Maximum value for each number. Default is positive infinity.
+ * - `separator`: Separator between numbers. Default is `,`.
+ * @returns
+ * - undefined if the string is undefined or could not be parsed.
+ * - An array of three numbers, clamped to the [min, max] range.
+ */
+function parseThreeNumberArray(stringArr, options) {
+  var _options$min, _options$max, _options$separator;
+  if (!stringArr) {
+    return undefined;
+  }
+  var min = (_options$min = options === null || options === void 0 ? void 0 : options.min) !== null && _options$min !== void 0 ? _options$min : Number.NEGATIVE_INFINITY;
+  var max = (_options$max = options === null || options === void 0 ? void 0 : options.max) !== null && _options$max !== void 0 ? _options$max : Number.POSITIVE_INFINITY;
+  var separator = (_options$separator = options === null || options === void 0 ? void 0 : options.separator) !== null && _options$separator !== void 0 ? _options$separator : ",";
+  var _stringArr$split$map = stringArr.split(separator).map(function (val) {
+      return parseStringFloat(val, min, max);
+    }),
+    _stringArr$split$map2 = _slicedToArray(_stringArr$split$map, 3),
+    x = _stringArr$split$map2[0],
+    y = _stringArr$split$map2[1],
+    z = _stringArr$split$map2[2];
+  if (x === undefined || y === undefined || z === undefined) {
+    return undefined;
+  }
+  return [x, y, z];
+}
+function parseStringRegion(region) {
+  if (!region || !REGION_REGEX.test(region)) {
+    return undefined;
+  }
+  var _region$split$map3 = region.split(",").map(function (axis) {
+      // each is a min/max pair
+      var _axis$split$map = axis.split(":").map(function (val) {
+          return parseStringFloat(val, 0, 1);
+        }),
+        _axis$split$map2 = _slicedToArray(_axis$split$map, 2),
+        min = _axis$split$map2[0],
+        max = _axis$split$map2[1];
+      if (min === undefined || max === undefined) {
+        return undefined;
+      }
+      // Ensure sorted order
+      return min < max ? [min, max] : [max, min];
+    }),
+    _region$split$map4 = _slicedToArray(_region$split$map3, 3),
+    x = _region$split$map4[0],
+    y = _region$split$map4[1],
+    z = _region$split$map4[2];
+  // Check for undefined values
+  if (x === undefined || y === undefined || z === undefined) {
+    return undefined;
+  }
+  return {
+    x: x,
+    y: y,
+    z: z
+  };
+}
+function parseCameraState(cameraSettings) {
+  if (!cameraSettings) {
+    return undefined;
+  }
+  var parsedCameraSettings = parseKeyValueList(cameraSettings);
+  var result = {
+    position: parseThreeNumberArray(parsedCameraSettings[CameraTransformKeys.Position], {
+      separator: ":"
+    }),
+    target: parseThreeNumberArray(parsedCameraSettings[CameraTransformKeys.Target], {
+      separator: ":"
+    }),
+    up: parseThreeNumberArray(parsedCameraSettings[CameraTransformKeys.Up], {
+      separator: ":"
+    }),
+    // Orthographic scales cannot be negative
+    orthoScale: parseStringFloat(parsedCameraSettings[CameraTransformKeys.OrthoScale], 0, Infinity),
+    fov: parseStringFloat(parsedCameraSettings[CameraTransformKeys.Fov], 0, 180)
+  };
+  return removeUndefinedProperties(result);
+}
+export function deserializeViewerState(params) {
+  var result = {
+    maskAlpha: parseStringInt(params[ViewerStateKeys.Mask], 0, 100),
+    imageType: parseStringEnum(params[ViewerStateKeys.Image], ImageType),
+    showAxes: parseStringBoolean(params[ViewerStateKeys.Axes]),
+    showBoundingBox: parseStringBoolean(params[ViewerStateKeys.BoundingBox]),
+    boundingBoxColor: parseHexColorAsColorArray(params[ViewerStateKeys.BoundingBoxColor]),
+    backgroundColor: parseHexColorAsColorArray(params[ViewerStateKeys.BackgroundColor]),
+    autorotate: parseStringBoolean(params[ViewerStateKeys.Autorotate]),
+    brightness: parseStringFloat(params[ViewerStateKeys.Brightness], 0, 100),
+    density: parseStringFloat(params[ViewerStateKeys.Density], 0, 100),
+    levels: parseThreeNumberArray(params[ViewerStateKeys.Levels], {
+      min: 0,
+      max: 255
+    }),
+    interpolationEnabled: parseStringBoolean(params[ViewerStateKeys.Interpolation]),
+    region: parseStringRegion(params[ViewerStateKeys.Region]),
+    slice: parseStringSlice(params[ViewerStateKeys.Slice]),
+    time: parseStringInt(params[ViewerStateKeys.Time], 0, Number.POSITIVE_INFINITY),
+    scene: parseStringInt(params[ViewerStateKeys.Scene], 0, Number.POSITIVE_INFINITY),
+    renderMode: parseStringEnum(params[ViewerStateKeys.Mode], RenderMode),
+    singleChannelMode: parseStringBoolean(params[ViewerStateKeys.SingleChannelMode]),
+    singleChannelIndex: parseStringInt(params[ViewerStateKeys.SingleChannelIndex], 0, Number.POSITIVE_INFINITY),
+    useExactScaleLevel: parseStringBoolean(params[ViewerStateKeys.UseExactScaleLevel]),
+    scaleLevelIndex: parseStringInt(params[ViewerStateKeys.ScaleLevelIndex], 0, Number.MAX_SAFE_INTEGER),
+    cameraState: parseCameraState(params[ViewerStateKeys.CameraState])
+  };
+
+  // Handle viewmode, since they use different mappings
+  // TODO: Allow lowercase
+  if (params.view) {
+    var viewParamToViewMode = {
+      "3D": ViewMode.threeD,
+      Z: ViewMode.xy,
+      Y: ViewMode.xz,
+      X: ViewMode.yz
+    };
+    var allowedViews = Object.keys(viewParamToViewMode);
+    var view;
+    if (allowedViews.includes(params.view.toUpperCase())) {
+      view = params.view.toUpperCase();
+    } else {
+      view = "3D";
+    }
+    result.viewMode = viewParamToViewMode[view];
+  }
+  return removeUndefinedProperties(result);
+}
+function parseControlPoints(controlPoints) {
+  if (!(controlPoints && (CONTROL_POINTS_REGEX.test(controlPoints) || LEGACY_CONTROL_POINTS_REGEX.test(controlPoints)))) {
+    return undefined;
+  }
+
+  // Parse raw control point data from the string into an array of [x, opacity, color] triplets.
+  var controlPointStrings;
+  if (LEGACY_CONTROL_POINTS_REGEX.test(controlPoints)) {
+    // Legacy format uses commas to separate control points.
+    controlPointStrings = controlPoints.split(",").map(function (cp) {
+      return cp.split(":");
+    });
+  } else {
+    // New format is all colon-separated, where every three elements represent a control point.
+    controlPointStrings = controlPoints.split(":").reduce(function (acc, _val, i, array) {
+      if ((i + 1) % 3 === 0) {
+        acc.push([array[i - 2], array[i - 1], array[i]]);
+      }
+      return acc;
+    }, []);
+  }
+  var newControlPoints = controlPointStrings.map(function (cp) {
+    var _parseStringFloat, _parseStringFloat2, _parseHexColorAsColor;
+    var _cp = _slicedToArray(cp, 3),
+      x = _cp[0],
+      opacity = _cp[1],
+      color = _cp[2];
+    return {
+      x: (_parseStringFloat = parseStringFloat(x, -Infinity, Infinity)) !== null && _parseStringFloat !== void 0 ? _parseStringFloat : 0,
+      opacity: (_parseStringFloat2 = parseStringFloat(opacity, 0, 1)) !== null && _parseStringFloat2 !== void 0 ? _parseStringFloat2 : 1.0,
+      color: (_parseHexColorAsColor = parseHexColorAsColorArray(color)) !== null && _parseHexColorAsColor !== void 0 ? _parseHexColorAsColor : DEFAULT_CONTROL_POINT_COLOR
+    };
+  });
+  // Sort control points by x value
+  return newControlPoints.sort(function (a, b) {
+    return a.x - b.x;
+  });
+}
+
+/**
+ * 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 function deserializeViewerChannelSetting(channelIndex, jsonState) {
+  // Missing/undefined fields should be handled downstream.
+  var result = {
+    match: channelIndex,
+    enabled: parseStringBoolean(jsonState[ViewerChannelSettingKeys.VolumeEnabled]),
+    surfaceEnabled: parseStringBoolean(jsonState[ViewerChannelSettingKeys.SurfaceEnabled]),
+    isovalue: parseStringFloat(jsonState[ViewerChannelSettingKeys.IsosurfaceValue], -Infinity, Infinity),
+    keepIntensityRange: parseStringBoolean(jsonState[ViewerChannelSettingKeys.KeepRange]),
+    surfaceOpacity: parseStringFloat(jsonState[ViewerChannelSettingKeys.IsosurfaceAlpha], 0, 1),
+    colorizeEnabled: parseStringBoolean(jsonState[ViewerChannelSettingKeys.Colorize]),
+    colorizeAlpha: parseStringFloat(jsonState[ViewerChannelSettingKeys.ColorizeAlpha], 0, 1),
+    controlPointsEnabled: parseStringBoolean(jsonState[ViewerChannelSettingKeys.ControlPointsEnabled])
+  };
+  if (jsonState[ViewerChannelSettingKeys.Color] && HEX_COLOR_STR_REGEX.test(jsonState.col)) {
+    result.color = jsonState[ViewerChannelSettingKeys.Color];
+  }
+  if (jsonState[ViewerChannelSettingKeys.Lut] && LUT_REGEX.test(jsonState.lut)) {
+    var _jsonState$ViewerChan = jsonState[ViewerChannelSettingKeys.Lut].split(":"),
+      _jsonState$ViewerChan2 = _slicedToArray(_jsonState$ViewerChan, 2),
+      min = _jsonState$ViewerChan2[0],
+      max = _jsonState$ViewerChan2[1];
+    result.intensity = _objectSpread(_objectSpread({}, result.intensity), {}, {
+      lut: [min.trim(), max.trim()]
+    });
+  }
+  if (jsonState[ViewerChannelSettingKeys.Ramp]) {
+    if (RAMP_REGEX.test(jsonState[ViewerChannelSettingKeys.Ramp])) {
+      var _jsonState$ViewerChan3 = jsonState[ViewerChannelSettingKeys.Ramp].split(":"),
+        _jsonState$ViewerChan4 = _slicedToArray(_jsonState$ViewerChan3, 2),
+        _min = _jsonState$ViewerChan4[0],
+        _max = _jsonState$ViewerChan4[1];
+      result.intensity = _objectSpread(_objectSpread({}, result.intensity), {}, {
+        ramp: [Number.parseFloat(_min), Number.parseFloat(_max)]
+      });
+    }
+  } else if (jsonState[ViewerChannelSettingKeys.RampLegacy]) {
+    if (RAMP_REGEX.test(jsonState[ViewerChannelSettingKeys.RampLegacy])) {
+      var _jsonState$ViewerChan5 = jsonState[ViewerChannelSettingKeys.RampLegacy].split(":"),
+        _jsonState$ViewerChan6 = _slicedToArray(_jsonState$ViewerChan5, 2),
+        _min2 = _jsonState$ViewerChan6[0],
+        _max2 = _jsonState$ViewerChan6[1];
+      result.ramp = [Number.parseFloat(_min2), Number.parseFloat(_max2)];
+    }
+  }
+  if (jsonState[ViewerChannelSettingKeys.ControlPoints]) {
+    var parsedResult = parseControlPoints(jsonState[ViewerChannelSettingKeys.ControlPoints]);
+    if (parsedResult) {
+      result.intensity = _objectSpread(_objectSpread({}, result.intensity), {}, {
+        controlPoints: parsedResult
+      });
+    }
+  } else if (jsonState[ViewerChannelSettingKeys.ControlPointsLegacy]) {
+    var _parsedResult = parseControlPoints(jsonState[ViewerChannelSettingKeys.ControlPointsLegacy]);
+    if (_parsedResult) {
+      result.controlPoints = _parsedResult;
+    }
+  }
+  return result;
+}

package/es/aics-image-viewer/state/serialize.js

@@ -0,0 +1,145 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { isEqual } from "lodash";
+import { getDefaultCameraState, getDefaultChannelState, getDefaultViewerState } from "../shared/constants";
+import { ViewMode } from "../shared/enums";
+import { removeMatchingProperties, removeUndefinedProperties } from "../shared/utils/datatypes";
+import { CameraTransformKeys, ViewerChannelSettingKeys, ViewerStateKeys } from "./types";
+var ENCODED_COLON_REGEX = /%3A/g;
+var DEFAULT_CONTROL_POINT_COLOR = [255, 255, 255];
+var DEFAULT_CONTROL_POINT_COLOR_CODE = "1";
+export function objectToKeyValueList(obj) {
+  var keyValuePairs = [];
+  for (var key in obj) {
+    var value = obj[key];
+    if (value === undefined) {
+      continue;
+    }
+    // Allow colon separators to remain unencoded to save URL character length.
+    var escapedValue = encodeURIComponent(value.trim()).replace(ENCODED_COLON_REGEX, ":");
+    keyValuePairs.push("".concat(encodeURIComponent(key.trim()), ":").concat(escapedValue));
+  }
+  return keyValuePairs.join(",");
+}
+function colorArrayToHex(color) {
+  return color.map(function (c) {
+    return c.toString(16).padStart(2, "0");
+  }).join("").toLowerCase();
+}
+
+/**
+ * Formats a float or integer value to a string with a maximum precision for float values.
+ * @param value The number to format.
+ * @param maxPrecision The maximum number of significant digits to display for float values.
+ * Default is 7.
+ * @returns
+ * - For integers, the integer value as a string.
+ * - For floats, the float value as a string with a maximum of `maxPrecision` significant digits
+ * and any trailing zeroes removed.
+ *
+ * @example
+ * ```
+ * formatFloat(1.23456, 3) // "1.23"
+ * formatFloat(123456, 3) // "123456"
+ * formatFloat(1.3999999999999999, 3) // "1.4"
+ * ```
+ */
+function formatFloat(value) {
+  var maxPrecision = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 7;
+  if (Number.isInteger(value)) {
+    return value.toString();
+  }
+  return Number(value.toPrecision(maxPrecision)).toString();
+}
+function perAxisToArray(perAxis) {
+  return [perAxis.x, perAxis.y, perAxis.z];
+}
+
+/** Serializes a region into a `x1:x2,y1:y2,z1:z2` string format. */
+function serializeRegion(region) {
+  return perAxisToArray(region).map(function (axis) {
+    return axis.map(function (val) {
+      return formatFloat(val);
+    }).join(":");
+  }).join(",");
+}
+
+/** Serializes a slice parameter into a `x,y,z` string format. */
+function serializeSlice(slice) {
+  return perAxisToArray(slice).map(function (val) {
+    return formatFloat(val);
+  }).join(",");
+}
+function serializeBoolean(value) {
+  if (value === undefined) {
+    return undefined;
+  }
+  return value ? "1" : "0";
+}
+export function serializeCameraState(cameraState, removeDefaults) {
+  var viewMode = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : ViewMode.threeD;
+  if (removeDefaults) {
+    // Note that we use the `getDefaultCameraState()` to get the defaults here,
+    // instead of `getDefaultViewerState().cameraState`. The latter is undefined, which signals
+    // that the camera should not be modified for URLs that don't specify it.
+    cameraState = removeMatchingProperties(cameraState, getDefaultCameraState(viewMode));
+    if (Object.keys(cameraState).length === 0) {
+      return undefined;
+    }
+  }
+  var cameraString = objectToKeyValueList(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, CameraTransformKeys.Position, cameraState.position && cameraState.position.map(function (value) {
+    return formatFloat(value);
+  }).join(":")), CameraTransformKeys.Target, cameraState.target && cameraState.target.map(function (value) {
+    return formatFloat(value);
+  }).join(":")), CameraTransformKeys.Up, cameraState.up && cameraState.up.map(function (value) {
+    return formatFloat(value);
+  }).join(":")), CameraTransformKeys.OrthoScale, cameraState.orthoScale === undefined ? undefined : formatFloat(cameraState.orthoScale)), CameraTransformKeys.Fov, cameraState.fov === undefined ? undefined : formatFloat(cameraState.fov)));
+  return cameraString === "" ? undefined : cameraString;
+}
+function serializeControlPoints(controlPoints) {
+  return controlPoints.map(function (cp) {
+    var x = formatFloat(cp.x);
+    var opacity = formatFloat(cp.opacity);
+    // Default control-point color is encoded as DEFAULT_CONTROL_POINT_COLOR_CODE ("1").
+    var color = isEqual(cp.color, DEFAULT_CONTROL_POINT_COLOR) ? DEFAULT_CONTROL_POINT_COLOR_CODE : colorArrayToHex(cp.color);
+    return "".concat(x, ":").concat(opacity, ":").concat(color);
+  }).join(":");
+}
+
+/**
+ * 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 function serializeViewerChannelSetting(channelSetting, removeDefaults) {
+  var _channelSetting$isova, _channelSetting$opaci, _channelSetting$color, _channelSetting$ramp, _removeUndefinedPrope;
+  if (removeDefaults) {
+    channelSetting = removeMatchingProperties(channelSetting, getDefaultChannelState());
+  }
+  return removeUndefinedProperties((_removeUndefinedPrope = {}, _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_removeUndefinedPrope, ViewerChannelSettingKeys.VolumeEnabled, serializeBoolean(channelSetting.volumeEnabled)), ViewerChannelSettingKeys.SurfaceEnabled, serializeBoolean(channelSetting.isosurfaceEnabled)), ViewerChannelSettingKeys.IsosurfaceValue, (_channelSetting$isova = channelSetting.isovalue) === null || _channelSetting$isova === void 0 ? void 0 : _channelSetting$isova.toString()), ViewerChannelSettingKeys.IsosurfaceAlpha, (_channelSetting$opaci = channelSetting.opacity) === null || _channelSetting$opaci === void 0 ? void 0 : _channelSetting$opaci.toString()), ViewerChannelSettingKeys.Colorize, serializeBoolean(channelSetting.colorizeEnabled)), ViewerChannelSettingKeys.ColorizeAlpha, (_channelSetting$color = channelSetting.colorizeAlpha) === null || _channelSetting$color === void 0 ? void 0 : _channelSetting$color.toString()), ViewerChannelSettingKeys.Color, channelSetting.color && colorArrayToHex(channelSetting.color)), ViewerChannelSettingKeys.ControlPoints, channelSetting.controlPoints && serializeControlPoints(channelSetting.controlPoints)), ViewerChannelSettingKeys.ControlPointsEnabled, serializeBoolean(channelSetting.useControlPoints)), ViewerChannelSettingKeys.Ramp, (_channelSetting$ramp = channelSetting.ramp) === null || _channelSetting$ramp === void 0 ? void 0 : _channelSetting$ramp.join(":")), _defineProperty(_removeUndefinedPrope, ViewerChannelSettingKeys.KeepRange, serializeBoolean(channelSetting.keepIntensityRange))));
+}
+
+/**
+ * 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 function serializeViewerState(state, removeDefaults) {
+  var _state$maskAlpha, _state$brightness, _state$density, _state$levels, _state$time, _state$scene, _state$singleChannelI, _state$scaleLevelInde, _result;
+  if (removeDefaults) {
+    state = removeMatchingProperties(state, getDefaultViewerState());
+    // special case: if there's an explicit scale level but it's not being used, no reason to include it
+    if (state.scaleLevelIndex !== undefined && state.useExactScaleLevel === undefined) {
+      delete state.scaleLevelIndex;
+    }
+  }
+  var result = (_result = {}, _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_result, ViewerStateKeys.Mode, state.renderMode), ViewerStateKeys.Mask, (_state$maskAlpha = state.maskAlpha) === null || _state$maskAlpha === void 0 ? void 0 : _state$maskAlpha.toString()), ViewerStateKeys.Image, state.imageType), ViewerStateKeys.Axes, serializeBoolean(state.showAxes)), ViewerStateKeys.BoundingBox, serializeBoolean(state.showBoundingBox)), ViewerStateKeys.BoundingBoxColor, state.boundingBoxColor && colorArrayToHex(state.boundingBoxColor)), ViewerStateKeys.BackgroundColor, state.backgroundColor && colorArrayToHex(state.backgroundColor)), ViewerStateKeys.Autorotate, serializeBoolean(state.autorotate)), ViewerStateKeys.Brightness, (_state$brightness = state.brightness) === null || _state$brightness === void 0 ? void 0 : _state$brightness.toString()), ViewerStateKeys.Density, (_state$density = state.density) === null || _state$density === void 0 ? void 0 : _state$density.toString()), _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_result, ViewerStateKeys.Interpolation, serializeBoolean(state.interpolationEnabled)), ViewerStateKeys.Region, state.region && serializeRegion(state.region)), ViewerStateKeys.Slice, state.slice && serializeSlice(state.slice)), ViewerStateKeys.Levels, (_state$levels = state.levels) === null || _state$levels === void 0 ? void 0 : _state$levels.join(",")), ViewerStateKeys.Time, (_state$time = state.time) === null || _state$time === void 0 ? void 0 : _state$time.toString()), ViewerStateKeys.Scene, (_state$scene = state.scene) === null || _state$scene === void 0 ? void 0 : _state$scene.toString()), ViewerStateKeys.SingleChannelMode, serializeBoolean(state.singleChannelMode)), ViewerStateKeys.SingleChannelIndex, (_state$singleChannelI = state.singleChannelIndex) === null || _state$singleChannelI === void 0 ? void 0 : _state$singleChannelI.toString()), ViewerStateKeys.UseExactScaleLevel, serializeBoolean(state.useExactScaleLevel)), ViewerStateKeys.ScaleLevelIndex, (_state$scaleLevelInde = state.scaleLevelIndex) === null || _state$scaleLevelInde === void 0 ? void 0 : _state$scaleLevelInde.toString()), _defineProperty(_result, ViewerStateKeys.CameraState, state.cameraState && serializeCameraState(state.cameraState, removeDefaults, state.viewMode)));
+  var viewModeToViewParam = _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, ViewMode.threeD, "3D"), ViewMode.xy, "Z"), ViewMode.xz, "Y"), ViewMode.yz, "X");
+  result[ViewerStateKeys.View] = state.viewMode && viewModeToViewParam[state.viewMode];
+  return removeUndefinedProperties(result);
+}