ViewsDataSource

Functionality for handling views information from server Allows to manage ViewInfo

Extends

• HttpDataSource <ViewInfo>

Constructors

new ViewsDataSource()

new ViewsDataSource(s): ViewsDataSource

Parameters

Parameter	Type
s	any

Returns

ViewsDataSource

Overrides

HttpDataSource . constructor

Constructs

ViewsDataSource

Source

src/dapi.ts:658

Properties

Property	Type	Inherited from
clsName	string	HttpDataSource.clsName
dart	any	HttpDataSource.dart

Methods

allPackageVersions()

allPackageVersions(): HttpDataSource <ViewInfo>

Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . allPackageVersions

Source

src/dapi.ts:301

---

by()

by(i): HttpDataSource <ViewInfo>

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . by

Source

src/dapi.ts:306

---

count()

count(): Promise<number>

Counts entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Returns

Promise<number>

Inherited from

HttpDataSource . count

Source

src/dapi.ts:272

---

delete()

delete(e): Promise<void>

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource . delete

Source

src/dapi.ts:296

---

filter()

filter(w): HttpDataSource <ViewInfo>

Applies filter to current request. Also can be set with list method "options" parameter See example: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/navigation/views/browse#entity-search

Parameters

Parameter	Type
w	string

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . filter

Source

src/dapi.ts:329

---

find()

find(id): Promise <ViewInfo>

Returns an entity with the specified id. Throws an exception if an entity does not exist, or is not accessible in the current context. Sample: https://public.datagrok.ai/js/samples/data-access/save-and-load-df

Parameters

Parameter	Type	Description
id	string	GUID of the corresponding object

Returns

Promise <ViewInfo>

{Promise<object>} - entity.

Inherited from

HttpDataSource . find

Source

src/dapi.ts:286

---

first()

first(): Promise <ViewInfo>

Returns fist entity that satisfies the filtering criteria (see filter).

Returns

Promise <ViewInfo>

Inherited from

HttpDataSource . first

Source

src/dapi.ts:277

---

include()

include(include): HttpDataSource <ViewInfo>

Includes entity in the result

Parameters

Parameter	Type
include	string

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . include

Source

src/dapi.ts:341

---

list()

list(options): Promise <ViewInfo[]>

Returns all entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Parameters

Parameter	Type
options	object
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise <ViewInfo[]>

Inherited from

HttpDataSource . list

Source

src/dapi.ts:257

---

nextPage()

nextPage(): HttpDataSource <ViewInfo>

Returns next page of all entities that satisfy the filtering criteria (see filter). Works only if pageSize was set during previous list() call See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . nextPage

Source

src/dapi.ts:320

---

order()

order(fieldName, desc): HttpDataSource <ViewInfo>

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . order

Source

src/dapi.ts:335

---

page()

page(i): HttpDataSource <ViewInfo>

Restricts results to the specified page number. See also nextPage.

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <ViewInfo>

Inherited from

HttpDataSource . page

Source

src/dapi.ts:312

---

save()

save(e): Promise <ViewInfo>

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise <ViewInfo>

Inherited from

HttpDataSource . save

Source

src/dapi.ts:291