高级栅格的属性
Mashup Builder 设计视图中的高级栅格和树形栅格属性可能会有所不同，具体取决于您是通过 Mashup Builder (静态配置) 还是通过服务 (动态配置) 配置栅格。下图列出了通过 Mashup Builder 配置栅格时可供使用的所有属性。
对于只能通过 Mashup Builder 进行配置而不能通过动态配置进行配置的属性，它们在表格中以星号 * 标记。
|
属性名称
|
说明
|
基本类型
|
默认值
|
是否可绑定 (Y/N)？
|
是否适用于栅格或树形栅格？
|
||||
|---|---|---|---|---|---|---|---|---|---|
|
Id*
|
ThingWorx 内部使用的唯一标识符。
|
INTEGER
|
Gridadvanced-<id>或
Treegridadvanced--<id>
|
N
|
两者
|
||||
|
Type*
|
小组件类型。
|
不可用
|
Grid-Advanced 或 Tree-Grid-Advanced
|
N
|
两者
|
||||
|
DisplayName*
|
显示时用于标识栅格的用户定义名称。
|
STRING
|
gridadvanced-n 或 treegridadvanced-n
|
N
|
两者
|
||||
|
Description*
|
用户定义的说明。
|
STRING
|
不可用
|
N
|
两者
|
||||
|
Data*
|
启动栅格时加载的数据源。 如果栅格绑定到数据源，则会显示实心箭头：  。如果没有数据源，则会显示  。 |
INFOTABLE
|
不可用
|
Y
|
两者
|
||||
|
ChildData*
|
展开节点时动态加载的子项数据源。 如果将栅格绑定到子项数据源，则会显示实心箭头： 如果没有子数据源，则会显示 。 |
INFOTABLE
|
不可用
|
Y
|
仅适用于树形栅格
|
||||
|
ParentIDFieldName
|
标识父项 ID 字段名称。创建层次树结构时需要此属性。
|
STRING
|
parentId
|
N
|
仅适用于树形栅格
|
||||
|
IDFieldName
|
栅格的主键列。此列中的值可作为每个数据行的唯一标识符。此属性对于高级栅格为可选属性，而对于树形栅格则为必需属性。
如果未指定任何字段，或者指定的字段不存在，则栅格会创建其自己的内部行 ID。
|
STRING
|
id
|
N
|
两者
|
||||
|
IDPathSeparator
|
启用配置路径分隔符字符。
|
STRING
|
:;
|
N
|
仅适用于树形栅格
|
||||
|
HasChildrenFieldName
|
指定用于指示行是否具有可用子项数据的列名称。
要指示某一行不具有子项，请输入下列项之一：‘0’、0、‘false’、false、empty string 或 undefined。
任何其他值均表示该行具有子项。
|
STRING
|
hasChildren
|
N
|
仅适用于树形栅格
|
||||
|
Configuration*
|
如果将栅格绑定到配置服务，则会显示实心箭头： 如果没有配置服务，则会显示 。
|
STRING
|
不可用
|
Y
|
两者
|
||||
|
IsEditable
|
确定当栅格在运行时显示时，是否可以编辑栅格单元格中的值。
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
EnableEditButtons
|
激活栅格工具栏中的“编辑”、“保存”和“取消”，以手动保存编辑内容。
如果要自动保存更改，请设置上述 IsEditable 属性。如果要手动保存更改，请设置 EnableEditButtons 属性。
设置此属性后，EnableAddDeleteButtons 属性即会显示在混搭属性面板中。
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
EnableAddDeleteButtons
|
如果将此属性设置为 True，则“添加”和“删除”即会显示在栅格工具栏中，可供您在栅格中添加或删除行。
|
BOOLEAN
|
False
|
N
|
仅适用于高级栅格
|
||||
|
EditedTable
|
可绑定属性，用于在运行时编辑单元格时指定已更新值的输出位置。必须将此属性绑定到信息表更新服务，才能保存已更新值。例如，绑定到数据表事物的 AddOrUpdateDataTableEntries 服务。
|
INFOTABLE
|
不可用
|
Y
|
两者
|
||||
|
DeletedTable
|
此属性可指定运行时从栅格中删除的行的输出位置。
必须将此属性绑定到信息表更新服务，才能保存已更新值。例如，将属性绑定到数据表事物上的 AddOrUpdateDataTableEntries 服务。
|
INFOTABLE
|
不可用
|
Y
|
仅适用于高级栅格
|
||||
|
DefaultSelectedRows
|
定义在显示栅格时默认突出显示的行号。值可以包含以逗号分隔的数字和范围。
示例：1,2,4-5 此属性还可由绑定服务定义。如果已绑定服务，则会显示 。如果没有任何服务，则会显示 。
|
STRING
|
不可用
|
Y
|
两者
|
||||
|
SelectedRows*
|
通过 INFOTABLE 源定义在显示栅格时默认突出显示的行。
在树形栅格中使用时，只需“行 ID”列即可进行行选择，不过其他列也可以包括在内。
在高级栅格中，可通过将服务中 SelectedRows 参数的输出绑定到栅格上的输入 SelectedRows 属性来进行行选择。
此属性可在输出或输入方向上绑定，以便一个实体可以控制另一个实体中的行选择。例如，一个表格可以控制另一个表格中的行选择，或者可使用 3D 图像选择表格中的行。 对于控制实体，将服务绑定为输出 INFOTABLE  对于受控制的实体，将服务绑定为输入 INFOTABLE: 
|
INFOTABLE
|
不可用
|
Y
|
两者
|
||||
|
IncludeRowExpansionParents*
|
确定在选择或展开子项行时，是否包括预加载客户端数据中未包括的父项行。如果为 True，则将使用子项行获取父项行，以便可以重新创建层次结构。
|
BOOLEAN
|
False
|
N
|
仅适用于树形栅格
|
||||
|
ExpandRows*
|
栅格中应展开的任何顶层行或子项行的 ID。只需“行 ID”列即可进行行选择，以便执行展开操作。
|
INFOTABLE
|
不可用
|
Y
|
仅适用于树形栅格
|
||||
|
ExpandLoadedRows*
|
启动栅格后将自动展开所有预加载数据。
|
BOOLEAN
|
False
|
Y
|
仅适用于树形栅格
|
||||
|
ExpandRowOnDoubleClick
|
双击行或单击节点图标时，会展开具有子项的行。
在 JSON 配置服务中，此属性名称为：treeSettings.expandRowOnDoubleClick。
|
BOOLEAN
|
False
|
N
|
仅适用于树形栅格
|
||||
|
PreserveRowExpansion
|
|
BOOLEAN
|
False
|
N
|
仅适用于树形栅格
|
||||
|
RowSelection
|
控制可配置的行选择。选项：none、single 或 multi。
|
STRING
|
无
|
N
|
仅适用于栅格
|
||||
|
AutoScroll
|
控制在调整栅格大小或刷新服务时，栅格是否会自动滚动至选定行。
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
CookiePersistence*
|
针对某些列设置 (顺序、大小、可见性和排序顺序) 激活客户端持久化方案。
|
BOOLEAN
|
True
|
N
|
两者
|
||||
|
EnableContextMenu*
|
启用或禁用在运行时显示栅格上下文菜单，以此允许最终用户显示或隐藏特定列。与 CookiePersistence 配合工作：
• 如果同时设置这两个属性 - 用户可以显示/隐藏列，并且这些选择会保持不变。
• 如果 EnableContextMenu 未设置且 CookiePersistence 已设置 - 用户不能显示或隐藏列，但先前的选择会保持不变。
• 如果 EnableContextMenu 已设置且 CookiePersistence 未设置 - 您可以显示和隐藏列，但只能用于当前请求。
在 JSON 配置服务中，您可以将属性设置为顶层参数，如下所示：
var config = {“enableContextMenu”: false,...}
|
BOOLEAN
|
True
|
N
|
两者
|
||||
|
EnableSorting
|
必须针对要进行的任何列排序类型设置，其中包括标题的升序/降序切换、MultiColumnSortOrder 属性或绑定排序服务。设置此选项后，属性面板中会显示以下属性：
• QueryFilter - 用于数据服务的可绑定筛选查询
• Filter - 用于触发查询数据服务的可绑定事件属性
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
MultiColumnSortOrder
|
设置默认列排序顺序。语法：列名称:顺序,列名称:顺序
示例：office:asc,title:des
|
STRING
|
不可用
|
N
|
两者
|
||||
|
EnableGridSearch
|
在栅格中放置带有全局搜索框的工具栏。设置此选项后，属性面板中会显示以下属性：
• QueryFilter - 用于数据服务的可绑定筛选查询
• Filter – - 用于触发查询数据服务的可绑定事件属性
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
GridSearchLocation
|
定义搜索框的放置位置。仅当 EnableGridSearch 属性已设置时，此选项才可用。
|
STRING
|
不可用
|
N
|
两者
|
||||
|
QueryFilter*
|
一种可绑定查询属性，用于将查询服务绑定为输入查询参数，以控制数据的排序、搜索和筛选。当打开 EnableSorting 或 EnableGridSearch 属性时，此属性会变为可用状态。用户可以在属性面板中或栅格自带的上下文菜单中设置此属性。 如果要在混搭中使用数据筛选器小组件，则可以将输出 QueryFilter 属性绑定到高级栅格或树形栅格小组件的输入查询属性。此栅格会将所有查询参数组合在一起，以创建绑定到指定服务的单一输出过滤器。当在两个方向上绑定查询筛选器时，会显示实心箭头：  如果不存在数据筛选器小组件且绑定仅发生在输出方向上，则一个箭头会显示为实心，而另一个箭头则会显示为空心： |
QUERY
|
不可用
|
Y
|
两者
|
||||
|
EnableGridReset
|
放置带有“栅格”重置按钮的工具栏。单击“重置”可清除存储在 cookie 中的所有栅格用户设置，并将栅格返回到其默认配置。
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
EnableFilterEventOnConfigChange*
|
当从服务更新配置时，打开或关闭事件触发。
设置此属性后，如果对绑定配置进行了更改，则还会触发筛选事件来更新数据。如果未设置此属性，则在更新绑定配置时，不会触发筛选事件。
|
BOOLEAN
|
True
|
N
|
两者
|
||||
|
EnableFooter
|
启用栅格中的脚注部分。将此属性设置为 True 时，会设置两个名为 FooterData 和 TableFooterStyle 的附加属性。
使用 FooterData 属性绑定脚注部分中的数据。
|
BOOLEAN
|
False
|
N
|
两者
|
||||
|
FooterData
|
包含在栅格脚注中显示的数据。
|
INFOTABLE
|
不可用
|
Y
|
两者
|
||||
|
GridResetButtonLocation
|
定义栅格重置按钮的放置位置。
|
STRING
|
不可用
|
N
|
两者
|
||||
|
RowFormat
|
随即打开一个对话框，您可在其中定义可选的基于行的规则，以应用动态“状态格式”。这些基于行的规则可通过基于单元格的状态格式进行覆盖，该格式可从栅格上下文菜单上的“配置栅格列”选项中找到。
|
STATE FORMATTING
|
状态格式
|
N
|
两者
|
||||
|
TableWrapperStyle
|
定义栅格的背景样式。此操作会在整个表格周围添加轮廓颜色，并设置背景颜色。支持的属性有线颜色、粗细和类型、背景颜色和替代背景颜色。
|
STYLEDEFINITION
|
DefaultTableWrapperStyle
|
N
|
两者
|
||||
|
TableHeaderStyle
|
定义栅格标题样式。
|
STYLEDEFINITION
|
DefaultTableHeaderStyle
|
N
|
两者
|
||||
|
FocusStyle
|
定义栅格中具有焦点的行的样式。
|
STYLEDEFINITION
|
DefaultFocusStyle
|
N
|
两者
|
||||
|
RowBackgroundStyle
|
定义行背景样式。此操作会添加背景颜色、字体颜色和粗细样式。但不会为每一行添加线型。
|
STYLEDEFINITION
|
DefaultRowBackgroundStyle
|
N
|
两者
|
||||
|
RowAlternateBackgroundStyle
|
为替代行定义第二行背景样式。此操作会添加字体颜色和粗细样式，但不会添加线型。
|
STYLEDEFINITION
|
DefaultRowAlternateBackgroundStyle
|
N
|
两者
|
||||
|
RowHoverStyle
|
在将指针置于行上时，定义行的样式。此操作会将背景颜色和字体添加至每个单元格。线颜色、粗细和类型仅应用于放置指针的行。
|
STYLEDEFINITION
|
DefaultRowHoverStyle
|
N
|
两者
|
||||
|
RowSelectedStyle
|
定义选定行的样式。此操作会将背景颜色和字体添加至每个单元格。线颜色、粗细和类型仅应用于选定行。
|
STYLEDEFINITION
|
DefaultRowSelectedStyle
|
N
|
两者
|
||||
|
RowBorderStyle
|
定义行边界样式。此操作会将线颜色、粗细和类型添加到单元格的水平边。
|
STYLEDEFINITION
|
DefaultRowBorderStyle
|
N
|
两者
|
||||
|
CellBorderStyle
|
定义单元格边界样式。此操作会将线颜色、粗细和类型添加到单元格的竖直边。
|
STYLEDEFINITION
|
DefaultCellBorderStyle
|
N
|
两者
|
||||
|
ToolbarStyle
|
定义工具栏的样式。
|
STYLEDEFINITION
|
DefaultToolbarStyle
|
N
|
两者
|
||||
|
TableFooterStyle
|
定义栅格中脚注部分的样式。其中包括背景颜色、边界样式和字体样式。
|
STYLE DEFINITION
|
DefaultGridAdvancedFooterStyle
|
N
|
两者
|
||||
|
TooltipStyle
|
定义工具提示的样式。
|
STYLEDEFINITION
|
DefaultTooltipStyle
|
N
|
两者
|
||||
|
SortAscendingStyle
|
定义排序升序图标的样式。
|
STYLEDEFINITION
|
DefaultSortAscendingStyle
|
N
|
两者
|
||||
|
SortDescendingStyle
|
定义排序降序图标的样式。
|
STYLEDEFINITION
|
DefaultSortDescendingStyle
|
N
|
两者
|
||||
|
CellValidationErrorStyle
|
定义发生验证错误时单元格的样式。
|
STYLE DEFINITION
|
DefaultCellValidationErrorStyle
|
N
|
两者
|
||||
|
CellValidationErrorTooltipStyle
|
定义发生验证错误时单元格工具提示的样式。
|
STYLE DEFINITION
|
DefaultCellValidationErrorTooltipStyle
|
N
|
两者
|
||||
|
RowIconStyle
|
定义树节点的文件夹图标的样式。
|
STYLEDEFINITION
|
DefaultRowIconStyle
|
N
|
仅适用于树形栅格
|
||||
|
RowExpansionIconStyle
|
定义树节点的展开图标的样式。
|
STYLEDEFINITION
|
DefaultRowExpansionIconStyle
|
N
|
仅适用于树形栅格
|
||||
|
RowCollapseIconStyle
|
定义树节点的折叠图标的样式。
|
STYLEDEFINITION
|
DefaultRowCollapseIconStyle
|
N
|
仅适用于树形栅格
|
||||
|
HeaderOverflow
|
提供用于处理溢出的标题单元格文本的选项。选项：
• fitted - 文本会连续换行，以适应列宽度，即使在中字中也是如此。
• wrapped - 文本会在空格或短划线处换行。
• clipped – 在标题单元格结尾处截断文本。
• ellipsis - 使用省略号 (...) 截断文本，其中省略号用于显示更多的文本。
• tooltip - 使用省略号 (...) 截断文本，并在工具提示中显示完整文本
|
STRING
|
工具提示
|
N
|
两者
|
||||
|
DataOverflow
|
为溢出的数据单元格文本提供选项。HeaderOverflow 属性中也会提供相同的选项。
|
STRING
|
剪切
|
N
|
两者
|
||||
|
MaxHeaderHeight
|
标题行在出现竖直滚动条之前可展开的最大高度 (以像素为单位)。
|
NUMBER
|
100
|
N
|
两者
|
||||
|
MinRowHeight
|
栅格中行的最小高度设置 (以像素为单位)。
假设您未将图像呈现器用于显示了大于默认最小行高 30 像素的图像的列。例如，应用包含图像的样式的状态定义。在这种情况下，请确保放大行高设置以适应图像的高度。
|
NUMBER
|
0
|
N
|
两者
|
||||
|
MaxRowCacheSize
|
栅格中可在客户端展开的最大行数。达到限制时，会生成警告，并且在执行其他展开操作之前必须要折叠节点。
|
NUMBER
|
5000
|
N
|
仅适用于树形栅格
|
||||
|
DoubleClicked*
|
双击栅格时触发的可绑定事件属性。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
Filter*
|
一种可绑定查询属性，用于将查询服务绑定为输入查询参数，以控制数据的排序、搜索和筛选。当打开 EnableSorting 或 EnableGridSearch 属性时，此属性会变为可用状态。用户可以在属性面板中或栅格自带的上下文菜单中设置此属性。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
EditCellStarted
|
可绑定事件属性，可在用户开始编辑单元格值时触发。这仅在设置了 IsEditable 参数时处于活动状态。
在编辑时，您可以使用此事件来更改混搭中其他小组件的状态。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
EditCellCompleted
|
可绑定事件属性，当您编辑单元格，然后单击 ENTER 键、TAB 键或已编辑单元格外部的任意位置时，可触发此属性。按 ESC 键使值保持未编辑状态。刷新栅格后，会显示已编辑的值。
此事件的两种用法如下：
• 可将其绑定到信息表更新服务，以使 EditedTable 信息表中的已编辑值保持不变。
• 可将其绑定到可在混搭中启用“保存”按钮小组件的服务。反过来，可将“保存”按钮绑定到信息表更新服务，以使 EditedTable 信息表中的更新值保持不变。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
EditStarted
|
单击栅格工具栏中的“编辑”时，会触发此事件。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
EditCompleted
|
单击栅格工具栏中的“保存”时，会触发此事件。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
EditCancelled
|
单击栅格工具栏中的“取消”时，会触发此事件。
|
EVENT
|
不可用
|
Y
|
两者
|
||||
|
Z-index*
|
分层小组件的排序。栅格小组件会按照 Z 索引从高到低的顺序进行排列。
|
NUMBER
|
10
|
N
|
两者
|
||||
|
Visible*
|
如果设置，栅格会在运行时显示。此属性可由绑定到栅格的服务定义。如果将可见服务绑定到栅格，则会显示实心箭头：  如果没有可见服务，则会显示  。 |
BOOLEAN
|
True
|
Y
|
两者
|
||||
|
SelectedRowsChanged*
|
可绑定事件属性，可用于在您选择或取消选择栅格中的一行或多行时触发另一个小组件或服务。
要使用此事件属性，请按以下步骤操作：
• 将 RowSelection 属性设置为 single 或 multi。
• 将 SelectedRows 属性绑定到另一个实体 (小组件或服务)。
• 将 SeletedRowsChanged 事件绑定到其他实体，以便在 SelectedRows 发生更改时触发此事件。
|
EVENT
|
不可用
|
Y
|
两者
|
* 将配置服务绑定到栅格时，Mashup Builder 的“属性”面板中仅会显示带有星标的属性。由于这些参数是从 JSON 服务传入的，其他所有属性都将从视图中隐藏。
 |
栅格样式的优先级高于依下列顺序排列的样式，其中，TableWrapperStyle 的优先级最低，而 RowHoverStyle 的优先级高于如下所示的所有其他样式。
1. TableWrapperStyle
2. RowBackground/RowAlternateBackgroundStyle
3. CellBorder/RowBorderStyle
4. FixedRowFormatter/State Definition
5. RowSelectedStyle
6. RowHoverStyle
|