Class: EntitiesDataSource

dg.EntitiesDataSource

Functionality for handling entities collection from server Allows to manage Entity

Hierarchy

• HttpDataSource<Entity>

  ↳ EntitiesDataSource

Constructors

constructor

• new EntitiesDataSource(s)

Constructs

CredentialsDataSource

Parameters

Name	Type
s	any

Overrides

HttpDataSource.constructor

Defined in

src/dapi.ts:566

Properties

clsName

• clsName: string

Inherited from

HttpDataSource.clsName

Defined in

src/dapi.ts:249

---

dart

• dart: any

Inherited from

HttpDataSource.dart

Defined in

src/dapi.ts:248

Methods

allPackageVersions

▸ allPackageVersions(): HttpDataSource<Entity>

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

Returns

HttpDataSource<Entity>

Inherited from

HttpDataSource.allPackageVersions

Defined in

src/dapi.ts:305

---

by

▸ by(i): HttpDataSource<Entity>

Parameters

Name	Type
i	number

Returns

HttpDataSource<Entity>

Inherited from

HttpDataSource.by

Defined in

src/dapi.ts:310

---

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

---

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

---

deleteProperties

▸ deleteProperties(props): Promise<void>

Deletes entity properties

Parameters

Name	Type
props	Map<Property, any>

Returns

Promise<void>

Defined in

src/dapi.ts:587

---

filter

▸ filter(w): HttpDataSource<Entity>

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

Inherited from

HttpDataSource.filter

Defined in

src/dapi.ts:336

---

find

▸ find(id): Promise<Entity>

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

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

Defined in

src/dapi.ts:290

---

first

▸ first(): Promise<Entity>

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

Returns

Promise<Entity>

Promise<object>

Inherited from

HttpDataSource.first

Defined in

src/dapi.ts:281

---

getProperties

▸ getProperties(entity): Promise<Map<Property, any>>

Returns entity properties

Parameters

Name	Type
entity	Entity

Returns

Promise<Map<Property, any>>

props

Defined in

src/dapi.ts:580

---

include

▸ include(include): HttpDataSource<Entity>

Includes entity in the result

Parameters

Name	Type
include	string

Returns

HttpDataSource<Entity>

Inherited from

HttpDataSource.include

Defined in

src/dapi.ts:353

---

list

▸ list(options?): Promise<Entity[]>

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

Inherited from

HttpDataSource.list

Defined in

src/dapi.ts:260

---

nextPage

▸ nextPage(): HttpDataSource<Entity>

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

Inherited from

HttpDataSource.nextPage

Defined in

src/dapi.ts:325

---

order

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

Instructs data source to return results in the specified order.

Parameters

Name	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource<Entity>

Inherited from

HttpDataSource.order

Defined in

src/dapi.ts:345

---

page

▸ page(i): HttpDataSource<Entity>

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

Parameters

Name	Type
i	number

Returns

HttpDataSource<Entity>

Inherited from

HttpDataSource.page

Defined in

src/dapi.ts:316

---

save

▸ save(e): Promise<Entity>

Saves an entity.

Parameters

Name	Type
e	Entity

Returns

Promise<Entity>

Inherited from

HttpDataSource.save

Defined in

src/dapi.ts:295

---

saveProperties

▸ saveProperties(props): Promise<void>

Allows to set properties for entities

Parameters

Name	Type
props	Map<Property, any>

Returns

Promise<void>

Defined in

src/dapi.ts:573