IntegerField
Defined in: core/field/types/Integer.ts:6
Integer field type
Extends
Section titled “Extends”BaseField<IntegerConstraints>
Indexable
Section titled “Indexable”[key: `${string}:${string}`]: any
Properties
Section titled “Properties”bareNumber?
Section titled “bareNumber?”
optionalbareNumber:boolean
Defined in: core/field/types/Integer.ts:20
Whether number is presented without currency symbols or percent signs
categories?
Section titled “categories?”
optionalcategories:number[] |object[]
Defined in: core/field/types/Integer.ts:26
Categories for enum values Can be an array of values or an array of {value, label} objects
categoriesOrdered?
Section titled “categoriesOrdered?”
optionalcategoriesOrdered:boolean
Defined in: core/field/types/Integer.ts:31
Whether categories should be considered to have a natural order
constraints?
Section titled “constraints?”
optionalconstraints:IntegerConstraints
Defined in: core/field/types/Base.ts:47
Validation constraints applied to values
Inherited from
Section titled “Inherited from”BaseField.constraints
description?
Section titled “description?”
optionaldescription:string
Defined in: core/field/types/Base.ts:20
Human-readable description
Inherited from
Section titled “Inherited from”BaseField.description
example?
Section titled “example?”
optionalexample:any
Defined in: core/field/types/Base.ts:25
Example value for this field
Inherited from
Section titled “Inherited from”BaseField.example
examples?
Section titled “examples?”
optionalexamples:any[]
Defined in: core/field/types/Base.ts:30
Examples for this field
Inherited from
Section titled “Inherited from”BaseField.examples
groupChar?
Section titled “groupChar?”
optionalgroupChar:string
Defined in: core/field/types/Integer.ts:15
Character used as thousands separator
missingValues?
Section titled “missingValues?”
optionalmissingValues: (string| {label:string;value:string; })[]
Defined in: core/field/types/Base.ts:42
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?”
optionalrdfType:string
Defined in: core/field/types/Base.ts:35
URI for semantic type (RDF)
Inherited from
Section titled “Inherited from”BaseField.rdfType
title?
Section titled “title?”
optionaltitle:string
Defined in: core/field/types/Base.ts:15
Human-readable title
Inherited from
Section titled “Inherited from”BaseField.title
type:
"integer"
Defined in: core/field/types/Integer.ts:10
Field type - discriminator property