TablesDataSource

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

Functionality for working with remote tables

Extends

• HttpDataSource<TableInfo>

Constructors

Constructor

new TablesDataSource(s): TablesDataSource

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

Parameters

Parameter	Type
s	any

Returns

TablesDataSource

Overrides

HttpDataSource.constructor

Properties

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

Methods

_prepare()

_prepare(q?): any

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

Parameters

Parameter	Type
q	DataSourceQuery

Returns

any

Inherited from

HttpDataSource._prepare

---

allPackageVersions()

allPackageVersions(): this

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

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

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

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

Deletes an entity.

Parameters

Parameter	Type
e	DartObject

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

filter()

filter(w): this

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

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

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

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

---

first()

first(): Promise<TableInfo>

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

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

Returns

Promise<TableInfo>

Inherited from

HttpDataSource.first

---

getTable()

getTable(id): Promise<DataFrame>

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

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>

---

include()

include(include): this

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

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

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

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

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): this

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

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

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

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

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.page

---

save()

save(e): Promise<TableInfo>

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

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

Parameters

Parameter	Type
e	DartObject

Returns

Promise<TableInfo>

Inherited from

HttpDataSource.save

---

uploadDataFrame()

uploadDataFrame(dataFrame): Promise<string>

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

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

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

Promise<string>

---

with()

protected with(patch): this

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

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