数据表字段

datatable - 渲染一个可编辑的记录表格，格式为网格。单元格内容可以直接在网格中编辑，从而允许管理多行多列的信息。

yaml

data:
    type: datatable
    adding: true
    deleting: true
    columns: []
    recordsPerPage: false
    searching: false

为了在模型中使用此功能，该字段应定义在 jsonable 属性中，或任何能够以数组形式存储的。

以下字段属性受支持且常用。

Property	Description
label	a name when displaying the form field to the user.
default	specifies a default string value, optional.
comment	places a descriptive comment below the field.
adding	allow records to be added to the data table. Default: `true`.
btnAddRowLabel	defines a custom label for the "Add Row Above" button.
btnAddRowBelowLabel	defines a custom label for the "Add Row Below" button.
btnDeleteRowLabel	defines a custom label for the "Delete Row" button.
columns	an array representing the column configuration of the data table. See the Column configuration section below.
deleting	allow records to be deleted from the data table. Default: `true`.
dynamicHeight	if `true`, the data table's height will extend or shrink depending on the records added, up to the maximum size defined by the `height` configuration value. Default: `false`.
fieldName	defines a custom field name to use in the POST data sent from the data table. Leave blank to use the default field alias.
height	the data table's height, in pixels. If set to `false`, the data table will stretch to fit the field container.
keyFrom	the data attribute to use for keying each record. This should usually be set to `id`. Only supports integer values.
postbackHandlerName	specifies the AJAX handler name in which the data table content will be sent with. When set to `null` (default), the handler name will be auto-detected from the request name used by the form which contains the data table. It is recommended to keep this as `null`.
recordsPerPage	the number of records to show per page. If set to `false`, the pagination will be disabled.
searching	allow records to be searched via a search box. Default: `false`.
toolbar	an array representing the toolbar configuration of the data table.

列配置

数据表小部件允许通过 columns 配置变量将列指定为数组. 每列应使用字段名作为键，并使用以下配置变量来设置该字段.

示例:

yaml

columns:
    id:
        type: string
        title: ID
        validation:
            integer:
                message: Please enter a number
    name:
        type: string
        title: Name

Option	Description
type	the input type for this column's cells. Must be one of the following: `string`, `checkbox`, `dropdown` or `autocomplete`.
options	for `dropdown` and `autocomplete` columns only - this specifies the AJAX handler that will return the available options, as an array. The array key is used as the value of the option, and the array value is used as the option label.
readOnly	whether this column is read-only. Default: `false`.
title	defines the column's title.
validation	an array specifying the validation for the content of the column's cells. See the Column validation section below.
width	defines the width of the column, in pixels.

列验证

列单元格可以根据下述验证类型进行验证。验证应指定为一个数组，其中验证类型用作键，并且可选消息作为该验证的 message 属性进行指定。

Validation	Description
float	Validates the data as a float. An optional boolean `allowNegative` attribute can be provided, allowing for negative float numbers.
integer	Validates the data as an integer. An optional boolean `allowNegative` attribute can be provided, allowing for negative integers.
length	Validates the data to be of a certain length. An integer `min` and `max` attribute must be provided, representing the minimum and maximum number of characters that must be entered.
regex	Validates the data against a regular expression. A string `pattern` attribute must be provided, defining the regular expression to test the data against.
required	Validates that the data must be entered before saving.

数据表字段

datatable - 渲染一个可编辑的记录表格，格式为网格。单元格内容可以直接在网格中编辑，从而允许管理多行多列的信息。

yaml

data:
    type: datatable
    adding: true
    deleting: true
    columns: []
    recordsPerPage: false
    searching: false

为了在模型中使用此功能，该字段应定义在 jsonable 属性中，或任何能够以数组形式存储的。

以下字段属性受支持且常用。

Property

Description

label

a name when displaying the form field to the user.

default

specifies a default string value, optional.

comment

places a descriptive comment below the field.

adding

allow records to be added to the data table. Default: true.

btnAddRowLabel

defines a custom label for the "Add Row Above" button.

btnAddRowBelowLabel

defines a custom label for the "Add Row Below" button.

btnDeleteRowLabel

defines a custom label for the "Delete Row" button.

columns

an array representing the column configuration of the data table. See the Column configuration section below.

deleting

allow records to be deleted from the data table. Default: true.

dynamicHeight

if true, the data table's height will extend or shrink depending on the records added, up to the maximum size defined by the height configuration value. Default: false.

fieldName

defines a custom field name to use in the POST data sent from the data table. Leave blank to use the default field alias.

height

the data table's height, in pixels. If set to false, the data table will stretch to fit the field container.

keyFrom

the data attribute to use for keying each record. This should usually be set to id. Only supports integer values.

postbackHandlerName

specifies the AJAX handler name in which the data table content will be sent with. When set to null (default), the handler name will be auto-detected from the request name used by the form which contains the data table. It is recommended to keep this as null.

recordsPerPage

the number of records to show per page. If set to false, the pagination will be disabled.

searching

allow records to be searched via a search box. Default: false.

toolbar

an array representing the toolbar configuration of the data table.

列配置

数据表小部件允许通过 columns 配置变量将列指定为数组. 每列应使用字段名作为键，并使用以下配置变量来设置该字段.

示例:

yaml

columns:
    id:
        type: string
        title: ID
        validation:
            integer:
                message: Please enter a number
    name:
        type: string
        title: Name

Option

Description

type

the input type for this column's cells. Must be one of the following: string, checkbox, dropdown or autocomplete.

options

for dropdown and autocomplete columns only - this specifies the AJAX handler that will return the available options, as an array. The array key is used as the value of the option, and the array value is used as the option label.

readOnly

whether this column is read-only. Default: false.

title

defines the column's title.

validation

an array specifying the validation for the content of the column's cells. See the Column validation section below.

width

defines the width of the column, in pixels.

列验证

列单元格可以根据下述验证类型进行验证。验证应指定为一个数组，其中验证类型用作键，并且可选消息作为该验证的 message 属性进行指定。

Validation

Description

float

Validates the data as a float. An optional boolean allowNegative attribute can be provided, allowing for negative float numbers.

integer

Validates the data as an integer. An optional boolean allowNegative attribute can be provided, allowing for negative integers.

length

Validates the data to be of a certain length. An integer min and max attribute must be provided, representing the minimum and maximum number of characters that must be entered.

regex

Validates the data against a regular expression. A string pattern attribute must be provided, defining the regular expression to test the data against.

required

Validates that the data must be entered before saving.

文档导航

数据表字段

列配置

列验证

数据表字段

列配置

列验证