gridColumnVisibility 列可见性

gridColumnVisibility 支持用户显示或隐藏 dataGrid 的列。

XML 元素

gridColumnVisibility

Java 类

JmixGridColumnVisibility

基本用法

gridColumnVisibility 由一个按钮和一个表格列的下拉菜单组成。

下面是在列表视图中使用 gridColumnVisibility 的示例：

<hbox id="buttonsPanel" classNames="buttons-panel">
    <!-- ... -->
    <gridColumnVisibility dataGrid="stepsTable"
                          icon="COG"
                          themeNames="icon"
                          exclude="duration">
        <menuItem refColumn="name" text="msg://menuItem.text"/>
    </gridColumnVisibility>
</hbox>
<dataGrid id="stepsTable"
          width="100%"
          minHeight="20em"
          dataContainer="stepsDc">
    <columns>
        <column property="name"/>
        <column property="duration"/>
        <column property="sortValue"/>
    </columns>
</dataGrid>

配置下拉菜单

默认情况下，下拉列表中的列名是表头中的列名。但是也可以通过 menuItem 元素自定义。

例如，在前一个示例中，用 menuItem 元素为 name 列设置了一个不同的本地消息值，而不使用 dataGrid 表头中的内容。

include

include 属性可以配置 gridColumnVisibility 的下拉列表中包含哪些列。

exclude

exclude 属性可以配置 gridColumnVisibility 的下拉列表中需要排除哪些列。

例如，在前一个示例中，排除了 duration 列。

hideAllEnabled

hideAllEnabled 属性用于控制 gridColumnVisibility 的下拉列表中 Hide all 的可见性。

showAllEnabled

showAllEnabled 属性用于控制 gridColumnVisibility 的下拉列表中 Show all 的可见性。

样式版本

使用 themeNames 属性配置一个或多个样式。

样式 描述 支持的主题

primary

主要按钮样式

Aura, Lumo

tertiary

低优先级的按钮样式

Aura, Lumo

tertiary-inline

适用于文本内容内部使用的内联按钮样式

Lumo

icon

减少图标周围的空白

Lumo

small

按钮较小

Aura, Lumo

large

按钮较大

Aura, Lumo

success

成功样式

Aura, Lumo

error

错误样式

Aura, Lumo

contrast

对比样式

Lumo

XML 属性

下面是 gridColumnVisibility 的特殊属性：

名称 描述 默认值

dataGrid

设置改组件管理的数据网格。

—

exclude

设置菜单中需要排除的列。参考 exclude。

—

hideAllEnabled

菜单是否包含 Hide all 项。参考 hideAllEnabled。

—

icon

设置图标。

—

include

设置菜单中需要包含的列。参考 include。

—

showAllEnabled

菜单是否包含 Show all 项。参考 showAllEnabled。

—

下面是 gridColumnVisibility 支持的其他通用属性：

id - alignSelf - classNames - colspan - css - enabled - focusShortcut - height - maxHeight - maxWidth - minHeight - minWidth - tabIndex - text - themeNames - visible - whiteSpace - width

事件和处理器

下面是 gridColumnVisibility 支持的通用事件：

AttachEvent - BlurEvent - DetachEvent - FocusEvent

XML 内部元素

一个 gridColumnVisibility 可以包含 menuItem 作为其内部元素。