Class: LayoutsDataSource

dg.LayoutsDataSource

Functionality for handling layouts collection from server Allows to manage ViewLayout

Hierarchy

• HttpDataSource<ViewLayout>

  ↳ LayoutsDataSource

Constructors

constructor

• new LayoutsDataSource(s)

Constructs

LayoutsDataSource

Parameters

Name	Type
s	any

Overrides

HttpDataSource.constructor

Defined in

src/dapi.ts:665

Properties

clsName

• clsName: string

Inherited from

HttpDataSource.clsName

Defined in

src/dapi.ts:253

---

dart

• dart: any

Inherited from

HttpDataSource.dart

Defined in

src/dapi.ts:252

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

Defined in

src/dapi.ts:309

---

by

▸ by(i): HttpDataSource<ViewLayout>

Parameters

Name	Type
i	number

Returns

HttpDataSource<ViewLayout>

Inherited from

HttpDataSource.by

Defined in

src/dapi.ts:314

---

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

Defined in

src/dapi.ts:279

---

delete

▸ delete(e): Promise<void>

Deletes an entity.

Parameters

Name	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

Defined in

src/dapi.ts:304

---

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

Name	Type
w	string

Returns

HttpDataSource<ViewLayout>

Inherited from

HttpDataSource.filter

Defined in

src/dapi.ts:340

---

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

Name	Type	Description
id	string	GUID of the corresponding object

Returns

Promise<ViewLayout>

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

Defined in

src/dapi.ts:294

---

first

▸ first(): Promise<ViewLayout>

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

Returns

Promise<ViewLayout>

Promise<object>

Inherited from

HttpDataSource.first

Defined in

src/dapi.ts:285

---

getApplicable

▸ getApplicable(t): Promise<ViewLayout[]>

Returns layouts that applicable to the table

Parameters

Name	Type
t	DataFrame

Returns

Promise<ViewLayout[]>

Defined in

src/dapi.ts:672

---

include

▸ include(include): HttpDataSource<ViewLayout>

Includes entity in the result

Parameters

Name	Type
include	string

Returns

HttpDataSource<ViewLayout>

Inherited from

HttpDataSource.include

Defined in

src/dapi.ts:357

---

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

Name	Type
options	Object
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise<ViewLayout[]>

Inherited from

HttpDataSource.list

Defined in

src/dapi.ts:264

---

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

Defined in

src/dapi.ts:329

---

order

▸ order(fieldName, desc?): HttpDataSource<ViewLayout>

Instructs data source to return results in the specified order.

Parameters

Name	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource<ViewLayout>

Inherited from

HttpDataSource.order

Defined in

src/dapi.ts:349

---

page

▸ page(i): HttpDataSource<ViewLayout>

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

Parameters

Name	Type
i	number

Returns

HttpDataSource<ViewLayout>

Inherited from

HttpDataSource.page

Defined in

src/dapi.ts:320

---

save

▸ save(e): Promise<ViewLayout>

Saves an entity.

Parameters

Name	Type
e	Entity

Returns

Promise<ViewLayout>

Inherited from

HttpDataSource.save

Defined in

src/dapi.ts:299