MapLayerFormat Class

Class representing a map-layer format. Each format has it's unique 'formatId' string, used to uniquely identify a format in the MapLayerFormatRegistry. When creating an ImageMapLayerSettings object, a format needs to be specified this 'formatId'. The MapLayerFormat object can later be used to validate a source, or create a provider.

Subclasses should override formatId, MapLayerFormat.createImageryProvider, and MapLayerFormat.createMapLayerTree.

Extended by

Methods

Name Description
constructor(): MapLayerFormat    
createImageryProvider(_settings: MapLayerSettings): undefined | MapLayerImageryProvider Static Create a MapLayerImageryProvider that will be used to feed data in a map-layer tile tree.  
createMapLayerTree(_layerSettings: MapLayerSettings, _layerIndex: number, _iModel: IModelConnection): undefined | MapLayerTileTreeReference Static Creates a MapLayerTileTreeReference for this map layer format.  
register(): void Static Register the current format in the MapLayerFormatRegistry.  
validate(args: ValidateSourceArgs): Promise<MapLayerSourceValidation> Static Allow a source object to be validated before being attached as a map-layer.  
validateSource(_url: string, _userName?: string, _password?: string, _ignoreCache?: boolean, _accesKey?: MapLayerKey): Promise<MapLayerSourceValidation> Static Allow a source of a specific format to be validated before being attached as a map-layer.  

Properties

Name Type Description
formatId Static string    

Defined in

Last Updated: 28 March, 2024