Constructors
constructor
- new default<
T extends
default<
DefaultApplicationClientConfig<
DefaultMapView,
DefaultLegalConfig,
DefaultApplicationTheme,
>,
DefaultLayerTree,
DefaultApplicationLayerConfig<
DefaultLayerClientConfig,
DefaultLayerSourceConfig,
>,
DefaultApplicationToolConfig,
>,
S extends default<DefaultLayerClientConfig, DefaultLayerSourceConfig>,
>(
opts?: SHOGunApplicationUtilOpts,
): default<T, S> Type Parameters
- T extends default<
DefaultApplicationClientConfig<
DefaultMapView,
DefaultLegalConfig,
DefaultApplicationTheme,
>,
DefaultLayerTree,
DefaultApplicationLayerConfig<
DefaultLayerClientConfig,
DefaultLayerSourceConfig,
>,
DefaultApplicationToolConfig,
> - S extends default<DefaultLayerClientConfig, DefaultLayerSourceConfig>
Methods
getLayerIds
- getLayerIds(nodes: DefaultLayerTree[], ids?: number[]): number[]
Returns number[]
getMapScales
- getMapScales(resolutions: number[], projUnit?: Units): number[]
Parameters
- resolutions: number[]
- projUnit: Units = 'm'
Returns number[]
parseFolder
- parseFolder(
el: DefaultLayerTree,
layers: S[],
projection?: ProjectionLike,
keepClientConfig?: boolean,
): Promise<LayerGroup> Parameters
- el: DefaultLayerTree
- layers: S[]
Optionalprojection: ProjectionLike- keepClientConfig: boolean = false
Returns Promise<LayerGroup>
parseImageLayer
- parseImageLayer(layer: S): ImageLayer<ImageWMS>
Returns ImageLayer<ImageWMS>
parseLayer
- parseLayer(
layer: S,
projection?: ProjectionLike,
): Promise<
| undefined
| ImageLayer<ImageWMS>
| TileLayer<TileWMS>
| TileLayer<WMTS>
| VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>
| TileLayer<XYZ>,
> Parameters
- layer: S
Optionalprojection: ProjectionLike
Returns Promise<
| undefined
| ImageLayer<ImageWMS>
| TileLayer<TileWMS>
| TileLayer<WMTS>
| VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>
| TileLayer<XYZ>,
>
parseLayerTree
- parseLayerTree(
application: T,
projection?: ProjectionLike,
keepClientConfig?: boolean,
): Promise<undefined | LayerGroup> Parameters
- application: T
Optionalprojection: ProjectionLike- keepClientConfig: boolean = false
Returns Promise<undefined | LayerGroup>
parseLayerTreeNodes
- parseLayerTreeNodes(
application: T,
layers: S[],
projection?: ProjectionLike,
keepClientConfig?: boolean,
): Promise<LayerGroup> Parameters
- application: T
- layers: S[]
Optionalprojection: ProjectionLike- keepClientConfig: boolean = false
Returns Promise<LayerGroup>
parseMapInteractions
- parseMapInteractions(
application: T,
): Promise<Collection<Interaction> | Interaction[]> Returns Promise<Collection<Interaction> | Interaction[]>
parseMapView
- parseMapView(application: T, additionalOpts?: ViewOptions): Promise<View>
Parameters
- application: T
OptionaladditionalOpts: ViewOptions
Returns Promise<View>
parseNodes
- parseNodes(
nodes: DefaultLayerTree[],
layers: S[],
projection?: ProjectionLike,
keepClientConfig?: boolean,
): Promise<BaseLayer[]> Parameters
- nodes: DefaultLayerTree[]
- layers: S[]
Optionalprojection: ProjectionLike- keepClientConfig: boolean = false
Returns Promise<BaseLayer[]>
parseTileLayer
- parseTileLayer(layer: S, projection?: ProjectionLike): TileLayer<TileWMS>
Parameters
- layer: S
- projection: ProjectionLike = 'EPSG:3857'
Returns TileLayer<TileWMS>
parseWFSLayer
- parseWFSLayer(
layer: S,
projection?: ProjectionLike,
): VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>> Parameters
- layer: S
- projection: ProjectionLike = 'EPSG:3857'
Returns VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>
parseWMSTimeLayer
- parseWMSTimeLayer(
layer: S,
projection?: ProjectionLike,
): Promise<TileLayer<TileWMS>> Parameters
- layer: S
- projection: ProjectionLike = 'EPSG:3857'
Returns Promise<TileLayer<TileWMS>>
parseWMTSLayer
- parseWMTSLayer(
layer: S,
projection?: ProjectionLike,
): Promise<undefined | TileLayer<WMTS>> Parameters
- layer: S
- projection: ProjectionLike = 'EPSG:3857'
Returns Promise<undefined | TileLayer<WMTS>>
parseXYZLayer
- parseXYZLayer(layer: S): TileLayer<XYZ>
Returns TileLayer<XYZ>