API Reference › ecschema-metadata› SchemaUnitProvider › SchemaUnitProvider › FindUnit

findUnit Method

Finds Unit by unitLabel, which could be a display label in the schema or alternate an display label defined in this._unitExtraData. If there are duplicates of the same display label in the context or teh same alternate display labels, specify schemaName, phenomenon, or unitSystem to get a specific unit.

findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>

@returns The UnitProps interface from the @itwin/core-quantity package.

Parameter Type Description
unitLabel string Display label or alternate display label to query unit by.
schemaName string Ensure Unit with unitLabel belongs to Schema with schemaName.
phenomenon string Full name of phenomenon that Unit belongs to.
unitSystem string Full name of unitSystem that Unit belongs to.

Returns - Promise<UnitProps>

The UnitProps interface from the @itwin/core-quantity package.

Defined in

Last Updated: 22 August, 2025