scientific/com.splendo.kaluga.scientific.formatter/DenominatorScientificValueFormatter/Builder

Builder

Builder for creating a DenominatorScientificValueFormatter

Properties

defaultUnitFormatter

var defaultUnitFormatter: NumberFormatter

The CommonScientificValueFormatter to use for units not specified by the denominator

denominatorUnitFormatter

var denominatorUnitFormatter: NumberFormatter

The NumberFormatter to use for all denominator units except for the last formatted denominator

includeZeroValues

var includeZeroValues: DenominatorScientificValueFormatter.IncludeZeroValues

The IncludeZeroValues settings to use when encountering a zero value denominator.

lastDenominatorUnitFormatter

var lastDenominatorUnitFormatter: NumberFormatter

The NumberFormatter to use for the last formatted denominator.

roundingPrecision

var roundingPrecision: Double

The precision at which denominators are rounded down. If within the precision unit the value will be rounded up, otherwise down.

var scale: UInt

The scale used for rounding the denominator units.

var separator: String

The separator between denominators

Functions

infix fun <Quantity : PhysicalQuantity, System : MeasurementSystem, Unit : SystemScientificUnit<System, Quantity>> Unit.denominateBy(denominators: List<SystemScientificUnit<System, Quantity>>)

Sets the denominator SystemScientificUnit of a given SystemScientificUnit When formatting this unit, it will be split up into the denominator units (including the unit itself).

infix fun <Quantity : PhysicalQuantity> Quantity.formatAs(unit: ScientificUnit<Quantity>)

Formats any ScientificValue with quantity Quantity as a unit of unit Is overruled by ScientificUnit.formatAs

infix fun <Quantity : PhysicalQuantity> ScientificUnit<Quantity>.formatAs(unit: ScientificUnit<Quantity>)

Formats any ScientificValue of this unit into unit Overrules PhysicalQuantity.formatAs

infix fun ScientificUnit<*>.formatUsing(handler: CustomFormatHandler)

Formats a value in a ScientificUnit using CustomFormatHandler

usesCustomSymbol

infix fun ScientificUnit<*>.usesCustomSymbol(symbol: String)

Sets a custom symbol for formatting a value of a ScientificUnit