TablesDataSource

Functionality for working with remote tables

Extends

• HttpDataSource <TableInfo>

Constructors

new TablesDataSource()

new TablesDataSource(s): TablesDataSource

Parameters

Parameter	Type
s	any

Returns

TablesDataSource

Overrides

HttpDataSource . constructor

Constructs

TablesDataSource

Source

src/dapi.ts:860

Properties

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

Methods

allPackageVersions()

allPackageVersions(): HttpDataSource <TableInfo>

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

Returns

HttpDataSource <TableInfo>

Inherited from

HttpDataSource . allPackageVersions

Source

src/dapi.ts:323

---

by()

by(i): HttpDataSource <TableInfo>

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <TableInfo>

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

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

Inherited from

HttpDataSource . filter

Source

src/dapi.ts:354

---

find()

find(id): Promise <TableInfo>

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

{Promise<object>} - entity.

Inherited from

HttpDataSource . find

Source

src/dapi.ts:308

---

first()

first(): Promise <TableInfo>

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

Returns

Promise <TableInfo>

Promise<object>

Inherited from

HttpDataSource . first

Source

src/dapi.ts:299

---

getTable()

getTable(id): Promise <DataFrame>

Loads a dataframe by id. Sample: https://public.datagrok.ai/js/samples/data-access/save-and-load-df

Parameters

Parameter	Type	Description
id	string	dataframe id

Returns

Promise <DataFrame>

Source

src/dapi.ts:876

---

include()

include(include): HttpDataSource <TableInfo>

Includes entity in the result

Parameters

Parameter	Type	Description
include	string

Returns

HttpDataSource <TableInfo>

Inherited from

HttpDataSource . include

Source

src/dapi.ts:371

---

list()

list(options): Promise <TableInfo[]>

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

Inherited from

HttpDataSource . list

Source

src/dapi.ts:278

---

nextPage()

nextPage(): HttpDataSource <TableInfo>

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

Inherited from

HttpDataSource . nextPage

Source

src/dapi.ts:343

---

order()

order(fieldName, desc): HttpDataSource <TableInfo>

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value	Description
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource <TableInfo>

Inherited from

HttpDataSource . order

Source

src/dapi.ts:363

---

page()

page(i): HttpDataSource <TableInfo>

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

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <TableInfo>

Inherited from

HttpDataSource . page

Source

src/dapi.ts:334

---

save()

save(e): Promise <TableInfo>

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise <TableInfo>

Inherited from

HttpDataSource . save

Source

src/dapi.ts:313

---

uploadDataFrame()

uploadDataFrame(dataFrame): Promise<string>

Saves a dataframe remotely. Sample: https://public.datagrok.ai/js/samples/data-access/save-and-load-df

Parameters

Parameter	Type	Description
dataFrame	DataFrame

Returns

Promise<string>

Source

src/dapi.ts:868