API Reference › core-Quantity› Quantity › GetDefaultPersistenceUnit

getDefaultPersistenceUnit Function

Returns the package's default built-in persistence unit for a supported bundled built-in phenomenon.

This helper is intentionally limited to the built-in canonical unit set shipped with @itwin/core-quantity. Phenomena.LENGTH_RATIO is intentionally excluded because the bundled built-in unit set does not yet provide an agreed default for that phenomenon. For schema-defined, custom, or iModel-specific persistence units, use a UnitsProvider-based workflow instead.

getDefaultPersistenceUnit(phenomenon: "Units.ANGLE" | "Units.ACCELERATION" | "Units.NUMBER" | "Units.LENGTH" | "Units.MASS" | "Units.TIME" | "Units.TEMPERATURE" | "Units.TEMPERATURE_CHANGE" | "Units.TEMPERATURE_GRADIENT" | "Units.LINEAR_COEFFICIENT_OF_THERMAL_EXPANSION" | "Units.LUMINOUS_FLUX" | "Units.ILLUMINANCE" | "Units.MOLE" | "Units.CAPITA" | "Units.ROTATIONAL_SPRING_CONSTANT" | "Units.LINEAR_ROTATIONAL_SPRING_CONSTANT" | "Units.SPRING_CONSTANT" | "Units.LINEAR_SPRING_CONSTANT" | "Units.AREA_SPRING_CONSTANT" | "Units.HORIZONTAL_DIRECTION" | "Units.AREA" | "Units.PIPE_DIAMETER_LENGTH" | "Units.DENSITY" | "Units.FORCE_DENSITY" | "Units.POPULATION_DENSITY" | "Units.CURRENT" | "Units.ELECTRIC_CHARGE" | "Units.ELECTRIC_POTENTIAL" | "Units.WORK" | "Units.ENERGY_DENSITY" | "Units.SPECIFIC_ENERGY" | "Units.SPECIFIC_HEAT_CAPACITY" | "Units.SPECIFIC_HEAT_CAPACITY_MOLAR" | "Units.VOLUMETRIC_FLOW" | "Units.FREQUENCY" | "Units.FLOW_DENSITY_PER_AREA" | "Units.MASS_RATIO" | "Units.MASS_FLOW" | "Units.MOLAR_FLOW" | "Units.FORCE" | "Units.HEAT_FLUX_DENSITY" | "Units.HEAT_TRANSFER" | "Units.LINEAR_DENSITY" | "Units.LINEAR_LOAD" | "Units.LINEAR_RATE" | "Units.TORQUE" | "Units.LINEAR_TORQUE" | "Units.AREA_TORQUE" | "Units.MOLAR_VOLUME" | "Units.MOLAR_CONCENTRATION" | "Units.AREA_MOMENT_INERTIA" | "Units.POWER" | "Units.PRESSURE" | "Units.PRESSURE_GRADIENT" | "Units.PERCENTAGE" | "Units.PROBABILITY" | "Units.SLOPE" | "Units.SURFACE_DENSITY" | "Units.THERMAL_CONDUCTIVITY" | "Units.THERMAL_INSULANCE" | "Units.VELOCITY" | "Units.ANGULAR_VELOCITY" | "Units.DYNAMIC_VISCOSITY" | "Units.KINEMATIC_VISCOSITY" | "Units.VOLUME" | "Units.VOLUME_RATIO" | "Units.SPECIFIC_VOLUME" | "Units.VOLUME_PER_LENGTH" | "Units.TORSIONAL_WARPING_CONSTANT" | "Units.APPARENT_POWER" | "Units.LUMINOSITY" | "Units.SOLIDANGLE" | "Units.CURRENCY" | "Units.ELECTRICAL_RESISTANCE" | "Units.ELECTRICAL_RESISTIVITY" | "Units.THREAD_PITCH" | "Units.ENTROPY" | "Units.LUMINOUS_EFFICACY" | "Units.MOMENT_DISPLAY_SCALE" | "Units.FORCE_DISPLAY_SCALE"): UnitName

Parameter Type Description
phenomenon "Units.ANGLE" | "Units.ACCELERATION" | "Units.NUMBER" | "Units.LENGTH" | "Units.MASS" | "Units.TIME" | "Units.TEMPERATURE" | "Units.TEMPERATURE_CHANGE" | "Units.TEMPERATURE_GRADIENT" | "Units.LINEAR_COEFFICIENT_OF_THERMAL_EXPANSION" | "Units.LUMINOUS_FLUX" | "Units.ILLUMINANCE" | "Units.MOLE" | "Units.CAPITA" | "Units.ROTATIONAL_SPRING_CONSTANT" | "Units.LINEAR_ROTATIONAL_SPRING_CONSTANT" | "Units.SPRING_CONSTANT" | "Units.LINEAR_SPRING_CONSTANT" | "Units.AREA_SPRING_CONSTANT" | "Units.HORIZONTAL_DIRECTION" | "Units.AREA" | "Units.PIPE_DIAMETER_LENGTH" | "Units.DENSITY" | "Units.FORCE_DENSITY" | "Units.POPULATION_DENSITY" | "Units.CURRENT" | "Units.ELECTRIC_CHARGE" | "Units.ELECTRIC_POTENTIAL" | "Units.WORK" | "Units.ENERGY_DENSITY" | "Units.SPECIFIC_ENERGY" | "Units.SPECIFIC_HEAT_CAPACITY" | "Units.SPECIFIC_HEAT_CAPACITY_MOLAR" | "Units.VOLUMETRIC_FLOW" | "Units.FREQUENCY" | "Units.FLOW_DENSITY_PER_AREA" | "Units.MASS_RATIO" | "Units.MASS_FLOW" | "Units.MOLAR_FLOW" | "Units.FORCE" | "Units.HEAT_FLUX_DENSITY" | "Units.HEAT_TRANSFER" | "Units.LINEAR_DENSITY" | "Units.LINEAR_LOAD" | "Units.LINEAR_RATE" | "Units.TORQUE" | "Units.LINEAR_TORQUE" | "Units.AREA_TORQUE" | "Units.MOLAR_VOLUME" | "Units.MOLAR_CONCENTRATION" | "Units.AREA_MOMENT_INERTIA" | "Units.POWER" | "Units.PRESSURE" | "Units.PRESSURE_GRADIENT" | "Units.PERCENTAGE" | "Units.PROBABILITY" | "Units.SLOPE" | "Units.SURFACE_DENSITY" | "Units.THERMAL_CONDUCTIVITY" | "Units.THERMAL_INSULANCE" | "Units.VELOCITY" | "Units.ANGULAR_VELOCITY" | "Units.DYNAMIC_VISCOSITY" | "Units.KINEMATIC_VISCOSITY" | "Units.VOLUME" | "Units.VOLUME_RATIO" | "Units.SPECIFIC_VOLUME" | "Units.VOLUME_PER_LENGTH" | "Units.TORSIONAL_WARPING_CONSTANT" | "Units.APPARENT_POWER" | "Units.LUMINOSITY" | "Units.SOLIDANGLE" | "Units.CURRENCY" | "Units.ELECTRICAL_RESISTANCE" | "Units.ELECTRICAL_RESISTIVITY" | "Units.THREAD_PITCH" | "Units.ENTROPY" | "Units.LUMINOUS_EFFICACY" | "Units.MOMENT_DISPLAY_SCALE" | "Units.FORCE_DISPLAY_SCALE"  

Returns - UnitName

Defined in

Last Updated: 27 May, 2026