Skip to content

Commit 933ffa7

Browse files
author
Marko Petzold
committed
chore: regenerate types
1 parent 8cf7534 commit 933ffa7

1 file changed

Lines changed: 73 additions & 16 deletions

File tree

src/definition-schema.d.ts

Lines changed: 73 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@
55
* and run json-schema-to-typescript to regenerate this file.
66
*/
77

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+
*/
811
export type Title = string;
12+
/**
13+
* Secondary text displayed below the title. Use for additional context like region, time period, or data source.
14+
*/
915
export type Subtitle = string;
1016
/**
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.
1218
*/
1319
export type MapStyle =
1420
| "streets-v12"
@@ -19,69 +25,96 @@ export type MapStyle =
1925
| "satellite-streets-v12"
2026
| "navigation-day-v1"
2127
| "navigation-night-v1";
28+
/**
29+
* When enabled, displays a legend identifying each data layer by color and label. Useful for multi-layer maps.
30+
*/
2231
export type ShowLegend = boolean;
2332
/**
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.
2534
*/
2635
export type AutoFollow = boolean;
2736
/**
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.
2938
*/
3039
export type SeriesLabel = string;
3140
/**
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.
3342
*/
3443
export type LayerType = "circle" | "symbol" | "heatmap" | "line";
3544
/**
36-
* 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.
3746
*/
3847
export type LatestValues = number;
3948
/**
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.
4150
*/
4251
export type Blur = number;
4352
/**
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.
4554
*/
4655
export type Opacity = number;
56+
/**
57+
* Font size in pixels for label text on circle markers.
58+
*/
4759
export type TextSize = number;
60+
/**
61+
* Font size in pixels for label text on symbol markers.
62+
*/
4863
export type TextSize1 = number;
4964
/**
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.
5166
*/
5267
export type IconName = "marker" | "car-front" | "car-top";
5368
/**
54-
* In multiples of the original icon size
69+
* Scale multiplier for the icon (1 = original size, 2 = double size, 0.5 = half size).
5570
*/
5671
export type IconSize = number;
5772
/**
58-
* The higher the intensity, the more 'hot' the heatmap becomes. The value is a multiple with default value 1. e.g. to double the intensitiy choose 2.
73+
* Heat intensity multiplier. Higher values make the heatmap appear 'hotter' with colors reaching maximum faster. Default is 1.
5974
*/
6075
export type Intensity = number;
76+
/**
77+
* Heatmap layer transparency from 0 (invisible) to 1 (fully opaque). Lower values let the base map show through.
78+
*/
6179
export type Opacity1 = number;
6280
/**
63-
* The radius will be combined with the data value to to determine the heat radius of a point.
81+
* Base radius in pixels for each point's heat contribution. Combined with data value to determine actual heat spread. Larger radius = more blending.
6482
*/
6583
export type RadiusBaseSize = number;
84+
/**
85+
* Thickness of the route line in pixels. Use thicker lines for emphasis or when zoomed out.
86+
*/
6687
export type LineWidth = number;
6788
/**
68-
* For available icons check the maki icon set here https://labs.mapbox.com/maki-icons/
89+
* Icon displayed at the current position (end of line): 'marker' for generic location, 'car-front'/'car-top' for vehicles.
6990
*/
7091
export type IconName1 = "marker" | "car-front" | "car-top";
7192
/**
72-
* In multiples of the original icon size
93+
* Scale multiplier for the position icon (1 = original size).
7394
*/
7495
export type IconSize1 = number;
96+
/**
97+
* The east-west coordinate in decimal degrees (-180 to 180). Example: -122.4194 for San Francisco.
98+
*/
7599
export type Longitude = number;
100+
/**
101+
* The north-south coordinate in decimal degrees (-90 to 90). Example: 37.7749 for San Francisco.
102+
*/
76103
export type Latitude = number;
104+
/**
105+
* Optional elevation/altitude value in meters. Can be used for 3D visualization or displayed in tooltips.
106+
*/
77107
export type Altitude = number;
108+
/**
109+
* Numeric value associated with this location. Used for heatmap intensity, marker sizing, or tooltip display.
110+
*/
78111
export type DataPointValue = number;
79112
/**
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).
81114
*/
82115
export type SplitDataBy = string;
83116
/**
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.
85118
*/
86119
export type MapData = {
87120
lon?: Longitude;
@@ -91,6 +124,9 @@ export type MapData = {
91124
pivot?: SplitDataBy;
92125
[k: string]: unknown;
93126
}[];
127+
/**
128+
* Array of map layers. Each layer displays geographic data points with its own visualization style (circles, symbols, heatmap, or lines).
129+
*/
94130
export type Dataseries = {
95131
label?: SeriesLabel;
96132
type?: LayerType;
@@ -105,7 +141,7 @@ export type Dataseries = {
105141
}[];
106142

107143
/**
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.
109145
*/
110146
export interface InputData {
111147
title?: Title;
@@ -116,35 +152,56 @@ export interface InputData {
116152
dataseries?: Dataseries;
117153
[k: string]: unknown;
118154
}
155+
/**
156+
* Primary color for this layer's markers or fill. Used as default when data-driven coloring isn't configured.
157+
*/
119158
export interface LayerBaseColor {
120159
[k: string]: unknown;
121160
}
161+
/**
162+
* Styling options specific to circle (point) layers.
163+
*/
122164
export interface CircleLayerConfiguration {
123165
"circle-blur"?: Blur;
124166
"circle-opacity"?: Opacity;
125167
"text-color"?: TextColor;
126168
"text-size"?: TextSize;
127169
[k: string]: unknown;
128170
}
171+
/**
172+
* Color of label text displayed on or near the circle markers.
173+
*/
129174
export interface TextColor {
130175
[k: string]: unknown;
131176
}
177+
/**
178+
* Styling options specific to symbol (icon) layers.
179+
*/
132180
export interface SymbolLayerConfiguration {
133181
"text-color"?: TextColor1;
134182
"text-size"?: TextSize1;
135183
"icon-image"?: IconName;
136184
"icon-size"?: IconSize;
137185
[k: string]: unknown;
138186
}
187+
/**
188+
* Color of label text displayed near the symbol icons.
189+
*/
139190
export interface TextColor1 {
140191
[k: string]: unknown;
141192
}
193+
/**
194+
* Styling options specific to heatmap (density) layers.
195+
*/
142196
export interface HeatmapLayerConfiguration {
143197
"heatmap-intensity"?: Intensity;
144198
"heatmap-opacity"?: Opacity1;
145199
"heatmap-radius"?: RadiusBaseSize;
146200
[k: string]: unknown;
147201
}
202+
/**
203+
* Styling options specific to line (track/route) layers.
204+
*/
148205
export interface TrackLayerConfiguration {
149206
"line-width"?: LineWidth;
150207
"icon-image"?: IconName1;

0 commit comments

Comments
 (0)