NumberField
Defined in: core/field/types/Number.ts:6
Number field type
Extends
Section titled “Extends”BaseField
<NumberConstraints
>
Indexable
Section titled “Indexable”[key
: `${string}:${string}`
]: any
Properties
Section titled “Properties”bareNumber?
Section titled “bareNumber?”
optional
bareNumber:boolean
Defined in: core/field/types/Number.ts:25
Whether number is presented without currency symbols or percent signs
constraints?
Section titled “constraints?”
optional
constraints:NumberConstraints
Defined in: core/field/types/Base.ts:42
Validation constraints applied to values
Inherited from
Section titled “Inherited from”BaseField.constraints
decimalChar?
Section titled “decimalChar?”
optional
decimalChar:string
Defined in: core/field/types/Number.ts:15
Character used as decimal separator
description?
Section titled “description?”
optional
description:string
Defined in: core/field/types/Base.ts:20
Human-readable description
Inherited from
Section titled “Inherited from”BaseField.description
example?
Section titled “example?”
optional
example:any
Defined in: core/field/types/Base.ts:25
Example value for this field
Inherited from
Section titled “Inherited from”BaseField.example
groupChar?
Section titled “groupChar?”
optional
groupChar:string
Defined in: core/field/types/Number.ts:20
Character used as thousands separator
missingValues?
Section titled “missingValues?”
optional
missingValues: (string
| {label
:string
;value
:string
; })[]
Defined in: core/field/types/Base.ts:37
Values representing missing data for this field Can be a simple array of strings or an array of {value, label} objects where label provides context for why the data is missing
Inherited from
Section titled “Inherited from”BaseField.missingValues
name:
string
Defined in: core/field/types/Base.ts:10
Name of the field matching the column name
Inherited from
Section titled “Inherited from”BaseField.name
rdfType?
Section titled “rdfType?”
optional
rdfType:string
Defined in: core/field/types/Base.ts:30
URI for semantic type (RDF)
Inherited from
Section titled “Inherited from”BaseField.rdfType
title?
Section titled “title?”
optional
title:string
Defined in: core/field/types/Base.ts:15
Human-readable title
Inherited from
Section titled “Inherited from”BaseField.title
type:
"number"
Defined in: core/field/types/Number.ts:10
Field type - discriminator property