You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ A control that provides a form for requesting a route range. Adds a marker to th
26
26
27
27
| Name | Return type | Description |
28
28
|------|-------------|-------------|
29
-
|`dataselected`|`azmaps.Shape[]`| Event fired when shapes are selected from the specified data source. |
29
+
|`dataselected`|`atlas.Shape[]`| Event fired when shapes are selected from the specified data source. |
30
30
31
31
**Usage**
32
32
@@ -78,7 +78,7 @@ Options for the SelectionControlOptions.
78
78
| `strokeColor` | `string` | The color to outline of the search area with. Default: `'#F2C811'` |
79
79
| `strokeWidth` | `number` | The width of the outline of the search area: Default: `1` |
80
80
| `selectionModes` | `SelectionControlMode[]`\|`'all'` | The selection modes to display in the selection control. Default: `'all'` |
81
-
| `source` | `azmaps.source.DataSource` | The data source to query data from. |
81
+
| `source` | `atlas.source.DataSource` | The data source to query data from. |
82
82
| `style` | `atlas.ControlStyle` | The style of the control. Can be; `light`, `dark`, or `auto`. When set to auto, the style will change based on the map style. Overridden if device is in high contrast mode. Default `light`. |
83
83
84
84
## RouteRangeControl class
@@ -105,16 +105,16 @@ This control only uses a `non-fixed` position when being added to the map. If a
105
105
|------|-------------|-------------|
106
106
| `dispose()` | | Disposes the control. |
107
107
| `getOptions()` | `RouteRangeControlOptions` | Gets the options of the control. |
108
-
| `setMarkerOptions(options:azmaps.HtmlMarkerOptions)` | | Sets the options for the marker. |
108
+
| `setMarkerOptions(options:atlas.HtmlMarkerOptions)` | | Sets the options for the marker. |
109
109
| `setVisible(isVisible: boolean)` | | Hides or shows the route range control. |
110
110
111
111
**Events**
112
112
113
113
| Name | Return type | Description |
114
114
|------|-------------|-------------|
115
115
| `error` | `string` | Event fired when an error occurs. |
116
-
| `showrange` | `azmaps.data.Polygon|azmaps.data.MultiPolygon` | Event fired when a route range is calculated and the showArea option is set to true. |
117
-
| `rangecalculated` | `azmaps.data.Polygon|azmaps.data.MultiPolygon` | Event fired when a route range has been calculated. |
116
+
| `showrange` | `atlas.data.Polygon|atlas.data.MultiPolygon` | Event fired when a route range is calculated and the showArea option is set to true. |
117
+
| `rangecalculated` | `atlas.data.Polygon|atlas.data.MultiPolygon` | Event fired when a route range has been calculated. |
118
118
119
119
120
120
**Usage**
@@ -188,6 +188,6 @@ The following static functions have been added to the `atlas.math` namespace.
188
188
| Name | Return type | Description |
189
189
|------|-------------|-------------|
190
190
| `convertWeight(weight: number, fromUnits: string | WeightUnits, toUnits: string | WeightUnits, decimals?: number)` | `number` | Converts a weight value from one unit to another. Supported units: kilograms, pounds, metricTon, longTon, shortTon. |
191
-
| `pointsWithinPolygon(points:azmaps.data.Feature<azmaps.data.Point, any>[], searchArea:azmaps.data.Polygon|azmaps.data.MultiPolygon|azmaps.data.Feature<azmaps.data.Geometry, any>|azmaps.Shape)` | `azmaps.data.Feature<azmaps.data.Point, any>[]` | Gets all point features that are within a polygon. |
192
-
| `shapePointsWithinPolygon(shapes:azmaps.Shape[] |azmaps.source.DataSource, searchArea:azmaps.data.Polygon|azmaps.data.MultiPolygon|azmaps.data.Feature<azmaps.data.Geometry, any>|azmaps.Shape)` | `azmaps.Shape[]` | Gets all shapes that have point features that are within a polygon. |
191
+
| `pointsWithinPolygon(points:atlas.data.Feature<atlas.data.Point, any>[], searchArea:atlas.data.Polygon|atlas.data.MultiPolygon|atlas.data.Feature<atlas.data.Geometry, any>|atlas.Shape)` | `atlas.data.Feature<atlas.data.Point, any>[]` | Gets all point features that are within a polygon. |
192
+
| `shapePointsWithinPolygon(shapes:atlas.Shape[] |atlas.source.DataSource, searchArea:atlas.data.Polygon|atlas.data.MultiPolygon|atlas.data.Feature<atlas.data.Geometry, any>|atlas.Shape)` | `atlas.Shape[]` | Gets all shapes that have point features that are within a polygon. |
0 commit comments