Class: GraphDataProvider

api.GraphDataProvider

Hierarchy

• DataProviderBase

  ↳ GraphDataProvider

Constructors

constructor

• new GraphDataProvider(options?, geometry?, converter?, queryCreator?)

Create a new data provider base instance.

Parameters

Name	Type
options?	GraphDataProviderOptions
geometry?	IGeometryProvider
converter?	GraphConverter
queryCreator?	GraphQueryCreator

Overrides

DataProviderBase.constructor

Defined in

api/provider/GraphDataProvider.ts:49

Events

on

• on(type, handler): void

Fired when data has been created in the data provider after initial load.

example

// Initialize the data providerclass MyDataProvider extends DataProviderBase {  // implementation}var provider = new MyDataProvider();// Set an event listenerprovider.on("datacreate", function() {  console.log("A datacreate event has occurred.");});

Parameters

Name	Type
type	"datacreate"
handler	(event: ProviderCellEvent) => void

Returns

void

Inherited from

DataProviderBase.on

Defined in

api/DataProviderBase.ts:258

Accessors

geometry

• get geometry(): IGeometryProvider

Get geometry property.

Returns

IGeometryProvider

Geometry provider instance.

Defined in

api/DataProviderBase.ts:53

Methods

fire

▸ fire(type, event): void

Fire when data has been created in the data provider after initial load.

example

// Initialize the data providerclass MyDataProvider extends DataProviderBase {  // Class implementation}var provider = new MyDataProvider();// Create the eventvar cellIds = [ // Determine updated cells ];var target = provider;var type = "datacreate";var event = {  cellIds,  target,  type,};// Fire the eventprovider.fire(type, event);

Parameters

Name	Type	Description
type	"datacreate"	datacreate
event	ProviderCellEvent	Provider cell event

Returns

void

Inherited from

DataProviderBase.fire

Defined in

../doc/api/DataProviderBase.ts:84

---

getCluster

▸ getCluster(url, abort?): Promise<ClusterContract>

Get a cluster reconstruction.

Parameters

Name	Type
url	string
abort?	Promise<void>

Returns

Promise<ClusterContract>

Promise to the cluster reconstruction.

Overrides

DataProviderBase.getCluster

Defined in

api/provider/GraphDataProvider.ts:66

---

getCoreImages

▸ getCoreImages(cellId): Promise<CoreImagesContract>

Get core images in a geometry cell.

Parameters

Name	Type
cellId	string

Returns

Promise<CoreImagesContract>

Promise to the core images of the requested geometry cell id.

Overrides

DataProviderBase.getCoreImages

Defined in

api/provider/GraphDataProvider.ts:85

---

getImageBuffer

▸ getImageBuffer(url, abort?): Promise<ArrayBuffer>

Get an image as an array buffer.

Parameters

Name	Type
url	string
abort?	Promise<void>

Returns

Promise<ArrayBuffer>

Promise to the array buffer containing the image.

Overrides

DataProviderBase.getImageBuffer

Defined in

api/provider/GraphDataProvider.ts:114

---

getImageTiles

▸ getImageTiles(request): Promise<ImageTilesContract>

Get image tiles urls for a tile level.

Parameters

Name	Type
request	ImageTilesRequestContract

Returns

Promise<ImageTilesContract>

Promise to the image tiles response contract

Overrides

DataProviderBase.getImageTiles

Defined in

api/provider/GraphDataProvider.ts:154

---

getImages

▸ getImages(imageIds): Promise<ImagesContract>

Get complete images.

Parameters

Name	Type
imageIds	string[]

Returns

Promise<ImagesContract>

Promise to the images of the requested image ids.

Overrides

DataProviderBase.getImages

Defined in

api/provider/GraphDataProvider.ts:121

---

getMesh

▸ getMesh(url, abort?): Promise<MeshContract>

Get a mesh.

Parameters

Name	Type
url	string
abort?	Promise<void>

Returns

Promise<MeshContract>

Promise to the mesh.

Overrides

DataProviderBase.getMesh

Defined in

api/provider/GraphDataProvider.ts:179

---

getSequence

▸ getSequence(sequenceId): Promise<SequenceEnt>

Get sequence.

Parameters

Name	Type
sequenceId	string

Returns

Promise<SequenceEnt>

Promise to the sequences of the requested image ids.

Overrides

DataProviderBase.getSequence

Defined in

api/provider/GraphDataProvider.ts:190

---

getSpatialImages

▸ getSpatialImages(imageIds): Promise<SpatialImagesContract>

Get spatial images.

Parameters

Name	Type
imageIds	string[]

Returns

Promise<SpatialImagesContract>

Promise to the spatial images of the requested image ids.

Overrides

DataProviderBase.getSpatialImages

Defined in

api/provider/GraphDataProvider.ts:211

---

off

▸ off(type, handler): void

Unsubscribe from an event by its name.

Parameters

Name	Type
type	"datacreate"
handler	(event: ProviderCellEvent) => void

Returns

void

Inherited from

DataProviderBase.off

Defined in

../doc/api/DataProviderBase.ts:224

---

setAccessToken

▸ setAccessToken(accessToken): void

Set an access token for authenticated API requests of protected resources.

Parameters

Name	Type
accessToken	string

Returns

void

Overrides

DataProviderBase.setAccessToken

Defined in

api/provider/GraphDataProvider.ts:242