Class: GeoJSONShapesDataProvider
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:15
Data provider for shape (polygon) collections
Implements
Constructors
Constructor
new GeoJSONShapesDataProvider():
GeoJSONShapesDataProvider
Returns
GeoJSONShapesDataProvider
Properties
name
readonlyname:"GeoJSON"="GeoJSON"
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:23
The name of the data provider
Implementation of
schema
readonlyschema:object
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:25
The JSON schema for the data source
properties
properties:
object
properties.idProperty
idProperty:
object
properties.idProperty.type
type:
string="string"
properties.nameProperty
nameProperty:
object
properties.nameProperty.type
type:
string="string"
properties.source
source:
object
properties.source.type
type:
string="string"
properties.table
table:
object
properties.table.type
type:
string="string"
required
required:
string[]
type
type:
string="object"
Implementation of
uischema
readonlyuischema:object
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:44
The JSON Forms UI schema for the data source
It must not contain a control for the data source's source, which the
application renders itself if the schema declares it, as a string.
elements
elements:
object[]
type
type:
string="VerticalLayout"
Implementation of
Methods
load()
load(
normalizedDataSource,options?):Promise<GeoJSONShapesData>
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:96
Opens a data source and returns the loaded data accessor
The data source has to have been normalized by DataProvider.normalize beforehand.
Parameters
normalizedDataSource
NormalizedGeoJSONShapesDataSource
The normalized data source to open
options?
See AnnotatedDataProviderLoadOptions
Returns
Promise<GeoJSONShapesData>
A promise that resolves to the loaded data accessor
Implementation of
normalize()
normalize(
dataSource,workspace,projectSource):NormalizedGeoJSONShapesDataSource
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:65
Returns the data source with all of this data provider's defaults applied and its source normalized
Data sources that normalize to the same value are considered equal, and their data is loaded only once and shared between all referencing objects. Normalization has to be idempotent: normalizing an already normalized data source must return the same value again.
The source is normalized with SourceUtils.normalizeSource, which resolves
it against the project source and the open workspace, so the result has to
be recomputed when either changes.
Normalizing may throw, e.g. for a source that cannot be resolved against the given workspace and project source. The data cache catches it, so only the objects referencing that data source fail to load; the data of all other objects is unaffected.
Parameters
dataSource
The data source to normalize
workspace
FileSystemDirectoryHandle | null
The directory handle of the open workspace, if any
projectSource
string | null
Where the project was loaded from: its absolute URL,
the workspace-relative path of the project file, or null for projects
that were loaded from neither
Returns
NormalizedGeoJSONShapesDataSource
The normalized data source
Implementation of
supports()
supports(
normalizedSource):Promise<boolean>
Defined in: @tissuumaps-storage/src/geojson/GeoJSONShapesDataProvider.ts:88
Returns whether a source has a GeoJSON file extension (see GeoJSONShapesDataProvider._extensions)
Parameters
normalizedSource
string
The normalized source to check
Returns
Promise<boolean>
A promise that resolves to whether the source is supported