SchemaFormatsProvider Class @beta
Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(contextOrLocater: ISchemaLocater, unitSystem?: UnitSystemKey): SchemaFormatsProvider | ||
| getFormat(name: string, system?: UnitSystemKey): Promise<FormatDefinition | undefined> | Retrieves a format definition from the schema context. | |
| getFormatSync(name: string, system?: UnitSystemKey): FormatDefinition | undefined | Retrieves a format definition using only schema metadata already loaded in the context. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| context Accessor ReadOnly | SchemaContext | ||
| onFormatsChanged | BeEvent<(args: FormatsChangedArgs) => void> | Fired when formats are added, removed, or changed. | |
| unitSystem Accessor | UnitSystemKey | undefined | ||
| unitSystem Setter | unitSystem(unitSystem: UnitSystemKey): void |
Defined in
Last Updated: 02 October, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.