The PivotFilterOverrides class contains multiple PivotFilter objects that can be used later to override a set of filters, e.g. in a pivot table calculation.

## Format

R6Class object.

## Details

Each cell in a pivot table has context (i.e. filters) coming from the row and column groups that are applicable to the cell. The PivotFilterOverrides class contains several different ways of changing this filter criteria as part of a calculation. In most use cases, only one of the available approaches will be used.

## Active bindings

removeAllFilters

TRUE to remove all existing filters before applying any other and/replace/or filters.

keepOnlyFiltersFor

Specify the names of existing variables to retain the filters for. All other filters will be removed.

removeFiltersFor

Specify the names of variables to remove filters for.

overrideFunction

A custom R function to amend the filters in each cell.

countAnd

The number of PivotFilters that will be combined with other pivot filters by intersecting their lists of allowed values.

countReplace

The number of PivotFilters that will be combined with other pivot filters by entirely replacing existing PivotFilter objects.

countOr

The number of PivotFilters that will be combined with other pivot filters by unioning their lists of allowed values.

countTotal

The total number of PivotFilters that will be combined with other pivot filters.

andFilters

The PivotFilters that will be combined with other pivot filters by intersecting their lists of allowed values.

replaceFilters

The PivotFilters that will be combined with other pivot filters by entirely replacing existing PivotFilter objects.

orFilters

The PivotFilters that will be combined with other pivot filters by unioning their lists of allowed values.

allFilters

The complete set of PivotFilters that will be combined with other pivot filters.

## Methods

### Method new()

Create a new PivotFilterOverrides object.

PivotFilterOverrides$new( parentPivot = NULL, removeAllFilters = FALSE, keepOnlyFiltersFor = NULL, removeFiltersFor = NULL, overrideFunction = NULL, filter = NULL, variableName = NULL, type = "ALL", values = NULL, action = "replace" ) #### Arguments parentPivot The pivot table that this PivotFilterOverrides instance belongs to. removeAllFilters Specifies whether to clear all existing filters, before applying the filter overrides. Default value FALSE keepOnlyFiltersFor A character vector specifying the variable names to retain the filter criteria for. Filter criteria for all other variables will be cleared. removeFiltersFor A character vector specifying the variable names for which the filter criteria will be cleared. Filter criteria for all other variables will be retained. overrideFunction A custom R function which will be invoked for each cell to modify the filters before the calculation is carried out. filter A PivotFilter object containing filter criteria which will be combined with the current set of filters using the specified combine method. variableName The variable name for a new filter to apply to. Specified in conjunction with the type and values parameters. type The type of a new filter to apply, must be either "ALL", "VALUES" or "NONE". values A single data value or a vector of multiple data values that a new filter will match on. action Specifies how the new filter defined in filter (or variableName, type and values) should be combined with the existing filter criteria for the cell. Must be one of "intersect", "replace" or "union". #### Returns A new PivotFilterOverrides object. ### Method add() Add additional filter criteria into this PivotFilterOverrides object. Either filter is specified, or variableName, type and values are specified. #### Usage PivotFilterOverrides$add(
filter = NULL,
variableName = NULL,
type = "ALL",
values = NULL,
action = "replace"
)

#### Arguments

filter

A PivotFilter to take criteria from.

variableName

The variable name the additional criteria applies to.

type

The type of the additional filter criteria, must be either "ALL", "VALUES" or "NONE".

values

A single data value or a vector of multiple data values that compromise the additional filter criteria.

action

Specifies how the additional filter should be combined with the existing filter criteria for the cell. Must be one of "intersect", "replace" or "union".

No return value.

### Method apply()

Apply the filter overrides to an existing PivotFilters object.

#### Returns

A list of various object properties.

### Method asJSON()

Return the contents of this object as JSON for debugging.

#### Arguments

includeVariableName

TRUE (default) to include the variable name in the string.

seperator

A character value used when concatenating multiple filter overrides.

#### Returns

A character summary of various object properties.

### Method clone()

The objects of this class are cloneable with this method.

PivotFilterOverrides$clone(deep = FALSE) #### Arguments deep Whether to make a deep clone. ## Examples pt <- PivotTable$new()
# ...
# PivotFilterOverrides constructor allows a filter to be defined
# e.g. to enable %of row or column type calculations
filterOverrides <- PivotFilterOverrides$new(pt, keepOnlyFiltersFor="Volume") # Alternatively/in addition, create a new filter filter <- PivotFilter$new(pt, variableName="Country", values="England")
# Add the filter to the set of overrides
filterOverrides\$add(filter=filter, action="replace")