@itwin/imodel-components-react 4.0.0-dev.11 → 4.0.0-dev.13

package/lib/cjs/imodel-components-react/quantityformat/misc/UnitDescr.d.ts

@@ -1,24 +1,24 @@
-/** @packageDocumentation
- * @module QuantityFormat
- */
-/// <reference types="react" />
-import { UnitsProvider } from "@itwin/core-quantity";
-import { CommonProps } from "@itwin/core-react";
-/** Properties of [[UnitDescr]] component.
- * @internal
- */
-export interface UnitDescrProps extends CommonProps {
-    name: string;
-    parentUnitName?: string;
-    label: string;
-    index: number;
-    unitsProvider: UnitsProvider;
-    readonly?: boolean;
-    onUnitChange: (value: string, index: number) => void;
-    onLabelChange: (value: string, index: number) => void;
-}
-/** Component use to display dropdown list of possible units.
- * @internal
- */
-export declare function UnitDescr(props: UnitDescrProps): JSX.Element;
+/** @packageDocumentation
+ * @module QuantityFormat
+ */
+/// <reference types="react" />
+import { UnitsProvider } from "@itwin/core-quantity";
+import { CommonProps } from "@itwin/core-react";
+/** Properties of [[UnitDescr]] component.
+ * @internal
+ */
+export interface UnitDescrProps extends CommonProps {
+    name: string;
+    parentUnitName?: string;
+    label: string;
+    index: number;
+    unitsProvider: UnitsProvider;
+    readonly?: boolean;
+    onUnitChange: (value: string, index: number) => void;
+    onLabelChange: (value: string, index: number) => void;
+}
+/** Component use to display dropdown list of possible units.
+ * @internal
+ */
+export declare function UnitDescr(props: UnitDescrProps): JSX.Element;
 //# sourceMappingURL=UnitDescr.d.ts.map

package/lib/cjs/imodel-components-react/quantityformat/misc/UnitDescr.js

@@ -1,120 +1,124 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module QuantityFormat
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnitDescr = void 0;
-const React = __importStar(require("react"));
-const itwinui_react_1 = require("@itwin/itwinui-react");
-async function getUnitConversionData(possibleUnits, toUnit, unitsProvider) {
-    const unitConversionEntries = possibleUnits.map(async (unit) => {
-        const conversion = await unitsProvider.getConversion(unit, toUnit);
-        return { conversion, unitProps: unit };
-    });
-    return unitConversionEntries;
-}
-async function getPossibleUnits(parentUnit, unitsProvider, ensureCompatibleComposite) {
-    const phenomenon = parentUnit.phenomenon;
-    const possibleUnits = await unitsProvider.getUnitsByFamily(phenomenon);
-    if (!ensureCompatibleComposite)
-        return possibleUnits;
-    const conversionPromises = await getUnitConversionData(possibleUnits, parentUnit, unitsProvider);
-    const conversionEntries = await Promise.all(conversionPromises);
-    // sort the entries so the best potential sub unit will be the first one in the array
-    return conversionEntries.filter((entry) => ((entry.unitProps.system === parentUnit.system) && (entry.conversion.factor < 1)))
-        .sort((a, b) => b.conversion.factor - a.conversion.factor)
-        .map((value) => value.unitProps);
-}
-function getUnitName(fullUnitName) {
-    const nameParts = fullUnitName.split(/[.:]/);
-    // istanbul ignore else
-    if (nameParts.length > 0)
-        return nameParts[nameParts.length - 1];
-    // istanbul ignore next
-    throw Error("Bad unit name encountered");
-}
-/** Component use to display dropdown list of possible units.
- * @internal
- */
-function UnitDescr(props) {
-    const { name, label, parentUnitName, index, onUnitChange, onLabelChange, readonly, unitsProvider } = props;
-    const [unitOptions, setUnitOptions] = React.useState([{ value: name, label: getUnitName(name) }]);
-    const [currentUnit, setCurrentUnit] = React.useState({ name, label });
-    const isMounted = React.useRef(false);
-    React.useEffect(() => {
-        isMounted.current = true;
-        return () => {
-            isMounted.current = false;
-        };
-    });
-    React.useEffect(() => {
-        async function fetchAllowableUnitSelections() {
-            const currentUnitProps = await unitsProvider.findUnitByName(name);
-            const parentUnit = await unitsProvider.findUnitByName(parentUnitName ? parentUnitName : name);
-            // istanbul ignore else
-            if (parentUnit && currentUnitProps) {
-                let potentialSubUnit;
-                const potentialUnits = await getPossibleUnits(parentUnit, unitsProvider, index !== 0);
-                // istanbul ignore else
-                if (index < 3) {
-                    const potentialSubUnits = await getPossibleUnits(currentUnitProps, unitsProvider, true);
-                    if (potentialSubUnits.length)
-                        potentialSubUnit = potentialSubUnits[0];
-                }
-                const options = (potentialUnits.length > 0) ?
-                    potentialUnits.map((unitValue) => {
-                        return { value: `${unitValue.name}:${unitValue.label}`, label: getUnitName(unitValue.name) };
-                    }).sort((a, b) => a.label.localeCompare(b.label))
-                    : /* istanbul ignore next */
-                        [{ value: `${currentUnitProps.name}:${currentUnitProps.label}`, label: getUnitName(name) }];
-                if (potentialSubUnit) {
-                    // construct an entry that will provide the name and label of the unit to add
-                    options.push({ value: `ADDSUBUNIT:${potentialSubUnit.name}:${potentialSubUnit.label}`, label: "Add sub-unit" }); // NEEDSWORK - i18n
-                }
-                if (index !== 0)
-                    options.push({ value: "REMOVEUNIT", label: "Remove" }); // NEEDSWORK - i18n
-                // istanbul ignore else
-                if (isMounted.current) {
-                    setUnitOptions(options);
-                    setCurrentUnit(currentUnitProps);
-                }
-            }
-        }
-        fetchAllowableUnitSelections(); // eslint-disable-line @typescript-eslint/no-floating-promises
-    }, [index, label, name, parentUnitName, unitsProvider]);
-    const handleOnUnitChange = React.useCallback((newValue) => {
-        onUnitChange && onUnitChange(newValue, index);
-    }, [index, onUnitChange]);
-    const handleOnLabelChange = React.useCallback((e) => {
-        e.preventDefault();
-        onLabelChange && onLabelChange(e.target.value, index);
-    }, [index, onLabelChange]);
-    return (React.createElement(React.Fragment, null,
-        React.createElement(itwinui_react_1.Select, { options: unitOptions, "data-testid": `unit-${currentUnit.name}`, value: `${currentUnit.name}:${currentUnit.label}`, onChange: handleOnUnitChange, disabled: readonly, size: "small" }),
-        React.createElement(itwinui_react_1.Input, { "data-testid": `unit-label-${currentUnit.name}`, value: label, onChange: handleOnLabelChange, size: "small" })));
-}
-exports.UnitDescr = UnitDescr;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module QuantityFormat
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitDescr = void 0;
+const React = __importStar(require("react"));
+const itwinui_react_1 = require("@itwin/itwinui-react");
+async function getUnitConversionData(possibleUnits, toUnit, unitsProvider) {
+    const unitConversionEntries = possibleUnits.map(async (unit) => {
+        const conversion = await unitsProvider.getConversion(unit, toUnit);
+        return { conversion, unitProps: unit };
+    });
+    return unitConversionEntries;
+}
+async function getPossibleUnits(parentUnit, unitsProvider, ensureCompatibleComposite) {
+    const phenomenon = parentUnit.phenomenon;
+    const possibleUnits = await unitsProvider.getUnitsByFamily(phenomenon);
+    if (!ensureCompatibleComposite)
+        return possibleUnits;
+    const conversionPromises = await getUnitConversionData(possibleUnits, parentUnit, unitsProvider);
+    const conversionEntries = await Promise.all(conversionPromises);
+    // sort the entries so the best potential sub unit will be the first one in the array
+    return conversionEntries.filter((entry) => ((entry.unitProps.system === parentUnit.system) && (entry.conversion.factor < 1)))
+        .sort((a, b) => b.conversion.factor - a.conversion.factor)
+        .map((value) => value.unitProps);
+}
+function getUnitName(fullUnitName) {
+    const nameParts = fullUnitName.split(/[.:]/);
+    // istanbul ignore else
+    if (nameParts.length > 0)
+        return nameParts[nameParts.length - 1];
+    // istanbul ignore next
+    throw Error("Bad unit name encountered");
+}
+/** Component use to display dropdown list of possible units.
+ * @internal
+ */
+function UnitDescr(props) {
+    const { name, label, parentUnitName, index, onUnitChange, onLabelChange, readonly, unitsProvider } = props;
+    const [unitOptions, setUnitOptions] = React.useState([{ value: name, label: getUnitName(name) }]);
+    const [currentUnit, setCurrentUnit] = React.useState({ name, label });
+    const isMounted = React.useRef(false);
+    React.useEffect(() => {
+        isMounted.current = true;
+        return () => {
+            isMounted.current = false;
+        };
+    });
+    React.useEffect(() => {
+        async function fetchAllowableUnitSelections() {
+            const currentUnitProps = await unitsProvider.findUnitByName(name);
+            const parentUnit = await unitsProvider.findUnitByName(parentUnitName ? parentUnitName : name);
+            // istanbul ignore else
+            if (parentUnit && currentUnitProps) {
+                let potentialSubUnit;
+                const potentialUnits = await getPossibleUnits(parentUnit, unitsProvider, index !== 0);
+                // istanbul ignore else
+                if (index < 3) {
+                    const potentialSubUnits = await getPossibleUnits(currentUnitProps, unitsProvider, true);
+                    if (potentialSubUnits.length)
+                        potentialSubUnit = potentialSubUnits[0];
+                }
+                const options = (potentialUnits.length > 0) ?
+                    potentialUnits.map((unitValue) => {
+                        return { value: `${unitValue.name}:${unitValue.label}`, label: getUnitName(unitValue.name) };
+                    }).sort((a, b) => a.label.localeCompare(b.label))
+                    : /* istanbul ignore next */
+                        [{ value: `${currentUnitProps.name}:${currentUnitProps.label}`, label: getUnitName(name) }];
+                if (potentialSubUnit) {
+                    // construct an entry that will provide the name and label of the unit to add
+                    options.push({ value: `ADDSUBUNIT:${potentialSubUnit.name}:${potentialSubUnit.label}`, label: "Add sub-unit" }); // NEEDSWORK - i18n
+                }
+                if (index !== 0)
+                    options.push({ value: "REMOVEUNIT", label: "Remove" }); // NEEDSWORK - i18n
+                // istanbul ignore else
+                if (isMounted.current) {
+                    setUnitOptions(options);
+                    setCurrentUnit(currentUnitProps);
+                }
+            }
+        }
+        fetchAllowableUnitSelections(); // eslint-disable-line @typescript-eslint/no-floating-promises
+    }, [index, label, name, parentUnitName, unitsProvider]);
+    const handleOnUnitChange = React.useCallback((newValue) => {
+        onUnitChange && onUnitChange(newValue, index);
+    }, [index, onUnitChange]);
+    const handleOnLabelChange = React.useCallback((e) => {
+        e.preventDefault();
+        onLabelChange && onLabelChange(e.target.value, index);
+    }, [index, onLabelChange]);
+    return (React.createElement(React.Fragment, null,
+        React.createElement(itwinui_react_1.Select, { options: unitOptions, "data-testid": `unit-${currentUnit.name}`, value: `${currentUnit.name}:${currentUnit.label}`, onChange: handleOnUnitChange, disabled: readonly, size: "small" }),
+        React.createElement(itwinui_react_1.Input, { "data-testid": `unit-label-${currentUnit.name}`, value: label, onChange: handleOnLabelChange, size: "small" })));
+}
+exports.UnitDescr = UnitDescr;
 //# sourceMappingURL=UnitDescr.js.map

package/lib/cjs/imodel-components-react/quantityformat/misc/UnitDescr.js.map

@@ -1 +1 @@
-{"version":3,"file":"UnitDescr.js","sourceRoot":"","sources":["../../../../../src/imodel-components-react/quantityformat/misc/UnitDescr.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAG/B,wDAAmE;AAgBnE,KAAK,UAAU,qBAAqB,CAAC,aAA0B,EAAE,MAAiB,EAAE,aAA4B;IAC9G,MAAM,qBAAqB,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC7D,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,UAAqB,EAAE,aAA4B,EAAE,yBAAkC;IACrH,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACzC,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACvE,IAAI,CAAC,yBAAyB;QAC5B,OAAO,aAAa,CAAC;IAEvB,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,aAAa,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IACjG,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAChE,qFAAqF;IACrF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;SAC1H,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;SACzD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,WAAW,CAAC,YAAoB;IACvC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7C,uBAAuB;IACvB,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;QACtB,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzC,uBAAuB;IACvB,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,KAAqB;IAC7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IAC3G,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAyB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1H,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEtC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,KAAK,UAAU,4BAA4B;YACzC,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAClE,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9F,uBAAuB;YACvB,IAAI,UAAU,IAAI,gBAAgB,EAAE;gBAClC,IAAI,gBAAuC,CAAC;gBAC5C,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC;gBACtF,uBAAuB;gBACvB,IAAI,KAAK,GAAG,CAAC,EAAE;oBACb,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,gBAAgB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;oBACxF,IAAI,iBAAiB,CAAC,MAAM;wBAC1B,gBAAgB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;iBAC3C;gBAED,MAAM,OAAO,GAAG,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;oBAC3C,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;wBAC/B,OAAO,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/F,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBACjD,CAAC,CAAC,0BAA0B;wBAC5B,CAAC,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAAC,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAE9F,IAAI,gBAAgB,EAAE;oBACpB,6EAA6E;oBAC7E,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,gBAAgB,CAAC,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC,CAAE,mBAAmB;iBACtI;gBAED,IAAI,KAAK,KAAK,CAAC;oBACb,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,mBAAmB;gBAE7E,uBAAuB;gBACvB,IAAI,SAAS,CAAC,OAAO,EAAE;oBACrB,cAAc,CAAC,OAAO,CAAC,CAAC;oBACxB,cAAc,CAAC,gBAAgB,CAAC,CAAC;iBAClC;aACF;QACH,CAAC;QACD,4BAA4B,EAAE,CAAC,CAAC,8DAA8D;IAChG,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAExD,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,QAAgB,EAAE,EAAE;QAChE,YAAY,IAAI,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;IAE1B,MAAM,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAsC,EAAE,EAAE;QACvF,CAAC,CAAC,cAAc,EAAE,CAAC;QACnB,aAAa,IAAI,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAE3B,OAAO,CACL;QACE,oBAAC,sBAAM,IAAC,OAAO,EAAE,WAAW,iBAAe,QAAQ,WAAW,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,EACtH,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAC,OAAO,GAAG;QACnE,oBAAC,qBAAK,mBAAc,cAAc,WAAW,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAC,OAAO,GAAG,CACjH,CACJ,CAAC;AACJ,CAAC;AArED,8BAqEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module QuantityFormat\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { UnitProps, UnitsProvider } from \"@itwin/core-quantity\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { Input, Select, SelectOption } from \"@itwin/itwinui-react\";\r\n\r\n/** Properties of [[UnitDescr]] component.\r\n * @internal\r\n */\r\nexport interface UnitDescrProps extends CommonProps {\r\n  name: string;\r\n  parentUnitName?: string;\r\n  label: string;\r\n  index: number;\r\n  unitsProvider: UnitsProvider;\r\n  readonly?: boolean;\r\n  onUnitChange: (value: string, index: number) => void;\r\n  onLabelChange: (value: string, index: number) => void;\r\n}\r\n\r\nasync function getUnitConversionData(possibleUnits: UnitProps[], toUnit: UnitProps, unitsProvider: UnitsProvider) {\r\n  const unitConversionEntries = possibleUnits.map(async (unit) => {\r\n    const conversion = await unitsProvider.getConversion(unit, toUnit);\r\n    return { conversion, unitProps: unit };\r\n  });\r\n  return unitConversionEntries;\r\n}\r\n\r\nasync function getPossibleUnits(parentUnit: UnitProps, unitsProvider: UnitsProvider, ensureCompatibleComposite: boolean) {\r\n  const phenomenon = parentUnit.phenomenon;\r\n  const possibleUnits = await unitsProvider.getUnitsByFamily(phenomenon);\r\n  if (!ensureCompatibleComposite)\r\n    return possibleUnits;\r\n\r\n  const conversionPromises = await getUnitConversionData(possibleUnits, parentUnit, unitsProvider);\r\n  const conversionEntries = await Promise.all(conversionPromises);\r\n  // sort the entries so the best potential sub unit will be the first one in the array\r\n  return conversionEntries.filter((entry) => ((entry.unitProps.system === parentUnit.system) && (entry.conversion.factor < 1)))\r\n    .sort((a, b) => b.conversion.factor - a.conversion.factor)\r\n    .map((value) => value.unitProps);\r\n}\r\n\r\nfunction getUnitName(fullUnitName: string) {\r\n  const nameParts = fullUnitName.split(/[.:]/);\r\n  // istanbul ignore else\r\n  if (nameParts.length > 0)\r\n    return nameParts[nameParts.length - 1];\r\n  // istanbul ignore next\r\n  throw Error(\"Bad unit name encountered\");\r\n}\r\n\r\n/** Component use to display dropdown list of possible units.\r\n * @internal\r\n */\r\nexport function UnitDescr(props: UnitDescrProps) {\r\n  const { name, label, parentUnitName, index, onUnitChange, onLabelChange, readonly, unitsProvider } = props;\r\n  const [unitOptions, setUnitOptions] = React.useState<SelectOption<string>[]>([{ value: name, label: getUnitName(name) }]);\r\n  const [currentUnit, setCurrentUnit] = React.useState({ name, label });\r\n  const isMounted = React.useRef(false);\r\n\r\n  React.useEffect(() => {\r\n    isMounted.current = true;\r\n    return () => {\r\n      isMounted.current = false;\r\n    };\r\n  });\r\n\r\n  React.useEffect(() => {\r\n    async function fetchAllowableUnitSelections() {\r\n      const currentUnitProps = await unitsProvider.findUnitByName(name);\r\n      const parentUnit = await unitsProvider.findUnitByName(parentUnitName ? parentUnitName : name);\r\n      // istanbul ignore else\r\n      if (parentUnit && currentUnitProps) {\r\n        let potentialSubUnit: UnitProps | undefined;\r\n        const potentialUnits = await getPossibleUnits(parentUnit, unitsProvider, index !== 0);\r\n        // istanbul ignore else\r\n        if (index < 3) {\r\n          const potentialSubUnits = await getPossibleUnits(currentUnitProps, unitsProvider, true);\r\n          if (potentialSubUnits.length)\r\n            potentialSubUnit = potentialSubUnits[0];\r\n        }\r\n\r\n        const options = (potentialUnits.length > 0) ?\r\n          potentialUnits.map((unitValue) => {\r\n            return { value: `${unitValue.name}:${unitValue.label}`, label: getUnitName(unitValue.name) };\r\n          }).sort((a, b) => a.label.localeCompare(b.label))\r\n          : /* istanbul ignore next */\r\n          [{ value: `${currentUnitProps.name}:${currentUnitProps.label}`, label: getUnitName(name) }];\r\n\r\n        if (potentialSubUnit) {\r\n          // construct an entry that will provide the name and label of the unit to add\r\n          options.push({ value: `ADDSUBUNIT:${potentialSubUnit.name}:${potentialSubUnit.label}`, label: \"Add sub-unit\" });  // NEEDSWORK - i18n\r\n        }\r\n\r\n        if (index !== 0)\r\n          options.push({ value: \"REMOVEUNIT\", label: \"Remove\" }); // NEEDSWORK - i18n\r\n\r\n        // istanbul ignore else\r\n        if (isMounted.current) {\r\n          setUnitOptions(options);\r\n          setCurrentUnit(currentUnitProps);\r\n        }\r\n      }\r\n    }\r\n    fetchAllowableUnitSelections(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n  }, [index, label, name, parentUnitName, unitsProvider]);\r\n\r\n  const handleOnUnitChange = React.useCallback((newValue: string) => {\r\n    onUnitChange && onUnitChange(newValue, index);\r\n  }, [index, onUnitChange]);\r\n\r\n  const handleOnLabelChange = React.useCallback((e: React.ChangeEvent<HTMLInputElement>) => {\r\n    e.preventDefault();\r\n    onLabelChange && onLabelChange(e.target.value, index);\r\n  }, [index, onLabelChange]);\r\n\r\n  return (\r\n    <>\r\n      <Select options={unitOptions} data-testid={`unit-${currentUnit.name}`} value={`${currentUnit.name}:${currentUnit.label}`}\r\n        onChange={handleOnUnitChange} disabled={readonly} size=\"small\" />\r\n      <Input data-testid={`unit-label-${currentUnit.name}`} value={label} onChange={handleOnLabelChange} size=\"small\" />\r\n    </>\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"UnitDescr.js","sourceRoot":"","sources":["../../../../../src/imodel-components-react/quantityformat/misc/UnitDescr.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAG/B,wDAAmE;AAgBnE,KAAK,UAAU,qBAAqB,CAAC,aAA0B,EAAE,MAAiB,EAAE,aAA4B;IAC9G,MAAM,qBAAqB,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC7D,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,UAAqB,EAAE,aAA4B,EAAE,yBAAkC;IACrH,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACzC,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACvE,IAAI,CAAC,yBAAyB;QAC5B,OAAO,aAAa,CAAC;IAEvB,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,aAAa,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IACjG,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAChE,qFAAqF;IACrF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;SAC1H,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;SACzD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,WAAW,CAAC,YAAoB;IACvC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7C,uBAAuB;IACvB,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;QACtB,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzC,uBAAuB;IACvB,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,KAAqB;IAC7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IAC3G,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAyB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1H,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEtC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,KAAK,UAAU,4BAA4B;YACzC,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAClE,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9F,uBAAuB;YACvB,IAAI,UAAU,IAAI,gBAAgB,EAAE;gBAClC,IAAI,gBAAuC,CAAC;gBAC5C,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC;gBACtF,uBAAuB;gBACvB,IAAI,KAAK,GAAG,CAAC,EAAE;oBACb,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,gBAAgB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;oBACxF,IAAI,iBAAiB,CAAC,MAAM;wBAC1B,gBAAgB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;iBAC3C;gBAED,MAAM,OAAO,GAAG,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;oBAC3C,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;wBAC/B,OAAO,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/F,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBACjD,CAAC,CAAC,0BAA0B;wBAC5B,CAAC,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAAC,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAE9F,IAAI,gBAAgB,EAAE;oBACpB,6EAA6E;oBAC7E,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,gBAAgB,CAAC,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC,CAAE,mBAAmB;iBACtI;gBAED,IAAI,KAAK,KAAK,CAAC;oBACb,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,mBAAmB;gBAE7E,uBAAuB;gBACvB,IAAI,SAAS,CAAC,OAAO,EAAE;oBACrB,cAAc,CAAC,OAAO,CAAC,CAAC;oBACxB,cAAc,CAAC,gBAAgB,CAAC,CAAC;iBAClC;aACF;QACH,CAAC;QACD,4BAA4B,EAAE,CAAC,CAAC,8DAA8D;IAChG,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAExD,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,QAAgB,EAAE,EAAE;QAChE,YAAY,IAAI,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;IAE1B,MAAM,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAsC,EAAE,EAAE;QACvF,CAAC,CAAC,cAAc,EAAE,CAAC;QACnB,aAAa,IAAI,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAE3B,OAAO,CACL;QACE,oBAAC,sBAAM,IAAC,OAAO,EAAE,WAAW,iBAAe,QAAQ,WAAW,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,EACtH,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAC,OAAO,GAAG;QACnE,oBAAC,qBAAK,mBAAc,cAAc,WAAW,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAC,OAAO,GAAG,CACjH,CACJ,CAAC;AACJ,CAAC;AArED,8BAqEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module QuantityFormat\n */\n\nimport * as React from \"react\";\nimport { UnitProps, UnitsProvider } from \"@itwin/core-quantity\";\nimport { CommonProps } from \"@itwin/core-react\";\nimport { Input, Select, SelectOption } from \"@itwin/itwinui-react\";\n\n/** Properties of [[UnitDescr]] component.\n * @internal\n */\nexport interface UnitDescrProps extends CommonProps {\n  name: string;\n  parentUnitName?: string;\n  label: string;\n  index: number;\n  unitsProvider: UnitsProvider;\n  readonly?: boolean;\n  onUnitChange: (value: string, index: number) => void;\n  onLabelChange: (value: string, index: number) => void;\n}\n\nasync function getUnitConversionData(possibleUnits: UnitProps[], toUnit: UnitProps, unitsProvider: UnitsProvider) {\n  const unitConversionEntries = possibleUnits.map(async (unit) => {\n    const conversion = await unitsProvider.getConversion(unit, toUnit);\n    return { conversion, unitProps: unit };\n  });\n  return unitConversionEntries;\n}\n\nasync function getPossibleUnits(parentUnit: UnitProps, unitsProvider: UnitsProvider, ensureCompatibleComposite: boolean) {\n  const phenomenon = parentUnit.phenomenon;\n  const possibleUnits = await unitsProvider.getUnitsByFamily(phenomenon);\n  if (!ensureCompatibleComposite)\n    return possibleUnits;\n\n  const conversionPromises = await getUnitConversionData(possibleUnits, parentUnit, unitsProvider);\n  const conversionEntries = await Promise.all(conversionPromises);\n  // sort the entries so the best potential sub unit will be the first one in the array\n  return conversionEntries.filter((entry) => ((entry.unitProps.system === parentUnit.system) && (entry.conversion.factor < 1)))\n    .sort((a, b) => b.conversion.factor - a.conversion.factor)\n    .map((value) => value.unitProps);\n}\n\nfunction getUnitName(fullUnitName: string) {\n  const nameParts = fullUnitName.split(/[.:]/);\n  // istanbul ignore else\n  if (nameParts.length > 0)\n    return nameParts[nameParts.length - 1];\n  // istanbul ignore next\n  throw Error(\"Bad unit name encountered\");\n}\n\n/** Component use to display dropdown list of possible units.\n * @internal\n */\nexport function UnitDescr(props: UnitDescrProps) {\n  const { name, label, parentUnitName, index, onUnitChange, onLabelChange, readonly, unitsProvider } = props;\n  const [unitOptions, setUnitOptions] = React.useState<SelectOption<string>[]>([{ value: name, label: getUnitName(name) }]);\n  const [currentUnit, setCurrentUnit] = React.useState({ name, label });\n  const isMounted = React.useRef(false);\n\n  React.useEffect(() => {\n    isMounted.current = true;\n    return () => {\n      isMounted.current = false;\n    };\n  });\n\n  React.useEffect(() => {\n    async function fetchAllowableUnitSelections() {\n      const currentUnitProps = await unitsProvider.findUnitByName(name);\n      const parentUnit = await unitsProvider.findUnitByName(parentUnitName ? parentUnitName : name);\n      // istanbul ignore else\n      if (parentUnit && currentUnitProps) {\n        let potentialSubUnit: UnitProps | undefined;\n        const potentialUnits = await getPossibleUnits(parentUnit, unitsProvider, index !== 0);\n        // istanbul ignore else\n        if (index < 3) {\n          const potentialSubUnits = await getPossibleUnits(currentUnitProps, unitsProvider, true);\n          if (potentialSubUnits.length)\n            potentialSubUnit = potentialSubUnits[0];\n        }\n\n        const options = (potentialUnits.length > 0) ?\n          potentialUnits.map((unitValue) => {\n            return { value: `${unitValue.name}:${unitValue.label}`, label: getUnitName(unitValue.name) };\n          }).sort((a, b) => a.label.localeCompare(b.label))\n          : /* istanbul ignore next */\n          [{ value: `${currentUnitProps.name}:${currentUnitProps.label}`, label: getUnitName(name) }];\n\n        if (potentialSubUnit) {\n          // construct an entry that will provide the name and label of the unit to add\n          options.push({ value: `ADDSUBUNIT:${potentialSubUnit.name}:${potentialSubUnit.label}`, label: \"Add sub-unit\" });  // NEEDSWORK - i18n\n        }\n\n        if (index !== 0)\n          options.push({ value: \"REMOVEUNIT\", label: \"Remove\" }); // NEEDSWORK - i18n\n\n        // istanbul ignore else\n        if (isMounted.current) {\n          setUnitOptions(options);\n          setCurrentUnit(currentUnitProps);\n        }\n      }\n    }\n    fetchAllowableUnitSelections(); // eslint-disable-line @typescript-eslint/no-floating-promises\n  }, [index, label, name, parentUnitName, unitsProvider]);\n\n  const handleOnUnitChange = React.useCallback((newValue: string) => {\n    onUnitChange && onUnitChange(newValue, index);\n  }, [index, onUnitChange]);\n\n  const handleOnLabelChange = React.useCallback((e: React.ChangeEvent<HTMLInputElement>) => {\n    e.preventDefault();\n    onLabelChange && onLabelChange(e.target.value, index);\n  }, [index, onLabelChange]);\n\n  return (\n    <>\n      <Select options={unitOptions} data-testid={`unit-${currentUnit.name}`} value={`${currentUnit.name}:${currentUnit.label}`}\n        onChange={handleOnUnitChange} disabled={readonly} size=\"small\" />\n      <Input data-testid={`unit-label-${currentUnit.name}`} value={label} onChange={handleOnLabelChange} size=\"small\" />\n    </>\n  );\n}\n"]}

package/lib/cjs/imodel-components-react/timeline/BaseSolarDataProvider.d.ts

@@ -1,53 +1,53 @@
-/** @packageDocumentation
- * @module Timeline
- */
-import { Cartographic, ColorDef } from "@itwin/core-common";
-import { IModelConnection, ScreenViewport } from "@itwin/core-frontend";
-import { SolarDataProvider } from "./interfaces";
-/** Base class that provides solar data for animation control
- * @alpha
- */
-export declare class BaseSolarDataProvider implements SolarDataProvider {
-    protected _projectTimeZoneOffset: number;
-    protected _viewport: ScreenViewport | undefined;
-    protected _cartographicCenter: Cartographic;
-    protected _shadowColor: ColorDef;
-    longitude: number;
-    latitude: number;
-    viewId: string;
-    supportsTimelineAnimation: boolean;
-    animationFraction: number;
-    private _projectDayStartMS;
-    private _projectSunriseMs;
-    private _projectSunsetMs;
-    private _zoneOffsetMs;
-    private _projectSunrise;
-    private _projectSunset;
-    private _projectDateTime;
-    private _projectDay;
-    protected initializeData(projectTimeZoneOffset: number, initialTime?: Date): void;
-    constructor(viewport?: ScreenViewport, longitude?: number, latitude?: number);
-    get timeZoneOffset(): number;
-    get shadowColor(): ColorDef;
-    set shadowColor(color: ColorDef);
-    get shouldShowTimeline(): boolean;
-    /** Get time at project location */
-    get timeOfDay(): Date;
-    /** The date can be in project time or if isProjectDate is false, it is assumed to be users current local time
-     *  which will be adjusted to the same time at project location. */
-    setDateAndTime(date: Date, isProjectDate?: boolean): void;
-    /** Project Day Start */
-    get day(): Date;
-    /** Project Day Start in milliseconds */
-    get dayStartMs(): number;
-    getCartographicCenter(iModel: IModelConnection): Cartographic;
-    set viewport(viewport: ScreenViewport | undefined);
-    get viewport(): ScreenViewport | undefined;
-    protected getZone(location: Cartographic): number;
-    get sunrise(): Date;
-    get sunriseMs(): number;
-    get sunset(): Date;
-    get sunsetMs(): number;
-    onTimeChanged: (_time: Date) => void;
-}
+/** @packageDocumentation
+ * @module Timeline
+ */
+import { Cartographic, ColorDef } from "@itwin/core-common";
+import { IModelConnection, ScreenViewport } from "@itwin/core-frontend";
+import { SolarDataProvider } from "./interfaces";
+/** Base class that provides solar data for animation control
+ * @alpha
+ */
+export declare class BaseSolarDataProvider implements SolarDataProvider {
+    protected _projectTimeZoneOffset: number;
+    protected _viewport: ScreenViewport | undefined;
+    protected _cartographicCenter: Cartographic;
+    protected _shadowColor: ColorDef;
+    longitude: number;
+    latitude: number;
+    viewId: string;
+    supportsTimelineAnimation: boolean;
+    animationFraction: number;
+    private _projectDayStartMS;
+    private _projectSunriseMs;
+    private _projectSunsetMs;
+    private _zoneOffsetMs;
+    private _projectSunrise;
+    private _projectSunset;
+    private _projectDateTime;
+    private _projectDay;
+    protected initializeData(projectTimeZoneOffset: number, initialTime?: Date): void;
+    constructor(viewport?: ScreenViewport, longitude?: number, latitude?: number);
+    get timeZoneOffset(): number;
+    get shadowColor(): ColorDef;
+    set shadowColor(color: ColorDef);
+    get shouldShowTimeline(): boolean;
+    /** Get time at project location */
+    get timeOfDay(): Date;
+    /** The date can be in project time or if isProjectDate is false, it is assumed to be users current local time
+     *  which will be adjusted to the same time at project location. */
+    setDateAndTime(date: Date, isProjectDate?: boolean): void;
+    /** Project Day Start */
+    get day(): Date;
+    /** Project Day Start in milliseconds */
+    get dayStartMs(): number;
+    getCartographicCenter(iModel: IModelConnection): Cartographic;
+    set viewport(viewport: ScreenViewport | undefined);
+    get viewport(): ScreenViewport | undefined;
+    protected getZone(location: Cartographic): number;
+    get sunrise(): Date;
+    get sunriseMs(): number;
+    get sunset(): Date;
+    get sunsetMs(): number;
+    onTimeChanged: (_time: Date) => void;
+}
 //# sourceMappingURL=BaseSolarDataProvider.d.ts.map