Piero

Appearance

Documentation / @giro3d/piero / index / validateConfiguration

Function: validateConfiguration() ​

validateConfiguration(config): object

Defined in: packages/piero/src/configuration/configuration.ts:90

Parameters ​

config ​

annotations? ​

PointAnnotation[] = ...

bookmarks? ​

Bookmark[] = ...

crsDefinitions? ​

CrsDefinitionCollection = ...

data? ​

DatasetOrGroup[] = ...

modules? ​

Record<string, unknown> = ...

scene ​

{ basemap: { background?: string | null; extent: Extent; skirt?: number; }; camera: LookAt; crs: string; } = SceneConfiguration

scene.basemap ​

{ background?: string | null; extent: Extent; skirt?: number; } = ...

scene.basemap.background? ​

string | null = ...

scene.basemap.extent ​

Extent = ...

scene.basemap.skirt? ​

number = ...

scene.camera ​

LookAt = ...

scene.crs ​

string = ...

title? ​

string = ...

version ​

2 = ...

Returns ​

object

annotations? ​

optional annotations?: PointAnnotation[]

bookmarks? ​

optional bookmarks?: Bookmark[]

crsDefinitions? ​

optional crsDefinitions?: CrsDefinitionCollection

data? ​

optional data?: DatasetOrGroup[]

modules? ​

optional modules?: Record<string, unknown>

scene ​

scene: object = SceneConfiguration

scene.basemap ​

basemap: object

scene.basemap.background? ​

optional background?: string | null

scene.basemap.extent ​

extent: Extent

scene.basemap.skirt? ​

optional skirt?: number

scene.camera ​

camera: LookAt

scene.crs ​

crs: string

title? ​

optional title?: string

version ​

version: 2