GridFilterBase

JS wrapper for the widget implemented in Dart.

Extends

• DartWidget

Constructors

new GridFilterBase()

new GridFilterBase(dart): GridFilterBase

Parameters

Parameter	Type
dart	any

Returns

GridFilterBase

Overrides

DartWidget . constructor

Source

src/widgets/data-widgets.ts:181

Properties

Property	Modifier	Type	Default value	Description	Inherited from
_functions	protected	Func[]	[]	-	DartWidget._functions
_properties	protected	Property[]	[]	-	DartWidget._properties
_root	protected	HTMLElement	undefined	-	DartWidget._root
dart	public	any	undefined	-	DartWidget.dart
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].	DartWidget.factory
isDetached	public	boolean	false	-	DartWidget.isDetached
props	public	any	undefined	-	DartWidget.props
subs	public	Subscription[]	undefined	-	DartWidget.subs
temp	public	any	undefined	Contains auxiliary information	DartWidget.temp

Accessors

caption

get caption(): string

set caption(value): void

Parameters

Parameter	Type
value	string

Returns

string

Source

src/widgets/data-widgets.ts:217

---

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets/base.ts:284

---

filterColumnName

get filterColumnName(): string

Returns

string

Source

src/widgets/data-widgets.ts:193

---

filterType

get filterType(): string

Returns

string

Source

src/widgets/data-widgets.ts:197

---

isActive

get isActive(): boolean

set isActive(value): void

Parameters

Parameter	Type
value	boolean

Returns

boolean

Source

src/widgets/data-widgets.ts:201

---

isFiltering

get isFiltering(): boolean

Returns

boolean

Source

src/widgets/data-widgets.ts:209

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets/base.ts:281

---

root

get root(): HTMLElement

Widget's visual root.

Returns

HTMLElement

Source

src/widgets/base.ts:356

---

type

get type(): string

Returns

string

Source

src/widgets/base.ts:355

Methods

addProperty()

private addProperty(propertyName, propertyType, defaultValue, options): any

Registers an property with the specified type, name, and defaultValue.

Parameters

Parameter	Type	Default value	Description
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "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" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | object & IProperty	null

Returns

any

Inherited from

DartWidget . addProperty

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets/base.ts:309

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

DartWidget . apply

Source

src/widgets/base.ts:248

---

applyState()

applyState(state): void

Parameters

Parameter	Type
state	Record<string, any>

Returns

void

Source

src/widgets/data-widgets.ts:189

---

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

Inherited from

DartWidget . detach

Source

src/widgets/base.ts:293

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

DartWidget . getDartProperties

Source

src/widgets/base.ts:269

---

getFunctions()

getFunctions(): Func[]

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

DartWidget . getFunctions

Source

src/widgets/base.ts:358

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

DartWidget . getProperties

Source

src/widgets/base.ts:357

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget . onFrameAttached

Source

src/widgets/base.ts:275

---

onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	null | Property	or null, if multiple properties were changed.

Returns

void

Inherited from

DartWidget . onPropertyChanged

Source

src/widgets/base.ts:267

---

saveState()

saveState(): Record<string, any>

Returns

Record<string, any>

Source

src/widgets/data-widgets.ts:185

---

setSorting()

setSorting(columnName, ascending): void

Parameters

Parameter	Type
columnName	"name" | "count"
ascending	boolean

Returns

void

Source

src/widgets/data-widgets.ts:213

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

DartWidget . sourceRowsChanged

Source

src/widgets/base.ts:273

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Inherited from

DartWidget . sub

Source

src/widgets/base.ts:241

---

toDart()

toDart(): any

Returns

any

Inherited from

DartWidget . toDart

Source

src/widgets/base.ts:233

---

find()

static find(root): null | Widget<any>

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Inherited from

DartWidget . find

Source

src/widgets/base.ts:229

---

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

DartWidget . fromRoot

Source

src/widgets/base.ts:332

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget . getAll

Source

src/widgets/base.ts:224