Skip to main content

LayerDatasetField

LayerDatasetField = object

Configuration for a single field within a dataset. Defines field metadata, visibility, and data constraints.

Example​

const temperatureField: LayerDatasetField = {
  id: 'temp_celsius',
  visible: true,
  nullable: false,
  type: 'f32',
  label: 'Temperature (°C)',
};

const statusField: LayerDatasetField = {
  id: 'status',
  visible: true,
  nullable: true,
  type: 'str',
  label: 'Status',
  availableValues: {
    'active': 'Active',
    'inactive': 'Inactive',
    'pending': 'Pending Review'
  }
};

Properties​

availableValues?​

optional availableValues: Record<string, any>

Predefined options for select/dropdown components. Key-value pairs where key is the internal value and value is display text. Only populated for fields with finite, enumerable options.

Example​

{
  'urban': 'Urban Area',
  'suburban': 'Suburban Area',
  'rural': 'Rural Area'
}

id​

id: string

Unique identifier for this field within the dataset.

label​

label: string

Human-readable display name for this field in UI components.

Example​

'Temperature (°C)', 'Population Density', 'Last Updated'

nullable​

nullable: boolean

Whether this field accepts null/undefined values.

type​

type: LayerDatasetFieldTypes

Data type specification for this field.

See​

LayerDatasetFieldTypes

visible​

visible: boolean

Controls field visibility in filter UI components. Hidden fields are still available for queries but not shown to users.