Skip to content

Commit 908ee2e

Browse files
viktorkombovviktorkombov
authored
Merge pull request #287 from IgniteUI/dtsvetkov/fix-maps-api-links
Fix maps api links
2 parents d4b09f5 + 6150e22 commit 908ee2e

48 files changed

Lines changed: 11783 additions & 132 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api-link-report-angular.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# API Link Check Report
22

3-
_Generated: 2026-05-22 09:54:39 UTC_
3+
_Generated: 2026-06-02 13:46:14 UTC_
44

55
## Summary
66

77
| | |
88
|---|---|
9-
| ✅ OK | 2084 |
9+
| ✅ OK | 2105 |
1010
| ❌ Not found (type/member missing) | 0 |
1111
| ❌ HTTP error | 0 |
1212
| ❌ **Total broken** | **0** |

‎api-link-report-blazor.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# API Link Check Report
22

3-
_Generated: 2026-05-22 09:58:46 UTC_
3+
_Generated: 2026-06-02 13:51:14 UTC_
44

55
## Summary
66

77
| | |
88
|---|---|
9-
| ✅ OK | 1785 |
9+
| ✅ OK | 1832 |
1010
| ❌ Not found (type/member missing) | 0 |
1111
| ❌ HTTP error | 0 |
1212
| ❌ **Total broken** | **0** |

‎api-link-report-react.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# API Link Check Report
22

3-
_Generated: 2026-05-22 09:55:43 UTC_
3+
_Generated: 2026-06-02 13:48:24 UTC_
44

55
## Summary
66

77
| | |
88
|---|---|
9-
| ✅ OK | 1812 |
9+
| ✅ OK | 1880 |
1010
| ❌ Not found (type/member missing) | 0 |
1111
| ❌ HTTP error | 0 |
1212
| ❌ **Total broken** | **0** |

‎api-link-report-wc.md‎

Lines changed: 11627 additions & 4 deletions
Large diffs are not rendered by default.

‎docs/angular/src/content/en/components/geo-map-binding-data-json-points.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,6 @@ export class MapBindingDataJsonPointsComponent implements AfterViewInit {
128128
<ApiLink type="GeographicHighDensityScatterSeries" pkg="maps" />
129129
<ApiLink type="GeographicSymbolSeries" pkg="maps" />
130130
<ApiLink type="GeographicMap" pkg="maps" />
131+
<ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" />
132+
<ApiLink pkg="maps" type="GeographicSymbolSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />
133+
<ApiLink pkg="maps" type="GeographicSymbolSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />

‎docs/angular/src/content/en/components/geo-map-binding-data-model.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1111

1212
# Angular Binding Geographic Data Models
1313

14-
The Ignite UI for Angular map component is designed to display geo-spatial data from shape files and/or geographic locations from data models on geographic imagery maps. The <ApiLink pkg="maps" type="GeographicMap" member="ItemsSource" label="ItemsSource" /> property of geographic series is used for the purpose of binding to data models. This property can be bound an array of custom objects.
14+
The Ignite UI for Angular map component is designed to display geo-spatial data from shape files and/or geographic locations from data models on geographic imagery maps. The <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" /> property of geographic series is used for the purpose of binding to data models. This property can be bound an array of custom objects.
1515

1616
## Angular Binding Geographic Data Models Example
1717

@@ -30,8 +30,8 @@ The following table summarized data structures required for each type of geograp
3030
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" /> | <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />, <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />, <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusMemberPath" label="RadiusMemberPath" /> | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for size/radius of symbols |
3131
| <ApiLink pkg="maps" type="GeographicScatterAreaSeries" /> | <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />, <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />, <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="colorMemberPath" label="ColorMemberPath" /> | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
3232
| <ApiLink pkg="maps" type="GeographicContourLineSeries" /> | <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />, <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />, <ApiLink pkg="maps" type="GeographicContourLineSeries" member="valueMemberPath" label="ValueMemberPath" /> | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
33-
|<ApiLink pkg="maps" type="GeographicShapeSeries" />|<ApiLink pkg="maps" type="GeographicShapeSeries" member="shapeMemberPath" label="ShapeMemberPath" />|Specifies the name of data column of <ApiLink pkg="maps" type="GeographicMap" member="ItemsSource" label="ItemsSource" /> items that contains the geographic points of shapes. This property must be mapped to an array of arrays of objects with x and y properties. |
34-
|<ApiLink pkg="maps" type="GeographicPolylineSeries" />|<ApiLink pkg="maps" type="GeographicShapeSeries" member="shapeMemberPath" label="ShapeMemberPath" />|Specifies the name of data column of <ApiLink pkg="maps" type="GeographicMap" member="ItemsSource" label="ItemsSource" /> items that contains the geographic coordinates of lines. This property must be mapped to an array of arrays of objects with x and y properties. |
33+
|<ApiLink pkg="maps" type="GeographicShapeSeries" />|<ApiLink pkg="maps" type="GeographicShapeSeries" member="shapeMemberPath" label="ShapeMemberPath" />|Specifies the name of data column of <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" /> items that contains the geographic points of shapes. This property must be mapped to an array of arrays of objects with x and y properties. |
34+
|<ApiLink pkg="maps" type="GeographicPolylineSeries" />|<ApiLink pkg="maps" type="GeographicShapeSeries" member="shapeMemberPath" label="ShapeMemberPath" />|Specifies the name of data column of <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" /> items that contains the geographic coordinates of lines. This property must be mapped to an array of arrays of objects with x and y properties. |
3535

3636
## Code Snippet
3737
The following code shows how to bind the <ApiLink pkg="maps" type="GeographicSymbolSeries" /> to a custom data model that contains geographic locations of some cities of the world stored using longitude and latitude coordinates. Also, we use the <ApiLink pkg="maps" type="GeographicPolylineSeries" /> to plot shortest geographic path between these locations using the [WorldUtility](geo-map-resources-world-util.md)

‎docs/angular/src/content/en/components/geo-map-binding-data-overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1010

1111
# Angular Data Binding
1212

13-
The Ignite UI for Angular map component is designed to display geo-spatial data from shape files and/or geographic locations from data models on geographic imagery maps. The <ApiLink pkg="maps" type="GeographicMap" member="ItemsSource" label="ItemsSource" /> property of geographic series is used for the purpose of binding to data models.
13+
The Ignite UI for Angular map component is designed to display geo-spatial data from shape files and/or geographic locations from data models on geographic imagery maps. The <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" /> property of geographic series is used for the purpose of binding to data models.
1414

1515
## Types of Data Sources
1616
The following section list some of data source that you can bind in the geographic map component

‎docs/angular/src/content/en/components/geo-map-binding-shp-file.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following code creates an instance of the <ApiLink pkg="geo-core" type="Shap
4141

4242

4343
## Binding Shapefiles
44-
In the map component, Geographic Series are used for displaying geo-spatial data that is loaded from shape files. All types of Geographic Series have an `ItemsSource` property which can be bound to an array of objects. The <ApiLink pkg="geo-core" type="ShapefileRecord" suffix={false} /> is an example such array because it contains a list of `IgxShapefileRecord` objects.
44+
In the map component, Geographic Series are used for displaying geo-spatial data that is loaded from shape files. All types of Geographic Series have an <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" /> property which can be bound to an array of objects. The <ApiLink pkg="geo-core" type="ShapefileRecord" suffix={false} /> is an example such array because it contains a list of `IgxShapefileRecord` objects.
4545

4646
The `ShapefileRecord` class provides properties for storing geo-spatial data, listed in the following table.
4747

@@ -148,3 +148,7 @@ export class MapBindingShapefilePolylinesComponent implements AfterViewInit {
148148
## API References
149149
<ApiLink type="GeographicPolylineSeries" pkg="maps" />
150150
<ApiLink pkg="geo-core" type="ShapefileRecord" suffix={false} />
151+
<ApiLink pkg="geo-core" type="ShapefileRecord" member="fields" label="Fields" suffix={false} />
152+
<ApiLink pkg="geo-core" type="ShapefileRecord" member="importCompleted" label="ImportCompleted" suffix={false} />
153+
<ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" />
154+
<ApiLink pkg="geo-core" type="ShapefileRecord" member="points" label="Points" suffix={false} />

‎docs/angular/src/content/en/components/geo-map-type-scatter-area-series.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ The following table summarizes properties of GeographicScatterAreaSeries used fo
3131

3232
| Property Name | Property Type | Description |
3333
|--------------|---------------| ---------------|
34-
|`ItemsSource`|any|The source of data items to perform triangulation on if the `TrianglesSource` property provides no triangulation data.|
35-
|`LongitudeMemberPath`|string|The name of the property containing the Longitude for all items bound to the `ItemsSource`.|
36-
|`LatitudeMemberPath`|string|The name of the property containing the Latitude for all items bound to the `ItemsSource`.|
37-
|`ColorMemberPath`|string|The name of the property containing a value at Latitude and Longitude coordinates of each data item. This numeric value will be be converted to a color when the `ColorScale` property is set.|
38-
|`TrianglesSource`|any|The source of triangulation data. Setting Triangles of the `TriangulationSource` object to this property improves both runtime performance and geographic series rendering.|
39-
|`TriangleVertexMemberPath1`|string|The name of the property of the `TrianglesSource` items which, for each triangle, contains the index of the first vertex point in the ItemsSource. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
40-
|`TriangleVertexMemberPath2`|string|The name of the property of the `TrianglesSource` items which, for each triangle, contains the index of the first vertex point in the ItemsSource. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
41-
|`TriangleVertexMemberPath3`|string|The name of the property of the `TrianglesSource` items which, for each triangle, contains the index of the first vertex point in the ItemsSource. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
34+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="triangulationDataSource" label="ItemsSource" />|any|The source of data items to perform triangulation on if the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="trianglesSource" label="TrianglesSource" /> property provides no triangulation data.|
35+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />|string|The name of the property containing the Longitude for all items bound to the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="triangulationDataSource" label="ItemsSource" />.|
36+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />|string|The name of the property containing the Latitude for all items bound to the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="triangulationDataSource" label="ItemsSource" />.|
37+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="colorMemberPath" label="ColorMemberPath" />|string|The name of the property containing a value at Latitude and Longitude coordinates of each data item. This numeric value will be be converted to a color when the `ColorScale` property is set.|
38+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="trianglesSource" label="TrianglesSource" />|any|The source of triangulation data. Setting Triangles of the `TriangulationSource` object to this property improves both runtime performance and geographic series rendering.|
39+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="triangleVertexMemberPath1" label="TriangleVertexMemberPath1" />|string|The name of the property of the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="trianglesSource" label="TrianglesSource" /> items which, for each triangle, contains the index of the first vertex point in the ItemsSource. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
40+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="triangleVertexMemberPath2" label="TriangleVertexMemberPath2" />|string|The name of the property of the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="trianglesSource" label="TrianglesSource" /> items which, for each triangle, contains the index of the first vertex point in the ItemsSource. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
41+
|<ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="triangleVertexMemberPath3" label="TriangleVertexMemberPath3" />|string|The name of the property of the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" member="trianglesSource" label="TrianglesSource" /> items which, for each triangle, contains the index of the first vertex point in the ItemsSource. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
4242

4343
## Color Scale
4444
Use the ColorScale property of the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" /> to resolve colors values of points and thus fill surface of the geographic series. The colors are smoothly interpolated around the shape of the surface by applying a pixel-wise triangle rasterizer to a triangulation data. Because rendering of the surface is pixel-wise, the color scale uses colors instead of brushes.
@@ -48,10 +48,10 @@ The following table list properties of the `CustomPaletteColorScale` affecting s
4848

4949
| Property Name | Property Type | Description |
5050
|--------------|---------------| ---------------|
51-
|`Palette`| `ObservableCollection<Color>` |Gets or sets the collection of colors to select from or to interpolate between.|
52-
|`InterpolationMode`|`ColorScaleInterpolationMode`|Gets or sets the method getting a color from the Palette.|
53-
|`MaximumValue`|double|The highest value to assign a color. Any given value greater than this value will be Transparent.|
54-
|`MinimumValue`|double|The lowest value to assign a color. Any given value less than this value will be Transparent.|
51+
|<ApiLink pkg="charts" type="CustomPaletteColorScale" member="palette" label="Palette" />| `ObservableCollection<Color>` |Gets or sets the collection of colors to select from or to interpolate between.|
52+
|<ApiLink pkg="charts" type="CustomPaletteColorScale" member="interpolationMode" label="InterpolationMode" />|`ColorScaleInterpolationMode`|Gets or sets the method getting a color from the Palette.|
53+
|<ApiLink pkg="charts" type="CustomPaletteColorScale" member="maximumValue" label="MaximumValue" />|double|The highest value to assign a color. Any given value greater than this value will be Transparent.|
54+
|<ApiLink pkg="charts" type="CustomPaletteColorScale" member="minimumValue" label="MinimumValue" />|double|The lowest value to assign a color. Any given value less than this value will be Transparent.|
5555

5656
## Code Snippet
5757
The following code shows how to bind the <ApiLink pkg="maps" type="GeographicScatterAreaSeries" /> to triangulation data representing surface temperatures in the world.

‎docs/angular/src/content/en/components/geo-map-type-scatter-bubble-series.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ In Angular map component, you can use the <ApiLink pkg="maps" type="GeographicPr
2525
The demo above shows the <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" /> series and how to specify data binding options of the series. Automatic marker selection is configured along with marker collision avoidance logic, and marker outline and fill colors are specified too.
2626

2727
## Configuration Summary
28-
Similar to other types of scatter series in the map control, the <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" /> series has the <ApiLink pkg="charts" type="Series" member="DataSource" label="ItemsSource" /> property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="longitudeMemberPath" label="LongitudeMemberPath" /> and <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="latitudeMemberPath" label="LatitudeMemberPath" /> properties to map these data columns. The <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusScale" label="RadiusScale" /> and <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusMemberPath" label="RadiusMemberPath" /> will settings configures the radius for the bubbles.
28+
Similar to other types of scatter series in the map control, the <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" /> series has the <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" /> property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="longitudeMemberPath" label="LongitudeMemberPath" /> and <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="latitudeMemberPath" label="LatitudeMemberPath" /> properties to map these data columns. The <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusScale" label="RadiusScale" /> and <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusMemberPath" label="RadiusMemberPath" /> will settings configures the radius for the bubbles.
2929

3030
The following table summarizes the GeographicHighDensityScatterSeries series properties used for data binding.
3131

3232
| Property|Type|Description |
3333
| ---|---|--- |
34-
| <ApiLink pkg="charts" type="Series" member="DataSource" label="ItemsSource" />|any|Gets or sets the items source |
35-
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />|string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
36-
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />|string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
34+
| <ApiLink pkg="maps" type="GeographicMap" member="dataSource" label="DataSource" />|any|Gets or sets the items source |
35+
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="longitudeMemberPath" label="LongitudeMemberPath" />|string|Uses the DataSource property to determine the location of the longitude values on the assigned items |
36+
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="latitudeMemberPath" label="LatitudeMemberPath" />|string|Uses the DataSource property to determine the location of the latitude values on the assigned items |
3737
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusMemberPath" label="RadiusMemberPath" />|string|Sets the path to use to get the radius values for the series. |
3838
| <ApiLink pkg="maps" type="GeographicProportionalSymbolSeries" member="radiusScale" label="RadiusScale" />|<ApiLink pkg="charts" type="SizeScale" />|Gets or sets the radius scale property for the current bubble series. |
3939
| <ApiLink pkg="charts" type="SizeScale" member="minimumValue" label="MinimumValue" />|any|Configure the minimum value for calculating value sub ranges. |

0 commit comments

Comments
 (0)