Types

This is the official documentation of Forest Admin Cloud.

Forest Admin fields can have different types to represent the data they store. These types fall into two categories: Primitive and Composite.

Primitive Types

Primitive types are basic types that directly represent the data. These types are:

  • Boolean: Represents true or false values.

  • Date: Represents a date and time in the ISO-8601 format.

  • Dateonly: Represents only the date part in the format YYYY-MM-DD.

  • Enum: Represents a predefined set of string values.

  • JSON: Represents any data in JSON format.

  • Number: Represents numerical values.

  • Point: Represents geographical coordinates with two numbers.

  • String: Represents a text.

  • Timeonly: Represents only the time part in the format HH:MM:SS.

  • Uuid: Represents a unique identifier using the uuid v4 format.

Composite Types

Composite types are combinations of primitive types to represent more complex data. These types are:

  • Object: Represents an object containing multiple key-value pairs.

  • [Any primite type]: Represents an array of a single primitive type.

  • [Object]: Represents an array of objects with multiple key-value pairs.

  • [['Number']]: Represents an object that contains a two-dimensional array of numbers.

Composite types are not sortable, do not support validation, and may be displayed differently in the Forest Admin UI. Arrays of primitive types may be filterable, depending on the data source.

When using composite types, the data in the UI may not be displayed as expected and might require using a JSON editor or custom widgets for editing.

Last updated