docs: supplement rowSeriesNumber options

This commit is contained in:
fangsmile 2024-11-05 16:35:07 +08:00
parent 981011b31e
commit af19683142
4 changed files with 140 additions and 2 deletions

View File

@ -209,6 +209,10 @@ Separately set the header not to respond to mouse hover interaction.
Cell selection interaction configuration, specific configuration items as follows:
##${prefix} highlightMode ('cross' | 'column' | 'row' | 'cell') = 'cell'
Highlight range mode: cross, whole column, whole row or single cell. Default is `cell`
##${prefix} headerSelectMode ('inline' | 'cell' | 'body') = 'inline'
When clicking on a header cell, whether the entire row or column needs to be selected along with the body.

View File

@ -30,4 +30,69 @@ Body cell style, please refer to: [style](../option/ListTable-columns-text#style
${prefix} disableColumnResize(boolean)
Whether to disable row serial number width adjustment.The default is false.
Whether to disable row serial number width adjustment.The default is false.
${prefix} headerIcon(string|Object|Array)
Table header cell icon configuration. The configurable types are:
```
string | ColumnIconOption | (string | ColumnIconOption)[];
```
For detailed configuration of ColumnIconOption, please refer to [Definition](/zh/option.html#ListTable-columns-text.icon.ColumnIconOptionDefinition:)
${prefix} icon(string|Object|Array|Funciton)
Body cell icon configuration.
```
icon?:
| string
| ColumnIconOption
| (string | ColumnIconOption)[]
| ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
```
#${prefix}ColumnIconOption
```
type ColumnIconOption = ImageIcon | SvgIcon;
```
#${prefix}ImageIcon(Object)
type is set to 'image'. The image address needs to be set in src
{{ use: image-icon( prefix = '##' + ${prefix}) }}
#${prefix}SvgIcon(Object)
type is set to 'svg'. You need to configure the svg address or the complete svg file string in svg
{{ use: svg-icon( prefix = '##' + ${prefix}) }}
${prefix} headerCustomLayout(Function)
The header cell custom layout element definition, this custom form is suitable for cells with complex content layout.
```
(args: CustomRenderFunctionArg) => ICustomLayoutObj;
```
{{ use: common-CustomRenderFunctionArg() }}
{{ use: custom-layout(
prefix = '#'+${prefix},
) }}
${prefix} customLayout(Function)
The body cell custom layout element definition is suitable for cells with complex content layout.
Defined as the following function:
```
(args: CustomRenderFunctionArg) => ICustomLayoutObj;
```
{{ use: common-CustomRenderFunctionArg() }}
{{ use: custom-layout(
prefix = '#'+${prefix},
) }}

View File

@ -204,6 +204,10 @@ hover 交互响应模式:十字交叉、整列、整行或者单个单元格
选择单元格交互配置,具体配置项如下:
##${prefix} highlightMode ('cross' | 'column' | 'row' | 'cell') = 'cell'
高亮范围模式:十字交叉 整列 整行 或者单个单元格。默认`cell`
##${prefix} headerSelectMode ('inline' | 'cell' | 'body') = 'inline'
点击表头单元格时连带 body 是否需要整行或整列选中。

View File

@ -30,4 +30,69 @@ body 单元格样式,可参考:[style](../option/ListTable-columns-text#styl
${prefix} disableColumnResize(boolean)
是否禁止列宽调整,默认为 false
是否禁止列宽调整,默认为 false
${prefix} headerIcon(string|Object|Array)
表头单元格图标配置。可配置类型有:
```
string | ColumnIconOption | (string | ColumnIconOption)[];
```
ColumnIconOption 具体配置可参考[定义](/zh/option.html#ListTable-columns-text.icon.ColumnIconOption定义)
${prefix} icon(string|Object|Array|Funciton)
body 单元格图标配置。
```
icon?:
| string
| ColumnIconOption
| (string | ColumnIconOption)[]
| ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
```
#${prefix}ColumnIconOption
```
type ColumnIconOption = ImageIcon | SvgIcon;
```
#${prefix}ImageIcon(Object)
type 配置成 'image'。需要配置图片地址在 src 中
{{ use: image-icon( prefix = '##' + ${prefix}) }}
#${prefix}SvgIcon(Object)
type 配置成 'svg'。需要配置 svg 地址或者 svg 完整文件字符串在 svg 中
{{ use: svg-icon( prefix = '##' + ${prefix}) }}
${prefix} headerCustomLayout(Function)
表头单元格自定义布局元素定义,该自定义形式适合内容复杂布局的单元格。
```
(args: CustomRenderFunctionArg) => ICustomLayoutObj;
```
{{ use: common-CustomRenderFunctionArg() }}
{{ use: custom-layout(
prefix = '#'+${prefix},
) }}
${prefix} customLayout(Function)
body 单元格自定义布局元素定义,该自定义形式适合内容复杂布局的单元格。
定义为如下函数:
```
(args: CustomRenderFunctionArg) => ICustomLayoutObj;
```
{{ use: common-CustomRenderFunctionArg() }}
{{ use: custom-layout(
prefix = '#'+${prefix},
) }}