/
atlas.WfsFeatureRequest.yml
147 lines (147 loc) · 4.49 KB
/
atlas.WfsFeatureRequest.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
### YamlMime:TSType
name: WfsFeatureRequest
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest
package: azure-maps-spatial-io
summary: Options for requesting features from a WFS service.
fullName: WfsFeatureRequest
remarks: ''
isDeprecated: false
type: interface
properties:
- name: bbox
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.bbox
package: azure-maps-spatial-io
summary: Bounding Box limit. Must not be used with Filter.
fullName: bbox
remarks: ''
isDeprecated: false
syntax:
content: 'bbox?: azmaps.data.BoundingBox'
return:
description: ''
type: <xref uid="azmaps.data.BoundingBox" />
- name: count
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.count
package: azure-maps-spatial-io
summary: Number of features to retrieve when paging.
fullName: count
remarks: ''
isDeprecated: false
syntax:
content: 'count: number'
return:
description: ''
type: number
- name: cql_filter
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.cql_filter
package: azure-maps-spatial-io
summary: A custom CQL filter to append to the request.
fullName: cql_filter
remarks: ''
isDeprecated: false
syntax:
content: 'cql_filter?: string'
return:
description: ''
type: string
- name: customDimensions
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.customDimensions
package: azure-maps-spatial-io
summary: A key-value object containing additional parameters to append the request.
fullName: customDimensions
remarks: ''
isDeprecated: false
syntax:
content: 'customDimensions?: Record<string, string>'
return:
description: ''
type: 'Record<string, string>'
- name: fallbackSrs
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.fallbackSrs
package: azure-maps-spatial-io
summary: >-
Specifies which SRS value to use if a valid one is not specified in the
capabilities.
Some WFS services support reprojection on the fly and thus do not list every possible supported SRS.
If set to null, and not supported SRS found in capabilities, an error will be thrown.
Default: 'urn:ogc:def:crs:EPSG::4326'
fullName: fallbackSrs
remarks: ''
isDeprecated: false
syntax:
content: 'fallbackSrs?: string'
return:
description: ''
type: string
- name: featureId
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.featureId
package: azure-maps-spatial-io
summary: The id of a feature to retrieve.
fullName: featureId
remarks: ''
isDeprecated: false
syntax:
content: 'featureId?: string'
return:
description: ''
type: string
- name: filter
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.filter
package: azure-maps-spatial-io
summary: Filter condition. Must not be used with BBOX option.
fullName: filter
remarks: ''
isDeprecated: false
syntax:
content: 'filter?: Filter'
return:
description: ''
type: <xref uid="azure-maps-spatial-io.atlas.io.ogc.filter.Filter" />
- name: propertyNames
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.propertyNames
package: azure-maps-spatial-io
summary: A comma delimited list of property names to return.
fullName: propertyNames
remarks: ''
isDeprecated: false
syntax:
content: 'propertyNames?: string'
return:
description: ''
type: string
- name: sortBy
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.sortBy
package: azure-maps-spatial-io
summary: Method describing how results should be sorted.
fullName: sortBy
remarks: ''
isDeprecated: false
syntax:
content: 'sortBy: string'
return:
description: ''
type: string
- name: startIndex
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.startIndex
package: azure-maps-spatial-io
summary: Start index to use for WFS paging.
fullName: startIndex
remarks: ''
isDeprecated: false
syntax:
content: 'startIndex: number'
return:
description: ''
type: number
- name: typeNames
uid: azure-maps-spatial-io.atlas.WfsFeatureRequest.typeNames
package: azure-maps-spatial-io
summary: The feature type names.
fullName: typeNames
remarks: ''
isDeprecated: false
syntax:
content: 'typeNames?: string | string[]'
return:
description: ''
type: 'string | string[]'