EntitiesDataSource

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

Functionality for handling entities collection from server Allows to manage Entity

Extends

• HttpDataSource<Entity>

Constructors

Constructor

new EntitiesDataSource(s): EntitiesDataSource

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

Parameters

Parameter	Type
s	any

Returns

EntitiesDataSource

Overrides

HttpDataSource.constructor

Properties

Property	Type	Inherited from	Defined in
clsName	string	HttpDataSource.clsName	js-api/src/dapi.ts:333
dart	any	HttpDataSource.dart	js-api/src/dapi.ts:332

Methods

allPackageVersions()

allPackageVersions(): this

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

A source without package version isolation: entities of all package versions, not only the current one.

Returns

this

Inherited from

HttpDataSource.allPackageVersions

---

by()

by(i): this

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

A source that returns at most [i] entities per page. See also page.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.by

---

count()

count(): Promise<number>

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

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

---

delete()

delete(e): Promise<void>

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

Deletes an entity.

Parameters

Parameter	Type
e	DartObject

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

deleteProperties()

deleteProperties(props): Promise<void>

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

Deletes entity properties

Parameters

Parameter	Type
props	Map<Property, any>

Returns

Promise<void>

---

filter()

filter(w): this

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

A source filtered by [w]; replaces the filter of this source, if any. 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/concepts/objects#entity-search

Parameters

Parameter	Type
w	string

Returns

this

Inherited from

HttpDataSource.filter

---

find()

find(id): Promise<Entity>

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

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

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

---

first()

first(): Promise<Entity>

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

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

Returns

Promise<Entity>

Inherited from

HttpDataSource.first

---

getFavorites()

getFavorites(group?): Promise<Entity[]>

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

Returns entities favorited by the specified group (or the current user's group if not specified)

Parameters

Parameter	Type
group?	Group

Returns

Promise<Entity[]>

---

getFavoritesForGroups()

getFavoritesForGroups(groups): Promise<{[gid: string]: Entity[]; }>

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

Returns favorites for multiple groups in a single round trip; object keyed by group id.

Parameters

Parameter	Type
groups	Group[]

Returns

Promise<{[gid: string]: Entity[]; }>

---

getProperties()

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

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

Returns entity properties

Parameters

Parameter	Type
entity	Entity

Returns

Promise<Map<Property, any>>

props

---

getRecentEntities()

getRecentEntities(): Promise<Entity[]>

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

Returns recent entities

Returns

Promise<Entity[]>

---

include()

include(include): this

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

A source that also loads the [include]d properties of every entity (adds to this source's includes).

Parameters

Parameter	Type
include	string

Returns

this

Inherited from

HttpDataSource.include

---

list()

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

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

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	{ filter?: string; order?: string; pageNumber?: number; pageSize?: number; }
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise<Entity[]>

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): this

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

A source for the page after this one (the first call gives page 1). Reassign to advance: source = source.nextPage(). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

this

Inherited from

HttpDataSource.nextPage

---

order()

order(fieldName, desc?): this

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

A source ordered by [fieldName]; replaces the order of this source, if any.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

this

Inherited from

HttpDataSource.order

---

page()

page(i): this

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

A source restricted to page [i]. See also nextPage.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.page

---

save()

save(e): Promise<Entity>

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

Saves an entity; the saved copy comes back with this source's includes loaded.

Parameters

Parameter	Type
e	DartObject

Returns

Promise<Entity>

Inherited from

HttpDataSource.save

---

saveProperties()

saveProperties(props): Promise<void>

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

Allows to set properties for entities

Parameters

Parameter	Type
props	Map<Property, any>

Returns

Promise<void>

---

with()

protected with(patch): this

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

A copy of this source whose query has [patch] applied. The Dart handle is shared; its state is rebuilt from the query right before every request, so the copies never observe each other.

Parameters

Parameter	Type
patch	Partial<DataSourceQuery>

Returns

this

Inherited from

HttpDataSource.with