@itwin/ecschema-metadata 4.0.0-dev.8 → 4.0.0-dev.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +41 -1
- package/lib/cjs/Constants.d.ts +23 -23
- package/lib/cjs/Constants.js +33 -33
- package/lib/cjs/Constants.js.map +1 -1
- package/lib/cjs/Context.d.ts +139 -139
- package/lib/cjs/Context.js +204 -204
- package/lib/cjs/DelayedPromise.d.ts +88 -88
- package/lib/cjs/DelayedPromise.d.ts.map +1 -1
- package/lib/cjs/DelayedPromise.js +91 -91
- package/lib/cjs/DelayedPromise.js.map +1 -1
- package/lib/cjs/Deserialization/AbstractParser.d.ts +45 -45
- package/lib/cjs/Deserialization/AbstractParser.d.ts.map +1 -1
- package/lib/cjs/Deserialization/AbstractParser.js +11 -11
- package/lib/cjs/Deserialization/Helper.d.ts +251 -251
- package/lib/cjs/Deserialization/Helper.js +843 -843
- package/lib/cjs/Deserialization/JsonParser.d.ts +165 -165
- package/lib/cjs/Deserialization/JsonParser.js +680 -680
- package/lib/cjs/Deserialization/JsonProps.d.ts +282 -282
- package/lib/cjs/Deserialization/JsonProps.d.ts.map +1 -1
- package/lib/cjs/Deserialization/JsonProps.js +9 -9
- package/lib/cjs/Deserialization/SchemaGraphUtil.d.ts +34 -34
- package/lib/cjs/Deserialization/SchemaGraphUtil.js +77 -77
- package/lib/cjs/Deserialization/XmlParser.d.ts +85 -85
- package/lib/cjs/Deserialization/XmlParser.js +973 -973
- package/lib/cjs/Deserialization/XmlSerializationUtils.d.ts +54 -54
- package/lib/cjs/Deserialization/XmlSerializationUtils.js +174 -174
- package/lib/cjs/ECName.d.ts +30 -30
- package/lib/cjs/ECName.js +85 -85
- package/lib/cjs/ECObjects.d.ts +162 -162
- package/lib/cjs/ECObjects.js +453 -453
- package/lib/cjs/Exception.d.ts +43 -43
- package/lib/cjs/Exception.js +84 -84
- package/lib/cjs/Interfaces.d.ts +66 -66
- package/lib/cjs/Interfaces.d.ts.map +1 -1
- package/lib/cjs/Interfaces.js +9 -9
- package/lib/cjs/Metadata/Class.d.ts +243 -243
- package/lib/cjs/Metadata/Class.js +558 -558
- package/lib/cjs/Metadata/Class.js.map +1 -1
- package/lib/cjs/Metadata/Constant.d.ts +64 -64
- package/lib/cjs/Metadata/Constant.js +123 -123
- package/lib/cjs/Metadata/Constant.js.map +1 -1
- package/lib/cjs/Metadata/CustomAttribute.d.ts +23 -23
- package/lib/cjs/Metadata/CustomAttribute.js +27 -27
- package/lib/cjs/Metadata/CustomAttributeClass.d.ts +39 -39
- package/lib/cjs/Metadata/CustomAttributeClass.js +68 -68
- package/lib/cjs/Metadata/CustomAttributeClass.js.map +1 -1
- package/lib/cjs/Metadata/EntityClass.d.ts +77 -77
- package/lib/cjs/Metadata/EntityClass.js +230 -230
- package/lib/cjs/Metadata/Enumeration.d.ts +86 -86
- package/lib/cjs/Metadata/Enumeration.d.ts.map +1 -1
- package/lib/cjs/Metadata/Enumeration.js +159 -159
- package/lib/cjs/Metadata/Enumeration.js.map +1 -1
- package/lib/cjs/Metadata/Format.d.ts +98 -98
- package/lib/cjs/Metadata/Format.js +242 -242
- package/lib/cjs/Metadata/InvertedUnit.d.ts +49 -49
- package/lib/cjs/Metadata/InvertedUnit.js +97 -97
- package/lib/cjs/Metadata/KindOfQuantity.d.ts +65 -65
- package/lib/cjs/Metadata/KindOfQuantity.js +225 -225
- package/lib/cjs/Metadata/KindOfQuantity.js.map +1 -1
- package/lib/cjs/Metadata/Mixin.d.ts +54 -54
- package/lib/cjs/Metadata/Mixin.js +113 -113
- package/lib/cjs/Metadata/Mixin.js.map +1 -1
- package/lib/cjs/Metadata/OverrideFormat.d.ts +55 -55
- package/lib/cjs/Metadata/OverrideFormat.js +88 -88
- package/lib/cjs/Metadata/Phenomenon.d.ts +33 -33
- package/lib/cjs/Metadata/Phenomenon.js +59 -59
- package/lib/cjs/Metadata/Property.d.ts +197 -197
- package/lib/cjs/Metadata/Property.d.ts.map +1 -1
- package/lib/cjs/Metadata/Property.js +491 -491
- package/lib/cjs/Metadata/Property.js.map +1 -1
- package/lib/cjs/Metadata/PropertyCategory.d.ts +39 -39
- package/lib/cjs/Metadata/PropertyCategory.js +61 -61
- package/lib/cjs/Metadata/PropertyCategory.js.map +1 -1
- package/lib/cjs/Metadata/RelationshipClass.d.ts +152 -152
- package/lib/cjs/Metadata/RelationshipClass.js +349 -349
- package/lib/cjs/Metadata/RelationshipClass.js.map +1 -1
- package/lib/cjs/Metadata/Schema.d.ts +291 -291
- package/lib/cjs/Metadata/Schema.d.ts.map +1 -1
- package/lib/cjs/Metadata/Schema.js +520 -520
- package/lib/cjs/Metadata/Schema.js.map +1 -1
- package/lib/cjs/Metadata/SchemaItem.d.ts +61 -61
- package/lib/cjs/Metadata/SchemaItem.js +136 -136
- package/lib/cjs/Metadata/Unit.d.ts +76 -76
- package/lib/cjs/Metadata/Unit.js +162 -162
- package/lib/cjs/Metadata/Unit.js.map +1 -1
- package/lib/cjs/Metadata/UnitSystem.d.ts +20 -20
- package/lib/cjs/Metadata/UnitSystem.js +29 -29
- package/lib/cjs/PropertyTypes.d.ts +49 -49
- package/lib/cjs/PropertyTypes.js +91 -91
- package/lib/cjs/PropertyTypes.js.map +1 -1
- package/lib/cjs/SchemaJsonLocater.d.ts +34 -34
- package/lib/cjs/SchemaJsonLocater.d.ts.map +1 -1
- package/lib/cjs/SchemaJsonLocater.js +42 -42
- package/lib/cjs/SchemaKey.d.ts +110 -110
- package/lib/cjs/SchemaKey.js +219 -219
- package/lib/cjs/SchemaLoader.d.ts +23 -23
- package/lib/cjs/SchemaLoader.js +47 -47
- package/lib/cjs/SchemaPartVisitorDelegate.d.ts +274 -274
- package/lib/cjs/SchemaPartVisitorDelegate.js +212 -212
- package/lib/cjs/UnitConversion/Graph.d.ts +34 -34
- package/lib/cjs/UnitConversion/Graph.js +83 -83
- package/lib/cjs/UnitConversion/Parser.d.ts +8 -8
- package/lib/cjs/UnitConversion/Parser.js +42 -42
- package/lib/cjs/UnitConversion/UnitConversion.d.ts +45 -45
- package/lib/cjs/UnitConversion/UnitConversion.js +77 -77
- package/lib/cjs/UnitConversion/UnitConversion.js.map +1 -1
- package/lib/cjs/UnitConversion/UnitConverter.d.ts +39 -39
- package/lib/cjs/UnitConversion/UnitConverter.js +116 -116
- package/lib/cjs/UnitConversion/UnitTree.d.ts +43 -43
- package/lib/cjs/UnitConversion/UnitTree.js +169 -169
- package/lib/cjs/UnitProvider/SchemaUnitProvider.d.ts +77 -77
- package/lib/cjs/UnitProvider/SchemaUnitProvider.js +234 -236
- package/lib/cjs/UnitProvider/SchemaUnitProvider.js.map +1 -1
- package/lib/cjs/Validation/SchemaWalker.d.ts +23 -23
- package/lib/cjs/Validation/SchemaWalker.js +53 -53
- package/lib/cjs/ecschema-metadata.d.ts +51 -51
- package/lib/cjs/ecschema-metadata.js +100 -96
- package/lib/cjs/ecschema-metadata.js.map +1 -1
- package/lib/cjs/utils/SchemaGraph.d.ts +25 -25
- package/lib/cjs/utils/SchemaGraph.js +65 -65
- package/package.json +12 -12
|
@@ -1,98 +1,98 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
|
6
|
-
/** @packageDocumentation
|
|
7
|
-
* @module Metadata
|
|
8
|
-
*/
|
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
-
exports.MutableInvertedUnit = exports.InvertedUnit = void 0;
|
|
11
|
-
const DelayedPromise_1 = require("../DelayedPromise");
|
|
12
|
-
const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
|
|
13
|
-
const ECObjects_1 = require("../ECObjects");
|
|
14
|
-
const Exception_1 = require("../Exception");
|
|
15
|
-
const SchemaItem_1 = require("./SchemaItem");
|
|
16
|
-
/**
|
|
17
|
-
* An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less.
|
|
18
|
-
* @beta
|
|
19
|
-
*/
|
|
20
|
-
class InvertedUnit extends SchemaItem_1.SchemaItem {
|
|
21
|
-
constructor(schema, name) {
|
|
22
|
-
super(schema, name);
|
|
23
|
-
this.schemaItemType = ECObjects_1.SchemaItemType.InvertedUnit;
|
|
24
|
-
}
|
|
25
|
-
get invertsUnit() { return this._invertsUnit; }
|
|
26
|
-
get unitSystem() { return this._unitSystem; }
|
|
27
|
-
/**
|
|
28
|
-
* Save this InvertedUnit's properties to an object for serializing to JSON.
|
|
29
|
-
* @param standalone Serialization includes only this object (as opposed to the full schema).
|
|
30
|
-
* @param includeSchemaVersion Include the Schema's version information in the serialized object.
|
|
31
|
-
*/
|
|
32
|
-
toJSON(standalone = false, includeSchemaVersion = false) {
|
|
33
|
-
const schemaJson = super.toJSON(standalone, includeSchemaVersion);
|
|
34
|
-
schemaJson.invertsUnit = this.invertsUnit.fullName;
|
|
35
|
-
schemaJson.unitSystem = this.unitSystem.fullName;
|
|
36
|
-
return schemaJson;
|
|
37
|
-
}
|
|
38
|
-
/** @internal */
|
|
39
|
-
async toXml(schemaXml) {
|
|
40
|
-
const itemElement = await super.toXml(schemaXml);
|
|
41
|
-
const unitSystem = await this.unitSystem;
|
|
42
|
-
if (undefined !== unitSystem) {
|
|
43
|
-
const unitSystemName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);
|
|
44
|
-
itemElement.setAttribute("unitSystem", unitSystemName);
|
|
45
|
-
}
|
|
46
|
-
const invertsUnit = await this.invertsUnit;
|
|
47
|
-
if (undefined !== invertsUnit) {
|
|
48
|
-
const invertsUnitName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, invertsUnit.schema, invertsUnit.name);
|
|
49
|
-
itemElement.setAttribute("invertsUnit", invertsUnitName);
|
|
50
|
-
}
|
|
51
|
-
return itemElement;
|
|
52
|
-
}
|
|
53
|
-
fromJSONSync(invertedUnitProps) {
|
|
54
|
-
super.fromJSONSync(invertedUnitProps);
|
|
55
|
-
const unitSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.invertsUnit);
|
|
56
|
-
this._invertsUnit = new DelayedPromise_1.DelayedPromiseWithProps(unitSchemaItemKey, async () => {
|
|
57
|
-
const invertsUnit = await this.schema.lookupItem(unitSchemaItemKey);
|
|
58
|
-
if (undefined === invertsUnit)
|
|
59
|
-
throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the invertsUnit ${invertedUnitProps.invertsUnit}.`);
|
|
60
|
-
return invertsUnit;
|
|
61
|
-
});
|
|
62
|
-
const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.unitSystem);
|
|
63
|
-
if (!unitSystemSchemaItemKey)
|
|
64
|
-
throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
|
|
65
|
-
this._unitSystem = new DelayedPromise_1.DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
|
|
66
|
-
const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey);
|
|
67
|
-
if (undefined === unitSystem)
|
|
68
|
-
throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
|
|
69
|
-
return unitSystem;
|
|
70
|
-
});
|
|
71
|
-
}
|
|
72
|
-
async fromJSON(invertedUnitProps) {
|
|
73
|
-
this.fromJSONSync(invertedUnitProps);
|
|
74
|
-
}
|
|
75
|
-
/**
|
|
76
|
-
* @alpha
|
|
77
|
-
* Used for schema editing
|
|
78
|
-
*/
|
|
79
|
-
setInvertsUnit(invertsUnit) {
|
|
80
|
-
this._invertsUnit = invertsUnit;
|
|
81
|
-
}
|
|
82
|
-
/**
|
|
83
|
-
* @alpha
|
|
84
|
-
* Used for schema editing
|
|
85
|
-
*/
|
|
86
|
-
setUnitSystem(unitSystem) {
|
|
87
|
-
this._unitSystem = unitSystem;
|
|
88
|
-
}
|
|
89
|
-
}
|
|
90
|
-
exports.InvertedUnit = InvertedUnit;
|
|
91
|
-
/**
|
|
92
|
-
* @internal
|
|
93
|
-
* An abstract class used for schema editing.
|
|
94
|
-
*/
|
|
95
|
-
class MutableInvertedUnit extends InvertedUnit {
|
|
96
|
-
}
|
|
97
|
-
exports.MutableInvertedUnit = MutableInvertedUnit;
|
|
1
|
+
"use strict";
|
|
2
|
+
/*---------------------------------------------------------------------------------------------
|
|
3
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
4
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
5
|
+
*--------------------------------------------------------------------------------------------*/
|
|
6
|
+
/** @packageDocumentation
|
|
7
|
+
* @module Metadata
|
|
8
|
+
*/
|
|
9
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
exports.MutableInvertedUnit = exports.InvertedUnit = void 0;
|
|
11
|
+
const DelayedPromise_1 = require("../DelayedPromise");
|
|
12
|
+
const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
|
|
13
|
+
const ECObjects_1 = require("../ECObjects");
|
|
14
|
+
const Exception_1 = require("../Exception");
|
|
15
|
+
const SchemaItem_1 = require("./SchemaItem");
|
|
16
|
+
/**
|
|
17
|
+
* An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less.
|
|
18
|
+
* @beta
|
|
19
|
+
*/
|
|
20
|
+
class InvertedUnit extends SchemaItem_1.SchemaItem {
|
|
21
|
+
constructor(schema, name) {
|
|
22
|
+
super(schema, name);
|
|
23
|
+
this.schemaItemType = ECObjects_1.SchemaItemType.InvertedUnit;
|
|
24
|
+
}
|
|
25
|
+
get invertsUnit() { return this._invertsUnit; }
|
|
26
|
+
get unitSystem() { return this._unitSystem; }
|
|
27
|
+
/**
|
|
28
|
+
* Save this InvertedUnit's properties to an object for serializing to JSON.
|
|
29
|
+
* @param standalone Serialization includes only this object (as opposed to the full schema).
|
|
30
|
+
* @param includeSchemaVersion Include the Schema's version information in the serialized object.
|
|
31
|
+
*/
|
|
32
|
+
toJSON(standalone = false, includeSchemaVersion = false) {
|
|
33
|
+
const schemaJson = super.toJSON(standalone, includeSchemaVersion);
|
|
34
|
+
schemaJson.invertsUnit = this.invertsUnit.fullName;
|
|
35
|
+
schemaJson.unitSystem = this.unitSystem.fullName;
|
|
36
|
+
return schemaJson;
|
|
37
|
+
}
|
|
38
|
+
/** @internal */
|
|
39
|
+
async toXml(schemaXml) {
|
|
40
|
+
const itemElement = await super.toXml(schemaXml);
|
|
41
|
+
const unitSystem = await this.unitSystem;
|
|
42
|
+
if (undefined !== unitSystem) {
|
|
43
|
+
const unitSystemName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);
|
|
44
|
+
itemElement.setAttribute("unitSystem", unitSystemName);
|
|
45
|
+
}
|
|
46
|
+
const invertsUnit = await this.invertsUnit;
|
|
47
|
+
if (undefined !== invertsUnit) {
|
|
48
|
+
const invertsUnitName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, invertsUnit.schema, invertsUnit.name);
|
|
49
|
+
itemElement.setAttribute("invertsUnit", invertsUnitName);
|
|
50
|
+
}
|
|
51
|
+
return itemElement;
|
|
52
|
+
}
|
|
53
|
+
fromJSONSync(invertedUnitProps) {
|
|
54
|
+
super.fromJSONSync(invertedUnitProps);
|
|
55
|
+
const unitSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.invertsUnit);
|
|
56
|
+
this._invertsUnit = new DelayedPromise_1.DelayedPromiseWithProps(unitSchemaItemKey, async () => {
|
|
57
|
+
const invertsUnit = await this.schema.lookupItem(unitSchemaItemKey);
|
|
58
|
+
if (undefined === invertsUnit)
|
|
59
|
+
throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the invertsUnit ${invertedUnitProps.invertsUnit}.`);
|
|
60
|
+
return invertsUnit;
|
|
61
|
+
});
|
|
62
|
+
const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.unitSystem);
|
|
63
|
+
if (!unitSystemSchemaItemKey)
|
|
64
|
+
throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
|
|
65
|
+
this._unitSystem = new DelayedPromise_1.DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
|
|
66
|
+
const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey);
|
|
67
|
+
if (undefined === unitSystem)
|
|
68
|
+
throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
|
|
69
|
+
return unitSystem;
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
async fromJSON(invertedUnitProps) {
|
|
73
|
+
this.fromJSONSync(invertedUnitProps);
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @alpha
|
|
77
|
+
* Used for schema editing
|
|
78
|
+
*/
|
|
79
|
+
setInvertsUnit(invertsUnit) {
|
|
80
|
+
this._invertsUnit = invertsUnit;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* @alpha
|
|
84
|
+
* Used for schema editing
|
|
85
|
+
*/
|
|
86
|
+
setUnitSystem(unitSystem) {
|
|
87
|
+
this._unitSystem = unitSystem;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
exports.InvertedUnit = InvertedUnit;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
* An abstract class used for schema editing.
|
|
94
|
+
*/
|
|
95
|
+
class MutableInvertedUnit extends InvertedUnit {
|
|
96
|
+
}
|
|
97
|
+
exports.MutableInvertedUnit = MutableInvertedUnit;
|
|
98
98
|
//# sourceMappingURL=InvertedUnit.js.map
|
|
@@ -1,66 +1,66 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module Metadata
|
|
3
|
-
*/
|
|
4
|
-
import { KindOfQuantityProps } from "../Deserialization/JsonProps";
|
|
5
|
-
import { SchemaItemType } from "../ECObjects";
|
|
6
|
-
import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
|
|
7
|
-
import { Format } from "./Format";
|
|
8
|
-
import { InvertedUnit } from "./InvertedUnit";
|
|
9
|
-
import { OverrideFormat } from "./OverrideFormat";
|
|
10
|
-
import { Schema } from "./Schema";
|
|
11
|
-
import { SchemaItem } from "./SchemaItem";
|
|
12
|
-
import { Unit } from "./Unit";
|
|
13
|
-
/** A Typescript class representation of a KindOfQuantity.
|
|
14
|
-
* @beta
|
|
15
|
-
*/
|
|
16
|
-
export declare class KindOfQuantity extends SchemaItem {
|
|
17
|
-
readonly schemaItemType: SchemaItemType.KindOfQuantity;
|
|
18
|
-
protected _relativeError: number;
|
|
19
|
-
protected _presentationFormats: Array<Format | OverrideFormat>;
|
|
20
|
-
protected _persistenceUnit?: LazyLoadedUnit | LazyLoadedInvertedUnit;
|
|
21
|
-
/** The first presentation format in the list of Formats. */
|
|
22
|
-
get defaultPresentationFormat(): Format | OverrideFormat | undefined;
|
|
23
|
-
/** A list of presentation formats. */
|
|
24
|
-
get presentationFormats(): Array<Format | OverrideFormat>;
|
|
25
|
-
get persistenceUnit(): LazyLoadedUnit | LazyLoadedInvertedUnit | undefined;
|
|
26
|
-
get relativeError(): number;
|
|
27
|
-
constructor(schema: Schema, name: string);
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @param format The Format to add to this KindOfQuantity
|
|
31
|
-
* @param isDefault
|
|
32
|
-
*/
|
|
33
|
-
protected addPresentationFormat(format: Format | OverrideFormat, isDefault?: boolean): void;
|
|
34
|
-
/** Parses the format string into the parts that make up an Override Format
|
|
35
|
-
* @param formatString
|
|
36
|
-
*/
|
|
37
|
-
private parseFormatString;
|
|
38
|
-
/** Creates an OverrideFormat in the context of this KindOfQuantity.
|
|
39
|
-
* @param parent The Format to override.
|
|
40
|
-
* @param precision The precision override
|
|
41
|
-
* @param unitLabelOverrides The list of unit and label overrides.
|
|
42
|
-
*/
|
|
43
|
-
protected createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;
|
|
44
|
-
private processPresentationUnits;
|
|
45
|
-
private processPresentationUnitsSync;
|
|
46
|
-
/**
|
|
47
|
-
* Save this KindOfQuantity's properties to an object for serializing to JSON.
|
|
48
|
-
* @param standalone Serialization includes only this object (as opposed to the full schema).
|
|
49
|
-
* @param includeSchemaVersion Include the Schema's version information in the serialized object.
|
|
50
|
-
*/
|
|
51
|
-
toJSON(standalone?: boolean, includeSchemaVersion?: boolean): KindOfQuantityProps;
|
|
52
|
-
/** @internal */
|
|
53
|
-
toXml(schemaXml: Document): Promise<Element>;
|
|
54
|
-
fromJSONSync(kindOfQuantityProps: KindOfQuantityProps): void;
|
|
55
|
-
fromJSON(kindOfQuantityProps: KindOfQuantityProps): Promise<void>;
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* @internal
|
|
59
|
-
* An abstract class used for schema editing.
|
|
60
|
-
*/
|
|
61
|
-
export declare abstract class MutableKindOfQuantity extends KindOfQuantity {
|
|
62
|
-
abstract addPresentationFormat(format: Format | OverrideFormat, isDefault: boolean): void;
|
|
63
|
-
abstract createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;
|
|
64
|
-
abstract setDisplayLabel(displayLabel: string): void;
|
|
65
|
-
}
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module Metadata
|
|
3
|
+
*/
|
|
4
|
+
import { KindOfQuantityProps } from "../Deserialization/JsonProps";
|
|
5
|
+
import { SchemaItemType } from "../ECObjects";
|
|
6
|
+
import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
|
|
7
|
+
import { Format } from "./Format";
|
|
8
|
+
import { InvertedUnit } from "./InvertedUnit";
|
|
9
|
+
import { OverrideFormat } from "./OverrideFormat";
|
|
10
|
+
import { Schema } from "./Schema";
|
|
11
|
+
import { SchemaItem } from "./SchemaItem";
|
|
12
|
+
import { Unit } from "./Unit";
|
|
13
|
+
/** A Typescript class representation of a KindOfQuantity.
|
|
14
|
+
* @beta
|
|
15
|
+
*/
|
|
16
|
+
export declare class KindOfQuantity extends SchemaItem {
|
|
17
|
+
readonly schemaItemType: SchemaItemType.KindOfQuantity;
|
|
18
|
+
protected _relativeError: number;
|
|
19
|
+
protected _presentationFormats: Array<Format | OverrideFormat>;
|
|
20
|
+
protected _persistenceUnit?: LazyLoadedUnit | LazyLoadedInvertedUnit;
|
|
21
|
+
/** The first presentation format in the list of Formats. */
|
|
22
|
+
get defaultPresentationFormat(): Format | OverrideFormat | undefined;
|
|
23
|
+
/** A list of presentation formats. */
|
|
24
|
+
get presentationFormats(): Array<Format | OverrideFormat>;
|
|
25
|
+
get persistenceUnit(): LazyLoadedUnit | LazyLoadedInvertedUnit | undefined;
|
|
26
|
+
get relativeError(): number;
|
|
27
|
+
constructor(schema: Schema, name: string);
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @param format The Format to add to this KindOfQuantity
|
|
31
|
+
* @param isDefault
|
|
32
|
+
*/
|
|
33
|
+
protected addPresentationFormat(format: Format | OverrideFormat, isDefault?: boolean): void;
|
|
34
|
+
/** Parses the format string into the parts that make up an Override Format
|
|
35
|
+
* @param formatString
|
|
36
|
+
*/
|
|
37
|
+
private parseFormatString;
|
|
38
|
+
/** Creates an OverrideFormat in the context of this KindOfQuantity.
|
|
39
|
+
* @param parent The Format to override.
|
|
40
|
+
* @param precision The precision override
|
|
41
|
+
* @param unitLabelOverrides The list of unit and label overrides.
|
|
42
|
+
*/
|
|
43
|
+
protected createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;
|
|
44
|
+
private processPresentationUnits;
|
|
45
|
+
private processPresentationUnitsSync;
|
|
46
|
+
/**
|
|
47
|
+
* Save this KindOfQuantity's properties to an object for serializing to JSON.
|
|
48
|
+
* @param standalone Serialization includes only this object (as opposed to the full schema).
|
|
49
|
+
* @param includeSchemaVersion Include the Schema's version information in the serialized object.
|
|
50
|
+
*/
|
|
51
|
+
toJSON(standalone?: boolean, includeSchemaVersion?: boolean): KindOfQuantityProps;
|
|
52
|
+
/** @internal */
|
|
53
|
+
toXml(schemaXml: Document): Promise<Element>;
|
|
54
|
+
fromJSONSync(kindOfQuantityProps: KindOfQuantityProps): void;
|
|
55
|
+
fromJSON(kindOfQuantityProps: KindOfQuantityProps): Promise<void>;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
* An abstract class used for schema editing.
|
|
60
|
+
*/
|
|
61
|
+
export declare abstract class MutableKindOfQuantity extends KindOfQuantity {
|
|
62
|
+
abstract addPresentationFormat(format: Format | OverrideFormat, isDefault: boolean): void;
|
|
63
|
+
abstract createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;
|
|
64
|
+
abstract setDisplayLabel(displayLabel: string): void;
|
|
65
|
+
}
|
|
66
66
|
//# sourceMappingURL=KindOfQuantity.d.ts.map
|