-
Notifications
You must be signed in to change notification settings - Fork 18
/
atlas.layer.OgcMapLayer.yml
189 lines (186 loc) · 6.36 KB
/
atlas.layer.OgcMapLayer.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
### YamlMime:TSType
name: OgcMapLayer
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer
package: azure-maps-spatial-io
summary: >-
Renders raster tiled images on top of the map tiles from an OGC Web Mapping
Service (WMS or WMTS).
fullName: OgcMapLayer<T>
remarks: ''
isDeprecated: false
type: class
constructors:
- name: OgcMapLayer(OgcMapLayerOptions)
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.constructor
package: azure-maps-spatial-io
summary: >-
Renders raster images on top of the map tiles from an OGC Web Mapping
Service (WMS or WMTS).
remarks: ''
isDeprecated: false
syntax:
content: 'new OgcMapLayer(options: OgcMapLayerOptions)'
parameters:
- id: options
type: <xref uid="azure-maps-spatial-io.atlas.OgcMapLayerOptions" />
description: |
Options for rendering the WMS layer.
properties:
- name: onActiveLayersChanged
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.onActiveLayersChanged
package: azure-maps-spatial-io
summary: ''
fullName: onActiveLayersChanged
remarks: ''
isDeprecated: false
syntax:
content: 'onActiveLayersChanged: (layer: OgcMapLayer) => void'
return:
description: ''
type: '(layer: OgcMapLayer) => void'
inheritedProperties:
- name: metadata
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.metadata
package: azure-maps-spatial-io
summary: A property for associating custom data with the layer.
fullName: metadata
remarks: ''
isDeprecated: false
syntax:
content: 'metadata?: any'
return:
description: ''
type: any
inheritanceDescription: <b>Inherited From</b> Layer.metadata
inheritedMethods:
- name: getId()
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.getId
package: azure-maps-spatial-io
summary: Gets the id of the layer
remarks: ''
isDeprecated: false
syntax:
content: 'function getId(): string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Layer.getId
- name: getMap()
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.getMap
package: azure-maps-spatial-io
summary: 'Gets the map that the layer is currently added to, or null.'
remarks: ''
isDeprecated: false
syntax:
content: 'function getMap(): Map'
return:
description: ''
type: Map
inheritanceDescription: <b>Inherited From</b> Layer.getMap
- name: onRemove()
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.onRemove
package: azure-maps-spatial-io
summary: |-
Method that is called when the layer is removed from the map.
Should perform any necessary cleanup for the layer.
remarks: ''
isDeprecated: false
syntax:
content: function onRemove()
inheritanceDescription: <b>Inherited From</b> Layer.onRemove
methods:
- name: getCapabilities()
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.getCapabilities
package: azure-maps-spatial-io
summary: Gets the capabilities of the underlying WMTS service.
remarks: ''
isDeprecated: false
syntax:
content: 'function getCapabilities(): Promise<OgcMapLayerCapabilities>'
return:
description: ''
type: >-
Promise<<xref
uid="azure-maps-spatial-io.atlas.OgcMapLayerCapabilities" />>
- name: getFeatureInfo(azmaps.data.Position)
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.getFeatureInfo
package: azure-maps-spatial-io
summary: >-
Retrieves an array of WMS feature info objects at a point on the map.
If the service does not return a geometry, a Point feature for the
specified position will be returned.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getFeatureInfo(position: azmaps.data.Position):
Promise<azmaps.data.FeatureCollection>
parameters:
- id: position
type: <xref uid="azmaps.data.Position" />
description: |
The position on the map to request feature info for.
return:
description: ''
type: Promise<<xref uid="azmaps.data.FeatureCollection" />>
- name: getFeatureInfoHtml(azmaps.data.Position)
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.getFeatureInfoHtml
package: azure-maps-spatial-io
summary: >-
Gets feature info for the WMS layer as a HTML string. The result will be a
HTML document string
and should be added to an IFrame when adding to an existing page. Returns
null if no feature is found.
Requires the service to support 'text/html' format.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getFeatureInfoHtml(position: azmaps.data.Position):
Promise<string>
parameters:
- id: position
type: <xref uid="azmaps.data.Position" />
description: |
The position on the map to request feature info for.
return:
description: ''
type: Promise<string>
- name: getOptions()
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.getOptions
package: azure-maps-spatial-io
summary: Gets the options of the WMS layer.
remarks: ''
isDeprecated: false
syntax:
content: 'function getOptions(): OgcMapLayerOptions'
return:
description: ''
type: <xref uid="azure-maps-spatial-io.atlas.OgcMapLayerOptions" />
- name: onAdd(azmaps.Map)
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.onAdd
package: azure-maps-spatial-io
summary: Initialization method for the layer which is called when added to the map.
remarks: ''
isDeprecated: false
syntax:
content: 'function onAdd(map: azmaps.Map)'
parameters:
- id: map
type: <xref uid="azmaps.Map" />
description: |
The map the layer has been added to.
- name: setOptions(OgcMapLayerOptions)
uid: azure-maps-spatial-io.atlas.layer.OgcMapLayer.setOptions
package: azure-maps-spatial-io
summary: Sets the options of the WMS layer.
remarks: ''
isDeprecated: false
syntax:
content: 'function setOptions(options: OgcMapLayerOptions)'
parameters:
- id: options
type: <xref uid="azure-maps-spatial-io.atlas.OgcMapLayerOptions" />
description: |
The options.
extends: TileLayer