@itwin/presentation-shared
Version:
The package contains types and utilities used across different iTwin.js Presentation packages.
114 lines • 4.51 kB
JavaScript
;
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.formatConcatenatedValue = formatConcatenatedValue;
exports.createDefaultValueFormatter = createDefaultValueFormatter;
const core_bentley_1 = require("@itwin/core-bentley");
const ConcatenatedValue_js_1 = require("./ConcatenatedValue.js");
const Utils_js_1 = require("./Utils.js");
/**
* Formats a concatenated value into a string, taking into account different types of `ConcatenatedValuePart` that
* the value consists of.
*
* @public
*/
async function formatConcatenatedValue(props) {
const { value, valueFormatter } = props;
if (typeof value === "string") {
return valueFormatter({ value, type: "String" });
}
return ConcatenatedValue_js_1.ConcatenatedValue.serialize({
parts: value,
partFormatter: async (part) => {
// strings are converted to typed strings
if (ConcatenatedValue_js_1.ConcatenatedValuePart.isString(part)) {
part = {
value: part,
type: "String",
};
}
// finally, use provided value formatter to create a string from `TypedPrimitiveValue`
return valueFormatter(part);
},
});
}
/**
* A values' formatter that knows how to format the following types:
*
* - `Boolean` values are formatted to either "true" or "false".
*
* - `Integer` and `Long` values are rounded to the closest integer.
*
* - `Double` values are rounded to 2 decimal places.
*
* - `DateTime` values accept 2 formats in addition to `Date`:
* - if the value is numeric, assume it's a julian day format,
* - if the value is string, assume it's an ISO 8601 format.
*
* If extended type is set to `ShortDate`, the date is formatted as locale date string. Otherwise, it's
* formatted as locale date + time string.
*
* - `Point2d` values are formatted in `(x, y)` format.
*
* - `Point3d` values are formatted in `(x, y, z)` format.
*
* - `String` and `Id` values are returned as-is.
*
* @public
*/
function createDefaultValueFormatter() {
const formatters = [applyBooleanFormatting, applyNumericFormatting, applyDatesFormatting, applyPointsFormatting];
return async function (value) {
for (const formatter of formatters) {
const result = formatter(value);
if (!!result) {
return result;
}
}
(0, core_bentley_1.assert)(typeof value.value === "undefined" || typeof value.value === "boolean" || typeof value.value === "number" || typeof value.value === "string");
return value.value.toString();
};
}
function applyBooleanFormatting(value) {
if (value.type === "Boolean") {
return Boolean(value.value).toString();
}
return undefined;
}
function applyNumericFormatting(value) {
if (value.type === "Integer" || value.type === "Long") {
return Math.round(value.value).toLocaleString();
}
if (value.type === "Double") {
return value.value.toLocaleString(undefined, { minimumFractionDigits: 2, maximumFractionDigits: 2 });
}
return undefined;
}
function applyDatesFormatting(value) {
function getDate(julianOrDate) {
return typeof julianOrDate === "number" ? (0, Utils_js_1.julianToDateTime)(julianOrDate) : typeof julianOrDate === "string" ? new Date(julianOrDate) : julianOrDate;
}
if (value.type !== "DateTime") {
return undefined;
}
if (value.extendedType === "ShortDate") {
return getDate(value.value).toLocaleDateString();
}
return getDate(value.value).toLocaleString();
}
function applyPointsFormatting(value) {
function formatComponent(n) {
return applyNumericFormatting({ type: "Double", value: n });
}
if (value.type === "Point3d") {
return `(${formatComponent(value.value.x)}, ${formatComponent(value.value.y)}, ${formatComponent(value.value.z)})`;
}
if (value.type === "Point2d") {
return `(${formatComponent(value.value.x)}, ${formatComponent(value.value.y)})`;
}
return undefined;
}
//# sourceMappingURL=Formatting.js.map