/
atlas.layer.PolygonExtrusionLayer.yml
145 lines (145 loc) · 5.14 KB
/
atlas.layer.PolygonExtrusionLayer.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
### YamlMime:TSType
name: PolygonExtrusionLayer
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer
package: azure-maps-control
summary: Renders extruded filled `Polygon` and `MultiPolygon` objects on the map.
fullName: PolygonExtrusionLayer<T>
remarks: ''
isDeprecated: false
type: class
constructors:
- name: >-
PolygonExtrusionLayer(string | Source, string,
PolygonExtrusionLayerOptions)
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.constructor
package: azure-maps-control
summary: Constructs a new PolygonExtrusionLayer.
remarks: ''
isDeprecated: false
syntax:
content: >-
new PolygonExtrusionLayer(source: string | Source, id?: string,
options?: PolygonExtrusionLayerOptions)
parameters:
- id: source
type: string | <xref uid="azure-maps-control.atlas.source.Source" />
description: The id or instance of a data source which the layer will render.
- id: id
type: string
description: >-
The id of the layer. If not specified a random one will be
generated.
- id: options
type: <xref uid="azure-maps-control.atlas.PolygonExtrusionLayerOptions" />
description: |
The options of the polygon extrusion layer.
inheritedProperties:
- name: metadata
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.metadata
package: azure-maps-control
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](xref:azure-maps-control.atlas.layer.Layer.metadata)
inheritedMethods:
- name: getId()
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.getId
package: azure-maps-control
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](xref:azure-maps-control.atlas.layer.Layer.getId)
- name: getMap()
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.getMap
package: azure-maps-control
summary: 'Gets the map that the layer is currently added to, or null.'
remarks: ''
isDeprecated: false
syntax:
content: 'function getMap(): Map'
return:
description: ''
type: <xref uid="azure-maps-control.atlas.Map" />
inheritanceDescription: >-
<b>Inherited From</b>
[Layer.getMap](xref:azure-maps-control.atlas.layer.Layer.getMap)
- name: onAdd(Map)
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.onAdd
package: azure-maps-control
summary: Initialization method for the layer which is called when added to the map.
remarks: ''
isDeprecated: false
syntax:
content: 'function onAdd(map: Map)'
parameters:
- id: map
type: <xref uid="azure-maps-control.atlas.Map" />
description: |
The map the layer has been added to.
inheritanceDescription: >-
<b>Inherited From</b>
[Layer.onAdd](xref:azure-maps-control.atlas.layer.Layer.onAdd)
- name: onRemove()
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.onRemove
package: azure-maps-control
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](xref:azure-maps-control.atlas.layer.Layer.onRemove)
methods:
- name: getOptions()
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.getOptions
package: azure-maps-control
summary: Gets the options of the polygon layer.
remarks: ''
isDeprecated: false
syntax:
content: 'function getOptions(): PolygonExtrusionLayerOptions'
return:
description: ''
type: <xref uid="azure-maps-control.atlas.PolygonExtrusionLayerOptions" />
- name: getSource()
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.getSource
package: azure-maps-control
summary: Gets the source provided when creating the layer.
remarks: ''
isDeprecated: false
syntax:
content: 'function getSource(): string | Source'
return:
description: ''
type: string | <xref uid="azure-maps-control.atlas.source.Source" />
- name: setOptions(PolygonExtrusionLayerOptions)
uid: azure-maps-control.atlas.layer.PolygonExtrusionLayer.setOptions
package: azure-maps-control
summary: Sets the options of the polygon layer.
remarks: ''
isDeprecated: false
syntax:
content: 'function setOptions(options: PolygonExtrusionLayerOptions)'
parameters:
- id: options
type: <xref uid="azure-maps-control.atlas.PolygonExtrusionLayerOptions" />
description: ''
extends: <xref uid="azure-maps-control.atlas.layer.Layer" />