Documentation
    Preparing search index...

    Class NumberProperty

    A property type strictly validating and formatting numeric values. Allows enforcement of integers, positive-only limits, and boundary checking.

    const price = new NumberProperty({
       name: 'price',
       type: NumberProperty.TYPE_FLOAT,
       sign: NumberProperty.TYPE_UNSIGNED,
       prefix: '$',
       minVal: 0
    });

    price.set(19.99);
    console.log(price.val(NumberProperty.TRANSFORM_FORMATTED)); // "$ 19.99"
    price.set(-5); // Throws Error: Value must be unsigned

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _allows _defaultValue _events _hasChanged _htmlType _id _mandatory _maxVal _minVal _name _parent _precision _prefix _protected _sign _suffix _type _value EVENT_ONCHANGE EVENT_ONDELETE SEPARATOR TRANSFORM_FORMATTED TYPE TYPE_FLOAT TYPE_INTEGER TYPE_SIGNED TYPE_UNSIGNED

    Accessors

    allows hasChanged htmlType mandatory maxVal minVal name protected type

    Methods

    _enable clone set toJSON val

    Constructors

    Properties

    Protected_allows

    _allows: string[] = []

    Protected_defaultValue

    _defaultValue: any

    Protected_events

    _events: { [key: string]: Function } = {}

    Protected_hasChanged

    _hasChanged: boolean

    Protected_htmlType

    _htmlType: PropertyHTMLType = 'off'

    Protected_id

    _id: string

    Protected_mandatory

    _mandatory: boolean = false

    Protected_maxVal

    _maxVal: number | undefined = undefined

    Protected_minVal

    _minVal: number | undefined = undefined

    Protected_name

    _name: string

    Protected_parent

    _parent: DataObjectClass<any> | undefined

    Protected_precision

    _precision: number = 0

    Protected_prefix

    _prefix: string = ''

    Protected_protected

    _protected: boolean = false

    Protected_sign

    _sign: string = NumberProperty.TYPE_SIGNED

    Protected_suffix

    _suffix: string = ''

    Protected_type

    _type: string = NumberProperty.TYPE_INTEGER

    Protected_value

    _value: number | undefined
    EVENT_ONCHANGE: string = 'onChange'

    Event name triggered when the property value changes.

    EVENT_ONDELETE: string = 'onDelete'

    Event name triggered when the property is deleted.

    SEPARATOR: string = ' '

    Default separator used for string formatting.

    TRANSFORM_FORMATTED: string = 'formatted'

    Transformation identifier to return the number as a formatted string.

    TYPE: string = 'number'

    The string literal type identifier for this property.

    TYPE_FLOAT: string = 'float'

    Type flag indicating a floating-point value.

    TYPE_INTEGER: string = 'integer'

    Type flag indicating an integer value.

    TYPE_SIGNED: string = 'signed'

    Constraint flag for signed numbers (positive and negative).

    TYPE_UNSIGNED: string = 'unsigned'

    Constraint flag for unsigned numbers (positive only).

    Accessors

    • get allows(): string[]

      Returns string[]

    • get hasChanged(): boolean

      Returns boolean

    • set hasChanged(val: boolean): void

      Parameters

      • val: boolean

      Returns void

    • get htmlType(): PropertyHTMLType

      Returns PropertyHTMLType

    • set htmlType(type: PropertyHTMLType): void

      Parameters

      Returns void

    • get mandatory(): boolean

      Returns boolean

    • get maxVal(): number | undefined

      Returns number | undefined

    • set maxVal(max: number | undefined): void

      Parameters

      • max: number | undefined

      Returns void

    • get minVal(): number | undefined

      Returns number | undefined

    • set minVal(min: number | undefined): void

      Parameters

      • min: number | undefined

      Returns void

    • get name(): string

      Returns string

    • get protected(): boolean

      Returns boolean

    • get type(): string

      Returns string

    Methods

    Protected_enable

    • _enable(value: boolean | undefined): value is true | undefined

      Parameters

      • value: boolean | undefined

      Returns value is true | undefined

    • Creates a deep clone of the current property instance, preserving its prototype chain.

      Returns any

      A new independent instance of the property.

    • Assigns a new numeric value while strictly enforcing boundary, sign, and type constraints. If configured as an integer, the input is floored.

      Parameters

      • value: number

        The number to assign.

      • setChanged: boolean = true

        Whether to mark the property as modified.

      Returns NumberProperty

      The property instance for chaining.

      If the number violates the min, max, or sign constraints.

    • Serializes the property for JSON stringification.

      Returns any

      The raw internal value of the property.

    • Retrieves the numeric value, optionally applying UI string formatting.

      Parameters

      • transform: string | undefined = undefined

        Use TRANSFORM_FORMATTED to return a string with the configured prefix and suffix.

      Returns string | number | undefined

      The raw number or the formatted string representation.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods