Bluestep JS Documentation
    Preparing search index...

    Interface UpdateNumberFloatFieldProperties

    Properties for updating a number float field.

    interface UpdateNumberFloatFieldProperties {
        autoCopy?: boolean;
        columnSpan?: number;
        commaFormat?: boolean;
        decimalPlaces?: number;
        defaultNumber?: number;
        defaultNumberSource?: "SPECIFIC_VALUE" | "UNIQUE_ID";
        defaultValue?: any;
        deprecated?: boolean;
        expectedVersion?: number;
        fieldControlFieldTopId?: string;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        fieldControlView?: "READONLY"
        | "HIDDEN";
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        longLabel?: boolean;
        maximumValue?: string;
        minimumValue?: string;
        name?: string;
        neverHideHelpText?: boolean;
        numberFormatType: "FLOAT";
        placeholder?: string;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        suffix?: string;
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index
    autoCopy?: boolean

    Whether to automatically copy this field's value when cloning a record

    columnSpan?: number

    How many of its row's columns this field spans: 0 for the whole row, 1-4 for that many columns. An explicit null clears it, leaving the field type's default placement. Read by layout clients; legacy form pages do not apply it.

    commaFormat?: boolean

    true means the field shows its numbers WITHOUT thousands separators (10000, $1000.00); false or unset shows them (10,000, $1,000.00). The name reads the other way round: it is legacy's CommaFormat setting, whose editor checkbox reads: Number will NOT use commas.

    decimalPlaces?: number

    How many decimal places the value is displayed with, 0-10. Display only: stored values are never rounded. An explicit null clears it, displaying the value as stored. Read by layout clients; legacy form pages do not apply it.

    defaultNumber?: number

    The default a new record starts with. Stored in this field's own formatting (money as $1,000.00, integer as 10,000, float to at most four decimals, without thousands separators when the field shows none), which is the spelling legacy pages read. A value the format cannot hold exactly, such as a fraction on an integer field or a third decimal on money, is refused rather than rounded. null clears the default. Writing it also selects the specific-value source (defaultNumberSource null). Cannot be sent together with defaultValue, or with a dynamic defaultNumberSource.

    defaultNumberSource?: "SPECIFIC_VALUE" | "UNIQUE_ID"

    Which source supplies the default for a new record. UNIQUE_ID draws the tenant's next sequence number per record and leaves the stored default unread; null selects the specific value (defaultNumber). Sending defaultNumber selects the specific value by itself, and sending it with UNIQUE_ID is refused.

    defaultValue?: any

    Default value pre-populated when creating new records, stored as sent: it must already be in this field's own formatting ($1,000.00 for money, 10,000 for integer, 1,234.5 for float, without separators when the field shows none) or a new record starts empty. Prefer defaultNumber, which takes a plain number and formats it. Cannot be sent together with defaultNumber.

    deprecated?: boolean

    Whether this field is deprecated and hidden from new configurations

    expectedVersion?: number

    The field's rowVersion this write was decided against. At that version the write applies and bumps it; one past it with a payload that changes nothing — a replay of a write that already landed — answers success without another bump; anything else is refused with CONCURRENT_MODIFICATION and extensions.currentVersion. Omit to write unconditionally.

    fieldControlFieldTopId?: string

    ID of the field a CUSTOM fieldControlType watches: another checkbox, radio, signature or single-select field on the same form. Null or an empty ID removes it.

    fieldControlType?:
        | "NORMAL"
        | "HIDDEN_DEFAULT"
        | "READONLY_DEFAULT"
        | "SMART_HIDE"
        | "READONLY_WHEN_COMPLETED"
        | "CUSTOM"

    Visibility/editability control mode for this field

    fieldControlValue?: string

    The watched field's value at which a CUSTOM fieldControlType applies: true or false for a checkbox or radio, signed or unsigned for a signature, one of its option IDs for a single-select (an empty string, accepted for legacy compatibility, stores no value).

    fieldControlView?: "READONLY" | "HIDDEN"

    What a CUSTOM fieldControlType does to this field while its condition holds. A header, spacer, static content or merge report field can only be HIDDEN, which writing its condition stores.

    formula?: string

    BlueStep formula expression for computed field values

    formulaId?: string

    Optional script/merge variable name (the 'Field Identifier' in the admin UI) used to reference this field from formula, endpoint, and merge-report code. Leave unset for a data-entry-only field that is not referenced from code — like the UI, it is not required.

    frozen?: boolean

    Whether this field is locked from editing by non-admin users

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    label?: string

    Display label shown to users on the form

    longLabel?: boolean

    Whether the label spans the full width above the field instead of beside it

    maximumValue?: string

    Maximum allowed value for validation

    minimumValue?: string

    Minimum allowed value for validation

    name?: string

    Field name.

    neverHideHelpText?: boolean

    Whether to always show help text (never collapse it)

    numberFormatType: "FLOAT"

    Format type discriminant.

    placeholder?: string

    Placeholder text shown in the empty input field

    popupHint?: boolean

    Whether to show help text as a popup tooltip instead of inline

    reportLabel?: string

    Alternate label used in reports and exports

    required?: boolean

    Whether this field must have a value before the record can be saved

    styleClass?: string

    CSS class name(s) applied to the field for custom styling

    suffix?: string

    Plain text shown after the input, such as a unit. It is displayed as text, never as markup. An explicit null or an empty string clears it.

    typeScriptDeclarations?: string

    Type script declarations

    userUpdateable?: boolean

    Whether end users can edit this field value (false = system-managed)