Skip to main content

Interface: ImageDataProvider<TImageDataSource, TImageData>

Defined in: storage/image.ts:10

Data provider for raster images

Extends​

Type Parameters​

TImageDataSource​

TImageDataSource extends ImageDataSource

TImageData​

TImageData extends ImageData

The concrete ImageData type produced by this data provider

Properties​

name​

readonly name: string

Defined in: storage/base.ts:14

The name of the data provider

Inherited from​

DataProvider.name

schema​

readonly schema: JsonSchema

Defined in: storage/base.ts:17

The JSON schema for the data source

Inherited from​

DataProvider.schema

uischema​

readonly uischema: UISchemaElement

Defined in: storage/base.ts:20

The JSON Forms UI schema for the data source

Inherited from​

DataProvider.uischema

Methods​

open()​

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

Defined in: storage/base.ts:29

Opens a data source and returns the loaded data accessor

Parameters​

dataSource​

TImageDataSource

The data source to open

options?​

Optional abort signal, progress callback, and workspace directory handle

onProgress?​

ProgressCallback

signal?​

AbortSignal

workspace?​

FileSystemDirectoryHandle | null

Returns​

Promise<TImageData>

A promise that resolves to the loaded data accessor

Inherited from​

DataProvider.open