LayoutsDataSource

Functionality for handling layouts collection from server Allows to manage ViewLayout

Extends

• HttpDataSource <ViewLayout>

Constructors

new LayoutsDataSource()

new LayoutsDataSource(s): LayoutsDataSource

Parameters

Parameter	Type
s	any

Returns

LayoutsDataSource

Overrides

HttpDataSource . constructor

Constructs

LayoutsDataSource

Source

src/dapi.ts:687

Properties

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

Methods

allPackageVersions()

allPackageVersions(): HttpDataSource <ViewLayout>

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

Returns

HttpDataSource <ViewLayout>

Inherited from

HttpDataSource . allPackageVersions

Source

src/dapi.ts:323

---

by()

by(i): HttpDataSource <ViewLayout>

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <ViewLayout>

Inherited from

HttpDataSource . by

Source

src/dapi.ts:328

---

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:293

---

delete()

delete(e): Promise<void>

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource . delete

Source

src/dapi.ts:318

---

filter()

filter(w): HttpDataSource <ViewLayout>

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/smart-search

Parameters

Parameter	Type	Description
w	string

Returns

HttpDataSource <ViewLayout>

Inherited from

HttpDataSource . filter

Source

src/dapi.ts:354

---

find()

find(id): Promise <ViewLayout>

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 <ViewLayout>

{Promise<object>} - entity.

Inherited from

HttpDataSource . find

Source

src/dapi.ts:308

---

first()

first(): Promise <ViewLayout>

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

Returns

Promise <ViewLayout>

Promise<object>

Inherited from

HttpDataSource . first

Source

src/dapi.ts:299

---

getApplicable()

getApplicable(t): Promise <ViewLayout[]>

Returns layouts that applicable to the table

Parameters

Parameter	Type	Description
t	DataFrame

Returns

Promise <ViewLayout[]>

Source

src/dapi.ts:694

---

include()

include(include): HttpDataSource <ViewLayout>

Includes entity in the result

Parameters

Parameter	Type	Description
include	string

Returns

HttpDataSource <ViewLayout>

Inherited from

HttpDataSource . include

Source

src/dapi.ts:371

---

list()

list(options): Promise <ViewLayout[]>

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 <ViewLayout[]>

Inherited from

HttpDataSource . list

Source

src/dapi.ts:278

---

nextPage()

nextPage(): HttpDataSource <ViewLayout>

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 <ViewLayout>

Inherited from

HttpDataSource . nextPage

Source

src/dapi.ts:343

---

order()

order(fieldName, desc): HttpDataSource <ViewLayout>

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value	Description
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource <ViewLayout>

Inherited from

HttpDataSource . order

Source

src/dapi.ts:363

---

page()

page(i): HttpDataSource <ViewLayout>

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

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <ViewLayout>

Inherited from

HttpDataSource . page

Source

src/dapi.ts:334

---

save()

save(e): Promise <ViewLayout>

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise <ViewLayout>

Inherited from

HttpDataSource . save

Source

src/dapi.ts:313