HierarchyFilter

A HierarchyFilter filters data by drilling down through an ordered list of columns. Each level in the list narrows the data by one column, and the selected values at each level determine which values are available at the next.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The column that anchors the filter. This column determines the dataset that the whole filter applies to, so every column in HierarchyLevels and in HierarchyTree must belong to the same dataset.

Link copied to clipboard

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Link copied to clipboard

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Link copied to clipboard

The ordered list of columns that defines the drill-down path of the filter. The first level is the top of the hierarchy. You can specify a maximum of 5 levels.

Link copied to clipboard

The tree of selected values for the filter. Each node records the values that are selected at one level of the hierarchy, and its children record the selections beneath those values. Omit this attribute to define the drill-down path without restricting any values.

Link copied to clipboard

Determines whether the values selected in HierarchyTree are kept or removed. Choose one of the following options:

Link copied to clipboard

This option determines how null values should be treated when filtering data.

Functions

Link copied to clipboard
inline fun copy(block: HierarchyFilter.Builder.() -> Unit = {}): HierarchyFilter
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String