PivotTable (Jmix-ui 1.0 API)

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.HasCaption, Component.HasDescription

All Known Implementing Classes:

PivotTableImpl
```
public interface PivotTable
extends Component, Component.BelongToFrame, Component.Editable, Component.HasCaption
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PivotTable.CellClickEvent` Describes PivotTable cell click event.
`static class`	`PivotTable.RefreshEvent` Describes PivotTable refresh event.

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String NAME
- Fields inherited from interface io.jmix.ui.component.Component
  AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`NAME`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAggregationProperties(java.lang.String... aggregationProperties)` Adds an array of properties names to prepopulate in vals area (gets passed to aggregator generating function).
`io.jmix.core.common.event.Subscription`	`addCellClickListener(java.util.function.Consumer<PivotTable.CellClickEvent> listener)` Adds a listener to the pivot table cell click events.
`void`	`addColumns(java.lang.String... cols)` Adds an array of property names to use as columns.
`void`	`addData(DataItem... dataItems)` Adds a data item to data provider.
`void`	`addExclusions(java.lang.String property, java.lang.String... exclusions)` Adds a values to given key of exclusions map.
`void`	`addHiddenFromAggregations(java.lang.String... hiddenFromAggregations)` Adds an array of properties names to omit from the aggregation arguments dropdowns.
`void`	`addHiddenFromDragDrop(java.lang.String... hiddenFromDragDrop)` Adds an array of properties names to omit from the drag'n'drop portion of the UI.
`void`	`addHiddenProperties(java.lang.String... hiddenProperties)` Adds an array of properties names to omit from the UI.
`void`	`addInclusions(java.lang.String property, java.lang.String... inclusions)` Adds a values to given key of inclusions map.
`void`	`addProperties(java.util.Map<java.lang.String,java.lang.String> properties)` Adds a map whose keys are `DataItem` property names to use as pivot table data and values they localized names.
`void`	`addProperty(java.lang.String property, java.lang.String value)` Add a property eith its localized value
`io.jmix.core.common.event.Subscription`	`addRefreshListener(java.util.function.Consumer<PivotTable.RefreshEvent> refreshListener)` Adds a listener to the pivot table refresh events.
`void`	`addRows(java.lang.String... rows)` Adds an array of properties names to use as rows.
`Aggregation`	`getAggregation()`
`java.util.List<java.lang.String>`	`getAggregationProperties()`
`Aggregations`	`getAggregations()`
`java.lang.Boolean`	`getAutoSortUnusedProperties()`
`ColumnOrder`	`getColumnOrder()`
`java.util.List<java.lang.String>`	`getColumns()`
`DataProvider`	`getDataProvider()`
`DerivedProperties`	`getDerivedProperties()`
`java.lang.String`	`getEmptyDataMessage()`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getExclusions()`
`JsFunction`	`getFilterFunction()`
`java.util.List<java.lang.String>`	`getHiddenFromAggregations()`
`java.util.List<java.lang.String>`	`getHiddenFromDragDrop()`
`java.util.List<java.lang.String>`	`getHiddenProperties()`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getInclusions()`
`java.lang.Integer`	`getMenuLimit()`
`java.lang.String`	`getNativeJson()`
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()`
`Renderer`	`getRenderer()`
`RendererOptions`	`getRendererOptions()`
`Renderers`	`getRenderers()`
`RowOrder`	`getRowOrder()`
`java.util.List<java.lang.String>`	`getRows()`
`JsFunction`	`getSortersFunction()`
`UnusedPropertiesVertical`	`getUnusedPropertiesVertical()`
`java.lang.Boolean`	`isColTotalsShown()`
`java.lang.Boolean`	`isRowTotalsShown()`
`java.lang.Boolean`	`isShowUI()`
`void`	`repaint()` Resend all items and properties to client and repaint pivot table.
`void`	`setAggregation(Aggregation aggregation)` Sets the aggregation object.
`void`	`setAggregationProperties(java.util.List<java.lang.String> aggregationProperties)` Sets the list of properties names to prepopulate in vals area (gets passed to aggregator generating function).
`void`	`setAggregations(Aggregations aggregations)` Sets the aggregations object which defines the collection of aggregations to use in pivot table and additional settings for them.
`void`	`setAutoSortUnusedProperties(java.lang.Boolean autoSortUnusedProperties)` Controls whether or not unused properties are kept sorted in the UI.
`void`	`setColumnOrder(ColumnOrder columnOrder)` Set the order in which column data is provided to the renderer.
`void`	`setColumns(java.util.List<java.lang.String> cols)` Sets the list of property names to use as columns.
`void`	`setDataProvider(DataProvider dataProvider)` Sets data provider for PivotTable.
`void`	`setDerivedProperties(DerivedProperties derivedProperties)` Sets object to define derived properties.
`void`	`setEmptyDataMessage(java.lang.String emptyDataMessage)` Sets the message that will be displayed in case of empty data.
`void`	`setExclusions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> exclusions)` Sets map whose keys are properties names and values are lists of properties values which denote records to exclude from rendering; used to prepopulate the filter menus that appear on double-click.
`void`	`setExclusions(java.lang.String property, java.util.List<java.lang.String> exclusions)` Sets the value of exclusions map.
`void`	`setFilterFunction(JsFunction filter)` Sets the `JsFunction` which defines a javascript code called on each record, returns `false` if the record is to be excluded from the input before rendering or `true` otherwise
`void`	`setHiddenFromAggregations(java.util.List<java.lang.String> hiddenFromAggregations)` Sets the list of properties names to omit from the aggregation arguments dropdowns.
`void`	`setHiddenFromDragDrop(java.util.List<java.lang.String> hiddenFromDragDrop)` Sets the list of properties names to omit from the drag'n'drop portion of the UI.
`void`	`setHiddenProperties(java.util.List<java.lang.String> hiddenProperties)` Sets the list of properties names to omit from the UI.
`void`	`setInclusions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> inclusions)` Sets map whose keys are properties names and values are lists of properties values which denote records to include in rendering; used to prepopulate the filter menus that appear on double-click (overrides `exclusions`).
`void`	`setInclusions(java.lang.String property, java.util.List<java.lang.String> inclusions)` Sets the value of inclusions map.
`void`	`setMenuLimit(java.lang.Integer menuLimit)` Sets maximum number of values to list in the double-click menu.
`void`	`setNativeJson(java.lang.String json)` Set additional JSON configuration as a string.
`void`	`setProperties(java.util.Map<java.lang.String,java.lang.String> properties)` Sets the map whose keys are `DataItem` property names to use as pivot table data and values they localized names.
`void`	`setRenderer(Renderer renderer)` Sets the renderer object.
`void`	`setRendererOptions(RendererOptions rendererOptions)` Sets object passed through to renderer as options.
`void`	`setRenderers(Renderers renderers)` Sets the renderers object which defines the collection of renderers to use in pivot table and additional settings for them.
`void`	`setRowOrder(RowOrder rowOrder)` Sets the order in which row data is provided to the renderer.
`void`	`setRows(java.util.List<java.lang.String> rows)` Sets the list of properties names to use as rows.
`void`	`setShowColTotals(java.lang.Boolean showColTotals)` Set `false` if col totals shouldn't be shown and `true` otherwise.
`void`	`setShowRowTotals(java.lang.Boolean showRowTotals)` Set `false` if row totals shouldn't be shown and `true` otherwise.
`void`	`setShowUI(java.lang.Boolean showUI)` Hides or shows UI elements in the editable pivot table.
`void`	`setSortersFunction(JsFunction sorters)` Sets the `JsFunction` which defines a javascript code called with an property name and can return a function which can be used as an argument to `Array.sort` for output purposes.
`void`	`setUnusedPropertiesVertical(UnusedPropertiesVertical unusedPropertiesVertical)` Controls whether or not unused properties are shown vertically instead of the default which is horizontally.

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable
isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasCaption
getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription
getDescription, setDescription

- Field Detail
  - NAME
```
static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - repaint
```
void repaint()
```
    Resend all items and properties to client and repaint pivot table. Use this method if you change some property of already displayed pivot table.
  - getProperties
```
java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Returns:
    
    the map whose keys are DataItem property names to use as pivot table data and values they localized names
  - setProperties
```
void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
```
    Sets the map whose keys are DataItem property names to use as pivot table data and values they localized names.
    
    Parameters:
    
    properties - a map of properties names with localized values
  - addProperties
```
void addProperties(java.util.Map<java.lang.String,java.lang.String> properties)
```
    Adds a map whose keys are DataItem property names to use as pivot table data and values they localized names.
    
    Parameters:
    
    properties - a map of properties names with localized values
  - addProperty
```
void addProperty(java.lang.String property,
                 java.lang.String value)
```
    Add a property eith its localized value
    
    Parameters:
    
    property - property name
    
    value - localized value
  - getRows
```
java.util.List<java.lang.String> getRows()
```
    Returns:
    
    the list of properties names to use as rows.
  - setRows
```
void setRows(java.util.List<java.lang.String> rows)
```
    Sets the list of properties names to use as rows.
    
    Parameters:
    
    rows - a list of properties names
  - addRows
```
void addRows(java.lang.String... rows)
```
    Adds an array of properties names to use as rows.
    
    Parameters:
    
    rows - an array of properties names
  - getColumns
```
java.util.List<java.lang.String> getColumns()
```
    Returns:
    
    the list of property names to use as columns.
  - setColumns
```
void setColumns(java.util.List<java.lang.String> cols)
```
    Sets the list of property names to use as columns.
    
    Parameters:
    
    cols - a list of properties names
  - addColumns
```
void addColumns(java.lang.String... cols)
```
    Adds an array of property names to use as columns.
    
    Parameters:
    
    cols - an array of properties names
  - getAggregation
```
Aggregation getAggregation()
```
    Returns:
    
    the aggregation object which defines how pivot table will aggregate results per cell
  - setAggregation
```
void setAggregation(Aggregation aggregation)
```
    Sets the aggregation object.
    Applies only when editable=false.
    
    Parameters:
    
    aggregation - an aggregation object
  - getRenderer
```
Renderer getRenderer()
```
    Returns:
    
    the renderer object which generates output from pivot data structure
  - setRenderer
```
void setRenderer(Renderer renderer)
```
    Sets the renderer object.
    Applies only when editable=false.
    
    Parameters:
    
    renderer - a renderer object
  - getAggregationProperties
```
java.util.List<java.lang.String> getAggregationProperties()
```
    Returns:
    
    the list of properties names to prepopulate in vals area (gets passed to aggregator generating function)
  - setAggregationProperties
```
void setAggregationProperties(java.util.List<java.lang.String> aggregationProperties)
```
    Sets the list of properties names to prepopulate in vals area (gets passed to aggregator generating function).
    Applies only when editable=true.
    
    Parameters:
    
    aggregationProperties - a list of properties names
  - addAggregationProperties
```
void addAggregationProperties(java.lang.String... aggregationProperties)
```
    Adds an array of properties names to prepopulate in vals area (gets passed to aggregator generating function).
    Applies only when editable=true.
    
    Parameters:
    
    aggregationProperties - an array of properties names
  - getAggregations
```
Aggregations getAggregations()
```
    Returns:
    
    the aggregations object which defines the collection of aggregations to use in pivot table and additional settings for them.
  - setAggregations
```
void setAggregations(Aggregations aggregations)
```
    Sets the aggregations object which defines the collection of aggregations to use in pivot table and additional settings for them.
    Applies only when editable=true.
    
    Parameters:
    
    aggregations - an aggregations object
  - getRenderers
```
Renderers getRenderers()
```
    Returns:
    
    the renderers object which defines the collection of renderers to use in pivot table and additional settings for them.
  - setRenderers
```
void setRenderers(Renderers renderers)
```
    Sets the renderers object which defines the collection of renderers to use in pivot table and additional settings for them.
    Applies only when editable=true.
    
    Parameters:
    
    renderers - a renderers object
  - getHiddenProperties
```
java.util.List<java.lang.String> getHiddenProperties()
```
    Returns:
    
    the list of properties names to omit from the UI
  - setHiddenProperties
```
void setHiddenProperties(java.util.List<java.lang.String> hiddenProperties)
```
    Sets the list of properties names to omit from the UI.
    Applies only when editable=true.
    
    Parameters:
    
    hiddenProperties - a list of properties names
  - addHiddenProperties
```
void addHiddenProperties(java.lang.String... hiddenProperties)
```
    Adds an array of properties names to omit from the UI.
    Applies only when editable=true.
    
    Parameters:
    
    hiddenProperties - an array of properties names
  - getHiddenFromAggregations
```
java.util.List<java.lang.String> getHiddenFromAggregations()
```
    Returns:
    
    list of properties names to omit from the aggregation arguments dropdowns
  - setHiddenFromAggregations
```
void setHiddenFromAggregations(java.util.List<java.lang.String> hiddenFromAggregations)
```
    Sets the list of properties names to omit from the aggregation arguments dropdowns.
    Applies only when editable=true.
    
    Parameters:
    
    hiddenFromAggregations - a list of properties names
  - addHiddenFromAggregations
```
void addHiddenFromAggregations(java.lang.String... hiddenFromAggregations)
```
    Adds an array of properties names to omit from the aggregation arguments dropdowns.
    Applies only when editable=true.
    
    Parameters:
    
    hiddenFromAggregations - an array of properties names
  - getHiddenFromDragDrop
```
java.util.List<java.lang.String> getHiddenFromDragDrop()
```
    Returns:
    
    list of properties names to omit from the drag'n'drop portion of the UI
  - setHiddenFromDragDrop
```
void setHiddenFromDragDrop(java.util.List<java.lang.String> hiddenFromDragDrop)
```
    Sets the list of properties names to omit from the drag'n'drop portion of the UI.
    Applies only when editable=true.
    
    Parameters:
    
    hiddenFromDragDrop - a list of properties names
  - addHiddenFromDragDrop
```
void addHiddenFromDragDrop(java.lang.String... hiddenFromDragDrop)
```
    Adds an array of properties names to omit from the drag'n'drop portion of the UI.
    Applies only when editable=true.
    
    Parameters:
    
    hiddenFromDragDrop - an array of properties names
  - getColumnOrder
```
ColumnOrder getColumnOrder()
```
    Returns:
    
    the order in which column data is provided to the renderer
  - setColumnOrder
```
void setColumnOrder(ColumnOrder columnOrder)
```
    Set the order in which column data is provided to the renderer.
    Ordering by value orders by column total.
    
    Parameters:
    
    columnOrder - the order in which column data is provided to the renderer
  - getRowOrder
```
RowOrder getRowOrder()
```
    Returns:
    
    the order in which row data is provided to the renderer
  - setRowOrder
```
void setRowOrder(RowOrder rowOrder)
```
    Sets the order in which row data is provided to the renderer.
    Ordering by value orders by row total.
    
    Parameters:
    
    rowOrder - the order in which row data is provided to the renderer
  - getMenuLimit
```
java.lang.Integer getMenuLimit()
```
    Returns:
    
    maximum number of values to list in the double-click menu
  - setMenuLimit
```
void setMenuLimit(java.lang.Integer menuLimit)
```
    Sets maximum number of values to list in the double-click menu.
    Applies only when editable=true.
    
    Parameters:
    
    menuLimit - maximum number of values to list in the double-click menu
  - getAutoSortUnusedProperties
```
java.lang.Boolean getAutoSortUnusedProperties()
```
    Returns:
    
    true if unused properties are kept sorted in the UI and false otherwise
  - setAutoSortUnusedProperties
```
void setAutoSortUnusedProperties(java.lang.Boolean autoSortUnusedProperties)
```
    Controls whether or not unused properties are kept sorted in the UI.
    Applies only when editable=true.
    
    Parameters:
    
    autoSortUnusedProperties - true if unused properties are kept sorted in the UI and false otherwise
  - getUnusedPropertiesVertical
```
UnusedPropertiesVertical getUnusedPropertiesVertical()
```
    Returns:
    
    true if unused attributes are shown always vertical, false if always horizontal. If set to a number (as is the default) then if the properties' names' combined length in characters exceeds the number then the properties will be shown vertically.
  - setUnusedPropertiesVertical
```
void setUnusedPropertiesVertical(UnusedPropertiesVertical unusedPropertiesVertical)
```
    Controls whether or not unused properties are shown vertically instead of the default which is horizontally. true means always vertical, false means always horizontal. If set to a number (as is the default) then if the properties' names' combined length in characters exceeds the number then the properties will be shown vertically.
    Applies only when editable=true.
    
    Parameters:
    
    unusedPropertiesVertical - properties
  - getDataProvider
```
DataProvider getDataProvider()
```
    Returns:
    
    data provider for PivotTable. Contains items which will be shown on PivotTable.
  - setDataProvider
```
void setDataProvider(DataProvider dataProvider)
```
    Sets data provider for PivotTable. Contains items which will be shown on PivotTable.
    
    Parameters:
    
    dataProvider - a data provider
  - addData
```
void addData(DataItem... dataItems)
```
    Adds a data item to data provider.
    
    Parameters:
    
    dataItems - a data item to add
  - getFilterFunction
```
JsFunction getFilterFunction()
```
    Returns:
    
    the JsFunction which defines a javascript code called on each record, returns false if the record is to be excluded from the input before rendering or true otherwise
  - setFilterFunction
```
void setFilterFunction(JsFunction filter)
```
    Sets the JsFunction which defines a javascript code called on each record, returns false if the record is to be excluded from the input before rendering or true otherwise
    
    Parameters:
    
    filter - a JsFunction to use as a filter
  - getSortersFunction
```
JsFunction getSortersFunction()
```
    Returns:
    
    the JsFunction which defines a javascript code called with an property name and can return a function which can be used as an argument to Array.sort for output purposes. If no function is returned, the default sorting mechanism is a built-in "natural sort" implementation. Useful for sorting attributes like month names
  - setSortersFunction
```
void setSortersFunction(JsFunction sorters)
```
    Sets the JsFunction which defines a javascript code called with an property name and can return a function which can be used as an argument to Array.sort for output purposes. If no function is returned, the default sorting mechanism is a built-in "natural sort" implementation. Useful for sorting attributes like month names
    
    Parameters:
    
    sorters - a JsFunction to use as a sorters
  - getRendererOptions
```
RendererOptions getRendererOptions()
```
    Returns:
    
    the object passed through to renderer as options
  - setRendererOptions
```
void setRendererOptions(RendererOptions rendererOptions)
```
    Sets object passed through to renderer as options.
    
    Parameters:
    
    rendererOptions - object defines renderer options
  - getInclusions
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getInclusions()
```
    Returns:
    
    map whose keys are properties names and values are lists of properties values which denote records to include in rendering; used to prepopulate the filter menus that appear on double-click
  - setInclusions
```
void setInclusions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> inclusions)
```
    Sets map whose keys are properties names and values are lists of properties values which denote records to include in rendering; used to prepopulate the filter menus that appear on double-click (overrides exclusions).
    Applies only when editable=true.
    
    Parameters:
    
    inclusions - map with properties and values included in rendering
    
    See Also:
    
    setInclusions(String, List), addInclusions(String, String...), setExclusions(Map), setExclusions(String, List), addExclusions(String, String...)
  - setInclusions
```
void setInclusions(java.lang.String property,
                   java.util.List<java.lang.String> inclusions)
```
    Sets the value of inclusions map.
    
    Parameters:
    
    property - property name
    
    inclusions - a list of properties values
    
    See Also:
    
    setInclusions(Map), addInclusions(String, String...), setExclusions(Map), setExclusions(String, List), addExclusions(String, String...)
  - addInclusions
```
void addInclusions(java.lang.String property,
                   java.lang.String... inclusions)
```
    Adds a values to given key of inclusions map.
    
    Parameters:
    
    property - a property name
    
    inclusions - an array of properties values
    
    See Also:
    
    setInclusions(Map), setInclusions(String, List), setExclusions(Map), setExclusions(String, List), addExclusions(String, String...)
  - getExclusions
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExclusions()
```
    Returns:
    
    map whose keys are properties names and values are lists of properties values which denote records to exclude from rendering; used to prepopulate the filter menus that appear on double-click
  - setExclusions
```
void setExclusions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> exclusions)
```
    Sets map whose keys are properties names and values are lists of properties values which denote records to exclude from rendering; used to prepopulate the filter menus that appear on double-click.
    Applies only when editable=true.
    
    Parameters:
    
    exclusions - map with properties and values excluded from rendering
    
    See Also:
    
    setExclusions(String, List), addExclusions(String, String...), setInclusions(Map), setInclusions(String, List), addInclusions(String, String...)
  - setExclusions
```
void setExclusions(java.lang.String property,
                   java.util.List<java.lang.String> exclusions)
```
    Sets the value of exclusions map.
    
    Parameters:
    
    property - property name
    
    exclusions - a list of properties values
    
    See Also:
    
    setExclusions(Map), addExclusions(String, String...), setInclusions(Map), setInclusions(String, List), addInclusions(String, String...)
  - addExclusions
```
void addExclusions(java.lang.String property,
                   java.lang.String... exclusions)
```
    Adds a values to given key of exclusions map.
    
    Parameters:
    
    property - a property name
    
    exclusions - an array of properties values
    
    See Also:
    
    setExclusions(Map), setExclusions(String, List), setInclusions(Map), setInclusions(String, List), addInclusions(String, String...)
  - getDerivedProperties
```
DerivedProperties getDerivedProperties()
```
    Returns:
    
    object to define derived properties
  - setDerivedProperties
```
void setDerivedProperties(DerivedProperties derivedProperties)
```
    Sets object to define derived properties.
    
    Parameters:
    
    derivedProperties - object to define derived properties
  - setNativeJson
```
void setNativeJson(java.lang.String json)
```
    Set additional JSON configuration as a string. This JSON can override configuration loaded from XML and from Component API.
    
    Parameters:
    
    json - additional JSON configuration
  - getNativeJson
```
java.lang.String getNativeJson()
```
    Returns:
    
    additional JSON configuration as a string.
  - getEmptyDataMessage
```
java.lang.String getEmptyDataMessage()
```
    Returns:
    
    the message that will be displayed in case of empty data
  - setShowUI
```
void setShowUI(java.lang.Boolean showUI)
```
    Hides or shows UI elements in the editable pivot table. true by default.
    Applies only when editable=true.
    
    Parameters:
    
    showUI - true if UI elements should be shown and false otherwise
  - isShowUI
```
java.lang.Boolean isShowUI()
```
    Returns:
    
    true if pivotUI() should be shown and false otherwise
  - setShowRowTotals
```
void setShowRowTotals(java.lang.Boolean showRowTotals)
```
    Set false if row totals shouldn't be shown and true otherwise. Works only for table renderers. true by default.
    
    Parameters:
    
    showRowTotals - false if row totals shouldn't be shown and true otherwise
  - isRowTotalsShown
```
java.lang.Boolean isRowTotalsShown()
```
    Returns:
    
    false if row totals shouldn't be shown and true otherwise
  - setShowColTotals
```
void setShowColTotals(java.lang.Boolean showColTotals)
```
    Set false if col totals shouldn't be shown and true otherwise. Works only for table renderers. true by default.
    
    Parameters:
    
    showColTotals - false if col totals shouldn't be shown and true otherwise
  - isColTotalsShown
```
java.lang.Boolean isColTotalsShown()
```
    Returns:
    
    false if col totals shouldn't be shown and true otherwise
  - setEmptyDataMessage
```
void setEmptyDataMessage(java.lang.String emptyDataMessage)
```
    Sets the message that will be displayed in case of empty data.
    
    Parameters:
    
    emptyDataMessage - the message that will be displayed in case of empty data
  - addRefreshListener
```
io.jmix.core.common.event.Subscription addRefreshListener(java.util.function.Consumer<PivotTable.RefreshEvent> refreshListener)
```
    Adds a listener to the pivot table refresh events. Fired only for editable PivotTable.
    
    Parameters:
    
    refreshListener - a listener to add
    
    Returns:
    
    subscription
  - addCellClickListener
```
io.jmix.core.common.event.Subscription addCellClickListener(java.util.function.Consumer<PivotTable.CellClickEvent> listener)
```
    Adds a listener to the pivot table cell click events. Fired only for table renderers (table, heatmap, table barchart, col heatmap, row heatmap).
    
    Parameters:
    
    listener - a listener to add
    
    Returns:
    
    subscription

Interface PivotTable

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Field Summary

Fields inherited from interface io.jmix.ui.component.Component

Method Summary

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable

Methods inherited from interface io.jmix.ui.component.Component

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

Field Detail

NAME

Method Detail

repaint

getProperties

setProperties

addProperties

addProperty

getRows

setRows

addRows

getColumns

setColumns

addColumns

getAggregation

setAggregation

getRenderer

setRenderer

getAggregationProperties

setAggregationProperties

addAggregationProperties

getAggregations

setAggregations

getRenderers

setRenderers

getHiddenProperties

setHiddenProperties

addHiddenProperties

getHiddenFromAggregations

setHiddenFromAggregations

addHiddenFromAggregations

getHiddenFromDragDrop

setHiddenFromDragDrop

addHiddenFromDragDrop

getColumnOrder

setColumnOrder

getRowOrder

setRowOrder

getMenuLimit

setMenuLimit

getAutoSortUnusedProperties

setAutoSortUnusedProperties

getUnusedPropertiesVertical

setUnusedPropertiesVertical

getDataProvider

setDataProvider

addData

getFilterFunction

setFilterFunction

getSortersFunction

setSortersFunction

getRendererOptions

setRendererOptions

getInclusions

setInclusions

setInclusions

addInclusions

getExclusions

setExclusions

setExclusions

addExclusions

getDerivedProperties

setDerivedProperties

setNativeJson

getNativeJson

getEmptyDataMessage

setShowUI

isShowUI

setShowRowTotals