docs/docs/cn/data-sources/data-modeling/collection-fields/advanced/china-region.md
<PluginInfo name="field-china-region"></PluginInfo>
在 NocoBase 中,中国行政区(China region) 用于保存省、市、区县等中国行政区划信息。
中国行政区字段基于内置的 chinaRegions 行政区划数据表,页面中使用级联选择器录入。用户可以按层级依次选择省、市、区,展示时会按层级拼接为完整路径。
如果需要保存街道、门牌号等详细地址,可以配合单行文本或多行文本字段使用。
中国行政区适合这些业务场景:
在数据表的「Configure fields」页面中,点击「Add field」,选择「中国行政区」可以创建中国行政区字段。
| 配置 | 说明 |
|---|---|
| Field interface | 字段的界面类型。中国行政区对应 chinaRegion,决定页面中如何录入和展示。 |
| Field display name | 字段在界面中显示的名称,比如「所在地区」「服务区域」「收货地区」。建议使用业务人员能直接理解的名称。 |
| Field name | 字段标识名称,用于 API、关系字段、权限、工作流等内部引用。创建后通常不再修改,只支持字母、数字和下划线,并且必须以字母开头。 |
| Field type | 字段在数据层的类型。中国行政区通常以关联记录或结构化值保存,具体以字段配置为准。 |
| 选择层级 | 控制可选择到的最深层级。当前支持「省」「市」「区」,默认为「区」。 |
| 必须选择到最后一级 | 启用后,用户必须选择到配置的最深层级才能提交;不启用时,可以在中间层级完成选择。 |
| Validation rules | 校验规则。通常配置必填和选择层级。 |
| Description | 字段说明。适合写字段含义、填写要求、数据来源或维护人。 |
:::warning 注意
字段名创建后会被页面区块、权限、工作流和 API 引用。创建前先确认命名,避免后续修改带来配置调整成本。
:::
中国行政区字段的默认行为如下:
| 特性 | 说明 |
|---|---|
| 默认 Field interface | chinaRegion。 |
| 数据来源 | 内置 chinaRegions 行政区划数据表。 |
| 页面组件 | 编辑模式使用级联选择器。 |
| 选择层级 | 当前支持省、市、区三级。 |
| 展示方式 | 阅读模式下按层级展示为 省 / 市 / 区。 |
| 筛选 | 支持按已保存的地区值筛选,具体能力取决于字段配置和页面区块。 |
| 多选 | 不支持多选。 |
创建后,点击字段右侧的「Edit」可以编辑中国行政区字段配置。编辑字段主要用于调整字段在 NocoBase 中的展示和使用方式,比如修改显示名称、说明、校验规则、选择层级或是否必须选择到最后一级。
如果字段来自主数据库中已经同步的表,编辑时通常是在做字段映射——把数据库字段映射为 NocoBase 的 Field type 和 Field interface。
| 配置 | 允许编辑 | 说明 |
|---|---|---|
| Field display name | 是 | 修改字段在界面中的显示名称,不改变字段标识名称。 |
| Field name | 否 | 字段标识名称创建后通常不能在编辑表单中修改。 |
| Field interface | 条件支持 | 主数据库字段或同步字段在字段映射时可以调整。调整后会影响页面输入、展示和校验方式。 |
| Field type | 条件支持 | 主数据库字段或同步字段在字段映射时可以调整。调整前需要确认已有数据能否按新类型使用。 |
| 选择层级 | 是 | 调整字段可选择到省、市或区。 |
| 必须选择到最后一级 | 是 | 控制提交时是否必须选择到配置的最深层级。 |
| Validation rules | 是 | 调整必填等校验规则。 |
| Description | 是 | 补充字段含义、填写要求、数据来源或维护人。 |
:::warning 注意
中国行政区字段依赖插件提供的 chinaRegions 数据表。使用前请确保「中国行政区划」字段插件已启用。
:::
点击字段右侧的「Delete」可以删除中国行政区字段。主数据库中还可以勾选多个字段后批量删除。
删除主数据库中新建的中国行政区字段时,通常会同时删除数据库中的真实列及该列已有数据。删除从数据库同步或外部数据源映射出的字段时,影响范围取决于对应数据源和字段来源。
:::danger 警告
删除字段可能影响页面区块、表单、筛选、权限、工作流、API、导入导出和已有数据。删除前先确认字段是否仍被业务配置引用。
:::
中国行政区字段适合在地址、区域和统计场景中使用。
| 场景 | 用途 |
|---|---|
| 表单区块 | 使用级联选择器选择省、市、区县。 |
| 详情区块 | 展示行政区划路径。 |
| 表格区块 | 展示记录所属地区。 |
| 筛选区块 | 按地区筛选记录。 |
| 图表区块 | 按省、市、区统计业务数据。 |
可编辑模式下,中国行政区字段显示为级联选择器。
阅读模式下,中国行政区字段会显示为文本路径,比如:
北京市 / 市辖区 / 东城区