Back to Nocobase

Line string

docs/docs/en/data-sources/data-modeling/collection-fields/geometric/line.md

2.1.305.0 KB
Original Source

Line string

Introduction

In NocoBase, the Line string field stores a geographic line.

It is suitable for delivery routes, inspection tracks, pipelines, and other linear geographic data.

Use cases

Line string fields are suitable for these business scenarios:

  • Delivery routes
  • Inspection tracks
  • Pipelines
  • Other linear geographic data

Create and configure

On the collection's Configure fields page, click Add field and select Line string to create this field.

SettingDescription
Field interfaceThe field interface. Line string uses lineString, which determines how the field is entered and displayed in pages.
Field display nameThe name displayed for the field, such as Delivery route, Inspection track, or Pipeline. Use a name that business users can recognize.
Field nameThe field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter.
Field typeThe data-layer type. Line string uses lineString by default.
Default valueThe default value. When a new record has no value, NocoBase can fill this value automatically.
Validation rulesValidation rules. Supports base validation such as required.
DescriptionA field description. Record the field meaning, entry requirements, data source, or maintainer.

:::warning Note

Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.

:::

Field behavior

The default behavior of a Line string field is as follows:

BehaviorDescription
Default Field interfacelineString.
Default Field typelineString.
Available Field typeslineString.
Page componentUses a map-drawing component in edit mode.
FilteringSpatial filtering depends on map-plugin and data-source capabilities.
SortingIt is usually not used for sorting.
ValidationSupports base validation such as required.

Edit configuration

After creation, click Edit beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.

When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.

SettingCan be editedDescription
Field display nameYesChanges the name displayed in the interface without changing the field identifier.
Field nameNoThe field identifier normally cannot be changed in the edit form after creation.
Field interfaceConditionalMain-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation.
Field typeConditionalMain-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first.
Default valueYesAdjusts the default value for new records.
Validation rulesYesAdjusts field validation rules.
DescriptionYesAdds the field meaning, entry requirements, data source, or maintainer.

:::warning Note

Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.

:::

Delete field

Click Delete beside a Line string field to delete it. You can also select multiple fields and delete them in the main data source.

Deleting a Line string field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.

:::danger Warning

Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.

:::

Use in pages

Line string fields are suitable for map display and linear geographic data.

ScenarioUse
Form blockDraw or edit a line on a map.
Details blockDisplay a geographic line.
Map and geographic blocksShow a route or track in a map context.
Workflows and APIsPass line data to business logic.