Class: Filter
dg.Filter
Base class for DataFrame-bound filtering controls. Supports collaborative filtering by efficiently working together with other filters.
Hierarchy
↳
Filter
Constructors
constructor
• new Filter()
Overrides
Defined in
Properties
_properties
• Protected _properties: Property[]
Inherited from
Defined in
_root
• Protected _root: HTMLElement
Inherited from
Defined in
column
• column: null | Column<any> = null
A column this filter is associated with.
Defined in
columnName
• Optional columnName: string
Defined in
controls
• controls: HTMLDivElement
Group of control icons on the right of the filter header, after the name. FilterGroup takes care of its visibility.
Defined in
dart
• dart: any
Inherited from
Defined in
dataFrame
• dataFrame: null | DataFrame
A DataFrame this filter is associated with.
Defined in
factory
• factory: null | Func = null
Constructor function. No parameters, returns [Widget].
Inherited from
Defined in
indicator
• indicator: HTMLDivElement
An indicator icon on the left of the filter header, before the name. A filter is responsible for hiding or showing it, depending on its state.
Defined in
isDetached
• isDetached: boolean = false
Inherited from
Defined in
props
• props: any
Inherited from
Defined in
subs
• subs: Subscription[]
Inherited from
Defined in
temp
• temp: any
Contains auxiliary information
Inherited from
Defined in
Accessors
caption
• get caption(): string
Caption to be shown in the filter group.
Returns
string
Defined in
filterSummary
• Abstract get filterSummary(): string
Override to provide short filter summary that might be shown on viewers or in the context panel.
Returns
string
Defined in
isFiltering
• get isFiltering(): boolean
Override to indicate whether the filter actually filters something (most don't in the initial state). This is used to minimize the number of unnecessary computations. Make sure to call super.isFiltering to check whether the filter has been disabled by the user
Returns
boolean
Defined in
isReadyToApplyFilter
• get isReadyToApplyFilter(): boolean
Whether a filter is ready to apply the filtering mask synchronously.
Returns
boolean
Defined in
root
• get root(): HTMLElement
Widget's visual root.
Returns
HTMLElement
Inherited from
Widget.root
Defined in
• set root(r): void
Parameters
| Name | Type |
|---|---|
r | HTMLElement |
Returns
void
Inherited from
Widget.root
Defined in
type
• get type(): string
Returns
string
Inherited from
Widget.type
Defined in
Methods
addProperty
▸ Private addProperty(propertyName, propertyType, defaultValue?, options?): any
Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization
Parameters
| Name | Type | Default value |
|---|---|---|
propertyName | string | undefined |
propertyType | "string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook" | undefined |
defaultValue | any | null |
options | null | { [key: string]: any; } & PropertyOptions | null |
Returns
any
Inherited from
Defined in
apply
▸ apply(properties): Widget<any>
Parameters
| Name | Type |
|---|---|
properties | object |
Returns
Widget<any>
Inherited from
Defined in
applyFilter
▸ Abstract applyFilter(): void
Override to filter the dataframe.
The method should work with this.dataFrame.filter, should disregard
false values (these are filtered out already by other filters), and should
filter out corresponding indexes.
Returns
void
Defined in
applyState
▸ applyState(state): void
Override to load filter state.
Parameters
| Name | Type |
|---|---|
state | any |
Returns
void
Defined in
attach
▸ attach(dataFrame): void
Gets called when a data frame is attached. Make sure to call super.attach(dataFrame) when overriding.
Parameters
| Name | Type |
|---|---|
dataFrame | DataFrame |
Returns
void
Defined in
detach
▸ detach(): void
Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.
Returns
void
Overrides
Defined in
getDartProperties
▸ getDartProperties(): any[]
Returns
any[]
Inherited from
Defined in
getProperties
▸ getProperties(): Property[]
Returns
Property[]
Inherited from
Defined in
onFrameAttached
▸ onFrameAttached(dataFrame): void
Parameters
| Name | Type |
|---|---|
dataFrame | DataFrame |
Returns
void
Inherited from
Defined in
onPropertyChanged
▸ onPropertyChanged(property): void
Gets called when viewer's property is changed.
Parameters
| Name | Type | Description |
|---|---|---|
property | null | Property | or null, if multiple properties were changed. |
Returns
void
Inherited from
Defined in
refresh
▸ refresh(): void
Gets called when a previously used filter gets moved in the DOM tree. Normally, you don't need to do anything, but this might be handy for the iframe-based filters.
Returns
void
Defined in
saveState
▸ saveState(): any
Override to save filter state.
Returns
any
Defined in
sourceRowsChanged
▸ sourceRowsChanged(): void
Returns
void
Inherited from
Defined in
sub
▸ sub(subscription): void
Registers a subscription to an external event.
Parameters
| Name | Type |
|---|---|
subscription | Subscription |
Returns
void
Inherited from
Defined in
toDart
▸ toDart(): any
Returns
any
Inherited from
Defined in
find
▸ Static find(root): null | Widget<any>
Finds existing widget from its visual root.
Parameters
| Name | Type |
|---|---|
root | Element |
Returns
null | Widget<any>
Inherited from
Defined in
fromRoot
▸ Static fromRoot(root): Widget<any>
Creates a new widget from the root element.
Parameters
| Name | Type |
|---|---|
root | HTMLElement |
Returns
Widget<any>
Inherited from
Defined in
getAll
▸ Static getAll(): Widget<any>[]
Returns all currently active widgets.
Returns
Widget<any>[]