@terrestris/shogun-util
Preparing search index...
parser/SHOGunApplicationUtil
default
Class default<T, S>
Type Parameters
T
extends
default
S
extends
default
Index
Constructors
constructor
Methods
get
Layer
Ids
get
Map
Scales
parse
Folder
parse
Image
Layer
parse
Layer
parse
Layer
Tree
parse
Layer
Tree
Nodes
parse
Mapbox
Style
Layer
parse
Map
Interactions
parse
Map
View
parse
Mvt
Layer
parse
Nodes
parse
OGC
Features
Layer
parse
Tile
Layer
parse
WFS
Layer
parse
WMS
Time
Layer
parse
WMTS
Layer
parse
XYZ
Layer
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
>
Parameters
Optional
opts
:
SHOGunApplicationUtilOpts
Returns
default
<
T
,
S
>
Methods
get
Layer
Ids
getLayerIds
(
nodes
:
DefaultLayerTree
[]
,
ids
?:
number
[]
)
:
number
[]
Parameters
nodes
:
DefaultLayerTree
[]
Optional
ids
:
number
[]
Returns
number
[]
get
Map
Scales
getMapScales
(
resolutions
:
number
[]
,
projUnit
?:
Units
)
:
number
[]
Parameters
resolutions
:
number
[]
projUnit
:
Units
= 'm'
Returns
number
[]
parse
Folder
parseFolder
(
el
:
DefaultLayerTree
,
layers
:
S
[]
,
projection
?:
ProjectionLike
,
keepClientConfig
?:
boolean
,
)
:
Promise
<
LayerGroup
>
Parameters
el
:
DefaultLayerTree
layers
:
S
[]
Optional
projection
:
ProjectionLike
keepClientConfig
:
boolean
= false
Returns
Promise
<
LayerGroup
>
parse
Image
Layer
parseImageLayer
(
layer
:
S
)
:
ImageLayer
<
ImageWMS
>
Parameters
layer
:
S
Returns
ImageLayer
<
ImageWMS
>
parse
Layer
parseLayer
(
layer
:
S
,
projection
?:
ProjectionLike
,
)
:
Promise
<
|
undefined
|
LayerGroup
|
ImageLayer
<
ImageWMS
>
|
TileLayer
<
TileWMS
>
|
TileLayer
<
WMTS
>
|
VectorLayer
<
VectorSource
<
Feature
<
Geometry
>
>
,
Feature
<
Geometry
>
>
|
TileLayer
<
XYZ
>
|
VectorTileLayer
<
VectorTile
<
RenderFeature
>
,
RenderFeature
>
,
>
Parameters
layer
:
S
Optional
projection
:
ProjectionLike
Returns
Promise
<
|
undefined
|
LayerGroup
|
ImageLayer
<
ImageWMS
>
|
TileLayer
<
TileWMS
>
|
TileLayer
<
WMTS
>
|
VectorLayer
<
VectorSource
<
Feature
<
Geometry
>
>
,
Feature
<
Geometry
>
>
|
TileLayer
<
XYZ
>
|
VectorTileLayer
<
VectorTile
<
RenderFeature
>
,
RenderFeature
>
,
>
parse
Layer
Tree
parseLayerTree
(
application
:
T
,
projection
?:
ProjectionLike
,
keepClientConfig
?:
boolean
,
)
:
Promise
<
undefined
|
LayerGroup
>
Parameters
application
:
T
Optional
projection
:
ProjectionLike
keepClientConfig
:
boolean
= false
Returns
Promise
<
undefined
|
LayerGroup
>
parse
Layer
Tree
Nodes
parseLayerTreeNodes
(
application
:
T
,
layers
:
S
[]
,
projection
?:
ProjectionLike
,
keepClientConfig
?:
boolean
,
)
:
Promise
<
LayerGroup
>
Parameters
application
:
T
layers
:
S
[]
Optional
projection
:
ProjectionLike
keepClientConfig
:
boolean
= false
Returns
Promise
<
LayerGroup
>
parse
Mapbox
Style
Layer
parseMapboxStyleLayer
(
layer
:
S
,
projection
?:
ProjectionLike
,
)
:
Promise
<
LayerGroup
>
Parameters
layer
:
S
Optional
projection
:
ProjectionLike
Returns
Promise
<
LayerGroup
>
parse
Map
Interactions
parseMapInteractions
(
application
:
T
,
)
:
Promise
<
Collection
<
Interaction
>
|
Interaction
[]
>
Parameters
application
:
T
Returns
Promise
<
Collection
<
Interaction
>
|
Interaction
[]
>
parse
Map
View
parseMapView
(
application
:
T
,
additionalOpts
?:
ViewOptions
)
:
Promise
<
View
>
Parameters
application
:
T
Optional
additionalOpts
:
ViewOptions
Returns
Promise
<
View
>
parse
Mvt
Layer
parseMvtLayer
(
layer
:
S
,
projection
?:
ProjectionLike
,
)
:
VectorTileLayer
<
VectorTile
<
RenderFeature
>
,
RenderFeature
>
Parameters
layer
:
S
projection
:
ProjectionLike
= 'EPSG:3857'
Returns
VectorTileLayer
<
VectorTile
<
RenderFeature
>
,
RenderFeature
>
parse
Nodes
parseNodes
(
nodes
:
DefaultLayerTree
[]
,
layers
:
S
[]
,
projection
?:
ProjectionLike
,
keepClientConfig
?:
boolean
,
)
:
Promise
<
BaseLayer
[]
>
Parameters
nodes
:
DefaultLayerTree
[]
layers
:
S
[]
Optional
projection
:
ProjectionLike
keepClientConfig
:
boolean
= false
Returns
Promise
<
BaseLayer
[]
>
parse
OGC
Features
Layer
parseOGCFeaturesLayer
(
layer
:
S
,
projection
?:
ProjectionLike
,
)
:
VectorLayer
<
VectorSource
<
Feature
<
Geometry
>
>
,
Feature
<
Geometry
>
>
Parameters
layer
:
S
projection
:
ProjectionLike
= 'EPSG:3857'
Returns
VectorLayer
<
VectorSource
<
Feature
<
Geometry
>
>
,
Feature
<
Geometry
>
>
parse
Tile
Layer
parseTileLayer
(
layer
:
S
,
projection
?:
ProjectionLike
)
:
TileLayer
<
TileWMS
>
Parameters
layer
:
S
projection
:
ProjectionLike
= 'EPSG:3857'
Returns
TileLayer
<
TileWMS
>
parse
WFS
Layer
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
>
>
parse
WMS
Time
Layer
parseWMSTimeLayer
(
layer
:
S
,
projection
?:
ProjectionLike
,
)
:
Promise
<
TileLayer
<
TileWMS
>
>
Parameters
layer
:
S
projection
:
ProjectionLike
= 'EPSG:3857'
Returns
Promise
<
TileLayer
<
TileWMS
>
>
parse
WMTS
Layer
parseWMTSLayer
(
layer
:
S
,
projection
?:
ProjectionLike
,
)
:
Promise
<
undefined
|
TileLayer
<
WMTS
>
>
Parameters
layer
:
S
projection
:
ProjectionLike
= 'EPSG:3857'
Returns
Promise
<
undefined
|
TileLayer
<
WMTS
>
>
parse
XYZ
Layer
parseXYZLayer
(
layer
:
S
,
projection
?:
ProjectionLike
)
:
TileLayer
<
XYZ
>
Parameters
layer
:
S
projection
:
ProjectionLike
= 'EPSG:3857'
Returns
TileLayer
<
XYZ
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
Layer
Ids
get
Map
Scales
parse
Folder
parse
Image
Layer
parse
Layer
parse
Layer
Tree
parse
Layer
Tree
Nodes
parse
Mapbox
Style
Layer
parse
Map
Interactions
parse
Map
View
parse
Mvt
Layer
parse
Nodes
parse
OGC
Features
Layer
parse
Tile
Layer
parse
WFS
Layer
parse
WMS
Time
Layer
parse
WMTS
Layer
parse
XYZ
Layer
@terrestris/shogun-util
Loading...