EntitiesDataSource
Functionality for handling entities collection from server Allows to manage Entity
Extends
Constructors
new EntitiesDataSource()
new EntitiesDataSource(
s
):EntitiesDataSource
Parameters
Parameter | Type |
---|---|
s | any |
Returns
Overrides
Constructs
CredentialsDataSource
Source
Properties
Property | Type | Inherited from |
---|---|---|
clsName | string | HttpDataSource .clsName |
dart | any | HttpDataSource .dart |
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
Inherited from
HttpDataSource
. allPackageVersions
Source
by()
by(
i
):HttpDataSource
<Entity
>
Parameters
Parameter | Type |
---|---|
i | number |
Returns
Inherited from
Source
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
Source
delete()
delete(
e
):Promise
<void
>
Deletes an entity.
Parameters
Parameter | Type |
---|---|
e | Entity |
Returns
Promise
<void
>
Inherited from
Source
deleteProperties()
deleteProperties(
props
):Promise
<void
>
Deletes entity properties
Parameters
Parameter | Type | Description |
---|---|---|
props | Map <Property , any > |
Returns
Promise
<void
>
Source
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
Parameter | Type | Description |
---|---|---|
w | string |
Returns
Inherited from
Source
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
Parameter | Type | Description |
---|---|---|
id | string | GUID of the corresponding object |
Returns
Promise
<Entity
>
{Promise<object>}
- entity.
Inherited from
Source
first()
first():
Promise
<Entity
>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise
<Entity
>
Promise<object>
Inherited from
Source
getProperties()
getProperties(
entity
):Promise
<Map
<Property
,any
>>
Returns entity properties
Parameters
Parameter | Type | Description |
---|---|---|
entity | Entity |
Returns
Promise
<Map
<Property
, any
>>
props
Source
include()
include(
include
):HttpDataSource
<Entity
>
Includes entity in the result
Parameters
Parameter | Type | Description |
---|---|---|
include | string |
Returns
Inherited from
Source
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
Parameter | Type |
---|---|
options | object |
options.filter ? | string |
options.order ? | string |
options.pageNumber ? | number |
options.pageSize ? | number |
Returns
Promise
<Entity
[]>
Inherited from
Source
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
Inherited from
Source
order()
order(
fieldName
,desc
):HttpDataSource
<Entity
>
Instructs data source to return results in the specified order.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
fieldName | string | undefined | |
desc | boolean | false |
Returns
Inherited from
Source
page()
page(
i
):HttpDataSource
<Entity
>
Restricts results to the specified page number. See also nextPage.
Parameters
Parameter | Type |
---|---|
i | number |
Returns
Inherited from
Source
save()
save(
e
):Promise
<Entity
>
Saves an entity.
Parameters
Parameter | Type |
---|---|
e | Entity |
Returns
Promise
<Entity
>
Inherited from
Source
saveProperties()
saveProperties(
props
):Promise
<void
>
Allows to set properties for entities
Parameters
Parameter | Type | Description |
---|---|---|
props | Map <Property , any > |
Returns
Promise
<void
>