Interface: IBindableSectionProxy¶

A IBindableSectionProxy can get/set the section's target. If a section doesn't have a section target, it doesn't support the interface

It is passed to rules to provide access to a section's target for application specific customizations.

Hierarchy¶

Summary¶

Properties¶

Class Properties¶

Currently none in this class.

Inherited Properties¶

Methods¶

Inherited Methods¶

Accessors¶

filterBarFilterQuery¶

Get Signature¶

▸ getter

This method returns the filter query options based on filter bar selections

Returns¶

string

filterBarSorterQuery¶

Get Signature¶

▸ getter

This method returns the sorter query options based on filter bar selections

Returns¶

string

filters¶

Get Signature¶

▸ getter

This method returns the filter selections based on filter bar selections

Example¶

// Access filter bar selections from a bindable section proxy
const filters = bindableSectionProxy.filters;

console.log(`Total controls with filter applied in the filter bar: ${filters.length}`);

Returns¶

FilterSelection[]

Methods¶

getFilterBar¶

▸ getFilterBar(): IFilterBarProxy

Get a filter bar from this section

Returns: IFilterBarProxy

getTargetSpecifier¶

▸ getTargetSpecifier(): ITargetProxy

Get a target specifier from this section * *

Returns: ITargetProxy

setFilters¶

▸ setFilters(newFilters: FilterSelection[]): Promise<any>

This method sets and overrides the currently applied filters

Parameters:

Name	Type	Description
newFilters	FilterSelection[]	An array of filter selection objects to be applied to the filter bar. Each entry should include the control name, and value.

Returns: Promise<any>

setTargetSpecifier¶

▸ setTargetSpecifier(specifier: ITargetProxy, redraw?: boolean): Promise<any>

Set the section target specifier *

Parameters:

Name	Type	Description
specifier	ITargetProxy	target specifier for the section
redraw?	boolean	whether to redraw the section *

Returns: Promise<any>

Throws¶

if specifier is incomplete