@itwin/ecschema-metadata 3.4.0-dev.8 → 3.5.0-dev.4

package/lib/cjs/Metadata/Format.d.ts

@@ -1,99 +1,99 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { FormatProps } from "../Deserialization/JsonProps";
-import { SchemaItemType } from "../ECObjects";
-import { BaseFormat, DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
-import { InvertedUnit } from "./InvertedUnit";
-import { Schema } from "./Schema";
-import { SchemaItem } from "./SchemaItem";
-import { Unit } from "./Unit";
-/**
- * @beta
- */
-export declare class Format extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Format;
-    protected _base: BaseFormat;
-    protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;
-    constructor(schema: Schema, name: string);
-    get roundFactor(): number;
-    get type(): FormatType;
-    get precision(): DecimalPrecision | FractionalPrecision;
-    get minWidth(): number | undefined;
-    get scientificType(): ScientificType | undefined;
-    get showSignOption(): ShowSignOption;
-    get decimalSeparator(): string;
-    get thousandSeparator(): string;
-    get uomSeparator(): string;
-    get stationSeparator(): string;
-    get stationOffsetSize(): number | undefined;
-    get formatTraits(): FormatTraits;
-    get spacer(): string | undefined;
-    get includeZero(): boolean | undefined;
-    get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined;
-    private parseFormatTraits;
-    hasFormatTrait(formatTrait: FormatTraits): boolean;
-    /**
-     * Adds a Unit, or InvertedUnit, with an optional label override.
-     * @param unit The Unit, or InvertedUnit, to add to this Format.
-     * @param label A label that overrides the label defined within the Unit when a value is formatted.
-     */
-    protected addUnit(unit: Unit | InvertedUnit, label?: string): void;
-    protected setPrecision(precision: number): void;
-    private typecheck;
-    fromJSONSync(formatProps: FormatProps): void;
-    fromJSON(formatProps: FormatProps): Promise<void>;
-    /**
-     * Save this Format's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): FormatProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setFormatType(formatType: FormatType): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setRoundFactor(roundFactor: number): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setShowSignOption(signOption: ShowSignOption): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setDecimalSeparator(separator: string): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setThousandSeparator(separator: string): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setUomSeparator(separator: string): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setStationSeparator(separator: string): void;
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutableFormat extends Format {
-    abstract addUnit(unit: Unit | InvertedUnit, label?: string): void;
-    abstract setPrecision(precision: number): void;
-    abstract setFormatType(formatType: FormatType): void;
-    abstract setRoundFactor(roundFactor: number): void;
-    abstract setShowSignOption(signOption: ShowSignOption): void;
-    abstract setDecimalSeparator(separator: string): void;
-    abstract setThousandSeparator(separator: string): void;
-    abstract setUomSeparator(separator: string): void;
-    abstract setStationSeparator(separator: string): void;
-    abstract setDisplayLabel(displayLabel: string): void;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { FormatProps } from "../Deserialization/JsonProps";
+import { SchemaItemType } from "../ECObjects";
+import { BaseFormat, DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
+import { InvertedUnit } from "./InvertedUnit";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+import { Unit } from "./Unit";
+/**
+ * @beta
+ */
+export declare class Format extends SchemaItem {
+    readonly schemaItemType: SchemaItemType.Format;
+    protected _base: BaseFormat;
+    protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;
+    constructor(schema: Schema, name: string);
+    get roundFactor(): number;
+    get type(): FormatType;
+    get precision(): DecimalPrecision | FractionalPrecision;
+    get minWidth(): number | undefined;
+    get scientificType(): ScientificType | undefined;
+    get showSignOption(): ShowSignOption;
+    get decimalSeparator(): string;
+    get thousandSeparator(): string;
+    get uomSeparator(): string;
+    get stationSeparator(): string;
+    get stationOffsetSize(): number | undefined;
+    get formatTraits(): FormatTraits;
+    get spacer(): string | undefined;
+    get includeZero(): boolean | undefined;
+    get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined;
+    private parseFormatTraits;
+    hasFormatTrait(formatTrait: FormatTraits): boolean;
+    /**
+     * Adds a Unit, or InvertedUnit, with an optional label override.
+     * @param unit The Unit, or InvertedUnit, to add to this Format.
+     * @param label A label that overrides the label defined within the Unit when a value is formatted.
+     */
+    protected addUnit(unit: Unit | InvertedUnit, label?: string): void;
+    protected setPrecision(precision: number): void;
+    private typecheck;
+    fromJSONSync(formatProps: FormatProps): void;
+    fromJSON(formatProps: FormatProps): Promise<void>;
+    /**
+     * Save this Format's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): FormatProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setFormatType(formatType: FormatType): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setRoundFactor(roundFactor: number): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setShowSignOption(signOption: ShowSignOption): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setDecimalSeparator(separator: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setThousandSeparator(separator: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setUomSeparator(separator: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setStationSeparator(separator: string): void;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableFormat extends Format {
+    abstract addUnit(unit: Unit | InvertedUnit, label?: string): void;
+    abstract setPrecision(precision: number): void;
+    abstract setFormatType(formatType: FormatType): void;
+    abstract setRoundFactor(roundFactor: number): void;
+    abstract setShowSignOption(signOption: ShowSignOption): void;
+    abstract setDecimalSeparator(separator: string): void;
+    abstract setThousandSeparator(separator: string): void;
+    abstract setUomSeparator(separator: string): void;
+    abstract setStationSeparator(separator: string): void;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
 //# sourceMappingURL=Format.d.ts.map

package/lib/cjs/Metadata/Format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAsB,mBAAmB,EAC3H,cAAc,EAA0B,cAAc,EAAyB,MAAM,sBAAsB,CAAC;AAC9G,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,EAAG,cAAc,CAAC,MAAM,CAAC;IAChE,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;gBAExD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAOxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAExG,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM;IAa3D,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,WAAW;IAe/B,QAAQ,CAAC,WAAW,EAAE,WAAW;IAevD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,WAAW;IA+CvG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA4ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;CAGhD;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aACxD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAsB,mBAAmB,EAC3H,cAAc,EAA0B,cAAc,EAAyB,MAAM,sBAAsB,CAAC;AAC9G,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,EAAG,cAAc,CAAC,MAAM,CAAC;IAChE,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;gBAExD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAOxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAExG,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM;IAa3D,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,WAAW;IAe/B,QAAQ,CAAC,WAAW,EAAE,WAAW;IAevD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,WAAW;IAyDvG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA4ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;CAGhD;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aACxD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}