DomainSavedFiltersClient

Defined in: js-api/src/dapi.ts:1996

Saved filter presets of one domain table (see DomainTableClient.filters): small shareable entities carrying the filter panel's state maps. Sharing uses the standard entity permission machinery (Dapi.permissions); the server scopes list to what the caller can see.

Constructors

Constructor

new DomainSavedFiltersClient(dart, schema, table): DomainSavedFiltersClient

Defined in: js-api/src/dapi.ts:1999

Parameters

Parameter	Type
dart	any
schema	string
table	string

Returns

DomainSavedFiltersClient

Properties

Property	Modifier	Type	Defined in
dart	public	any	js-api/src/dapi.ts:1997
schema	readonly	string	js-api/src/dapi.ts:1999
table	readonly	string	js-api/src/dapi.ts:1999

Methods

delete()

delete(id): Promise<void>

Defined in: js-api/src/dapi.ts:2015

Deletes a preset (requires the entity Delete permission).

Parameters

Parameter	Type
id	string

Returns

Promise<void>

---

list()

list(): Promise<DomainSavedFilterInfo[]>

Defined in: js-api/src/dapi.ts:2004

Presets of this table visible to the current user, ordered by name.

Returns

Promise<DomainSavedFilterInfo[]>

---

save()

save(name, states, options?): Promise<DomainSavedFilterInfo>

Defined in: js-api/src/dapi.ts:2010

Saves a preset for the caller; pass options.id to update an existing preset in place (the original author is preserved). Resolves to the saved preset.

Parameters

Parameter	Type
name	string
states	{[column: string]: any; }
options?	{ id?: string; }
options.id?	string

Returns

Promise<DomainSavedFilterInfo>