Interface: DataProvider<TDataSource, TData>

Defined in: storage/base.ts:9

Base interface for data providers

Extended by

• ImageDataProvider
• LabelsDataProvider
• PointsDataProvider
• ShapesDataProvider
• TableDataProvider

Type Parameters

TDataSource

TDataSource extends DataSource

TData

TData extends Data

Properties

name

readonly name: string

Defined in: storage/base.ts:14

The name of the data provider

---

schema

readonly schema: JsonSchema

Defined in: storage/base.ts:17

The JSON schema for the data source

---

uischema

readonly uischema: UISchemaElement

Defined in: storage/base.ts:20

The JSON Forms UI schema for the data source

Methods

open()

open(dataSource, options?): Promise<TData>

Defined in: storage/base.ts:29

Opens a data source and returns the loaded data accessor

Parameters

dataSource

TDataSource

The data source to open

options?

Optional abort signal, progress callback, and workspace directory handle

onProgress?

ProgressCallback

signal?

AbortSignal

workspace?

FileSystemDirectoryHandle | null

Returns

Promise<TData>

A promise that resolves to the loaded data accessor