@itwin/ecschema-metadata 3.6.0-dev.11 → 3.6.0-dev.21

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