Piero

Appearance

Documentation / @giro3d/piero / index / ConfigurationBuilder

Class: ConfigurationBuilder ​

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

Constructors ​

Constructor ​

new ConfigurationBuilder(): ConfigurationBuilder

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

Returns ​

ConfigurationBuilder

Methods ​

build() ​

build(): object

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

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

withBookmarks() ​

withBookmarks(bookarks): this

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

Parameters ​

bookarks ​

Bookmark[]

Returns ​

this

withCrsDefinitions() ​

withCrsDefinitions(crsDefinitions): this

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

Parameters ​

crsDefinitions ​

CrsDefinitionCollection

Returns ​

this

withDatasets() ​

withDatasets(datasets): this

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

Parameters ​

datasets ​

DatasetOrGroup[]

Returns ​

this