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: src/definition-schema.d.ts
+73-16Lines changed: 73 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,16 @@
5
5
* and run json-schema-to-typescript to regenerate this file.
6
6
*/
7
7
8
+
/**
9
+
* The main heading displayed above the map. Use to describe what geographic data is being shown (e.g., 'Fleet Locations', 'Sensor Network').
10
+
*/
8
11
exporttypeTitle=string;
12
+
/**
13
+
* Secondary text displayed below the title. Use for additional context like region, time period, or data source.
14
+
*/
9
15
exporttypeSubtitle=string;
10
16
/**
11
-
* The basic style of the map.
17
+
* The visual appearance of the base map: 'streets' for road-focused, 'outdoors' for terrain, 'light/dark' for minimal designs, 'satellite' for aerial imagery, 'navigation' for routing focus.
12
18
*/
13
19
exporttypeMapStyle=
14
20
|"streets-v12"
@@ -19,69 +25,96 @@ export type MapStyle =
19
25
|"satellite-streets-v12"
20
26
|"navigation-day-v1"
21
27
|"navigation-night-v1";
28
+
/**
29
+
* When enabled, displays a legend identifying each data layer by color and label. Useful for multi-layer maps.
30
+
*/
22
31
exporttypeShowLegend=boolean;
23
32
/**
24
-
* If true, the map automatically keeps the drawn locations in focus.
33
+
* When enabled, the map automatically pans and zooms to keep all data points in view as they update. Disable for fixed-view maps where users control the viewport.
25
34
*/
26
35
exporttypeAutoFollow=boolean;
27
36
/**
28
-
* The name for this data series
37
+
* Display name for this map layer shown in legends and tooltips. Should identify what entities or data this layer represents.
29
38
*/
30
39
exporttypeSeriesLabel=string;
31
40
/**
32
-
* Create the specified type of layer on the map.
41
+
* Visualization style: 'circle' for point markers, 'symbol' for icon markers with labels, 'heatmap' for density visualization, 'line' for connected paths/routes.
* Restrict the number of rows for this dataseries to the given number of newest values. (If you use split data, then per each of the split dataseries.)
45
+
* Limit displayed data to the N most recent points per pivot group. Useful for showing only current positions without historical trail. Leave empty to show all data.
37
46
*/
38
47
exporttypeLatestValues=number;
39
48
/**
40
-
* Blur of 1 means the whole circle is blurred starting from the center point. Blur 0 means no blur effect.
49
+
* Edge blur effect from 0 (sharp edges) to 1 (fully blurred from center). Use slight blur (0.1-0.3) for softer appearance.
41
50
*/
42
51
exporttypeBlur=number;
43
52
/**
44
-
* Opactity 1 means fully opaque, 0 means fully transparent.
53
+
* Circle transparency from 0 (invisible) to 1 (fully opaque). Use lower values when circles overlap to see density.
45
54
*/
46
55
exporttypeOpacity=number;
56
+
/**
57
+
* Font size in pixels for label text on circle markers.
58
+
*/
47
59
exporttypeTextSize=number;
60
+
/**
61
+
* Font size in pixels for label text on symbol markers.
62
+
*/
48
63
exporttypeTextSize1=number;
49
64
/**
50
-
* For available icons check the maki icon set here https://labs.mapbox.com/maki-icons/
65
+
* Icon identifier from available icons: 'marker' for location pin, 'car-front'/'car-top' for vehicle tracking. See Maki icon set at https://labs.mapbox.com/maki-icons/ for more options.
* Scale multiplier for the position icon (1 = original size).
73
94
*/
74
95
exporttypeIconSize1=number;
96
+
/**
97
+
* The east-west coordinate in decimal degrees (-180 to 180). Example: -122.4194 for San Francisco.
98
+
*/
75
99
exporttypeLongitude=number;
100
+
/**
101
+
* The north-south coordinate in decimal degrees (-90 to 90). Example: 37.7749 for San Francisco.
102
+
*/
76
103
exporttypeLatitude=number;
104
+
/**
105
+
* Optional elevation/altitude value in meters. Can be used for 3D visualization or displayed in tooltips.
106
+
*/
77
107
exporttypeAltitude=number;
108
+
/**
109
+
* Numeric value associated with this location. Used for heatmap intensity, marker sizing, or tooltip display.
110
+
*/
78
111
exporttypeDataPointValue=number;
79
112
/**
80
-
* You can specify a column in the input data to autogenerate dataseries for each distinct entry in this column. E.g. if you have a table with columns [city, lon, lat, temperature] and specify 'city' as split column, then you will get a layer for each city.
113
+
* Column value used to split data into multiple layers automatically. Each unique pivot value creates a separate map layer (e.g., pivot by 'vehicle_id' for fleet tracking).
81
114
*/
82
115
exporttypeSplitDataBy=string;
83
116
/**
84
-
* This is the map data
117
+
* Array of geographic data points. Each point must have latitude and longitude coordinates, with optional altitude, value, and pivot for grouping.
85
118
*/
86
119
exporttypeMapData={
87
120
lon?: Longitude;
@@ -91,6 +124,9 @@ export type MapData = {
91
124
pivot?: SplitDataBy;
92
125
[k: string]: unknown;
93
126
}[];
127
+
/**
128
+
* Array of map layers. Each layer displays geographic data points with its own visualization style (circles, symbols, heatmap, or lines).
129
+
*/
94
130
exporttypeDataseries={
95
131
label?: SeriesLabel;
96
132
type?: LayerType;
@@ -105,7 +141,7 @@ export type Dataseries = {
105
141
}[];
106
142
107
143
/**
108
-
* A map-chart
144
+
* A Mapbox-powered geospatial visualization widget for displaying location-based data on interactive maps. Use this widget for GPS tracking, asset locations, geographic heatmaps, route visualization, or any data with latitude/longitude coordinates. Supports multiple layer types including circles (points), symbols (icons), heatmaps (density), and lines (tracks/routes). Features auto-follow mode to keep markers in view, multiple map styles, and pivot-based auto-generation of layers from data columns. Ideal for fleet management, IoT device monitoring, field service tracking, and geographic data analysis.
0 commit comments