IFClite TypeScript API
    Preparing search index...

    Interface SubjectValue

    The result readSubject returns for every Subject kind.

    interface SubjectValue {
        displayValues?: readonly string[];
        present: boolean;
        unit?: string;
        values: readonly (string | number)[];
        valueSiScales?: readonly (number | undefined)[];
        valueUnits?: readonly (string | undefined)[];
    }
    Index
    displayValues? present unit? values valueSiScales? valueUnits?
    displayValues?: readonly string[]

    Property subjects only: one value per matched property, a list, enumerated or table value as its joined display text, where values holds each member (#5475). The set checks (unique, aggregate, compare) read a property as ONE value, so they use these; element checks match members.

    present: boolean

    At least one value, after String(v).trim(), is non-empty (plan §4.2).

    unit?: string

    Quantity subjects only — the stored unit label, when known.

    values: readonly (string | number)[]
    valueSiScales?: readonly (number | undefined)[]

    Property and quantity subjects only, aligned with values: the factor that turns each value into SI base units, from the same unit as valueUnits; undefined for a value with no unit (#5225).

    valueUnits?: readonly (string | undefined)[]

    Property and quantity subjects only: the unit each entry of values is recorded in, index for index (#5300). The value's own explicit Unit when the file declares one, otherwise the project unit for its measure type; undefined for a value that has no unit (a label, a count, an untyped property).

    Settings
    Member Visibility

    On This Page
    Properties