Class CityJSONLoaderPlugin

Viewer plugin that loads models from CityJSON files.

Hierarchy

Plugin
- CityJSONLoaderPlugin

Index

Constructors

constructor

Properties

Accessors

dataSource

Methods

Constructors

constructor

new CityJSONLoaderPlugin(viewer: Viewer, cfg?: CityJSONLoaderPluginConfiguration): CityJSONLoaderPlugin

Overrides Plugin.constructor
- Defined in plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts:55
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: CityJSONLoaderPluginConfiguration
  
  Plugin configuration.
Returns CityJSONLoaderPlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

dataSource

get dataSource(): ICityJSONDefaultDataSource
set dataSource(arg: ICityJSONDefaultDataSource): void

- Defined in plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts:73
Gets the custom data source through which the CityJSONLoaderPlugin can load CityJSON files.

Default value is {@link CityJSONDefaultDataSource}, which loads via HTTP.

Returns ICityJSONDefaultDataSource
- Defined in plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts:64
Sets a custom data source through which the CityJSONLoaderPlugin can load CityJSON files.

Default value is {@link CityJSONDefaultDataSource}, which loads via HTTP.

Parameters
- arg: ICityJSONDefaultDataSource
Returns void

Methods

destroy

destroy(): void

Inherited from Plugin.destroy
- Defined in viewer/Plugin.d.ts:68
Destroys this Plugin and removes it from its Viewer.

Returns void

error

error(msg: string): void

Inherited from Plugin.error
- Defined in viewer/Plugin.d.ts:63
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

fire

fire(event: string, value: any): void

Inherited from Plugin.fire
- Defined in viewer/Plugin.d.ts:42
Fires an event at this Plugin.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
Returns void

load

load(params: LoadCityJSONModel): Entity

- Defined in plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts:80
Loads an CityJSON model into this CityJSONLoaderPlugin's Viewer.

Parameters
- params: LoadCityJSONModel
  
  Loading parameters.
Returns Entity

log

log(msg: string): void

Inherited from Plugin.log
- Defined in viewer/Plugin.d.ts:49
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

on

on(event: string, callback: () => void): void

Inherited from Plugin.on
- Defined in viewer/Plugin.d.ts:35
Subscribes to an event fired at this Plugin.

Parameters
- event: string
  
  The event
- callback: () => void
  
  Callback fired on the event
  - - (): void
    - Returns void
Returns void

warn

warn(msg: string): void

Inherited from Plugin.warn
- Defined in viewer/Plugin.d.ts:56
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

Generated using TypeDoc