@feltmaps/js-sdk 1.5.0-next.15 → 1.5.0-next.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.cts +34 -15
- package/dist/client.d.ts +34 -15
- package/dist/handler.cjs +1 -1
- package/dist/handler.d.cts +496 -198
- package/dist/handler.d.ts +496 -198
- package/dist/handler.js +1 -1
- package/dist/{types-PSY3LPGC.d.cts → types-C0CJJN-7.d.cts} +2816 -425
- package/dist/{types-PSY3LPGC.d.ts → types-C0CJJN-7.d.ts} +2816 -425
- package/handler.d.ts +496 -198
- package/handler.js +1 -1
- package/package.json +1 -2
- package/{types-PSY3LPGC.d.ts → types-C0CJJN-7.d.ts} +2816 -425
- package/dist/tsdoc-metadata.json +0 -11
|
@@ -14,21 +14,314 @@ type zInfer<T extends {
|
|
|
14
14
|
shape: ZodRawShape;
|
|
15
15
|
}> = objectOutputType<T["shape"], ZodTypeAny, "strip">;
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
/**
|
|
18
|
+
* Represents a point in world coordinates.
|
|
19
|
+
*/
|
|
20
|
+
interface LatLng {
|
|
21
|
+
latitude: number;
|
|
22
|
+
longitude: number;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* A tuple representing a longitude and latitude coordinate.
|
|
26
|
+
*
|
|
27
|
+
* This is used hen serializing geometry because that's the standard used in
|
|
28
|
+
* GeoJSON.
|
|
29
|
+
*/
|
|
30
|
+
type LngLatTuple = [longitude: number, latitude: number];
|
|
31
|
+
/**
|
|
32
|
+
* A GeoJSON properties object.
|
|
33
|
+
*/
|
|
34
|
+
type GeoJsonProperties = Record<string, unknown>;
|
|
35
|
+
/**
|
|
36
|
+
* A GeoJSON feature object, compliant with:
|
|
37
|
+
* https://datatracker.ietf.org/doc/html/rfc7946#section-3.2
|
|
38
|
+
*
|
|
39
|
+
* @interface
|
|
40
|
+
*/
|
|
41
|
+
type GeoJsonFeature = {
|
|
42
|
+
type: "Feature";
|
|
43
|
+
/**
|
|
44
|
+
* The bounding box of the feature in [west, south, east, north] order.
|
|
45
|
+
*/
|
|
46
|
+
bbox?: FeltBoundary;
|
|
47
|
+
/**
|
|
48
|
+
* The feature's geometry
|
|
49
|
+
*/
|
|
50
|
+
geometry: GeoJsonGeometry;
|
|
51
|
+
/**
|
|
52
|
+
* A value that uniquely identifies this feature in a
|
|
53
|
+
* https://tools.ietf.org/html/rfc7946#section-3.2.
|
|
54
|
+
*/
|
|
55
|
+
id?: string | number | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* Properties associated with this feature.
|
|
58
|
+
*/
|
|
59
|
+
properties: GeoJsonProperties;
|
|
60
|
+
};
|
|
61
|
+
interface PointGeometry {
|
|
62
|
+
type: "Point";
|
|
63
|
+
coordinates: LngLatTuple;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* A GeoJSON multi-point geometry.
|
|
67
|
+
*
|
|
68
|
+
* @remarks
|
|
69
|
+
* You shouldn't expect this to come from Felt - it is here for completeness
|
|
70
|
+
* of the GeoJSON spec.
|
|
71
|
+
*/
|
|
72
|
+
interface MultiPointGeometry {
|
|
73
|
+
type: "MultiPoint";
|
|
74
|
+
coordinates: PointGeometry["coordinates"][];
|
|
75
|
+
}
|
|
76
|
+
interface PolygonGeometry extends zInfer<typeof PolygonGeometrySchema> {
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* A GeoJSON polygon geometry.
|
|
80
|
+
*/
|
|
81
|
+
declare const PolygonGeometrySchema: z.ZodObject<{
|
|
82
|
+
type: z.ZodLiteral<"Polygon">;
|
|
83
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
84
|
+
}, "strip", z.ZodTypeAny, {
|
|
85
|
+
type: "Polygon";
|
|
86
|
+
coordinates: [number, number][][];
|
|
87
|
+
}, {
|
|
88
|
+
type: "Polygon";
|
|
89
|
+
coordinates: [number, number][][];
|
|
90
|
+
}>;
|
|
91
|
+
/**
|
|
92
|
+
* A GeoJSON multi-polygon geometry.
|
|
93
|
+
*
|
|
94
|
+
* @interface
|
|
95
|
+
*/
|
|
96
|
+
type MultiPolygonGeometry = {
|
|
97
|
+
type: "MultiPolygon";
|
|
98
|
+
coordinates: PolygonGeometry["coordinates"][];
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* A GeoJSON line string geometry.
|
|
102
|
+
*
|
|
103
|
+
* @interface
|
|
104
|
+
*/
|
|
105
|
+
type LineStringGeometry = {
|
|
106
|
+
type: "LineString";
|
|
107
|
+
coordinates: LngLatTuple[];
|
|
108
|
+
};
|
|
109
|
+
/**
|
|
110
|
+
* A GeoJSON multi-line string geometry.
|
|
111
|
+
*
|
|
112
|
+
* @interface
|
|
113
|
+
*/
|
|
114
|
+
type MultiLineStringGeometry = {
|
|
115
|
+
type: "MultiLineString";
|
|
116
|
+
coordinates: LineStringGeometry["coordinates"][];
|
|
117
|
+
};
|
|
118
|
+
/**
|
|
119
|
+
* A GeoJSON geometry of any type
|
|
120
|
+
*/
|
|
121
|
+
type GeoJsonGeometry = PointGeometry | PolygonGeometry | LineStringGeometry | MultiLineStringGeometry | MultiPolygonGeometry | MultiPointGeometry;
|
|
122
|
+
/**
|
|
123
|
+
* @ignore
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
declare const FeltZoomSchema: z.ZodNumber;
|
|
127
|
+
/**
|
|
128
|
+
* The zoom level of the map.
|
|
129
|
+
*
|
|
130
|
+
* It is a floating-point number between 1 and 23, where 1 is the most
|
|
131
|
+
* zoomed out and 23 is the most zoomed in.
|
|
132
|
+
*
|
|
133
|
+
* @group Types
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
type FeltZoom = z.infer<typeof FeltZoomSchema>;
|
|
137
|
+
/**
|
|
138
|
+
* @ignore
|
|
139
|
+
* @internal
|
|
140
|
+
*/
|
|
141
|
+
declare const FeltBoundarySchema: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
|
|
142
|
+
/**
|
|
143
|
+
* The edges of the map in the form of a bounding box.
|
|
144
|
+
*
|
|
145
|
+
* The boundary is a tuple of the form `[west, south, east, north]`.
|
|
146
|
+
*
|
|
147
|
+
* @group Types
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
type FeltBoundary = z.infer<typeof FeltBoundarySchema>;
|
|
151
|
+
/**
|
|
152
|
+
* The parameters for the methods that change the visibility of entities.
|
|
153
|
+
*
|
|
154
|
+
* @public
|
|
155
|
+
* @category Visibility
|
|
156
|
+
*/
|
|
157
|
+
interface SetVisibilityRequest extends zInfer<typeof SetVisibilityRequestSchema> {
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* @internal
|
|
161
|
+
*/
|
|
162
|
+
declare const SetVisibilityRequestSchema: z.ZodObject<{
|
|
163
|
+
/**
|
|
164
|
+
* The ids of the entities you want to change the visibility of.
|
|
165
|
+
*/
|
|
166
|
+
show: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
167
|
+
hide: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
168
|
+
}, "strip", z.ZodTypeAny, {
|
|
169
|
+
show?: string[] | undefined;
|
|
170
|
+
hide?: string[] | undefined;
|
|
171
|
+
}, {
|
|
172
|
+
show?: string[] | undefined;
|
|
173
|
+
hide?: string[] | undefined;
|
|
174
|
+
}>;
|
|
175
|
+
/**
|
|
176
|
+
* Specifies the direction to sort data in
|
|
177
|
+
*
|
|
178
|
+
* @group Types
|
|
179
|
+
*/
|
|
180
|
+
type SortDirection = z.infer<typeof SortDirectionSchema>;
|
|
181
|
+
/** @ignore */
|
|
182
|
+
declare const SortDirectionSchema: z.ZodEnum<["asc", "desc"]>;
|
|
183
|
+
/**
|
|
184
|
+
* Configuration for sorting data by a specific attribute
|
|
185
|
+
*
|
|
186
|
+
* @group Types
|
|
187
|
+
*/
|
|
188
|
+
interface SortConfig extends zInfer<typeof SortConfigSchema> {
|
|
189
|
+
direction: SortDirection;
|
|
190
|
+
}
|
|
191
|
+
/** @ignore */
|
|
192
|
+
declare const SortConfigSchema: z.ZodObject<{
|
|
193
|
+
/**
|
|
194
|
+
* The attribute to sort by. What this represents depends on the context.
|
|
195
|
+
* For instance, when sorting features in a data table, the attribute is
|
|
196
|
+
* the column to sort by.
|
|
197
|
+
*/
|
|
198
|
+
attribute: z.ZodString;
|
|
199
|
+
/**
|
|
200
|
+
* The direction to sort in
|
|
201
|
+
*/
|
|
202
|
+
direction: z.ZodEnum<["asc", "desc"]>;
|
|
203
|
+
}, "strip", z.ZodTypeAny, {
|
|
204
|
+
attribute: string;
|
|
205
|
+
direction: "asc" | "desc";
|
|
206
|
+
}, {
|
|
207
|
+
attribute: string;
|
|
208
|
+
direction: "asc" | "desc";
|
|
209
|
+
}>;
|
|
210
|
+
|
|
211
|
+
declare const PlaceCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
21
212
|
id: z.ZodOptional<z.ZodString>;
|
|
22
213
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
23
214
|
color: z.ZodOptional<z.ZodString>;
|
|
24
|
-
name: z.ZodOptional<z.
|
|
25
|
-
description: z.ZodOptional<z.
|
|
215
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
216
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
26
217
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
27
218
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
28
219
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
220
|
+
type: z.ZodOptional<z.ZodLiteral<"Place">>;
|
|
221
|
+
coordinates: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
222
|
+
symbol: z.ZodOptional<z.ZodString>;
|
|
29
223
|
frame: z.ZodOptional<z.ZodNullable<z.ZodEnum<["frame-circle", "frame-square"]>>>;
|
|
30
224
|
hideLabel: z.ZodOptional<z.ZodBoolean>;
|
|
31
|
-
},
|
|
225
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
226
|
+
/**
|
|
227
|
+
* The unique identifier for the element.
|
|
228
|
+
*/
|
|
229
|
+
id: z.ZodString;
|
|
230
|
+
/**
|
|
231
|
+
* The ID of the element group that the element belongs to.
|
|
232
|
+
* For elements that are not part of a group, this will be null.
|
|
233
|
+
*/
|
|
234
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
235
|
+
/**
|
|
236
|
+
* The color of the element in some CSS-like format.
|
|
237
|
+
*
|
|
238
|
+
* @example
|
|
239
|
+
* ```typescript
|
|
240
|
+
* "#ABC123";
|
|
241
|
+
* "rgb(255, 0, 0)";
|
|
242
|
+
* "hsl(200, 100%, 50%)";
|
|
243
|
+
* ```
|
|
244
|
+
*
|
|
245
|
+
* @default "#C93535"
|
|
246
|
+
*/
|
|
247
|
+
color: z.ZodString;
|
|
248
|
+
/**
|
|
249
|
+
* The element's name. For elements that can show a label or text on
|
|
250
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
251
|
+
*
|
|
252
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
253
|
+
* the element is selected by clicking on it.
|
|
254
|
+
*/
|
|
255
|
+
name: z.ZodNullable<z.ZodString>;
|
|
256
|
+
/**
|
|
257
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
258
|
+
* is selected.
|
|
259
|
+
*
|
|
260
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
261
|
+
* and Markers, so their description will not be shown.
|
|
262
|
+
*/
|
|
263
|
+
description: z.ZodNullable<z.ZodString>;
|
|
264
|
+
/**
|
|
265
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
266
|
+
*
|
|
267
|
+
* This is most useful for associating additional data with an element that is not
|
|
268
|
+
* part of the element's core data, such as a Place's address or some other
|
|
269
|
+
* data.
|
|
270
|
+
*/
|
|
271
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
272
|
+
/**
|
|
273
|
+
* Whether the element is interactive.
|
|
274
|
+
*
|
|
275
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
276
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
277
|
+
*
|
|
278
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
279
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
280
|
+
* accident.
|
|
281
|
+
*
|
|
282
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
283
|
+
* not editable and have special behaviour depending on their name, description and
|
|
284
|
+
* attributes.
|
|
285
|
+
*
|
|
286
|
+
* @default "default"
|
|
287
|
+
*/
|
|
288
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
289
|
+
}, {
|
|
290
|
+
/**
|
|
291
|
+
* The URL of an image that has been added to the element.
|
|
292
|
+
*/
|
|
293
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
294
|
+
}>, {
|
|
295
|
+
type: z.ZodLiteral<"Place">;
|
|
296
|
+
coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
297
|
+
/**
|
|
298
|
+
* The symbol that is rendered for the Place.
|
|
299
|
+
*
|
|
300
|
+
* This can be an emoji by using colon-enclosed characters (e.g. `":smiley:"`)
|
|
301
|
+
* or one of the symbols available in Felt's symbol library.
|
|
302
|
+
*
|
|
303
|
+
* You can see the available symbols in the Felt UI when editing a Place
|
|
304
|
+
* by hovering a symbol and converting the tooltip to kebab-case. For example,
|
|
305
|
+
* the "Oil barrel" symbol is `oil-barrel`.
|
|
306
|
+
*/
|
|
307
|
+
symbol: z.ZodString;
|
|
308
|
+
/**
|
|
309
|
+
* The frame that is rendered around the Place's symbol. This is
|
|
310
|
+
* only available for non-emoji symbols.
|
|
311
|
+
*/
|
|
312
|
+
frame: z.ZodNullable<z.ZodEnum<["frame-circle", "frame-square"]>>;
|
|
313
|
+
/**
|
|
314
|
+
* Whether the element's label is hidden on the map. This allows you
|
|
315
|
+
* to add a name to the element and can show in popups, but not have
|
|
316
|
+
* it visible on the map.
|
|
317
|
+
*
|
|
318
|
+
* This will also hide the faint placeholder label that is shown when
|
|
319
|
+
* an editable Place is selected.
|
|
320
|
+
*
|
|
321
|
+
* @default false
|
|
322
|
+
*/
|
|
323
|
+
hideLabel: z.ZodBoolean;
|
|
324
|
+
}>, "type" | "coordinates">>, "id">, "strip", z.ZodTypeAny, {
|
|
32
325
|
type: "Place";
|
|
33
326
|
coordinates: [number, number];
|
|
34
327
|
symbol?: string | undefined;
|
|
@@ -55,24 +348,138 @@ declare const PlaceCreateSchema: z.ZodObject<Omit<{
|
|
|
55
348
|
frame?: "frame-circle" | "frame-square" | null | undefined;
|
|
56
349
|
hideLabel?: boolean | undefined;
|
|
57
350
|
}>;
|
|
58
|
-
declare const PathCreateSchema: z.ZodObject<Omit<{
|
|
59
|
-
type: z.ZodLiteral<"Path">;
|
|
60
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
351
|
+
declare const PathCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
61
352
|
id: z.ZodOptional<z.ZodString>;
|
|
62
353
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
63
354
|
color: z.ZodOptional<z.ZodString>;
|
|
64
|
-
name: z.ZodOptional<z.
|
|
65
|
-
description: z.ZodOptional<z.
|
|
355
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
356
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
66
357
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
67
358
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
68
359
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
69
360
|
strokeOpacity: z.ZodOptional<z.ZodNumber>;
|
|
70
361
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
71
362
|
strokeStyle: z.ZodOptional<z.ZodEnum<["solid", "dashed", "dotted"]>>;
|
|
363
|
+
type: z.ZodOptional<z.ZodLiteral<"Path">>;
|
|
364
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
72
365
|
distanceMarker: z.ZodOptional<z.ZodBoolean>;
|
|
73
|
-
endCaps: z.ZodOptional<z.ZodBoolean>;
|
|
74
366
|
routingMode: z.ZodOptional<z.ZodNullable<z.ZodEnum<["driving", "cycling", "walking", "flying"]>>>;
|
|
75
|
-
|
|
367
|
+
endCaps: z.ZodOptional<z.ZodBoolean>;
|
|
368
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
369
|
+
/**
|
|
370
|
+
* The unique identifier for the element.
|
|
371
|
+
*/
|
|
372
|
+
id: z.ZodString;
|
|
373
|
+
/**
|
|
374
|
+
* The ID of the element group that the element belongs to.
|
|
375
|
+
* For elements that are not part of a group, this will be null.
|
|
376
|
+
*/
|
|
377
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
378
|
+
/**
|
|
379
|
+
* The color of the element in some CSS-like format.
|
|
380
|
+
*
|
|
381
|
+
* @example
|
|
382
|
+
* ```typescript
|
|
383
|
+
* "#ABC123";
|
|
384
|
+
* "rgb(255, 0, 0)";
|
|
385
|
+
* "hsl(200, 100%, 50%)";
|
|
386
|
+
* ```
|
|
387
|
+
*
|
|
388
|
+
* @default "#C93535"
|
|
389
|
+
*/
|
|
390
|
+
color: z.ZodString;
|
|
391
|
+
/**
|
|
392
|
+
* The element's name. For elements that can show a label or text on
|
|
393
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
394
|
+
*
|
|
395
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
396
|
+
* the element is selected by clicking on it.
|
|
397
|
+
*/
|
|
398
|
+
name: z.ZodNullable<z.ZodString>;
|
|
399
|
+
/**
|
|
400
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
401
|
+
* is selected.
|
|
402
|
+
*
|
|
403
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
404
|
+
* and Markers, so their description will not be shown.
|
|
405
|
+
*/
|
|
406
|
+
description: z.ZodNullable<z.ZodString>;
|
|
407
|
+
/**
|
|
408
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
409
|
+
*
|
|
410
|
+
* This is most useful for associating additional data with an element that is not
|
|
411
|
+
* part of the element's core data, such as a Place's address or some other
|
|
412
|
+
* data.
|
|
413
|
+
*/
|
|
414
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
415
|
+
/**
|
|
416
|
+
* Whether the element is interactive.
|
|
417
|
+
*
|
|
418
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
419
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
420
|
+
*
|
|
421
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
422
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
423
|
+
* accident.
|
|
424
|
+
*
|
|
425
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
426
|
+
* not editable and have special behaviour depending on their name, description and
|
|
427
|
+
* attributes.
|
|
428
|
+
*
|
|
429
|
+
* @default "default"
|
|
430
|
+
*/
|
|
431
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
432
|
+
}, {
|
|
433
|
+
/**
|
|
434
|
+
* The URL of an image that has been added to the element.
|
|
435
|
+
*/
|
|
436
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
437
|
+
}>, {
|
|
438
|
+
/**
|
|
439
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
440
|
+
*
|
|
441
|
+
* @default 1
|
|
442
|
+
*/
|
|
443
|
+
strokeOpacity: z.ZodNumber;
|
|
444
|
+
/**
|
|
445
|
+
* The width of the element's stroke in pixels.
|
|
446
|
+
*
|
|
447
|
+
* @default 2
|
|
448
|
+
*/
|
|
449
|
+
strokeWidth: z.ZodNumber;
|
|
450
|
+
/**
|
|
451
|
+
* The style of the element's stroke.
|
|
452
|
+
*
|
|
453
|
+
* @default "solid"
|
|
454
|
+
*/
|
|
455
|
+
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
456
|
+
}>, {
|
|
457
|
+
type: z.ZodLiteral<"Path">;
|
|
458
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
459
|
+
/**
|
|
460
|
+
* Whether a distance marker is shown at the midpoint of the path.
|
|
461
|
+
*
|
|
462
|
+
* @default false
|
|
463
|
+
*/
|
|
464
|
+
distanceMarker: z.ZodBoolean;
|
|
465
|
+
/**
|
|
466
|
+
* Whether this represents a route, and if so, what mode of transport
|
|
467
|
+
* is used.
|
|
468
|
+
*
|
|
469
|
+
* If this is `null`, the path is not considered to be a route, so while it
|
|
470
|
+
* can have a `distanceMarker`, it will does not have a start or end cap.
|
|
471
|
+
*
|
|
472
|
+
* @default null
|
|
473
|
+
*/
|
|
474
|
+
routingMode: z.ZodNullable<z.ZodEnum<["driving", "cycling", "walking", "flying"]>>;
|
|
475
|
+
/**
|
|
476
|
+
* Whether or not to show Start and End caps on the path. This is
|
|
477
|
+
* only available if the `routingMode` is set.
|
|
478
|
+
*
|
|
479
|
+
* @default false
|
|
480
|
+
*/
|
|
481
|
+
endCaps: z.ZodBoolean;
|
|
482
|
+
}>, "type" | "coordinates">>, "id">, "strip", z.ZodTypeAny, {
|
|
76
483
|
type: "Path";
|
|
77
484
|
coordinates: [number, number][][];
|
|
78
485
|
groupId?: string | null | undefined;
|
|
@@ -86,8 +493,8 @@ declare const PathCreateSchema: z.ZodObject<Omit<{
|
|
|
86
493
|
strokeWidth?: number | undefined;
|
|
87
494
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
88
495
|
distanceMarker?: boolean | undefined;
|
|
89
|
-
endCaps?: boolean | undefined;
|
|
90
496
|
routingMode?: "driving" | "cycling" | "walking" | "flying" | null | undefined;
|
|
497
|
+
endCaps?: boolean | undefined;
|
|
91
498
|
}, {
|
|
92
499
|
type: "Path";
|
|
93
500
|
coordinates: [number, number][][];
|
|
@@ -102,26 +509,129 @@ declare const PathCreateSchema: z.ZodObject<Omit<{
|
|
|
102
509
|
strokeWidth?: number | undefined;
|
|
103
510
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
104
511
|
distanceMarker?: boolean | undefined;
|
|
105
|
-
endCaps?: boolean | undefined;
|
|
106
512
|
routingMode?: "driving" | "cycling" | "walking" | "flying" | null | undefined;
|
|
513
|
+
endCaps?: boolean | undefined;
|
|
107
514
|
}>;
|
|
108
|
-
declare const PolygonCreateSchema: z.ZodObject<Omit<{
|
|
109
|
-
type: z.ZodLiteral<"Polygon">;
|
|
110
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
515
|
+
declare const PolygonCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
111
516
|
id: z.ZodOptional<z.ZodString>;
|
|
112
517
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
113
518
|
color: z.ZodOptional<z.ZodString>;
|
|
114
|
-
name: z.ZodOptional<z.
|
|
115
|
-
description: z.ZodOptional<z.
|
|
519
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
520
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
116
521
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
117
522
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
118
523
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
119
524
|
strokeOpacity: z.ZodOptional<z.ZodNumber>;
|
|
120
525
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
121
526
|
strokeStyle: z.ZodOptional<z.ZodEnum<["solid", "dashed", "dotted"]>>;
|
|
527
|
+
type: z.ZodOptional<z.ZodLiteral<"Polygon">>;
|
|
528
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
122
529
|
fillOpacity: z.ZodOptional<z.ZodNumber>;
|
|
123
530
|
areaMarker: z.ZodOptional<z.ZodBoolean>;
|
|
124
|
-
},
|
|
531
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
532
|
+
/**
|
|
533
|
+
* The unique identifier for the element.
|
|
534
|
+
*/
|
|
535
|
+
id: z.ZodString;
|
|
536
|
+
/**
|
|
537
|
+
* The ID of the element group that the element belongs to.
|
|
538
|
+
* For elements that are not part of a group, this will be null.
|
|
539
|
+
*/
|
|
540
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
541
|
+
/**
|
|
542
|
+
* The color of the element in some CSS-like format.
|
|
543
|
+
*
|
|
544
|
+
* @example
|
|
545
|
+
* ```typescript
|
|
546
|
+
* "#ABC123";
|
|
547
|
+
* "rgb(255, 0, 0)";
|
|
548
|
+
* "hsl(200, 100%, 50%)";
|
|
549
|
+
* ```
|
|
550
|
+
*
|
|
551
|
+
* @default "#C93535"
|
|
552
|
+
*/
|
|
553
|
+
color: z.ZodString;
|
|
554
|
+
/**
|
|
555
|
+
* The element's name. For elements that can show a label or text on
|
|
556
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
557
|
+
*
|
|
558
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
559
|
+
* the element is selected by clicking on it.
|
|
560
|
+
*/
|
|
561
|
+
name: z.ZodNullable<z.ZodString>;
|
|
562
|
+
/**
|
|
563
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
564
|
+
* is selected.
|
|
565
|
+
*
|
|
566
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
567
|
+
* and Markers, so their description will not be shown.
|
|
568
|
+
*/
|
|
569
|
+
description: z.ZodNullable<z.ZodString>;
|
|
570
|
+
/**
|
|
571
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
572
|
+
*
|
|
573
|
+
* This is most useful for associating additional data with an element that is not
|
|
574
|
+
* part of the element's core data, such as a Place's address or some other
|
|
575
|
+
* data.
|
|
576
|
+
*/
|
|
577
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
578
|
+
/**
|
|
579
|
+
* Whether the element is interactive.
|
|
580
|
+
*
|
|
581
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
582
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
583
|
+
*
|
|
584
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
585
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
586
|
+
* accident.
|
|
587
|
+
*
|
|
588
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
589
|
+
* not editable and have special behaviour depending on their name, description and
|
|
590
|
+
* attributes.
|
|
591
|
+
*
|
|
592
|
+
* @default "default"
|
|
593
|
+
*/
|
|
594
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
595
|
+
}, {
|
|
596
|
+
/**
|
|
597
|
+
* The URL of an image that has been added to the element.
|
|
598
|
+
*/
|
|
599
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
600
|
+
}>, {
|
|
601
|
+
/**
|
|
602
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
603
|
+
*
|
|
604
|
+
* @default 1
|
|
605
|
+
*/
|
|
606
|
+
strokeOpacity: z.ZodNumber;
|
|
607
|
+
/**
|
|
608
|
+
* The width of the element's stroke in pixels.
|
|
609
|
+
*
|
|
610
|
+
* @default 2
|
|
611
|
+
*/
|
|
612
|
+
strokeWidth: z.ZodNumber;
|
|
613
|
+
/**
|
|
614
|
+
* The style of the element's stroke.
|
|
615
|
+
*
|
|
616
|
+
* @default "solid"
|
|
617
|
+
*/
|
|
618
|
+
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
619
|
+
}>, {
|
|
620
|
+
type: z.ZodLiteral<"Polygon">;
|
|
621
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
622
|
+
/**
|
|
623
|
+
* The opacity of the polygon's fill, between 0 and 1.
|
|
624
|
+
*
|
|
625
|
+
* @default 0.25
|
|
626
|
+
*/
|
|
627
|
+
fillOpacity: z.ZodNumber;
|
|
628
|
+
/**
|
|
629
|
+
* Whether to show an area marker on the polygon.
|
|
630
|
+
*
|
|
631
|
+
* @default false
|
|
632
|
+
*/
|
|
633
|
+
areaMarker: z.ZodBoolean;
|
|
634
|
+
}>, "type" | "coordinates">>, "id">, "strip", z.ZodTypeAny, {
|
|
125
635
|
type: "Polygon";
|
|
126
636
|
coordinates: [number, number][][];
|
|
127
637
|
groupId?: string | null | undefined;
|
|
@@ -152,28 +662,155 @@ declare const PolygonCreateSchema: z.ZodObject<Omit<{
|
|
|
152
662
|
fillOpacity?: number | undefined;
|
|
153
663
|
areaMarker?: boolean | undefined;
|
|
154
664
|
}>;
|
|
155
|
-
declare const CircleCreateSchema: z.ZodObject<Omit<{
|
|
156
|
-
type: z.ZodLiteral<"Circle">;
|
|
157
|
-
coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
665
|
+
declare const CircleCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
158
666
|
id: z.ZodOptional<z.ZodString>;
|
|
159
667
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
160
668
|
color: z.ZodOptional<z.ZodString>;
|
|
161
|
-
name: z.ZodOptional<z.
|
|
162
|
-
description: z.ZodOptional<z.
|
|
669
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
670
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
163
671
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
164
672
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
165
673
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
166
674
|
strokeOpacity: z.ZodOptional<z.ZodNumber>;
|
|
167
675
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
168
676
|
strokeStyle: z.ZodOptional<z.ZodEnum<["solid", "dashed", "dotted"]>>;
|
|
169
|
-
|
|
170
|
-
|
|
677
|
+
type: z.ZodOptional<z.ZodLiteral<"Circle">>;
|
|
678
|
+
center: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
679
|
+
radius: z.ZodOptional<z.ZodNumber>;
|
|
680
|
+
radiusMarker: z.ZodOptional<z.ZodBoolean>;
|
|
171
681
|
radiusDisplayAngle: z.ZodOptional<z.ZodNumber>;
|
|
172
682
|
radiusDisplayUnit: z.ZodOptional<z.ZodNullable<z.ZodEnum<["meter", "kilometer", "foot", "mile"]>>>;
|
|
173
|
-
|
|
174
|
-
},
|
|
683
|
+
fillOpacity: z.ZodOptional<z.ZodNumber>;
|
|
684
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
685
|
+
/**
|
|
686
|
+
* The unique identifier for the element.
|
|
687
|
+
*/
|
|
688
|
+
id: z.ZodString;
|
|
689
|
+
/**
|
|
690
|
+
* The ID of the element group that the element belongs to.
|
|
691
|
+
* For elements that are not part of a group, this will be null.
|
|
692
|
+
*/
|
|
693
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
694
|
+
/**
|
|
695
|
+
* The color of the element in some CSS-like format.
|
|
696
|
+
*
|
|
697
|
+
* @example
|
|
698
|
+
* ```typescript
|
|
699
|
+
* "#ABC123";
|
|
700
|
+
* "rgb(255, 0, 0)";
|
|
701
|
+
* "hsl(200, 100%, 50%)";
|
|
702
|
+
* ```
|
|
703
|
+
*
|
|
704
|
+
* @default "#C93535"
|
|
705
|
+
*/
|
|
706
|
+
color: z.ZodString;
|
|
707
|
+
/**
|
|
708
|
+
* The element's name. For elements that can show a label or text on
|
|
709
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
710
|
+
*
|
|
711
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
712
|
+
* the element is selected by clicking on it.
|
|
713
|
+
*/
|
|
714
|
+
name: z.ZodNullable<z.ZodString>;
|
|
715
|
+
/**
|
|
716
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
717
|
+
* is selected.
|
|
718
|
+
*
|
|
719
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
720
|
+
* and Markers, so their description will not be shown.
|
|
721
|
+
*/
|
|
722
|
+
description: z.ZodNullable<z.ZodString>;
|
|
723
|
+
/**
|
|
724
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
725
|
+
*
|
|
726
|
+
* This is most useful for associating additional data with an element that is not
|
|
727
|
+
* part of the element's core data, such as a Place's address or some other
|
|
728
|
+
* data.
|
|
729
|
+
*/
|
|
730
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
731
|
+
/**
|
|
732
|
+
* Whether the element is interactive.
|
|
733
|
+
*
|
|
734
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
735
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
736
|
+
*
|
|
737
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
738
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
739
|
+
* accident.
|
|
740
|
+
*
|
|
741
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
742
|
+
* not editable and have special behaviour depending on their name, description and
|
|
743
|
+
* attributes.
|
|
744
|
+
*
|
|
745
|
+
* @default "default"
|
|
746
|
+
*/
|
|
747
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
748
|
+
}, {
|
|
749
|
+
/**
|
|
750
|
+
* The URL of an image that has been added to the element.
|
|
751
|
+
*/
|
|
752
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
753
|
+
}>, {
|
|
754
|
+
/**
|
|
755
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
756
|
+
*
|
|
757
|
+
* @default 1
|
|
758
|
+
*/
|
|
759
|
+
strokeOpacity: z.ZodNumber;
|
|
760
|
+
/**
|
|
761
|
+
* The width of the element's stroke in pixels.
|
|
762
|
+
*
|
|
763
|
+
* @default 2
|
|
764
|
+
*/
|
|
765
|
+
strokeWidth: z.ZodNumber;
|
|
766
|
+
/**
|
|
767
|
+
* The style of the element's stroke.
|
|
768
|
+
*
|
|
769
|
+
* @default "solid"
|
|
770
|
+
*/
|
|
771
|
+
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
772
|
+
}>, {
|
|
773
|
+
type: z.ZodLiteral<"Circle">;
|
|
774
|
+
/**
|
|
775
|
+
* The center of the circle.
|
|
776
|
+
*/
|
|
777
|
+
center: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
778
|
+
/**
|
|
779
|
+
* The radius of the circle in meters.
|
|
780
|
+
*/
|
|
781
|
+
radius: z.ZodNumber;
|
|
782
|
+
/**
|
|
783
|
+
* Whether to show a marker on the circle that indicates the radius
|
|
784
|
+
*
|
|
785
|
+
* @default false
|
|
786
|
+
*/
|
|
787
|
+
radiusMarker: z.ZodBoolean;
|
|
788
|
+
/**
|
|
789
|
+
* The angle at which the control point for setting the radius is displayed,
|
|
790
|
+
* in degrees. When the `radiusMarker` is `true`, there is a dotted line rendered
|
|
791
|
+
* from the center of the circle to the control point, and the marker is shown
|
|
792
|
+
* at the midpoint of this line.
|
|
793
|
+
*
|
|
794
|
+
* @default 90
|
|
795
|
+
*/
|
|
796
|
+
radiusDisplayAngle: z.ZodNumber;
|
|
797
|
+
/**
|
|
798
|
+
* The unit of the radius used when the `radiusMarker` is `true`.
|
|
799
|
+
*
|
|
800
|
+
* A value of `null` means that the unit matches the user's locale.
|
|
801
|
+
*
|
|
802
|
+
* @default null
|
|
803
|
+
*/
|
|
804
|
+
radiusDisplayUnit: z.ZodNullable<z.ZodEnum<["meter", "kilometer", "foot", "mile"]>>;
|
|
805
|
+
/**
|
|
806
|
+
* The opacity of the circle's fill.
|
|
807
|
+
*
|
|
808
|
+
* @default 0.25
|
|
809
|
+
*/
|
|
810
|
+
fillOpacity: z.ZodNumber;
|
|
811
|
+
}>, "type" | "center" | "radius">>, "id">, "strip", z.ZodTypeAny, {
|
|
175
812
|
type: "Circle";
|
|
176
|
-
|
|
813
|
+
center: [number, number];
|
|
177
814
|
radius: number;
|
|
178
815
|
groupId?: string | null | undefined;
|
|
179
816
|
color?: string | undefined;
|
|
@@ -186,12 +823,12 @@ declare const CircleCreateSchema: z.ZodObject<Omit<{
|
|
|
186
823
|
strokeWidth?: number | undefined;
|
|
187
824
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
188
825
|
fillOpacity?: number | undefined;
|
|
826
|
+
radiusMarker?: boolean | undefined;
|
|
189
827
|
radiusDisplayAngle?: number | undefined;
|
|
190
828
|
radiusDisplayUnit?: "meter" | "kilometer" | "foot" | "mile" | null | undefined;
|
|
191
|
-
radiusMarker?: boolean | undefined;
|
|
192
829
|
}, {
|
|
193
830
|
type: "Circle";
|
|
194
|
-
|
|
831
|
+
center: [number, number];
|
|
195
832
|
radius: number;
|
|
196
833
|
groupId?: string | null | undefined;
|
|
197
834
|
color?: string | undefined;
|
|
@@ -204,24 +841,112 @@ declare const CircleCreateSchema: z.ZodObject<Omit<{
|
|
|
204
841
|
strokeWidth?: number | undefined;
|
|
205
842
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
206
843
|
fillOpacity?: number | undefined;
|
|
844
|
+
radiusMarker?: boolean | undefined;
|
|
207
845
|
radiusDisplayAngle?: number | undefined;
|
|
208
846
|
radiusDisplayUnit?: "meter" | "kilometer" | "foot" | "mile" | null | undefined;
|
|
209
|
-
radiusMarker?: boolean | undefined;
|
|
210
847
|
}>;
|
|
211
|
-
declare const MarkerCreateSchema: z.ZodObject<Omit<{
|
|
212
|
-
type: z.ZodLiteral<"Marker">;
|
|
213
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
848
|
+
declare const MarkerCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
214
849
|
id: z.ZodOptional<z.ZodString>;
|
|
215
850
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
216
851
|
color: z.ZodOptional<z.ZodString>;
|
|
217
|
-
name: z.ZodOptional<z.
|
|
218
|
-
description: z.ZodOptional<z.
|
|
852
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
853
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
219
854
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
220
855
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
856
|
+
type: z.ZodOptional<z.ZodLiteral<"Marker">>;
|
|
857
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
221
858
|
opacity: z.ZodOptional<z.ZodNumber>;
|
|
222
859
|
size: z.ZodOptional<z.ZodNumber>;
|
|
223
860
|
zoom: z.ZodOptional<z.ZodNumber>;
|
|
224
|
-
},
|
|
861
|
+
}, Pick<z.objectUtil.extendShape<{
|
|
862
|
+
/**
|
|
863
|
+
* The unique identifier for the element.
|
|
864
|
+
*/
|
|
865
|
+
id: z.ZodString;
|
|
866
|
+
/**
|
|
867
|
+
* The ID of the element group that the element belongs to.
|
|
868
|
+
* For elements that are not part of a group, this will be null.
|
|
869
|
+
*/
|
|
870
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
871
|
+
/**
|
|
872
|
+
* The color of the element in some CSS-like format.
|
|
873
|
+
*
|
|
874
|
+
* @example
|
|
875
|
+
* ```typescript
|
|
876
|
+
* "#ABC123";
|
|
877
|
+
* "rgb(255, 0, 0)";
|
|
878
|
+
* "hsl(200, 100%, 50%)";
|
|
879
|
+
* ```
|
|
880
|
+
*
|
|
881
|
+
* @default "#C93535"
|
|
882
|
+
*/
|
|
883
|
+
color: z.ZodString;
|
|
884
|
+
/**
|
|
885
|
+
* The element's name. For elements that can show a label or text on
|
|
886
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
887
|
+
*
|
|
888
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
889
|
+
* the element is selected by clicking on it.
|
|
890
|
+
*/
|
|
891
|
+
name: z.ZodNullable<z.ZodString>;
|
|
892
|
+
/**
|
|
893
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
894
|
+
* is selected.
|
|
895
|
+
*
|
|
896
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
897
|
+
* and Markers, so their description will not be shown.
|
|
898
|
+
*/
|
|
899
|
+
description: z.ZodNullable<z.ZodString>;
|
|
900
|
+
/**
|
|
901
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
902
|
+
*
|
|
903
|
+
* This is most useful for associating additional data with an element that is not
|
|
904
|
+
* part of the element's core data, such as a Place's address or some other
|
|
905
|
+
* data.
|
|
906
|
+
*/
|
|
907
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
908
|
+
/**
|
|
909
|
+
* Whether the element is interactive.
|
|
910
|
+
*
|
|
911
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
912
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
913
|
+
*
|
|
914
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
915
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
916
|
+
* accident.
|
|
917
|
+
*
|
|
918
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
919
|
+
* not editable and have special behaviour depending on their name, description and
|
|
920
|
+
* attributes.
|
|
921
|
+
*
|
|
922
|
+
* @default "default"
|
|
923
|
+
*/
|
|
924
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
925
|
+
}, {
|
|
926
|
+
type: z.ZodLiteral<"Marker">;
|
|
927
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
928
|
+
/**
|
|
929
|
+
* The opacity of the marker, between 0 and 1.
|
|
930
|
+
*
|
|
931
|
+
* @default 1
|
|
932
|
+
*/
|
|
933
|
+
opacity: z.ZodNumber;
|
|
934
|
+
/**
|
|
935
|
+
* The size of the marker, used in conjunction with the `zoom` to determine
|
|
936
|
+
* the actual size of the marker.
|
|
937
|
+
*
|
|
938
|
+
* @default 10
|
|
939
|
+
*/
|
|
940
|
+
size: z.ZodNumber;
|
|
941
|
+
/**
|
|
942
|
+
* The zoom level at which the marker was created. This is combined with
|
|
943
|
+
* the `size` to determine the actual size of the marker.
|
|
944
|
+
*
|
|
945
|
+
* When creating a marker, if you don't supply this value it defaults to
|
|
946
|
+
* the current zoom of the map when you call `createElement`.
|
|
947
|
+
*/
|
|
948
|
+
zoom: z.ZodNumber;
|
|
949
|
+
}>, "type" | "coordinates">>, "id">, "strip", z.ZodTypeAny, {
|
|
225
950
|
type: "Marker";
|
|
226
951
|
coordinates: [number, number][][];
|
|
227
952
|
groupId?: string | null | undefined;
|
|
@@ -246,20 +971,106 @@ declare const MarkerCreateSchema: z.ZodObject<Omit<{
|
|
|
246
971
|
size?: number | undefined;
|
|
247
972
|
zoom?: number | undefined;
|
|
248
973
|
}>;
|
|
249
|
-
declare const HighlighterCreateSchema: z.ZodObject<Omit<{
|
|
250
|
-
type: z.ZodLiteral<"Highlighter">;
|
|
251
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
974
|
+
declare const HighlighterCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
252
975
|
id: z.ZodOptional<z.ZodString>;
|
|
253
976
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
254
977
|
color: z.ZodOptional<z.ZodString>;
|
|
255
|
-
name: z.ZodOptional<z.
|
|
256
|
-
description: z.ZodOptional<z.
|
|
978
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
979
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
257
980
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
258
981
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
982
|
+
type: z.ZodOptional<z.ZodLiteral<"Highlighter">>;
|
|
983
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">, "many">>;
|
|
984
|
+
renderHoles: z.ZodOptional<z.ZodBoolean>;
|
|
259
985
|
opacity: z.ZodOptional<z.ZodNumber>;
|
|
260
|
-
},
|
|
986
|
+
}, Pick<z.objectUtil.extendShape<{
|
|
987
|
+
/**
|
|
988
|
+
* The unique identifier for the element.
|
|
989
|
+
*/
|
|
990
|
+
id: z.ZodString;
|
|
991
|
+
/**
|
|
992
|
+
* The ID of the element group that the element belongs to.
|
|
993
|
+
* For elements that are not part of a group, this will be null.
|
|
994
|
+
*/
|
|
995
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
996
|
+
/**
|
|
997
|
+
* The color of the element in some CSS-like format.
|
|
998
|
+
*
|
|
999
|
+
* @example
|
|
1000
|
+
* ```typescript
|
|
1001
|
+
* "#ABC123";
|
|
1002
|
+
* "rgb(255, 0, 0)";
|
|
1003
|
+
* "hsl(200, 100%, 50%)";
|
|
1004
|
+
* ```
|
|
1005
|
+
*
|
|
1006
|
+
* @default "#C93535"
|
|
1007
|
+
*/
|
|
1008
|
+
color: z.ZodString;
|
|
1009
|
+
/**
|
|
1010
|
+
* The element's name. For elements that can show a label or text on
|
|
1011
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1012
|
+
*
|
|
1013
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1014
|
+
* the element is selected by clicking on it.
|
|
1015
|
+
*/
|
|
1016
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1017
|
+
/**
|
|
1018
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1019
|
+
* is selected.
|
|
1020
|
+
*
|
|
1021
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1022
|
+
* and Markers, so their description will not be shown.
|
|
1023
|
+
*/
|
|
1024
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1025
|
+
/**
|
|
1026
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1027
|
+
*
|
|
1028
|
+
* This is most useful for associating additional data with an element that is not
|
|
1029
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1030
|
+
* data.
|
|
1031
|
+
*/
|
|
1032
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1033
|
+
/**
|
|
1034
|
+
* Whether the element is interactive.
|
|
1035
|
+
*
|
|
1036
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1037
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1038
|
+
*
|
|
1039
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1040
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1041
|
+
* accident.
|
|
1042
|
+
*
|
|
1043
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1044
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1045
|
+
* attributes.
|
|
1046
|
+
*
|
|
1047
|
+
* @default "default"
|
|
1048
|
+
*/
|
|
1049
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
1050
|
+
}, {
|
|
1051
|
+
type: z.ZodLiteral<"Highlighter">;
|
|
1052
|
+
/**
|
|
1053
|
+
* A multipolygon describing the area that is highlighted.
|
|
1054
|
+
*
|
|
1055
|
+
* If `renderHoles` is set to false, only the outer ring of each polygon
|
|
1056
|
+
* will be rendered, filling in the area inside the highlighted region.
|
|
1057
|
+
*/
|
|
1058
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">, "many">;
|
|
1059
|
+
/**
|
|
1060
|
+
* Whether to render the holes of the highlighted area.
|
|
1061
|
+
*
|
|
1062
|
+
* @default false
|
|
1063
|
+
*/
|
|
1064
|
+
renderHoles: z.ZodBoolean;
|
|
1065
|
+
/**
|
|
1066
|
+
* The opacity of the highlighter, between 0 and 1.
|
|
1067
|
+
*
|
|
1068
|
+
* @default 0.5
|
|
1069
|
+
*/
|
|
1070
|
+
opacity: z.ZodNumber;
|
|
1071
|
+
}>, "type" | "coordinates">>, "id">, "strip", z.ZodTypeAny, {
|
|
261
1072
|
type: "Highlighter";
|
|
262
|
-
coordinates: [number, number][][];
|
|
1073
|
+
coordinates: [number, number][][][];
|
|
263
1074
|
groupId?: string | null | undefined;
|
|
264
1075
|
color?: string | undefined;
|
|
265
1076
|
name?: string | null | undefined;
|
|
@@ -267,9 +1078,10 @@ declare const HighlighterCreateSchema: z.ZodObject<Omit<{
|
|
|
267
1078
|
attributes?: Record<string, unknown> | undefined;
|
|
268
1079
|
interaction?: "default" | "locked" | undefined;
|
|
269
1080
|
opacity?: number | undefined;
|
|
1081
|
+
renderHoles?: boolean | undefined;
|
|
270
1082
|
}, {
|
|
271
1083
|
type: "Highlighter";
|
|
272
|
-
coordinates: [number, number][][];
|
|
1084
|
+
coordinates: [number, number][][][];
|
|
273
1085
|
groupId?: string | null | undefined;
|
|
274
1086
|
color?: string | undefined;
|
|
275
1087
|
name?: string | null | undefined;
|
|
@@ -277,25 +1089,29 @@ declare const HighlighterCreateSchema: z.ZodObject<Omit<{
|
|
|
277
1089
|
attributes?: Record<string, unknown> | undefined;
|
|
278
1090
|
interaction?: "default" | "locked" | undefined;
|
|
279
1091
|
opacity?: number | undefined;
|
|
1092
|
+
renderHoles?: boolean | undefined;
|
|
280
1093
|
}>;
|
|
281
|
-
declare const TextCreateSchema: z.ZodObject<
|
|
282
|
-
type: z.ZodLiteral<"Text">;
|
|
283
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1094
|
+
declare const TextCreateSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
284
1095
|
id: z.ZodOptional<z.ZodString>;
|
|
285
1096
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
286
1097
|
color: z.ZodOptional<z.ZodString>;
|
|
287
|
-
|
|
288
|
-
description: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
|
|
1098
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
289
1099
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
290
1100
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
291
|
-
zoom: z.ZodOptional<z.ZodNumber>;
|
|
292
1101
|
position: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
293
1102
|
rotation: z.ZodOptional<z.ZodNumber>;
|
|
294
1103
|
scale: z.ZodOptional<z.ZodNumber>;
|
|
295
|
-
|
|
1104
|
+
zoom: z.ZodOptional<z.ZodNumber>;
|
|
1105
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1106
|
+
text: z.ZodOptional<z.ZodString>;
|
|
296
1107
|
align: z.ZodOptional<z.ZodEnum<["left", "center", "right"]>>;
|
|
297
1108
|
style: z.ZodOptional<z.ZodEnum<["italic", "light", "regular", "caps"]>>;
|
|
298
|
-
|
|
1109
|
+
name: z.ZodOptional<z.ZodString>;
|
|
1110
|
+
type: z.ZodOptional<z.ZodLiteral<"Text">>;
|
|
1111
|
+
}, "type" | "coordinates" | "id" | "name">, {
|
|
1112
|
+
type: z.ZodLiteral<"Text">;
|
|
1113
|
+
text: z.ZodString;
|
|
1114
|
+
}>, "strip", z.ZodTypeAny, {
|
|
299
1115
|
type: "Text";
|
|
300
1116
|
text: string;
|
|
301
1117
|
groupId?: string | null | undefined;
|
|
@@ -307,7 +1123,7 @@ declare const TextCreateSchema: z.ZodObject<Omit<Omit<{
|
|
|
307
1123
|
position?: [number, number] | undefined;
|
|
308
1124
|
rotation?: number | undefined;
|
|
309
1125
|
scale?: number | undefined;
|
|
310
|
-
align?: "
|
|
1126
|
+
align?: "center" | "left" | "right" | undefined;
|
|
311
1127
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
312
1128
|
}, {
|
|
313
1129
|
type: "Text";
|
|
@@ -321,28 +1137,31 @@ declare const TextCreateSchema: z.ZodObject<Omit<Omit<{
|
|
|
321
1137
|
position?: [number, number] | undefined;
|
|
322
1138
|
rotation?: number | undefined;
|
|
323
1139
|
scale?: number | undefined;
|
|
324
|
-
align?: "
|
|
1140
|
+
align?: "center" | "left" | "right" | undefined;
|
|
325
1141
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
326
1142
|
}>;
|
|
327
|
-
declare const NoteCreateSchema: z.ZodObject<
|
|
328
|
-
type: z.ZodLiteral<"Note">;
|
|
329
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1143
|
+
declare const NoteCreateSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
330
1144
|
id: z.ZodOptional<z.ZodString>;
|
|
331
1145
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
332
1146
|
color: z.ZodOptional<z.ZodString>;
|
|
333
|
-
|
|
334
|
-
description: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
|
|
1147
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
335
1148
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
336
1149
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
337
|
-
zoom: z.ZodOptional<z.ZodNumber>;
|
|
338
1150
|
position: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
339
1151
|
rotation: z.ZodOptional<z.ZodNumber>;
|
|
340
1152
|
scale: z.ZodOptional<z.ZodNumber>;
|
|
341
|
-
|
|
1153
|
+
zoom: z.ZodOptional<z.ZodNumber>;
|
|
1154
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1155
|
+
text: z.ZodOptional<z.ZodString>;
|
|
342
1156
|
align: z.ZodOptional<z.ZodEnum<["left", "center", "right"]>>;
|
|
343
1157
|
style: z.ZodOptional<z.ZodEnum<["italic", "light", "regular", "caps"]>>;
|
|
1158
|
+
name: z.ZodOptional<z.ZodString>;
|
|
1159
|
+
type: z.ZodOptional<z.ZodLiteral<"Note">>;
|
|
344
1160
|
widthScale: z.ZodOptional<z.ZodNumber>;
|
|
345
|
-
}, "
|
|
1161
|
+
}, "type" | "coordinates" | "id" | "name">, {
|
|
1162
|
+
type: z.ZodLiteral<"Note">;
|
|
1163
|
+
text: z.ZodString;
|
|
1164
|
+
}>, "strip", z.ZodTypeAny, {
|
|
346
1165
|
type: "Note";
|
|
347
1166
|
text: string;
|
|
348
1167
|
groupId?: string | null | undefined;
|
|
@@ -354,7 +1173,7 @@ declare const NoteCreateSchema: z.ZodObject<Omit<Omit<{
|
|
|
354
1173
|
position?: [number, number] | undefined;
|
|
355
1174
|
rotation?: number | undefined;
|
|
356
1175
|
scale?: number | undefined;
|
|
357
|
-
align?: "
|
|
1176
|
+
align?: "center" | "left" | "right" | undefined;
|
|
358
1177
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
359
1178
|
widthScale?: number | undefined;
|
|
360
1179
|
}, {
|
|
@@ -369,22 +1188,99 @@ declare const NoteCreateSchema: z.ZodObject<Omit<Omit<{
|
|
|
369
1188
|
position?: [number, number] | undefined;
|
|
370
1189
|
rotation?: number | undefined;
|
|
371
1190
|
scale?: number | undefined;
|
|
372
|
-
align?: "
|
|
1191
|
+
align?: "center" | "left" | "right" | undefined;
|
|
373
1192
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
374
1193
|
widthScale?: number | undefined;
|
|
375
1194
|
}>;
|
|
376
|
-
declare const ImageCreateSchema: z.ZodObject<Omit<{
|
|
377
|
-
type: z.ZodLiteral<"Image"
|
|
378
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many"
|
|
1195
|
+
declare const ImageCreateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
1196
|
+
type: z.ZodOptional<z.ZodLiteral<"Image">>;
|
|
1197
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
379
1198
|
id: z.ZodOptional<z.ZodString>;
|
|
380
1199
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
381
|
-
name: z.ZodOptional<z.
|
|
382
|
-
description: z.ZodOptional<z.
|
|
1200
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1201
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
383
1202
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
384
1203
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
385
|
-
imageUrl: z.ZodString
|
|
1204
|
+
imageUrl: z.ZodOptional<z.ZodString>;
|
|
386
1205
|
opacity: z.ZodOptional<z.ZodNumber>;
|
|
387
|
-
},
|
|
1206
|
+
}, Pick<Omit<z.objectUtil.extendShape<{
|
|
1207
|
+
/**
|
|
1208
|
+
* The unique identifier for the element.
|
|
1209
|
+
*/
|
|
1210
|
+
id: z.ZodString;
|
|
1211
|
+
/**
|
|
1212
|
+
* The ID of the element group that the element belongs to.
|
|
1213
|
+
* For elements that are not part of a group, this will be null.
|
|
1214
|
+
*/
|
|
1215
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
1216
|
+
/**
|
|
1217
|
+
* The color of the element in some CSS-like format.
|
|
1218
|
+
*
|
|
1219
|
+
* @example
|
|
1220
|
+
* ```typescript
|
|
1221
|
+
* "#ABC123";
|
|
1222
|
+
* "rgb(255, 0, 0)";
|
|
1223
|
+
* "hsl(200, 100%, 50%)";
|
|
1224
|
+
* ```
|
|
1225
|
+
*
|
|
1226
|
+
* @default "#C93535"
|
|
1227
|
+
*/
|
|
1228
|
+
color: z.ZodString;
|
|
1229
|
+
/**
|
|
1230
|
+
* The element's name. For elements that can show a label or text on
|
|
1231
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1232
|
+
*
|
|
1233
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1234
|
+
* the element is selected by clicking on it.
|
|
1235
|
+
*/
|
|
1236
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1237
|
+
/**
|
|
1238
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1239
|
+
* is selected.
|
|
1240
|
+
*
|
|
1241
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1242
|
+
* and Markers, so their description will not be shown.
|
|
1243
|
+
*/
|
|
1244
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1245
|
+
/**
|
|
1246
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1247
|
+
*
|
|
1248
|
+
* This is most useful for associating additional data with an element that is not
|
|
1249
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1250
|
+
* data.
|
|
1251
|
+
*/
|
|
1252
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1253
|
+
/**
|
|
1254
|
+
* Whether the element is interactive.
|
|
1255
|
+
*
|
|
1256
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1257
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1258
|
+
*
|
|
1259
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1260
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1261
|
+
* accident.
|
|
1262
|
+
*
|
|
1263
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1264
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1265
|
+
* attributes.
|
|
1266
|
+
*
|
|
1267
|
+
* @default "default"
|
|
1268
|
+
*/
|
|
1269
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
1270
|
+
}, {
|
|
1271
|
+
type: z.ZodLiteral<"Image">;
|
|
1272
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1273
|
+
/**
|
|
1274
|
+
* The URL of the image that is rendered in this element
|
|
1275
|
+
*/
|
|
1276
|
+
imageUrl: z.ZodString;
|
|
1277
|
+
/**
|
|
1278
|
+
* The opacity of the image, between 0 and 1.
|
|
1279
|
+
*
|
|
1280
|
+
* @default 1
|
|
1281
|
+
*/
|
|
1282
|
+
opacity: z.ZodNumber;
|
|
1283
|
+
}>, "color">, "type" | "coordinates" | "imageUrl">>, "id">, "strip", z.ZodTypeAny, {
|
|
388
1284
|
type: "Image";
|
|
389
1285
|
coordinates: [number, number][][];
|
|
390
1286
|
imageUrl: string;
|
|
@@ -406,20 +1302,103 @@ declare const ImageCreateSchema: z.ZodObject<Omit<{
|
|
|
406
1302
|
opacity?: number | undefined;
|
|
407
1303
|
}>;
|
|
408
1304
|
declare const PlaceReadSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
1305
|
+
/**
|
|
1306
|
+
* The unique identifier for the element.
|
|
1307
|
+
*/
|
|
409
1308
|
id: z.ZodString;
|
|
1309
|
+
/**
|
|
1310
|
+
* The ID of the element group that the element belongs to.
|
|
1311
|
+
* For elements that are not part of a group, this will be null.
|
|
1312
|
+
*/
|
|
410
1313
|
groupId: z.ZodNullable<z.ZodString>;
|
|
1314
|
+
/**
|
|
1315
|
+
* The color of the element in some CSS-like format.
|
|
1316
|
+
*
|
|
1317
|
+
* @example
|
|
1318
|
+
* ```typescript
|
|
1319
|
+
* "#ABC123";
|
|
1320
|
+
* "rgb(255, 0, 0)";
|
|
1321
|
+
* "hsl(200, 100%, 50%)";
|
|
1322
|
+
* ```
|
|
1323
|
+
*
|
|
1324
|
+
* @default "#C93535"
|
|
1325
|
+
*/
|
|
411
1326
|
color: z.ZodString;
|
|
412
|
-
|
|
413
|
-
|
|
1327
|
+
/**
|
|
1328
|
+
* The element's name. For elements that can show a label or text on
|
|
1329
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1330
|
+
*
|
|
1331
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1332
|
+
* the element is selected by clicking on it.
|
|
1333
|
+
*/
|
|
1334
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1335
|
+
/**
|
|
1336
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1337
|
+
* is selected.
|
|
1338
|
+
*
|
|
1339
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1340
|
+
* and Markers, so their description will not be shown.
|
|
1341
|
+
*/
|
|
1342
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1343
|
+
/**
|
|
1344
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1345
|
+
*
|
|
1346
|
+
* This is most useful for associating additional data with an element that is not
|
|
1347
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1348
|
+
* data.
|
|
1349
|
+
*/
|
|
414
1350
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1351
|
+
/**
|
|
1352
|
+
* Whether the element is interactive.
|
|
1353
|
+
*
|
|
1354
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1355
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1356
|
+
*
|
|
1357
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1358
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1359
|
+
* accident.
|
|
1360
|
+
*
|
|
1361
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1362
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1363
|
+
* attributes.
|
|
1364
|
+
*
|
|
1365
|
+
* @default "default"
|
|
1366
|
+
*/
|
|
415
1367
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
416
1368
|
}, {
|
|
1369
|
+
/**
|
|
1370
|
+
* The URL of an image that has been added to the element.
|
|
1371
|
+
*/
|
|
417
1372
|
imageUrl: z.ZodNullable<z.ZodString>;
|
|
418
1373
|
}>, {
|
|
419
1374
|
type: z.ZodLiteral<"Place">;
|
|
420
1375
|
coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
1376
|
+
/**
|
|
1377
|
+
* The symbol that is rendered for the Place.
|
|
1378
|
+
*
|
|
1379
|
+
* This can be an emoji by using colon-enclosed characters (e.g. `":smiley:"`)
|
|
1380
|
+
* or one of the symbols available in Felt's symbol library.
|
|
1381
|
+
*
|
|
1382
|
+
* You can see the available symbols in the Felt UI when editing a Place
|
|
1383
|
+
* by hovering a symbol and converting the tooltip to kebab-case. For example,
|
|
1384
|
+
* the "Oil barrel" symbol is `oil-barrel`.
|
|
1385
|
+
*/
|
|
421
1386
|
symbol: z.ZodString;
|
|
1387
|
+
/**
|
|
1388
|
+
* The frame that is rendered around the Place's symbol. This is
|
|
1389
|
+
* only available for non-emoji symbols.
|
|
1390
|
+
*/
|
|
422
1391
|
frame: z.ZodNullable<z.ZodEnum<["frame-circle", "frame-square"]>>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Whether the element's label is hidden on the map. This allows you
|
|
1394
|
+
* to add a name to the element and can show in popups, but not have
|
|
1395
|
+
* it visible on the map.
|
|
1396
|
+
*
|
|
1397
|
+
* This will also hide the faint placeholder label that is shown when
|
|
1398
|
+
* an editable Place is selected.
|
|
1399
|
+
*
|
|
1400
|
+
* @default false
|
|
1401
|
+
*/
|
|
423
1402
|
hideLabel: z.ZodBoolean;
|
|
424
1403
|
}>, "strip", z.ZodTypeAny, {
|
|
425
1404
|
symbol: string;
|
|
@@ -451,25 +1430,119 @@ declare const PlaceReadSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil
|
|
|
451
1430
|
interaction?: "default" | "locked" | undefined;
|
|
452
1431
|
}>;
|
|
453
1432
|
declare const PathReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
1433
|
+
/**
|
|
1434
|
+
* The unique identifier for the element.
|
|
1435
|
+
*/
|
|
454
1436
|
id: z.ZodString;
|
|
1437
|
+
/**
|
|
1438
|
+
* The ID of the element group that the element belongs to.
|
|
1439
|
+
* For elements that are not part of a group, this will be null.
|
|
1440
|
+
*/
|
|
455
1441
|
groupId: z.ZodNullable<z.ZodString>;
|
|
1442
|
+
/**
|
|
1443
|
+
* The color of the element in some CSS-like format.
|
|
1444
|
+
*
|
|
1445
|
+
* @example
|
|
1446
|
+
* ```typescript
|
|
1447
|
+
* "#ABC123";
|
|
1448
|
+
* "rgb(255, 0, 0)";
|
|
1449
|
+
* "hsl(200, 100%, 50%)";
|
|
1450
|
+
* ```
|
|
1451
|
+
*
|
|
1452
|
+
* @default "#C93535"
|
|
1453
|
+
*/
|
|
456
1454
|
color: z.ZodString;
|
|
457
|
-
|
|
458
|
-
|
|
1455
|
+
/**
|
|
1456
|
+
* The element's name. For elements that can show a label or text on
|
|
1457
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1458
|
+
*
|
|
1459
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1460
|
+
* the element is selected by clicking on it.
|
|
1461
|
+
*/
|
|
1462
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1463
|
+
/**
|
|
1464
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1465
|
+
* is selected.
|
|
1466
|
+
*
|
|
1467
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1468
|
+
* and Markers, so their description will not be shown.
|
|
1469
|
+
*/
|
|
1470
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1471
|
+
/**
|
|
1472
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1473
|
+
*
|
|
1474
|
+
* This is most useful for associating additional data with an element that is not
|
|
1475
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1476
|
+
* data.
|
|
1477
|
+
*/
|
|
459
1478
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1479
|
+
/**
|
|
1480
|
+
* Whether the element is interactive.
|
|
1481
|
+
*
|
|
1482
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1483
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1484
|
+
*
|
|
1485
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1486
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1487
|
+
* accident.
|
|
1488
|
+
*
|
|
1489
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1490
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1491
|
+
* attributes.
|
|
1492
|
+
*
|
|
1493
|
+
* @default "default"
|
|
1494
|
+
*/
|
|
460
1495
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
461
1496
|
}, {
|
|
1497
|
+
/**
|
|
1498
|
+
* The URL of an image that has been added to the element.
|
|
1499
|
+
*/
|
|
462
1500
|
imageUrl: z.ZodNullable<z.ZodString>;
|
|
463
1501
|
}>, {
|
|
1502
|
+
/**
|
|
1503
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
1504
|
+
*
|
|
1505
|
+
* @default 1
|
|
1506
|
+
*/
|
|
464
1507
|
strokeOpacity: z.ZodNumber;
|
|
1508
|
+
/**
|
|
1509
|
+
* The width of the element's stroke in pixels.
|
|
1510
|
+
*
|
|
1511
|
+
* @default 2
|
|
1512
|
+
*/
|
|
465
1513
|
strokeWidth: z.ZodNumber;
|
|
1514
|
+
/**
|
|
1515
|
+
* The style of the element's stroke.
|
|
1516
|
+
*
|
|
1517
|
+
* @default "solid"
|
|
1518
|
+
*/
|
|
466
1519
|
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
467
1520
|
}>, {
|
|
468
1521
|
type: z.ZodLiteral<"Path">;
|
|
469
1522
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1523
|
+
/**
|
|
1524
|
+
* Whether a distance marker is shown at the midpoint of the path.
|
|
1525
|
+
*
|
|
1526
|
+
* @default false
|
|
1527
|
+
*/
|
|
470
1528
|
distanceMarker: z.ZodBoolean;
|
|
471
|
-
|
|
1529
|
+
/**
|
|
1530
|
+
* Whether this represents a route, and if so, what mode of transport
|
|
1531
|
+
* is used.
|
|
1532
|
+
*
|
|
1533
|
+
* If this is `null`, the path is not considered to be a route, so while it
|
|
1534
|
+
* can have a `distanceMarker`, it will does not have a start or end cap.
|
|
1535
|
+
*
|
|
1536
|
+
* @default null
|
|
1537
|
+
*/
|
|
472
1538
|
routingMode: z.ZodNullable<z.ZodEnum<["driving", "cycling", "walking", "flying"]>>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Whether or not to show Start and End caps on the path. This is
|
|
1541
|
+
* only available if the `routingMode` is set.
|
|
1542
|
+
*
|
|
1543
|
+
* @default false
|
|
1544
|
+
*/
|
|
1545
|
+
endCaps: z.ZodBoolean;
|
|
473
1546
|
}>, "coordinates">, "strip", z.ZodTypeAny, {
|
|
474
1547
|
type: "Path";
|
|
475
1548
|
id: string;
|
|
@@ -483,8 +1556,8 @@ declare const PathReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
483
1556
|
strokeWidth: number;
|
|
484
1557
|
strokeStyle: "solid" | "dashed" | "dotted";
|
|
485
1558
|
distanceMarker: boolean;
|
|
486
|
-
endCaps: boolean;
|
|
487
1559
|
routingMode: "driving" | "cycling" | "walking" | "flying" | null;
|
|
1560
|
+
endCaps: boolean;
|
|
488
1561
|
interaction?: "default" | "locked" | undefined;
|
|
489
1562
|
}, {
|
|
490
1563
|
type: "Path";
|
|
@@ -499,28 +1572,112 @@ declare const PathReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
499
1572
|
strokeWidth: number;
|
|
500
1573
|
strokeStyle: "solid" | "dashed" | "dotted";
|
|
501
1574
|
distanceMarker: boolean;
|
|
502
|
-
endCaps: boolean;
|
|
503
1575
|
routingMode: "driving" | "cycling" | "walking" | "flying" | null;
|
|
1576
|
+
endCaps: boolean;
|
|
504
1577
|
interaction?: "default" | "locked" | undefined;
|
|
505
1578
|
}>;
|
|
506
1579
|
declare const PolygonReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
1580
|
+
/**
|
|
1581
|
+
* The unique identifier for the element.
|
|
1582
|
+
*/
|
|
507
1583
|
id: z.ZodString;
|
|
1584
|
+
/**
|
|
1585
|
+
* The ID of the element group that the element belongs to.
|
|
1586
|
+
* For elements that are not part of a group, this will be null.
|
|
1587
|
+
*/
|
|
508
1588
|
groupId: z.ZodNullable<z.ZodString>;
|
|
1589
|
+
/**
|
|
1590
|
+
* The color of the element in some CSS-like format.
|
|
1591
|
+
*
|
|
1592
|
+
* @example
|
|
1593
|
+
* ```typescript
|
|
1594
|
+
* "#ABC123";
|
|
1595
|
+
* "rgb(255, 0, 0)";
|
|
1596
|
+
* "hsl(200, 100%, 50%)";
|
|
1597
|
+
* ```
|
|
1598
|
+
*
|
|
1599
|
+
* @default "#C93535"
|
|
1600
|
+
*/
|
|
509
1601
|
color: z.ZodString;
|
|
510
|
-
|
|
511
|
-
|
|
1602
|
+
/**
|
|
1603
|
+
* The element's name. For elements that can show a label or text on
|
|
1604
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1605
|
+
*
|
|
1606
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1607
|
+
* the element is selected by clicking on it.
|
|
1608
|
+
*/
|
|
1609
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1610
|
+
/**
|
|
1611
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1612
|
+
* is selected.
|
|
1613
|
+
*
|
|
1614
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1615
|
+
* and Markers, so their description will not be shown.
|
|
1616
|
+
*/
|
|
1617
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1618
|
+
/**
|
|
1619
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1620
|
+
*
|
|
1621
|
+
* This is most useful for associating additional data with an element that is not
|
|
1622
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1623
|
+
* data.
|
|
1624
|
+
*/
|
|
512
1625
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1626
|
+
/**
|
|
1627
|
+
* Whether the element is interactive.
|
|
1628
|
+
*
|
|
1629
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1630
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1631
|
+
*
|
|
1632
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1633
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1634
|
+
* accident.
|
|
1635
|
+
*
|
|
1636
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1637
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1638
|
+
* attributes.
|
|
1639
|
+
*
|
|
1640
|
+
* @default "default"
|
|
1641
|
+
*/
|
|
513
1642
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
514
1643
|
}, {
|
|
1644
|
+
/**
|
|
1645
|
+
* The URL of an image that has been added to the element.
|
|
1646
|
+
*/
|
|
515
1647
|
imageUrl: z.ZodNullable<z.ZodString>;
|
|
516
1648
|
}>, {
|
|
1649
|
+
/**
|
|
1650
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
1651
|
+
*
|
|
1652
|
+
* @default 1
|
|
1653
|
+
*/
|
|
517
1654
|
strokeOpacity: z.ZodNumber;
|
|
1655
|
+
/**
|
|
1656
|
+
* The width of the element's stroke in pixels.
|
|
1657
|
+
*
|
|
1658
|
+
* @default 2
|
|
1659
|
+
*/
|
|
518
1660
|
strokeWidth: z.ZodNumber;
|
|
1661
|
+
/**
|
|
1662
|
+
* The style of the element's stroke.
|
|
1663
|
+
*
|
|
1664
|
+
* @default "solid"
|
|
1665
|
+
*/
|
|
519
1666
|
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
520
1667
|
}>, {
|
|
521
1668
|
type: z.ZodLiteral<"Polygon">;
|
|
522
1669
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1670
|
+
/**
|
|
1671
|
+
* The opacity of the polygon's fill, between 0 and 1.
|
|
1672
|
+
*
|
|
1673
|
+
* @default 0.25
|
|
1674
|
+
*/
|
|
523
1675
|
fillOpacity: z.ZodNumber;
|
|
1676
|
+
/**
|
|
1677
|
+
* Whether to show an area marker on the polygon.
|
|
1678
|
+
*
|
|
1679
|
+
* @default false
|
|
1680
|
+
*/
|
|
524
1681
|
areaMarker: z.ZodBoolean;
|
|
525
1682
|
}>, "coordinates">, "strip", z.ZodTypeAny, {
|
|
526
1683
|
type: "Polygon";
|
|
@@ -554,30 +1711,134 @@ declare const PolygonReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.obj
|
|
|
554
1711
|
interaction?: "default" | "locked" | undefined;
|
|
555
1712
|
}>;
|
|
556
1713
|
declare const CircleReadSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
1714
|
+
/**
|
|
1715
|
+
* The unique identifier for the element.
|
|
1716
|
+
*/
|
|
557
1717
|
id: z.ZodString;
|
|
1718
|
+
/**
|
|
1719
|
+
* The ID of the element group that the element belongs to.
|
|
1720
|
+
* For elements that are not part of a group, this will be null.
|
|
1721
|
+
*/
|
|
558
1722
|
groupId: z.ZodNullable<z.ZodString>;
|
|
1723
|
+
/**
|
|
1724
|
+
* The color of the element in some CSS-like format.
|
|
1725
|
+
*
|
|
1726
|
+
* @example
|
|
1727
|
+
* ```typescript
|
|
1728
|
+
* "#ABC123";
|
|
1729
|
+
* "rgb(255, 0, 0)";
|
|
1730
|
+
* "hsl(200, 100%, 50%)";
|
|
1731
|
+
* ```
|
|
1732
|
+
*
|
|
1733
|
+
* @default "#C93535"
|
|
1734
|
+
*/
|
|
559
1735
|
color: z.ZodString;
|
|
560
|
-
|
|
561
|
-
|
|
1736
|
+
/**
|
|
1737
|
+
* The element's name. For elements that can show a label or text on
|
|
1738
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1739
|
+
*
|
|
1740
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1741
|
+
* the element is selected by clicking on it.
|
|
1742
|
+
*/
|
|
1743
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1744
|
+
/**
|
|
1745
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1746
|
+
* is selected.
|
|
1747
|
+
*
|
|
1748
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1749
|
+
* and Markers, so their description will not be shown.
|
|
1750
|
+
*/
|
|
1751
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1752
|
+
/**
|
|
1753
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1754
|
+
*
|
|
1755
|
+
* This is most useful for associating additional data with an element that is not
|
|
1756
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1757
|
+
* data.
|
|
1758
|
+
*/
|
|
562
1759
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1760
|
+
/**
|
|
1761
|
+
* Whether the element is interactive.
|
|
1762
|
+
*
|
|
1763
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1764
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1765
|
+
*
|
|
1766
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1767
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1768
|
+
* accident.
|
|
1769
|
+
*
|
|
1770
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1771
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1772
|
+
* attributes.
|
|
1773
|
+
*
|
|
1774
|
+
* @default "default"
|
|
1775
|
+
*/
|
|
563
1776
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
564
1777
|
}, {
|
|
1778
|
+
/**
|
|
1779
|
+
* The URL of an image that has been added to the element.
|
|
1780
|
+
*/
|
|
565
1781
|
imageUrl: z.ZodNullable<z.ZodString>;
|
|
566
1782
|
}>, {
|
|
1783
|
+
/**
|
|
1784
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
1785
|
+
*
|
|
1786
|
+
* @default 1
|
|
1787
|
+
*/
|
|
567
1788
|
strokeOpacity: z.ZodNumber;
|
|
1789
|
+
/**
|
|
1790
|
+
* The width of the element's stroke in pixels.
|
|
1791
|
+
*
|
|
1792
|
+
* @default 2
|
|
1793
|
+
*/
|
|
568
1794
|
strokeWidth: z.ZodNumber;
|
|
1795
|
+
/**
|
|
1796
|
+
* The style of the element's stroke.
|
|
1797
|
+
*
|
|
1798
|
+
* @default "solid"
|
|
1799
|
+
*/
|
|
569
1800
|
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
570
1801
|
}>, {
|
|
571
1802
|
type: z.ZodLiteral<"Circle">;
|
|
572
|
-
|
|
1803
|
+
/**
|
|
1804
|
+
* The center of the circle.
|
|
1805
|
+
*/
|
|
1806
|
+
center: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
1807
|
+
/**
|
|
1808
|
+
* The radius of the circle in meters.
|
|
1809
|
+
*/
|
|
573
1810
|
radius: z.ZodNumber;
|
|
1811
|
+
/**
|
|
1812
|
+
* Whether to show a marker on the circle that indicates the radius
|
|
1813
|
+
*
|
|
1814
|
+
* @default false
|
|
1815
|
+
*/
|
|
1816
|
+
radiusMarker: z.ZodBoolean;
|
|
1817
|
+
/**
|
|
1818
|
+
* The angle at which the control point for setting the radius is displayed,
|
|
1819
|
+
* in degrees. When the `radiusMarker` is `true`, there is a dotted line rendered
|
|
1820
|
+
* from the center of the circle to the control point, and the marker is shown
|
|
1821
|
+
* at the midpoint of this line.
|
|
1822
|
+
*
|
|
1823
|
+
* @default 90
|
|
1824
|
+
*/
|
|
574
1825
|
radiusDisplayAngle: z.ZodNumber;
|
|
1826
|
+
/**
|
|
1827
|
+
* The unit of the radius used when the `radiusMarker` is `true`.
|
|
1828
|
+
*
|
|
1829
|
+
* A value of `null` means that the unit matches the user's locale.
|
|
1830
|
+
*
|
|
1831
|
+
* @default null
|
|
1832
|
+
*/
|
|
575
1833
|
radiusDisplayUnit: z.ZodNullable<z.ZodEnum<["meter", "kilometer", "foot", "mile"]>>;
|
|
1834
|
+
/**
|
|
1835
|
+
* The opacity of the circle's fill.
|
|
1836
|
+
*
|
|
1837
|
+
* @default 0.25
|
|
1838
|
+
*/
|
|
576
1839
|
fillOpacity: z.ZodNumber;
|
|
577
|
-
radiusMarker: z.ZodBoolean;
|
|
578
1840
|
}>, "strip", z.ZodTypeAny, {
|
|
579
1841
|
type: "Circle";
|
|
580
|
-
coordinates: [number, number];
|
|
581
1842
|
id: string;
|
|
582
1843
|
groupId: string | null;
|
|
583
1844
|
color: string;
|
|
@@ -589,14 +1850,14 @@ declare const CircleReadSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
589
1850
|
strokeWidth: number;
|
|
590
1851
|
strokeStyle: "solid" | "dashed" | "dotted";
|
|
591
1852
|
fillOpacity: number;
|
|
1853
|
+
center: [number, number];
|
|
592
1854
|
radius: number;
|
|
1855
|
+
radiusMarker: boolean;
|
|
593
1856
|
radiusDisplayAngle: number;
|
|
594
1857
|
radiusDisplayUnit: "meter" | "kilometer" | "foot" | "mile" | null;
|
|
595
|
-
radiusMarker: boolean;
|
|
596
1858
|
interaction?: "default" | "locked" | undefined;
|
|
597
1859
|
}, {
|
|
598
1860
|
type: "Circle";
|
|
599
|
-
coordinates: [number, number];
|
|
600
1861
|
id: string;
|
|
601
1862
|
groupId: string | null;
|
|
602
1863
|
color: string;
|
|
@@ -608,25 +1869,100 @@ declare const CircleReadSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
608
1869
|
strokeWidth: number;
|
|
609
1870
|
strokeStyle: "solid" | "dashed" | "dotted";
|
|
610
1871
|
fillOpacity: number;
|
|
1872
|
+
center: [number, number];
|
|
611
1873
|
radius: number;
|
|
1874
|
+
radiusMarker: boolean;
|
|
612
1875
|
radiusDisplayAngle: number;
|
|
613
1876
|
radiusDisplayUnit: "meter" | "kilometer" | "foot" | "mile" | null;
|
|
614
|
-
radiusMarker: boolean;
|
|
615
1877
|
interaction?: "default" | "locked" | undefined;
|
|
616
1878
|
}>;
|
|
617
1879
|
declare const MarkerReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
1880
|
+
/**
|
|
1881
|
+
* The unique identifier for the element.
|
|
1882
|
+
*/
|
|
618
1883
|
id: z.ZodString;
|
|
1884
|
+
/**
|
|
1885
|
+
* The ID of the element group that the element belongs to.
|
|
1886
|
+
* For elements that are not part of a group, this will be null.
|
|
1887
|
+
*/
|
|
619
1888
|
groupId: z.ZodNullable<z.ZodString>;
|
|
1889
|
+
/**
|
|
1890
|
+
* The color of the element in some CSS-like format.
|
|
1891
|
+
*
|
|
1892
|
+
* @example
|
|
1893
|
+
* ```typescript
|
|
1894
|
+
* "#ABC123";
|
|
1895
|
+
* "rgb(255, 0, 0)";
|
|
1896
|
+
* "hsl(200, 100%, 50%)";
|
|
1897
|
+
* ```
|
|
1898
|
+
*
|
|
1899
|
+
* @default "#C93535"
|
|
1900
|
+
*/
|
|
620
1901
|
color: z.ZodString;
|
|
621
|
-
|
|
622
|
-
|
|
1902
|
+
/**
|
|
1903
|
+
* The element's name. For elements that can show a label or text on
|
|
1904
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
1905
|
+
*
|
|
1906
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
1907
|
+
* the element is selected by clicking on it.
|
|
1908
|
+
*/
|
|
1909
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1910
|
+
/**
|
|
1911
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
1912
|
+
* is selected.
|
|
1913
|
+
*
|
|
1914
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
1915
|
+
* and Markers, so their description will not be shown.
|
|
1916
|
+
*/
|
|
1917
|
+
description: z.ZodNullable<z.ZodString>;
|
|
1918
|
+
/**
|
|
1919
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
1920
|
+
*
|
|
1921
|
+
* This is most useful for associating additional data with an element that is not
|
|
1922
|
+
* part of the element's core data, such as a Place's address or some other
|
|
1923
|
+
* data.
|
|
1924
|
+
*/
|
|
623
1925
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1926
|
+
/**
|
|
1927
|
+
* Whether the element is interactive.
|
|
1928
|
+
*
|
|
1929
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
1930
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
1931
|
+
*
|
|
1932
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
1933
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
1934
|
+
* accident.
|
|
1935
|
+
*
|
|
1936
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
1937
|
+
* not editable and have special behaviour depending on their name, description and
|
|
1938
|
+
* attributes.
|
|
1939
|
+
*
|
|
1940
|
+
* @default "default"
|
|
1941
|
+
*/
|
|
624
1942
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
625
1943
|
}, {
|
|
626
1944
|
type: z.ZodLiteral<"Marker">;
|
|
627
1945
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1946
|
+
/**
|
|
1947
|
+
* The opacity of the marker, between 0 and 1.
|
|
1948
|
+
*
|
|
1949
|
+
* @default 1
|
|
1950
|
+
*/
|
|
628
1951
|
opacity: z.ZodNumber;
|
|
1952
|
+
/**
|
|
1953
|
+
* The size of the marker, used in conjunction with the `zoom` to determine
|
|
1954
|
+
* the actual size of the marker.
|
|
1955
|
+
*
|
|
1956
|
+
* @default 10
|
|
1957
|
+
*/
|
|
629
1958
|
size: z.ZodNumber;
|
|
1959
|
+
/**
|
|
1960
|
+
* The zoom level at which the marker was created. This is combined with
|
|
1961
|
+
* the `size` to determine the actual size of the marker.
|
|
1962
|
+
*
|
|
1963
|
+
* When creating a marker, if you don't supply this value it defaults to
|
|
1964
|
+
* the current zoom of the map when you call `createElement`.
|
|
1965
|
+
*/
|
|
630
1966
|
zoom: z.ZodNumber;
|
|
631
1967
|
}>, "coordinates">, "strip", z.ZodTypeAny, {
|
|
632
1968
|
type: "Marker";
|
|
@@ -654,16 +1990,89 @@ declare const MarkerReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
|
654
1990
|
interaction?: "default" | "locked" | undefined;
|
|
655
1991
|
}>;
|
|
656
1992
|
declare const HighlighterReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
1993
|
+
/**
|
|
1994
|
+
* The unique identifier for the element.
|
|
1995
|
+
*/
|
|
657
1996
|
id: z.ZodString;
|
|
1997
|
+
/**
|
|
1998
|
+
* The ID of the element group that the element belongs to.
|
|
1999
|
+
* For elements that are not part of a group, this will be null.
|
|
2000
|
+
*/
|
|
658
2001
|
groupId: z.ZodNullable<z.ZodString>;
|
|
2002
|
+
/**
|
|
2003
|
+
* The color of the element in some CSS-like format.
|
|
2004
|
+
*
|
|
2005
|
+
* @example
|
|
2006
|
+
* ```typescript
|
|
2007
|
+
* "#ABC123";
|
|
2008
|
+
* "rgb(255, 0, 0)";
|
|
2009
|
+
* "hsl(200, 100%, 50%)";
|
|
2010
|
+
* ```
|
|
2011
|
+
*
|
|
2012
|
+
* @default "#C93535"
|
|
2013
|
+
*/
|
|
659
2014
|
color: z.ZodString;
|
|
660
|
-
|
|
661
|
-
|
|
2015
|
+
/**
|
|
2016
|
+
* The element's name. For elements that can show a label or text on
|
|
2017
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2018
|
+
*
|
|
2019
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2020
|
+
* the element is selected by clicking on it.
|
|
2021
|
+
*/
|
|
2022
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2023
|
+
/**
|
|
2024
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2025
|
+
* is selected.
|
|
2026
|
+
*
|
|
2027
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2028
|
+
* and Markers, so their description will not be shown.
|
|
2029
|
+
*/
|
|
2030
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2031
|
+
/**
|
|
2032
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2033
|
+
*
|
|
2034
|
+
* This is most useful for associating additional data with an element that is not
|
|
2035
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2036
|
+
* data.
|
|
2037
|
+
*/
|
|
662
2038
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2039
|
+
/**
|
|
2040
|
+
* Whether the element is interactive.
|
|
2041
|
+
*
|
|
2042
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2043
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2044
|
+
*
|
|
2045
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2046
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2047
|
+
* accident.
|
|
2048
|
+
*
|
|
2049
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2050
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2051
|
+
* attributes.
|
|
2052
|
+
*
|
|
2053
|
+
* @default "default"
|
|
2054
|
+
*/
|
|
663
2055
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
664
2056
|
}, {
|
|
665
2057
|
type: z.ZodLiteral<"Highlighter">;
|
|
666
|
-
|
|
2058
|
+
/**
|
|
2059
|
+
* A multipolygon describing the area that is highlighted.
|
|
2060
|
+
*
|
|
2061
|
+
* If `renderHoles` is set to false, only the outer ring of each polygon
|
|
2062
|
+
* will be rendered, filling in the area inside the highlighted region.
|
|
2063
|
+
*/
|
|
2064
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">, "many">;
|
|
2065
|
+
/**
|
|
2066
|
+
* Whether to render the holes of the highlighted area.
|
|
2067
|
+
*
|
|
2068
|
+
* @default false
|
|
2069
|
+
*/
|
|
2070
|
+
renderHoles: z.ZodBoolean;
|
|
2071
|
+
/**
|
|
2072
|
+
* The opacity of the highlighter, between 0 and 1.
|
|
2073
|
+
*
|
|
2074
|
+
* @default 0.5
|
|
2075
|
+
*/
|
|
667
2076
|
opacity: z.ZodNumber;
|
|
668
2077
|
}>, "coordinates">, "strip", z.ZodTypeAny, {
|
|
669
2078
|
type: "Highlighter";
|
|
@@ -674,6 +2083,7 @@ declare const HighlighterReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
|
674
2083
|
description: string | null;
|
|
675
2084
|
attributes: Record<string, unknown>;
|
|
676
2085
|
opacity: number;
|
|
2086
|
+
renderHoles: boolean;
|
|
677
2087
|
interaction?: "default" | "locked" | undefined;
|
|
678
2088
|
}, {
|
|
679
2089
|
type: "Highlighter";
|
|
@@ -684,15 +2094,72 @@ declare const HighlighterReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
|
684
2094
|
description: string | null;
|
|
685
2095
|
attributes: Record<string, unknown>;
|
|
686
2096
|
opacity: number;
|
|
2097
|
+
renderHoles: boolean;
|
|
687
2098
|
interaction?: "default" | "locked" | undefined;
|
|
688
2099
|
}>;
|
|
689
2100
|
declare const TextReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
2101
|
+
/**
|
|
2102
|
+
* The unique identifier for the element.
|
|
2103
|
+
*/
|
|
690
2104
|
id: z.ZodString;
|
|
2105
|
+
/**
|
|
2106
|
+
* The ID of the element group that the element belongs to.
|
|
2107
|
+
* For elements that are not part of a group, this will be null.
|
|
2108
|
+
*/
|
|
691
2109
|
groupId: z.ZodNullable<z.ZodString>;
|
|
2110
|
+
/**
|
|
2111
|
+
* The color of the element in some CSS-like format.
|
|
2112
|
+
*
|
|
2113
|
+
* @example
|
|
2114
|
+
* ```typescript
|
|
2115
|
+
* "#ABC123";
|
|
2116
|
+
* "rgb(255, 0, 0)";
|
|
2117
|
+
* "hsl(200, 100%, 50%)";
|
|
2118
|
+
* ```
|
|
2119
|
+
*
|
|
2120
|
+
* @default "#C93535"
|
|
2121
|
+
*/
|
|
692
2122
|
color: z.ZodString;
|
|
693
|
-
|
|
694
|
-
|
|
2123
|
+
/**
|
|
2124
|
+
* The element's name. For elements that can show a label or text on
|
|
2125
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2126
|
+
*
|
|
2127
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2128
|
+
* the element is selected by clicking on it.
|
|
2129
|
+
*/
|
|
2130
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2131
|
+
/**
|
|
2132
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2133
|
+
* is selected.
|
|
2134
|
+
*
|
|
2135
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2136
|
+
* and Markers, so their description will not be shown.
|
|
2137
|
+
*/
|
|
2138
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2139
|
+
/**
|
|
2140
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2141
|
+
*
|
|
2142
|
+
* This is most useful for associating additional data with an element that is not
|
|
2143
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2144
|
+
* data.
|
|
2145
|
+
*/
|
|
695
2146
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2147
|
+
/**
|
|
2148
|
+
* Whether the element is interactive.
|
|
2149
|
+
*
|
|
2150
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2151
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2152
|
+
*
|
|
2153
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2154
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2155
|
+
* accident.
|
|
2156
|
+
*
|
|
2157
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2158
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2159
|
+
* attributes.
|
|
2160
|
+
*
|
|
2161
|
+
* @default "default"
|
|
2162
|
+
*/
|
|
696
2163
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
697
2164
|
}, {
|
|
698
2165
|
position: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
@@ -701,9 +2168,28 @@ declare const TextReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
701
2168
|
zoom: z.ZodNumber;
|
|
702
2169
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
703
2170
|
}>, {
|
|
2171
|
+
/**
|
|
2172
|
+
* The text in the element.
|
|
2173
|
+
*/
|
|
704
2174
|
text: z.ZodString;
|
|
2175
|
+
/**
|
|
2176
|
+
* The alignment of the text, either `left`, `center` or `right`.
|
|
2177
|
+
*
|
|
2178
|
+
* @default "center"
|
|
2179
|
+
*/
|
|
705
2180
|
align: z.ZodEnum<["left", "center", "right"]>;
|
|
2181
|
+
/**
|
|
2182
|
+
* The style of the text, either `italic`, `light`, `regular` or `caps`.
|
|
2183
|
+
*
|
|
2184
|
+
* @default "regular"
|
|
2185
|
+
*/
|
|
706
2186
|
style: z.ZodEnum<["italic", "light", "regular", "caps"]>;
|
|
2187
|
+
/**
|
|
2188
|
+
* The text shown in the element, which is identical to the `text` property.
|
|
2189
|
+
*
|
|
2190
|
+
* @remarks This is added for consistency with other elements that have a `name`
|
|
2191
|
+
* property.
|
|
2192
|
+
*/
|
|
707
2193
|
name: z.ZodString;
|
|
708
2194
|
}>, {
|
|
709
2195
|
type: z.ZodLiteral<"Text">;
|
|
@@ -720,7 +2206,7 @@ declare const TextReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
720
2206
|
rotation: number;
|
|
721
2207
|
scale: number;
|
|
722
2208
|
text: string;
|
|
723
|
-
align: "
|
|
2209
|
+
align: "center" | "left" | "right";
|
|
724
2210
|
style: "italic" | "light" | "regular" | "caps";
|
|
725
2211
|
interaction?: "default" | "locked" | undefined;
|
|
726
2212
|
}, {
|
|
@@ -736,17 +2222,73 @@ declare const TextReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
736
2222
|
rotation: number;
|
|
737
2223
|
scale: number;
|
|
738
2224
|
text: string;
|
|
739
|
-
align: "
|
|
2225
|
+
align: "center" | "left" | "right";
|
|
740
2226
|
style: "italic" | "light" | "regular" | "caps";
|
|
741
2227
|
interaction?: "default" | "locked" | undefined;
|
|
742
2228
|
}>;
|
|
743
2229
|
declare const NoteReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
2230
|
+
/**
|
|
2231
|
+
* The unique identifier for the element.
|
|
2232
|
+
*/
|
|
744
2233
|
id: z.ZodString;
|
|
2234
|
+
/**
|
|
2235
|
+
* The ID of the element group that the element belongs to.
|
|
2236
|
+
* For elements that are not part of a group, this will be null.
|
|
2237
|
+
*/
|
|
745
2238
|
groupId: z.ZodNullable<z.ZodString>;
|
|
2239
|
+
/**
|
|
2240
|
+
* The color of the element in some CSS-like format.
|
|
2241
|
+
*
|
|
2242
|
+
* @example
|
|
2243
|
+
* ```typescript
|
|
2244
|
+
* "#ABC123";
|
|
2245
|
+
* "rgb(255, 0, 0)";
|
|
2246
|
+
* "hsl(200, 100%, 50%)";
|
|
2247
|
+
* ```
|
|
2248
|
+
*
|
|
2249
|
+
* @default "#C93535"
|
|
2250
|
+
*/
|
|
746
2251
|
color: z.ZodString;
|
|
747
|
-
|
|
748
|
-
|
|
2252
|
+
/**
|
|
2253
|
+
* The element's name. For elements that can show a label or text on
|
|
2254
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2255
|
+
*
|
|
2256
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2257
|
+
* the element is selected by clicking on it.
|
|
2258
|
+
*/
|
|
2259
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2260
|
+
/**
|
|
2261
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2262
|
+
* is selected.
|
|
2263
|
+
*
|
|
2264
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2265
|
+
* and Markers, so their description will not be shown.
|
|
2266
|
+
*/
|
|
2267
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2268
|
+
/**
|
|
2269
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2270
|
+
*
|
|
2271
|
+
* This is most useful for associating additional data with an element that is not
|
|
2272
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2273
|
+
* data.
|
|
2274
|
+
*/
|
|
749
2275
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2276
|
+
/**
|
|
2277
|
+
* Whether the element is interactive.
|
|
2278
|
+
*
|
|
2279
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2280
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2281
|
+
*
|
|
2282
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2283
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2284
|
+
* accident.
|
|
2285
|
+
*
|
|
2286
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2287
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2288
|
+
* attributes.
|
|
2289
|
+
*
|
|
2290
|
+
* @default "default"
|
|
2291
|
+
*/
|
|
750
2292
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
751
2293
|
}, {
|
|
752
2294
|
position: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
@@ -755,9 +2297,28 @@ declare const NoteReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
755
2297
|
zoom: z.ZodNumber;
|
|
756
2298
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
757
2299
|
}>, {
|
|
2300
|
+
/**
|
|
2301
|
+
* The text in the element.
|
|
2302
|
+
*/
|
|
758
2303
|
text: z.ZodString;
|
|
2304
|
+
/**
|
|
2305
|
+
* The alignment of the text, either `left`, `center` or `right`.
|
|
2306
|
+
*
|
|
2307
|
+
* @default "center"
|
|
2308
|
+
*/
|
|
759
2309
|
align: z.ZodEnum<["left", "center", "right"]>;
|
|
2310
|
+
/**
|
|
2311
|
+
* The style of the text, either `italic`, `light`, `regular` or `caps`.
|
|
2312
|
+
*
|
|
2313
|
+
* @default "regular"
|
|
2314
|
+
*/
|
|
760
2315
|
style: z.ZodEnum<["italic", "light", "regular", "caps"]>;
|
|
2316
|
+
/**
|
|
2317
|
+
* The text shown in the element, which is identical to the `text` property.
|
|
2318
|
+
*
|
|
2319
|
+
* @remarks This is added for consistency with other elements that have a `name`
|
|
2320
|
+
* property.
|
|
2321
|
+
*/
|
|
761
2322
|
name: z.ZodString;
|
|
762
2323
|
}>, {
|
|
763
2324
|
type: z.ZodLiteral<"Note">;
|
|
@@ -775,7 +2336,7 @@ declare const NoteReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
775
2336
|
rotation: number;
|
|
776
2337
|
scale: number;
|
|
777
2338
|
text: string;
|
|
778
|
-
align: "
|
|
2339
|
+
align: "center" | "left" | "right";
|
|
779
2340
|
style: "italic" | "light" | "regular" | "caps";
|
|
780
2341
|
widthScale: number;
|
|
781
2342
|
interaction?: "default" | "locked" | undefined;
|
|
@@ -792,23 +2353,87 @@ declare const NoteReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<z.object
|
|
|
792
2353
|
rotation: number;
|
|
793
2354
|
scale: number;
|
|
794
2355
|
text: string;
|
|
795
|
-
align: "
|
|
2356
|
+
align: "center" | "left" | "right";
|
|
796
2357
|
style: "italic" | "light" | "regular" | "caps";
|
|
797
2358
|
widthScale: number;
|
|
798
2359
|
interaction?: "default" | "locked" | undefined;
|
|
799
2360
|
}>;
|
|
800
2361
|
declare const ImageReadSchema: z.ZodObject<Omit<Omit<z.objectUtil.extendShape<{
|
|
2362
|
+
/**
|
|
2363
|
+
* The unique identifier for the element.
|
|
2364
|
+
*/
|
|
801
2365
|
id: z.ZodString;
|
|
2366
|
+
/**
|
|
2367
|
+
* The ID of the element group that the element belongs to.
|
|
2368
|
+
* For elements that are not part of a group, this will be null.
|
|
2369
|
+
*/
|
|
802
2370
|
groupId: z.ZodNullable<z.ZodString>;
|
|
2371
|
+
/**
|
|
2372
|
+
* The color of the element in some CSS-like format.
|
|
2373
|
+
*
|
|
2374
|
+
* @example
|
|
2375
|
+
* ```typescript
|
|
2376
|
+
* "#ABC123";
|
|
2377
|
+
* "rgb(255, 0, 0)";
|
|
2378
|
+
* "hsl(200, 100%, 50%)";
|
|
2379
|
+
* ```
|
|
2380
|
+
*
|
|
2381
|
+
* @default "#C93535"
|
|
2382
|
+
*/
|
|
803
2383
|
color: z.ZodString;
|
|
804
|
-
|
|
805
|
-
|
|
2384
|
+
/**
|
|
2385
|
+
* The element's name. For elements that can show a label or text on
|
|
2386
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2387
|
+
*
|
|
2388
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2389
|
+
* the element is selected by clicking on it.
|
|
2390
|
+
*/
|
|
2391
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2392
|
+
/**
|
|
2393
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2394
|
+
* is selected.
|
|
2395
|
+
*
|
|
2396
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2397
|
+
* and Markers, so their description will not be shown.
|
|
2398
|
+
*/
|
|
2399
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2400
|
+
/**
|
|
2401
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2402
|
+
*
|
|
2403
|
+
* This is most useful for associating additional data with an element that is not
|
|
2404
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2405
|
+
* data.
|
|
2406
|
+
*/
|
|
806
2407
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2408
|
+
/**
|
|
2409
|
+
* Whether the element is interactive.
|
|
2410
|
+
*
|
|
2411
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2412
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2413
|
+
*
|
|
2414
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2415
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2416
|
+
* accident.
|
|
2417
|
+
*
|
|
2418
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2419
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2420
|
+
* attributes.
|
|
2421
|
+
*
|
|
2422
|
+
* @default "default"
|
|
2423
|
+
*/
|
|
807
2424
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
808
2425
|
}, {
|
|
809
2426
|
type: z.ZodLiteral<"Image">;
|
|
810
2427
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
2428
|
+
/**
|
|
2429
|
+
* The URL of the image that is rendered in this element
|
|
2430
|
+
*/
|
|
811
2431
|
imageUrl: z.ZodString;
|
|
2432
|
+
/**
|
|
2433
|
+
* The opacity of the image, between 0 and 1.
|
|
2434
|
+
*
|
|
2435
|
+
* @default 1
|
|
2436
|
+
*/
|
|
812
2437
|
opacity: z.ZodNumber;
|
|
813
2438
|
}>, "color">, "coordinates">, "strip", z.ZodTypeAny, {
|
|
814
2439
|
type: "Image";
|
|
@@ -832,16 +2457,75 @@ declare const ImageReadSchema: z.ZodObject<Omit<Omit<z.objectUtil.extendShape<{
|
|
|
832
2457
|
interaction?: "default" | "locked" | undefined;
|
|
833
2458
|
}>;
|
|
834
2459
|
declare const LinkReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
2460
|
+
/**
|
|
2461
|
+
* The unique identifier for the element.
|
|
2462
|
+
*/
|
|
835
2463
|
id: z.ZodString;
|
|
2464
|
+
/**
|
|
2465
|
+
* The ID of the element group that the element belongs to.
|
|
2466
|
+
* For elements that are not part of a group, this will be null.
|
|
2467
|
+
*/
|
|
836
2468
|
groupId: z.ZodNullable<z.ZodString>;
|
|
2469
|
+
/**
|
|
2470
|
+
* The color of the element in some CSS-like format.
|
|
2471
|
+
*
|
|
2472
|
+
* @example
|
|
2473
|
+
* ```typescript
|
|
2474
|
+
* "#ABC123";
|
|
2475
|
+
* "rgb(255, 0, 0)";
|
|
2476
|
+
* "hsl(200, 100%, 50%)";
|
|
2477
|
+
* ```
|
|
2478
|
+
*
|
|
2479
|
+
* @default "#C93535"
|
|
2480
|
+
*/
|
|
837
2481
|
color: z.ZodString;
|
|
838
|
-
|
|
839
|
-
|
|
2482
|
+
/**
|
|
2483
|
+
* The element's name. For elements that can show a label or text on
|
|
2484
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2485
|
+
*
|
|
2486
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2487
|
+
* the element is selected by clicking on it.
|
|
2488
|
+
*/
|
|
2489
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2490
|
+
/**
|
|
2491
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2492
|
+
* is selected.
|
|
2493
|
+
*
|
|
2494
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2495
|
+
* and Markers, so their description will not be shown.
|
|
2496
|
+
*/
|
|
2497
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2498
|
+
/**
|
|
2499
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2500
|
+
*
|
|
2501
|
+
* This is most useful for associating additional data with an element that is not
|
|
2502
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2503
|
+
* data.
|
|
2504
|
+
*/
|
|
840
2505
|
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2506
|
+
/**
|
|
2507
|
+
* Whether the element is interactive.
|
|
2508
|
+
*
|
|
2509
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2510
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2511
|
+
*
|
|
2512
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2513
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2514
|
+
* accident.
|
|
2515
|
+
*
|
|
2516
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2517
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2518
|
+
* attributes.
|
|
2519
|
+
*
|
|
2520
|
+
* @default "default"
|
|
2521
|
+
*/
|
|
841
2522
|
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
842
2523
|
}, {
|
|
843
2524
|
type: z.ZodLiteral<"Link">;
|
|
844
2525
|
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
2526
|
+
/**
|
|
2527
|
+
* The URL of the link that is rendered in this element.
|
|
2528
|
+
*/
|
|
845
2529
|
url: z.ZodString;
|
|
846
2530
|
}>, "coordinates">, "strip", z.ZodTypeAny, {
|
|
847
2531
|
type: "Link";
|
|
@@ -864,21 +2548,120 @@ declare const LinkReadSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
|
864
2548
|
url: string;
|
|
865
2549
|
interaction?: "default" | "locked" | undefined;
|
|
866
2550
|
}>;
|
|
867
|
-
declare const PlaceUpdateSchema: z.ZodObject<{
|
|
868
|
-
|
|
869
|
-
type: z.ZodLiteral<"Place">;
|
|
870
|
-
coordinates: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
871
|
-
id: z.ZodString;
|
|
2551
|
+
declare const PlaceUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
2552
|
+
id: z.ZodOptional<z.ZodString>;
|
|
872
2553
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
873
2554
|
color: z.ZodOptional<z.ZodString>;
|
|
874
|
-
name: z.ZodOptional<z.
|
|
875
|
-
description: z.ZodOptional<z.
|
|
2555
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2556
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
876
2557
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
877
2558
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
878
2559
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2560
|
+
type: z.ZodOptional<z.ZodLiteral<"Place">>;
|
|
2561
|
+
coordinates: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
2562
|
+
symbol: z.ZodOptional<z.ZodString>;
|
|
879
2563
|
frame: z.ZodOptional<z.ZodNullable<z.ZodEnum<["frame-circle", "frame-square"]>>>;
|
|
880
2564
|
hideLabel: z.ZodOptional<z.ZodBoolean>;
|
|
881
|
-
},
|
|
2565
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
2566
|
+
/**
|
|
2567
|
+
* The unique identifier for the element.
|
|
2568
|
+
*/
|
|
2569
|
+
id: z.ZodString;
|
|
2570
|
+
/**
|
|
2571
|
+
* The ID of the element group that the element belongs to.
|
|
2572
|
+
* For elements that are not part of a group, this will be null.
|
|
2573
|
+
*/
|
|
2574
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
2575
|
+
/**
|
|
2576
|
+
* The color of the element in some CSS-like format.
|
|
2577
|
+
*
|
|
2578
|
+
* @example
|
|
2579
|
+
* ```typescript
|
|
2580
|
+
* "#ABC123";
|
|
2581
|
+
* "rgb(255, 0, 0)";
|
|
2582
|
+
* "hsl(200, 100%, 50%)";
|
|
2583
|
+
* ```
|
|
2584
|
+
*
|
|
2585
|
+
* @default "#C93535"
|
|
2586
|
+
*/
|
|
2587
|
+
color: z.ZodString;
|
|
2588
|
+
/**
|
|
2589
|
+
* The element's name. For elements that can show a label or text on
|
|
2590
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2591
|
+
*
|
|
2592
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2593
|
+
* the element is selected by clicking on it.
|
|
2594
|
+
*/
|
|
2595
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2596
|
+
/**
|
|
2597
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2598
|
+
* is selected.
|
|
2599
|
+
*
|
|
2600
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2601
|
+
* and Markers, so their description will not be shown.
|
|
2602
|
+
*/
|
|
2603
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2604
|
+
/**
|
|
2605
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2606
|
+
*
|
|
2607
|
+
* This is most useful for associating additional data with an element that is not
|
|
2608
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2609
|
+
* data.
|
|
2610
|
+
*/
|
|
2611
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2612
|
+
/**
|
|
2613
|
+
* Whether the element is interactive.
|
|
2614
|
+
*
|
|
2615
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2616
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2617
|
+
*
|
|
2618
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2619
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2620
|
+
* accident.
|
|
2621
|
+
*
|
|
2622
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2623
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2624
|
+
* attributes.
|
|
2625
|
+
*
|
|
2626
|
+
* @default "default"
|
|
2627
|
+
*/
|
|
2628
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
2629
|
+
}, {
|
|
2630
|
+
/**
|
|
2631
|
+
* The URL of an image that has been added to the element.
|
|
2632
|
+
*/
|
|
2633
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
2634
|
+
}>, {
|
|
2635
|
+
type: z.ZodLiteral<"Place">;
|
|
2636
|
+
coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
2637
|
+
/**
|
|
2638
|
+
* The symbol that is rendered for the Place.
|
|
2639
|
+
*
|
|
2640
|
+
* This can be an emoji by using colon-enclosed characters (e.g. `":smiley:"`)
|
|
2641
|
+
* or one of the symbols available in Felt's symbol library.
|
|
2642
|
+
*
|
|
2643
|
+
* You can see the available symbols in the Felt UI when editing a Place
|
|
2644
|
+
* by hovering a symbol and converting the tooltip to kebab-case. For example,
|
|
2645
|
+
* the "Oil barrel" symbol is `oil-barrel`.
|
|
2646
|
+
*/
|
|
2647
|
+
symbol: z.ZodString;
|
|
2648
|
+
/**
|
|
2649
|
+
* The frame that is rendered around the Place's symbol. This is
|
|
2650
|
+
* only available for non-emoji symbols.
|
|
2651
|
+
*/
|
|
2652
|
+
frame: z.ZodNullable<z.ZodEnum<["frame-circle", "frame-square"]>>;
|
|
2653
|
+
/**
|
|
2654
|
+
* Whether the element's label is hidden on the map. This allows you
|
|
2655
|
+
* to add a name to the element and can show in popups, but not have
|
|
2656
|
+
* it visible on the map.
|
|
2657
|
+
*
|
|
2658
|
+
* This will also hide the faint placeholder label that is shown when
|
|
2659
|
+
* an editable Place is selected.
|
|
2660
|
+
*
|
|
2661
|
+
* @default false
|
|
2662
|
+
*/
|
|
2663
|
+
hideLabel: z.ZodBoolean;
|
|
2664
|
+
}>, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
882
2665
|
type: "Place";
|
|
883
2666
|
id: string;
|
|
884
2667
|
symbol?: string | undefined;
|
|
@@ -907,24 +2690,138 @@ declare const PlaceUpdateSchema: z.ZodObject<{
|
|
|
907
2690
|
frame?: "frame-circle" | "frame-square" | null | undefined;
|
|
908
2691
|
hideLabel?: boolean | undefined;
|
|
909
2692
|
}>;
|
|
910
|
-
declare const PathUpdateSchema: z.ZodObject<{
|
|
911
|
-
|
|
912
|
-
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
913
|
-
id: z.ZodString;
|
|
2693
|
+
declare const PathUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
2694
|
+
id: z.ZodOptional<z.ZodString>;
|
|
914
2695
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
915
2696
|
color: z.ZodOptional<z.ZodString>;
|
|
916
|
-
name: z.ZodOptional<z.
|
|
917
|
-
description: z.ZodOptional<z.
|
|
2697
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2698
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
918
2699
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
919
2700
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
920
2701
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
921
2702
|
strokeOpacity: z.ZodOptional<z.ZodNumber>;
|
|
922
2703
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
923
2704
|
strokeStyle: z.ZodOptional<z.ZodEnum<["solid", "dashed", "dotted"]>>;
|
|
2705
|
+
type: z.ZodOptional<z.ZodLiteral<"Path">>;
|
|
2706
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
924
2707
|
distanceMarker: z.ZodOptional<z.ZodBoolean>;
|
|
925
|
-
endCaps: z.ZodOptional<z.ZodBoolean>;
|
|
926
2708
|
routingMode: z.ZodOptional<z.ZodNullable<z.ZodEnum<["driving", "cycling", "walking", "flying"]>>>;
|
|
927
|
-
|
|
2709
|
+
endCaps: z.ZodOptional<z.ZodBoolean>;
|
|
2710
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
2711
|
+
/**
|
|
2712
|
+
* The unique identifier for the element.
|
|
2713
|
+
*/
|
|
2714
|
+
id: z.ZodString;
|
|
2715
|
+
/**
|
|
2716
|
+
* The ID of the element group that the element belongs to.
|
|
2717
|
+
* For elements that are not part of a group, this will be null.
|
|
2718
|
+
*/
|
|
2719
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
2720
|
+
/**
|
|
2721
|
+
* The color of the element in some CSS-like format.
|
|
2722
|
+
*
|
|
2723
|
+
* @example
|
|
2724
|
+
* ```typescript
|
|
2725
|
+
* "#ABC123";
|
|
2726
|
+
* "rgb(255, 0, 0)";
|
|
2727
|
+
* "hsl(200, 100%, 50%)";
|
|
2728
|
+
* ```
|
|
2729
|
+
*
|
|
2730
|
+
* @default "#C93535"
|
|
2731
|
+
*/
|
|
2732
|
+
color: z.ZodString;
|
|
2733
|
+
/**
|
|
2734
|
+
* The element's name. For elements that can show a label or text on
|
|
2735
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2736
|
+
*
|
|
2737
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2738
|
+
* the element is selected by clicking on it.
|
|
2739
|
+
*/
|
|
2740
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2741
|
+
/**
|
|
2742
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2743
|
+
* is selected.
|
|
2744
|
+
*
|
|
2745
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2746
|
+
* and Markers, so their description will not be shown.
|
|
2747
|
+
*/
|
|
2748
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2749
|
+
/**
|
|
2750
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2751
|
+
*
|
|
2752
|
+
* This is most useful for associating additional data with an element that is not
|
|
2753
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2754
|
+
* data.
|
|
2755
|
+
*/
|
|
2756
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2757
|
+
/**
|
|
2758
|
+
* Whether the element is interactive.
|
|
2759
|
+
*
|
|
2760
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2761
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2762
|
+
*
|
|
2763
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2764
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2765
|
+
* accident.
|
|
2766
|
+
*
|
|
2767
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2768
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2769
|
+
* attributes.
|
|
2770
|
+
*
|
|
2771
|
+
* @default "default"
|
|
2772
|
+
*/
|
|
2773
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
2774
|
+
}, {
|
|
2775
|
+
/**
|
|
2776
|
+
* The URL of an image that has been added to the element.
|
|
2777
|
+
*/
|
|
2778
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
2779
|
+
}>, {
|
|
2780
|
+
/**
|
|
2781
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
2782
|
+
*
|
|
2783
|
+
* @default 1
|
|
2784
|
+
*/
|
|
2785
|
+
strokeOpacity: z.ZodNumber;
|
|
2786
|
+
/**
|
|
2787
|
+
* The width of the element's stroke in pixels.
|
|
2788
|
+
*
|
|
2789
|
+
* @default 2
|
|
2790
|
+
*/
|
|
2791
|
+
strokeWidth: z.ZodNumber;
|
|
2792
|
+
/**
|
|
2793
|
+
* The style of the element's stroke.
|
|
2794
|
+
*
|
|
2795
|
+
* @default "solid"
|
|
2796
|
+
*/
|
|
2797
|
+
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
2798
|
+
}>, {
|
|
2799
|
+
type: z.ZodLiteral<"Path">;
|
|
2800
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
2801
|
+
/**
|
|
2802
|
+
* Whether a distance marker is shown at the midpoint of the path.
|
|
2803
|
+
*
|
|
2804
|
+
* @default false
|
|
2805
|
+
*/
|
|
2806
|
+
distanceMarker: z.ZodBoolean;
|
|
2807
|
+
/**
|
|
2808
|
+
* Whether this represents a route, and if so, what mode of transport
|
|
2809
|
+
* is used.
|
|
2810
|
+
*
|
|
2811
|
+
* If this is `null`, the path is not considered to be a route, so while it
|
|
2812
|
+
* can have a `distanceMarker`, it will does not have a start or end cap.
|
|
2813
|
+
*
|
|
2814
|
+
* @default null
|
|
2815
|
+
*/
|
|
2816
|
+
routingMode: z.ZodNullable<z.ZodEnum<["driving", "cycling", "walking", "flying"]>>;
|
|
2817
|
+
/**
|
|
2818
|
+
* Whether or not to show Start and End caps on the path. This is
|
|
2819
|
+
* only available if the `routingMode` is set.
|
|
2820
|
+
*
|
|
2821
|
+
* @default false
|
|
2822
|
+
*/
|
|
2823
|
+
endCaps: z.ZodBoolean;
|
|
2824
|
+
}>, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
928
2825
|
type: "Path";
|
|
929
2826
|
id: string;
|
|
930
2827
|
coordinates?: [number, number][][] | undefined;
|
|
@@ -939,8 +2836,8 @@ declare const PathUpdateSchema: z.ZodObject<{
|
|
|
939
2836
|
strokeWidth?: number | undefined;
|
|
940
2837
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
941
2838
|
distanceMarker?: boolean | undefined;
|
|
942
|
-
endCaps?: boolean | undefined;
|
|
943
2839
|
routingMode?: "driving" | "cycling" | "walking" | "flying" | null | undefined;
|
|
2840
|
+
endCaps?: boolean | undefined;
|
|
944
2841
|
}, {
|
|
945
2842
|
type: "Path";
|
|
946
2843
|
id: string;
|
|
@@ -956,26 +2853,129 @@ declare const PathUpdateSchema: z.ZodObject<{
|
|
|
956
2853
|
strokeWidth?: number | undefined;
|
|
957
2854
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
958
2855
|
distanceMarker?: boolean | undefined;
|
|
959
|
-
endCaps?: boolean | undefined;
|
|
960
2856
|
routingMode?: "driving" | "cycling" | "walking" | "flying" | null | undefined;
|
|
2857
|
+
endCaps?: boolean | undefined;
|
|
961
2858
|
}>;
|
|
962
|
-
declare const PolygonUpdateSchema: z.ZodObject<{
|
|
963
|
-
|
|
964
|
-
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
965
|
-
id: z.ZodString;
|
|
2859
|
+
declare const PolygonUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
2860
|
+
id: z.ZodOptional<z.ZodString>;
|
|
966
2861
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
967
2862
|
color: z.ZodOptional<z.ZodString>;
|
|
968
|
-
name: z.ZodOptional<z.
|
|
969
|
-
description: z.ZodOptional<z.
|
|
2863
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2864
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
970
2865
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
971
2866
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
972
2867
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
973
2868
|
strokeOpacity: z.ZodOptional<z.ZodNumber>;
|
|
974
2869
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
975
2870
|
strokeStyle: z.ZodOptional<z.ZodEnum<["solid", "dashed", "dotted"]>>;
|
|
2871
|
+
type: z.ZodOptional<z.ZodLiteral<"Polygon">>;
|
|
2872
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
976
2873
|
fillOpacity: z.ZodOptional<z.ZodNumber>;
|
|
977
2874
|
areaMarker: z.ZodOptional<z.ZodBoolean>;
|
|
978
|
-
},
|
|
2875
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
2876
|
+
/**
|
|
2877
|
+
* The unique identifier for the element.
|
|
2878
|
+
*/
|
|
2879
|
+
id: z.ZodString;
|
|
2880
|
+
/**
|
|
2881
|
+
* The ID of the element group that the element belongs to.
|
|
2882
|
+
* For elements that are not part of a group, this will be null.
|
|
2883
|
+
*/
|
|
2884
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
2885
|
+
/**
|
|
2886
|
+
* The color of the element in some CSS-like format.
|
|
2887
|
+
*
|
|
2888
|
+
* @example
|
|
2889
|
+
* ```typescript
|
|
2890
|
+
* "#ABC123";
|
|
2891
|
+
* "rgb(255, 0, 0)";
|
|
2892
|
+
* "hsl(200, 100%, 50%)";
|
|
2893
|
+
* ```
|
|
2894
|
+
*
|
|
2895
|
+
* @default "#C93535"
|
|
2896
|
+
*/
|
|
2897
|
+
color: z.ZodString;
|
|
2898
|
+
/**
|
|
2899
|
+
* The element's name. For elements that can show a label or text on
|
|
2900
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
2901
|
+
*
|
|
2902
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
2903
|
+
* the element is selected by clicking on it.
|
|
2904
|
+
*/
|
|
2905
|
+
name: z.ZodNullable<z.ZodString>;
|
|
2906
|
+
/**
|
|
2907
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
2908
|
+
* is selected.
|
|
2909
|
+
*
|
|
2910
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
2911
|
+
* and Markers, so their description will not be shown.
|
|
2912
|
+
*/
|
|
2913
|
+
description: z.ZodNullable<z.ZodString>;
|
|
2914
|
+
/**
|
|
2915
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
2916
|
+
*
|
|
2917
|
+
* This is most useful for associating additional data with an element that is not
|
|
2918
|
+
* part of the element's core data, such as a Place's address or some other
|
|
2919
|
+
* data.
|
|
2920
|
+
*/
|
|
2921
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2922
|
+
/**
|
|
2923
|
+
* Whether the element is interactive.
|
|
2924
|
+
*
|
|
2925
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
2926
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
2927
|
+
*
|
|
2928
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
2929
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
2930
|
+
* accident.
|
|
2931
|
+
*
|
|
2932
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
2933
|
+
* not editable and have special behaviour depending on their name, description and
|
|
2934
|
+
* attributes.
|
|
2935
|
+
*
|
|
2936
|
+
* @default "default"
|
|
2937
|
+
*/
|
|
2938
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
2939
|
+
}, {
|
|
2940
|
+
/**
|
|
2941
|
+
* The URL of an image that has been added to the element.
|
|
2942
|
+
*/
|
|
2943
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
2944
|
+
}>, {
|
|
2945
|
+
/**
|
|
2946
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
2947
|
+
*
|
|
2948
|
+
* @default 1
|
|
2949
|
+
*/
|
|
2950
|
+
strokeOpacity: z.ZodNumber;
|
|
2951
|
+
/**
|
|
2952
|
+
* The width of the element's stroke in pixels.
|
|
2953
|
+
*
|
|
2954
|
+
* @default 2
|
|
2955
|
+
*/
|
|
2956
|
+
strokeWidth: z.ZodNumber;
|
|
2957
|
+
/**
|
|
2958
|
+
* The style of the element's stroke.
|
|
2959
|
+
*
|
|
2960
|
+
* @default "solid"
|
|
2961
|
+
*/
|
|
2962
|
+
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
2963
|
+
}>, {
|
|
2964
|
+
type: z.ZodLiteral<"Polygon">;
|
|
2965
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
2966
|
+
/**
|
|
2967
|
+
* The opacity of the polygon's fill, between 0 and 1.
|
|
2968
|
+
*
|
|
2969
|
+
* @default 0.25
|
|
2970
|
+
*/
|
|
2971
|
+
fillOpacity: z.ZodNumber;
|
|
2972
|
+
/**
|
|
2973
|
+
* Whether to show an area marker on the polygon.
|
|
2974
|
+
*
|
|
2975
|
+
* @default false
|
|
2976
|
+
*/
|
|
2977
|
+
areaMarker: z.ZodBoolean;
|
|
2978
|
+
}>, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
979
2979
|
type: "Polygon";
|
|
980
2980
|
id: string;
|
|
981
2981
|
coordinates?: [number, number][][] | undefined;
|
|
@@ -1008,29 +3008,155 @@ declare const PolygonUpdateSchema: z.ZodObject<{
|
|
|
1008
3008
|
fillOpacity?: number | undefined;
|
|
1009
3009
|
areaMarker?: boolean | undefined;
|
|
1010
3010
|
}>;
|
|
1011
|
-
declare const CircleUpdateSchema: z.ZodObject<{
|
|
1012
|
-
|
|
1013
|
-
coordinates: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
1014
|
-
id: z.ZodString;
|
|
3011
|
+
declare const CircleUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
3012
|
+
id: z.ZodOptional<z.ZodString>;
|
|
1015
3013
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1016
3014
|
color: z.ZodOptional<z.ZodString>;
|
|
1017
|
-
name: z.ZodOptional<z.
|
|
1018
|
-
description: z.ZodOptional<z.
|
|
3015
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3016
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1019
3017
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1020
3018
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
1021
3019
|
imageUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1022
3020
|
strokeOpacity: z.ZodOptional<z.ZodNumber>;
|
|
1023
3021
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
1024
3022
|
strokeStyle: z.ZodOptional<z.ZodEnum<["solid", "dashed", "dotted"]>>;
|
|
1025
|
-
|
|
3023
|
+
type: z.ZodOptional<z.ZodLiteral<"Circle">>;
|
|
3024
|
+
center: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
1026
3025
|
radius: z.ZodOptional<z.ZodNumber>;
|
|
3026
|
+
radiusMarker: z.ZodOptional<z.ZodBoolean>;
|
|
1027
3027
|
radiusDisplayAngle: z.ZodOptional<z.ZodNumber>;
|
|
1028
3028
|
radiusDisplayUnit: z.ZodOptional<z.ZodNullable<z.ZodEnum<["meter", "kilometer", "foot", "mile"]>>>;
|
|
1029
|
-
|
|
1030
|
-
},
|
|
3029
|
+
fillOpacity: z.ZodOptional<z.ZodNumber>;
|
|
3030
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
3031
|
+
/**
|
|
3032
|
+
* The unique identifier for the element.
|
|
3033
|
+
*/
|
|
3034
|
+
id: z.ZodString;
|
|
3035
|
+
/**
|
|
3036
|
+
* The ID of the element group that the element belongs to.
|
|
3037
|
+
* For elements that are not part of a group, this will be null.
|
|
3038
|
+
*/
|
|
3039
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
3040
|
+
/**
|
|
3041
|
+
* The color of the element in some CSS-like format.
|
|
3042
|
+
*
|
|
3043
|
+
* @example
|
|
3044
|
+
* ```typescript
|
|
3045
|
+
* "#ABC123";
|
|
3046
|
+
* "rgb(255, 0, 0)";
|
|
3047
|
+
* "hsl(200, 100%, 50%)";
|
|
3048
|
+
* ```
|
|
3049
|
+
*
|
|
3050
|
+
* @default "#C93535"
|
|
3051
|
+
*/
|
|
3052
|
+
color: z.ZodString;
|
|
3053
|
+
/**
|
|
3054
|
+
* The element's name. For elements that can show a label or text on
|
|
3055
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
3056
|
+
*
|
|
3057
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
3058
|
+
* the element is selected by clicking on it.
|
|
3059
|
+
*/
|
|
3060
|
+
name: z.ZodNullable<z.ZodString>;
|
|
3061
|
+
/**
|
|
3062
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
3063
|
+
* is selected.
|
|
3064
|
+
*
|
|
3065
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
3066
|
+
* and Markers, so their description will not be shown.
|
|
3067
|
+
*/
|
|
3068
|
+
description: z.ZodNullable<z.ZodString>;
|
|
3069
|
+
/**
|
|
3070
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
3071
|
+
*
|
|
3072
|
+
* This is most useful for associating additional data with an element that is not
|
|
3073
|
+
* part of the element's core data, such as a Place's address or some other
|
|
3074
|
+
* data.
|
|
3075
|
+
*/
|
|
3076
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3077
|
+
/**
|
|
3078
|
+
* Whether the element is interactive.
|
|
3079
|
+
*
|
|
3080
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
3081
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
3082
|
+
*
|
|
3083
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
3084
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
3085
|
+
* accident.
|
|
3086
|
+
*
|
|
3087
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
3088
|
+
* not editable and have special behaviour depending on their name, description and
|
|
3089
|
+
* attributes.
|
|
3090
|
+
*
|
|
3091
|
+
* @default "default"
|
|
3092
|
+
*/
|
|
3093
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
3094
|
+
}, {
|
|
3095
|
+
/**
|
|
3096
|
+
* The URL of an image that has been added to the element.
|
|
3097
|
+
*/
|
|
3098
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
3099
|
+
}>, {
|
|
3100
|
+
/**
|
|
3101
|
+
* A value between 0 and 1 that describes the opacity of the element's stroke.
|
|
3102
|
+
*
|
|
3103
|
+
* @default 1
|
|
3104
|
+
*/
|
|
3105
|
+
strokeOpacity: z.ZodNumber;
|
|
3106
|
+
/**
|
|
3107
|
+
* The width of the element's stroke in pixels.
|
|
3108
|
+
*
|
|
3109
|
+
* @default 2
|
|
3110
|
+
*/
|
|
3111
|
+
strokeWidth: z.ZodNumber;
|
|
3112
|
+
/**
|
|
3113
|
+
* The style of the element's stroke.
|
|
3114
|
+
*
|
|
3115
|
+
* @default "solid"
|
|
3116
|
+
*/
|
|
3117
|
+
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
3118
|
+
}>, {
|
|
3119
|
+
type: z.ZodLiteral<"Circle">;
|
|
3120
|
+
/**
|
|
3121
|
+
* The center of the circle.
|
|
3122
|
+
*/
|
|
3123
|
+
center: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
3124
|
+
/**
|
|
3125
|
+
* The radius of the circle in meters.
|
|
3126
|
+
*/
|
|
3127
|
+
radius: z.ZodNumber;
|
|
3128
|
+
/**
|
|
3129
|
+
* Whether to show a marker on the circle that indicates the radius
|
|
3130
|
+
*
|
|
3131
|
+
* @default false
|
|
3132
|
+
*/
|
|
3133
|
+
radiusMarker: z.ZodBoolean;
|
|
3134
|
+
/**
|
|
3135
|
+
* The angle at which the control point for setting the radius is displayed,
|
|
3136
|
+
* in degrees. When the `radiusMarker` is `true`, there is a dotted line rendered
|
|
3137
|
+
* from the center of the circle to the control point, and the marker is shown
|
|
3138
|
+
* at the midpoint of this line.
|
|
3139
|
+
*
|
|
3140
|
+
* @default 90
|
|
3141
|
+
*/
|
|
3142
|
+
radiusDisplayAngle: z.ZodNumber;
|
|
3143
|
+
/**
|
|
3144
|
+
* The unit of the radius used when the `radiusMarker` is `true`.
|
|
3145
|
+
*
|
|
3146
|
+
* A value of `null` means that the unit matches the user's locale.
|
|
3147
|
+
*
|
|
3148
|
+
* @default null
|
|
3149
|
+
*/
|
|
3150
|
+
radiusDisplayUnit: z.ZodNullable<z.ZodEnum<["meter", "kilometer", "foot", "mile"]>>;
|
|
3151
|
+
/**
|
|
3152
|
+
* The opacity of the circle's fill.
|
|
3153
|
+
*
|
|
3154
|
+
* @default 0.25
|
|
3155
|
+
*/
|
|
3156
|
+
fillOpacity: z.ZodNumber;
|
|
3157
|
+
}>, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
1031
3158
|
type: "Circle";
|
|
1032
3159
|
id: string;
|
|
1033
|
-
coordinates?: [number, number] | undefined;
|
|
1034
3160
|
groupId?: string | null | undefined;
|
|
1035
3161
|
color?: string | undefined;
|
|
1036
3162
|
name?: string | null | undefined;
|
|
@@ -1042,14 +3168,14 @@ declare const CircleUpdateSchema: z.ZodObject<{
|
|
|
1042
3168
|
strokeWidth?: number | undefined;
|
|
1043
3169
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
1044
3170
|
fillOpacity?: number | undefined;
|
|
3171
|
+
center?: [number, number] | undefined;
|
|
1045
3172
|
radius?: number | undefined;
|
|
3173
|
+
radiusMarker?: boolean | undefined;
|
|
1046
3174
|
radiusDisplayAngle?: number | undefined;
|
|
1047
3175
|
radiusDisplayUnit?: "meter" | "kilometer" | "foot" | "mile" | null | undefined;
|
|
1048
|
-
radiusMarker?: boolean | undefined;
|
|
1049
3176
|
}, {
|
|
1050
3177
|
type: "Circle";
|
|
1051
3178
|
id: string;
|
|
1052
|
-
coordinates?: [number, number] | undefined;
|
|
1053
3179
|
groupId?: string | null | undefined;
|
|
1054
3180
|
color?: string | undefined;
|
|
1055
3181
|
name?: string | null | undefined;
|
|
@@ -1061,25 +3187,114 @@ declare const CircleUpdateSchema: z.ZodObject<{
|
|
|
1061
3187
|
strokeWidth?: number | undefined;
|
|
1062
3188
|
strokeStyle?: "solid" | "dashed" | "dotted" | undefined;
|
|
1063
3189
|
fillOpacity?: number | undefined;
|
|
3190
|
+
center?: [number, number] | undefined;
|
|
1064
3191
|
radius?: number | undefined;
|
|
3192
|
+
radiusMarker?: boolean | undefined;
|
|
1065
3193
|
radiusDisplayAngle?: number | undefined;
|
|
1066
3194
|
radiusDisplayUnit?: "meter" | "kilometer" | "foot" | "mile" | null | undefined;
|
|
1067
|
-
radiusMarker?: boolean | undefined;
|
|
1068
3195
|
}>;
|
|
1069
|
-
declare const MarkerUpdateSchema: z.ZodObject<{
|
|
1070
|
-
|
|
1071
|
-
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1072
|
-
id: z.ZodString;
|
|
3196
|
+
declare const MarkerUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
3197
|
+
id: z.ZodOptional<z.ZodString>;
|
|
1073
3198
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1074
3199
|
color: z.ZodOptional<z.ZodString>;
|
|
1075
|
-
name: z.ZodOptional<z.
|
|
1076
|
-
description: z.ZodOptional<z.
|
|
3200
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3201
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1077
3202
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1078
3203
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
3204
|
+
type: z.ZodOptional<z.ZodLiteral<"Marker">>;
|
|
3205
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1079
3206
|
opacity: z.ZodOptional<z.ZodNumber>;
|
|
1080
3207
|
size: z.ZodOptional<z.ZodNumber>;
|
|
1081
3208
|
zoom: z.ZodOptional<z.ZodNumber>;
|
|
1082
|
-
},
|
|
3209
|
+
}, Pick<z.objectUtil.extendShape<{
|
|
3210
|
+
/**
|
|
3211
|
+
* The unique identifier for the element.
|
|
3212
|
+
*/
|
|
3213
|
+
id: z.ZodString;
|
|
3214
|
+
/**
|
|
3215
|
+
* The ID of the element group that the element belongs to.
|
|
3216
|
+
* For elements that are not part of a group, this will be null.
|
|
3217
|
+
*/
|
|
3218
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
3219
|
+
/**
|
|
3220
|
+
* The color of the element in some CSS-like format.
|
|
3221
|
+
*
|
|
3222
|
+
* @example
|
|
3223
|
+
* ```typescript
|
|
3224
|
+
* "#ABC123";
|
|
3225
|
+
* "rgb(255, 0, 0)";
|
|
3226
|
+
* "hsl(200, 100%, 50%)";
|
|
3227
|
+
* ```
|
|
3228
|
+
*
|
|
3229
|
+
* @default "#C93535"
|
|
3230
|
+
*/
|
|
3231
|
+
color: z.ZodString;
|
|
3232
|
+
/**
|
|
3233
|
+
* The element's name. For elements that can show a label or text on
|
|
3234
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
3235
|
+
*
|
|
3236
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
3237
|
+
* the element is selected by clicking on it.
|
|
3238
|
+
*/
|
|
3239
|
+
name: z.ZodNullable<z.ZodString>;
|
|
3240
|
+
/**
|
|
3241
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
3242
|
+
* is selected.
|
|
3243
|
+
*
|
|
3244
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
3245
|
+
* and Markers, so their description will not be shown.
|
|
3246
|
+
*/
|
|
3247
|
+
description: z.ZodNullable<z.ZodString>;
|
|
3248
|
+
/**
|
|
3249
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
3250
|
+
*
|
|
3251
|
+
* This is most useful for associating additional data with an element that is not
|
|
3252
|
+
* part of the element's core data, such as a Place's address or some other
|
|
3253
|
+
* data.
|
|
3254
|
+
*/
|
|
3255
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3256
|
+
/**
|
|
3257
|
+
* Whether the element is interactive.
|
|
3258
|
+
*
|
|
3259
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
3260
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
3261
|
+
*
|
|
3262
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
3263
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
3264
|
+
* accident.
|
|
3265
|
+
*
|
|
3266
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
3267
|
+
* not editable and have special behaviour depending on their name, description and
|
|
3268
|
+
* attributes.
|
|
3269
|
+
*
|
|
3270
|
+
* @default "default"
|
|
3271
|
+
*/
|
|
3272
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
3273
|
+
}, {
|
|
3274
|
+
type: z.ZodLiteral<"Marker">;
|
|
3275
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
3276
|
+
/**
|
|
3277
|
+
* The opacity of the marker, between 0 and 1.
|
|
3278
|
+
*
|
|
3279
|
+
* @default 1
|
|
3280
|
+
*/
|
|
3281
|
+
opacity: z.ZodNumber;
|
|
3282
|
+
/**
|
|
3283
|
+
* The size of the marker, used in conjunction with the `zoom` to determine
|
|
3284
|
+
* the actual size of the marker.
|
|
3285
|
+
*
|
|
3286
|
+
* @default 10
|
|
3287
|
+
*/
|
|
3288
|
+
size: z.ZodNumber;
|
|
3289
|
+
/**
|
|
3290
|
+
* The zoom level at which the marker was created. This is combined with
|
|
3291
|
+
* the `size` to determine the actual size of the marker.
|
|
3292
|
+
*
|
|
3293
|
+
* When creating a marker, if you don't supply this value it defaults to
|
|
3294
|
+
* the current zoom of the map when you call `createElement`.
|
|
3295
|
+
*/
|
|
3296
|
+
zoom: z.ZodNumber;
|
|
3297
|
+
}>, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
1083
3298
|
type: "Marker";
|
|
1084
3299
|
id: string;
|
|
1085
3300
|
coordinates?: [number, number][][] | undefined;
|
|
@@ -1106,21 +3321,107 @@ declare const MarkerUpdateSchema: z.ZodObject<{
|
|
|
1106
3321
|
size?: number | undefined;
|
|
1107
3322
|
zoom?: number | undefined;
|
|
1108
3323
|
}>;
|
|
1109
|
-
declare const HighlighterUpdateSchema: z.ZodObject<{
|
|
1110
|
-
|
|
1111
|
-
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1112
|
-
id: z.ZodString;
|
|
3324
|
+
declare const HighlighterUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
3325
|
+
id: z.ZodOptional<z.ZodString>;
|
|
1113
3326
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1114
3327
|
color: z.ZodOptional<z.ZodString>;
|
|
1115
|
-
name: z.ZodOptional<z.
|
|
1116
|
-
description: z.ZodOptional<z.
|
|
3328
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3329
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1117
3330
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1118
3331
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
3332
|
+
type: z.ZodOptional<z.ZodLiteral<"Highlighter">>;
|
|
3333
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">, "many">>;
|
|
3334
|
+
renderHoles: z.ZodOptional<z.ZodBoolean>;
|
|
1119
3335
|
opacity: z.ZodOptional<z.ZodNumber>;
|
|
1120
|
-
},
|
|
3336
|
+
}, Pick<z.objectUtil.extendShape<{
|
|
3337
|
+
/**
|
|
3338
|
+
* The unique identifier for the element.
|
|
3339
|
+
*/
|
|
3340
|
+
id: z.ZodString;
|
|
3341
|
+
/**
|
|
3342
|
+
* The ID of the element group that the element belongs to.
|
|
3343
|
+
* For elements that are not part of a group, this will be null.
|
|
3344
|
+
*/
|
|
3345
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
3346
|
+
/**
|
|
3347
|
+
* The color of the element in some CSS-like format.
|
|
3348
|
+
*
|
|
3349
|
+
* @example
|
|
3350
|
+
* ```typescript
|
|
3351
|
+
* "#ABC123";
|
|
3352
|
+
* "rgb(255, 0, 0)";
|
|
3353
|
+
* "hsl(200, 100%, 50%)";
|
|
3354
|
+
* ```
|
|
3355
|
+
*
|
|
3356
|
+
* @default "#C93535"
|
|
3357
|
+
*/
|
|
3358
|
+
color: z.ZodString;
|
|
3359
|
+
/**
|
|
3360
|
+
* The element's name. For elements that can show a label or text on
|
|
3361
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
3362
|
+
*
|
|
3363
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
3364
|
+
* the element is selected by clicking on it.
|
|
3365
|
+
*/
|
|
3366
|
+
name: z.ZodNullable<z.ZodString>;
|
|
3367
|
+
/**
|
|
3368
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
3369
|
+
* is selected.
|
|
3370
|
+
*
|
|
3371
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
3372
|
+
* and Markers, so their description will not be shown.
|
|
3373
|
+
*/
|
|
3374
|
+
description: z.ZodNullable<z.ZodString>;
|
|
3375
|
+
/**
|
|
3376
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
3377
|
+
*
|
|
3378
|
+
* This is most useful for associating additional data with an element that is not
|
|
3379
|
+
* part of the element's core data, such as a Place's address or some other
|
|
3380
|
+
* data.
|
|
3381
|
+
*/
|
|
3382
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3383
|
+
/**
|
|
3384
|
+
* Whether the element is interactive.
|
|
3385
|
+
*
|
|
3386
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
3387
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
3388
|
+
*
|
|
3389
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
3390
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
3391
|
+
* accident.
|
|
3392
|
+
*
|
|
3393
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
3394
|
+
* not editable and have special behaviour depending on their name, description and
|
|
3395
|
+
* attributes.
|
|
3396
|
+
*
|
|
3397
|
+
* @default "default"
|
|
3398
|
+
*/
|
|
3399
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
3400
|
+
}, {
|
|
3401
|
+
type: z.ZodLiteral<"Highlighter">;
|
|
3402
|
+
/**
|
|
3403
|
+
* A multipolygon describing the area that is highlighted.
|
|
3404
|
+
*
|
|
3405
|
+
* If `renderHoles` is set to false, only the outer ring of each polygon
|
|
3406
|
+
* will be rendered, filling in the area inside the highlighted region.
|
|
3407
|
+
*/
|
|
3408
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">, "many">;
|
|
3409
|
+
/**
|
|
3410
|
+
* Whether to render the holes of the highlighted area.
|
|
3411
|
+
*
|
|
3412
|
+
* @default false
|
|
3413
|
+
*/
|
|
3414
|
+
renderHoles: z.ZodBoolean;
|
|
3415
|
+
/**
|
|
3416
|
+
* The opacity of the highlighter, between 0 and 1.
|
|
3417
|
+
*
|
|
3418
|
+
* @default 0.5
|
|
3419
|
+
*/
|
|
3420
|
+
opacity: z.ZodNumber;
|
|
3421
|
+
}>, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
1121
3422
|
type: "Highlighter";
|
|
1122
3423
|
id: string;
|
|
1123
|
-
coordinates?: [number, number][][] | undefined;
|
|
3424
|
+
coordinates?: [number, number][][][] | undefined;
|
|
1124
3425
|
groupId?: string | null | undefined;
|
|
1125
3426
|
color?: string | undefined;
|
|
1126
3427
|
name?: string | null | undefined;
|
|
@@ -1128,10 +3429,11 @@ declare const HighlighterUpdateSchema: z.ZodObject<{
|
|
|
1128
3429
|
attributes?: Record<string, unknown> | undefined;
|
|
1129
3430
|
interaction?: "default" | "locked" | undefined;
|
|
1130
3431
|
opacity?: number | undefined;
|
|
3432
|
+
renderHoles?: boolean | undefined;
|
|
1131
3433
|
}, {
|
|
1132
3434
|
type: "Highlighter";
|
|
1133
3435
|
id: string;
|
|
1134
|
-
coordinates?: [number, number][][] | undefined;
|
|
3436
|
+
coordinates?: [number, number][][][] | undefined;
|
|
1135
3437
|
groupId?: string | null | undefined;
|
|
1136
3438
|
color?: string | undefined;
|
|
1137
3439
|
name?: string | null | undefined;
|
|
@@ -1139,25 +3441,122 @@ declare const HighlighterUpdateSchema: z.ZodObject<{
|
|
|
1139
3441
|
attributes?: Record<string, unknown> | undefined;
|
|
1140
3442
|
interaction?: "default" | "locked" | undefined;
|
|
1141
3443
|
opacity?: number | undefined;
|
|
3444
|
+
renderHoles?: boolean | undefined;
|
|
1142
3445
|
}>;
|
|
1143
|
-
declare const TextUpdateSchema: z.ZodObject<Omit<{
|
|
1144
|
-
|
|
1145
|
-
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1146
|
-
id: z.ZodString;
|
|
3446
|
+
declare const TextUpdateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
3447
|
+
id: z.ZodOptional<z.ZodString>;
|
|
1147
3448
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1148
3449
|
color: z.ZodOptional<z.ZodString>;
|
|
1149
|
-
|
|
1150
|
-
description: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
|
|
3450
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1151
3451
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1152
3452
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
1153
|
-
zoom: z.ZodOptional<z.ZodNumber>;
|
|
1154
3453
|
position: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
1155
3454
|
rotation: z.ZodOptional<z.ZodNumber>;
|
|
1156
3455
|
scale: z.ZodOptional<z.ZodNumber>;
|
|
3456
|
+
zoom: z.ZodOptional<z.ZodNumber>;
|
|
3457
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1157
3458
|
text: z.ZodOptional<z.ZodString>;
|
|
1158
3459
|
align: z.ZodOptional<z.ZodEnum<["left", "center", "right"]>>;
|
|
1159
3460
|
style: z.ZodOptional<z.ZodEnum<["italic", "light", "regular", "caps"]>>;
|
|
1160
|
-
|
|
3461
|
+
name: z.ZodOptional<z.ZodString>;
|
|
3462
|
+
type: z.ZodOptional<z.ZodLiteral<"Text">>;
|
|
3463
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
3464
|
+
/**
|
|
3465
|
+
* The unique identifier for the element.
|
|
3466
|
+
*/
|
|
3467
|
+
id: z.ZodString;
|
|
3468
|
+
/**
|
|
3469
|
+
* The ID of the element group that the element belongs to.
|
|
3470
|
+
* For elements that are not part of a group, this will be null.
|
|
3471
|
+
*/
|
|
3472
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
3473
|
+
/**
|
|
3474
|
+
* The color of the element in some CSS-like format.
|
|
3475
|
+
*
|
|
3476
|
+
* @example
|
|
3477
|
+
* ```typescript
|
|
3478
|
+
* "#ABC123";
|
|
3479
|
+
* "rgb(255, 0, 0)";
|
|
3480
|
+
* "hsl(200, 100%, 50%)";
|
|
3481
|
+
* ```
|
|
3482
|
+
*
|
|
3483
|
+
* @default "#C93535"
|
|
3484
|
+
*/
|
|
3485
|
+
color: z.ZodString;
|
|
3486
|
+
/**
|
|
3487
|
+
* The element's name. For elements that can show a label or text on
|
|
3488
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
3489
|
+
*
|
|
3490
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
3491
|
+
* the element is selected by clicking on it.
|
|
3492
|
+
*/
|
|
3493
|
+
name: z.ZodNullable<z.ZodString>;
|
|
3494
|
+
/**
|
|
3495
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
3496
|
+
* is selected.
|
|
3497
|
+
*
|
|
3498
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
3499
|
+
* and Markers, so their description will not be shown.
|
|
3500
|
+
*/
|
|
3501
|
+
description: z.ZodNullable<z.ZodString>;
|
|
3502
|
+
/**
|
|
3503
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
3504
|
+
*
|
|
3505
|
+
* This is most useful for associating additional data with an element that is not
|
|
3506
|
+
* part of the element's core data, such as a Place's address or some other
|
|
3507
|
+
* data.
|
|
3508
|
+
*/
|
|
3509
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3510
|
+
/**
|
|
3511
|
+
* Whether the element is interactive.
|
|
3512
|
+
*
|
|
3513
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
3514
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
3515
|
+
*
|
|
3516
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
3517
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
3518
|
+
* accident.
|
|
3519
|
+
*
|
|
3520
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
3521
|
+
* not editable and have special behaviour depending on their name, description and
|
|
3522
|
+
* attributes.
|
|
3523
|
+
*
|
|
3524
|
+
* @default "default"
|
|
3525
|
+
*/
|
|
3526
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
3527
|
+
}, {
|
|
3528
|
+
position: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
3529
|
+
rotation: z.ZodNumber;
|
|
3530
|
+
scale: z.ZodNumber;
|
|
3531
|
+
zoom: z.ZodNumber;
|
|
3532
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
3533
|
+
}>, {
|
|
3534
|
+
/**
|
|
3535
|
+
* The text in the element.
|
|
3536
|
+
*/
|
|
3537
|
+
text: z.ZodString;
|
|
3538
|
+
/**
|
|
3539
|
+
* The alignment of the text, either `left`, `center` or `right`.
|
|
3540
|
+
*
|
|
3541
|
+
* @default "center"
|
|
3542
|
+
*/
|
|
3543
|
+
align: z.ZodEnum<["left", "center", "right"]>;
|
|
3544
|
+
/**
|
|
3545
|
+
* The style of the text, either `italic`, `light`, `regular` or `caps`.
|
|
3546
|
+
*
|
|
3547
|
+
* @default "regular"
|
|
3548
|
+
*/
|
|
3549
|
+
style: z.ZodEnum<["italic", "light", "regular", "caps"]>;
|
|
3550
|
+
/**
|
|
3551
|
+
* The text shown in the element, which is identical to the `text` property.
|
|
3552
|
+
*
|
|
3553
|
+
* @remarks This is added for consistency with other elements that have a `name`
|
|
3554
|
+
* property.
|
|
3555
|
+
*/
|
|
3556
|
+
name: z.ZodString;
|
|
3557
|
+
}>, {
|
|
3558
|
+
type: z.ZodLiteral<"Text">;
|
|
3559
|
+
}>, "type" | "id">>, "coordinates" | "name">, "strip", z.ZodTypeAny, {
|
|
1161
3560
|
type: "Text";
|
|
1162
3561
|
id: string;
|
|
1163
3562
|
groupId?: string | null | undefined;
|
|
@@ -1170,7 +3569,7 @@ declare const TextUpdateSchema: z.ZodObject<Omit<{
|
|
|
1170
3569
|
rotation?: number | undefined;
|
|
1171
3570
|
scale?: number | undefined;
|
|
1172
3571
|
text?: string | undefined;
|
|
1173
|
-
align?: "
|
|
3572
|
+
align?: "center" | "left" | "right" | undefined;
|
|
1174
3573
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
1175
3574
|
}, {
|
|
1176
3575
|
type: "Text";
|
|
@@ -1185,28 +3584,125 @@ declare const TextUpdateSchema: z.ZodObject<Omit<{
|
|
|
1185
3584
|
rotation?: number | undefined;
|
|
1186
3585
|
scale?: number | undefined;
|
|
1187
3586
|
text?: string | undefined;
|
|
1188
|
-
align?: "
|
|
3587
|
+
align?: "center" | "left" | "right" | undefined;
|
|
1189
3588
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
1190
3589
|
}>;
|
|
1191
|
-
declare const NoteUpdateSchema: z.ZodObject<Omit<{
|
|
1192
|
-
|
|
1193
|
-
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1194
|
-
id: z.ZodString;
|
|
3590
|
+
declare const NoteUpdateSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
|
|
3591
|
+
id: z.ZodOptional<z.ZodString>;
|
|
1195
3592
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1196
3593
|
color: z.ZodOptional<z.ZodString>;
|
|
1197
|
-
|
|
1198
|
-
description: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
|
|
3594
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1199
3595
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1200
3596
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
1201
|
-
zoom: z.ZodOptional<z.ZodNumber>;
|
|
1202
3597
|
position: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
|
|
1203
3598
|
rotation: z.ZodOptional<z.ZodNumber>;
|
|
1204
3599
|
scale: z.ZodOptional<z.ZodNumber>;
|
|
3600
|
+
zoom: z.ZodOptional<z.ZodNumber>;
|
|
3601
|
+
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1205
3602
|
text: z.ZodOptional<z.ZodString>;
|
|
1206
3603
|
align: z.ZodOptional<z.ZodEnum<["left", "center", "right"]>>;
|
|
1207
3604
|
style: z.ZodOptional<z.ZodEnum<["italic", "light", "regular", "caps"]>>;
|
|
3605
|
+
name: z.ZodOptional<z.ZodString>;
|
|
3606
|
+
type: z.ZodOptional<z.ZodLiteral<"Note">>;
|
|
1208
3607
|
widthScale: z.ZodOptional<z.ZodNumber>;
|
|
1209
|
-
},
|
|
3608
|
+
}, Pick<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
3609
|
+
/**
|
|
3610
|
+
* The unique identifier for the element.
|
|
3611
|
+
*/
|
|
3612
|
+
id: z.ZodString;
|
|
3613
|
+
/**
|
|
3614
|
+
* The ID of the element group that the element belongs to.
|
|
3615
|
+
* For elements that are not part of a group, this will be null.
|
|
3616
|
+
*/
|
|
3617
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
3618
|
+
/**
|
|
3619
|
+
* The color of the element in some CSS-like format.
|
|
3620
|
+
*
|
|
3621
|
+
* @example
|
|
3622
|
+
* ```typescript
|
|
3623
|
+
* "#ABC123";
|
|
3624
|
+
* "rgb(255, 0, 0)";
|
|
3625
|
+
* "hsl(200, 100%, 50%)";
|
|
3626
|
+
* ```
|
|
3627
|
+
*
|
|
3628
|
+
* @default "#C93535"
|
|
3629
|
+
*/
|
|
3630
|
+
color: z.ZodString;
|
|
3631
|
+
/**
|
|
3632
|
+
* The element's name. For elements that can show a label or text on
|
|
3633
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
3634
|
+
*
|
|
3635
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
3636
|
+
* the element is selected by clicking on it.
|
|
3637
|
+
*/
|
|
3638
|
+
name: z.ZodNullable<z.ZodString>;
|
|
3639
|
+
/**
|
|
3640
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
3641
|
+
* is selected.
|
|
3642
|
+
*
|
|
3643
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
3644
|
+
* and Markers, so their description will not be shown.
|
|
3645
|
+
*/
|
|
3646
|
+
description: z.ZodNullable<z.ZodString>;
|
|
3647
|
+
/**
|
|
3648
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
3649
|
+
*
|
|
3650
|
+
* This is most useful for associating additional data with an element that is not
|
|
3651
|
+
* part of the element's core data, such as a Place's address or some other
|
|
3652
|
+
* data.
|
|
3653
|
+
*/
|
|
3654
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3655
|
+
/**
|
|
3656
|
+
* Whether the element is interactive.
|
|
3657
|
+
*
|
|
3658
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
3659
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
3660
|
+
*
|
|
3661
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
3662
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
3663
|
+
* accident.
|
|
3664
|
+
*
|
|
3665
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
3666
|
+
* not editable and have special behaviour depending on their name, description and
|
|
3667
|
+
* attributes.
|
|
3668
|
+
*
|
|
3669
|
+
* @default "default"
|
|
3670
|
+
*/
|
|
3671
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
3672
|
+
}, {
|
|
3673
|
+
position: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
3674
|
+
rotation: z.ZodNumber;
|
|
3675
|
+
scale: z.ZodNumber;
|
|
3676
|
+
zoom: z.ZodNumber;
|
|
3677
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
3678
|
+
}>, {
|
|
3679
|
+
/**
|
|
3680
|
+
* The text in the element.
|
|
3681
|
+
*/
|
|
3682
|
+
text: z.ZodString;
|
|
3683
|
+
/**
|
|
3684
|
+
* The alignment of the text, either `left`, `center` or `right`.
|
|
3685
|
+
*
|
|
3686
|
+
* @default "center"
|
|
3687
|
+
*/
|
|
3688
|
+
align: z.ZodEnum<["left", "center", "right"]>;
|
|
3689
|
+
/**
|
|
3690
|
+
* The style of the text, either `italic`, `light`, `regular` or `caps`.
|
|
3691
|
+
*
|
|
3692
|
+
* @default "regular"
|
|
3693
|
+
*/
|
|
3694
|
+
style: z.ZodEnum<["italic", "light", "regular", "caps"]>;
|
|
3695
|
+
/**
|
|
3696
|
+
* The text shown in the element, which is identical to the `text` property.
|
|
3697
|
+
*
|
|
3698
|
+
* @remarks This is added for consistency with other elements that have a `name`
|
|
3699
|
+
* property.
|
|
3700
|
+
*/
|
|
3701
|
+
name: z.ZodString;
|
|
3702
|
+
}>, {
|
|
3703
|
+
type: z.ZodLiteral<"Note">;
|
|
3704
|
+
widthScale: z.ZodNumber;
|
|
3705
|
+
}>, "type" | "id">>, "coordinates" | "name">, "strip", z.ZodTypeAny, {
|
|
1210
3706
|
type: "Note";
|
|
1211
3707
|
id: string;
|
|
1212
3708
|
groupId?: string | null | undefined;
|
|
@@ -1219,7 +3715,7 @@ declare const NoteUpdateSchema: z.ZodObject<Omit<{
|
|
|
1219
3715
|
rotation?: number | undefined;
|
|
1220
3716
|
scale?: number | undefined;
|
|
1221
3717
|
text?: string | undefined;
|
|
1222
|
-
align?: "
|
|
3718
|
+
align?: "center" | "left" | "right" | undefined;
|
|
1223
3719
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
1224
3720
|
widthScale?: number | undefined;
|
|
1225
3721
|
}, {
|
|
@@ -1235,22 +3731,99 @@ declare const NoteUpdateSchema: z.ZodObject<Omit<{
|
|
|
1235
3731
|
rotation?: number | undefined;
|
|
1236
3732
|
scale?: number | undefined;
|
|
1237
3733
|
text?: string | undefined;
|
|
1238
|
-
align?: "
|
|
3734
|
+
align?: "center" | "left" | "right" | undefined;
|
|
1239
3735
|
style?: "italic" | "light" | "regular" | "caps" | undefined;
|
|
1240
3736
|
widthScale?: number | undefined;
|
|
1241
3737
|
}>;
|
|
1242
|
-
declare const ImageUpdateSchema: z.ZodObject<{
|
|
1243
|
-
type: z.ZodLiteral<"Image"
|
|
3738
|
+
declare const ImageUpdateSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
3739
|
+
type: z.ZodOptional<z.ZodLiteral<"Image">>;
|
|
1244
3740
|
coordinates: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">>;
|
|
1245
|
-
id: z.ZodString
|
|
3741
|
+
id: z.ZodOptional<z.ZodString>;
|
|
1246
3742
|
groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1247
|
-
name: z.ZodOptional<z.
|
|
1248
|
-
description: z.ZodOptional<z.
|
|
3743
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3744
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1249
3745
|
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1250
3746
|
interaction: z.ZodOptional<z.ZodOptional<z.ZodEnum<["default", "locked"]>>>;
|
|
1251
3747
|
imageUrl: z.ZodOptional<z.ZodString>;
|
|
1252
3748
|
opacity: z.ZodOptional<z.ZodNumber>;
|
|
1253
|
-
},
|
|
3749
|
+
}, Pick<Omit<z.objectUtil.extendShape<{
|
|
3750
|
+
/**
|
|
3751
|
+
* The unique identifier for the element.
|
|
3752
|
+
*/
|
|
3753
|
+
id: z.ZodString;
|
|
3754
|
+
/**
|
|
3755
|
+
* The ID of the element group that the element belongs to.
|
|
3756
|
+
* For elements that are not part of a group, this will be null.
|
|
3757
|
+
*/
|
|
3758
|
+
groupId: z.ZodNullable<z.ZodString>;
|
|
3759
|
+
/**
|
|
3760
|
+
* The color of the element in some CSS-like format.
|
|
3761
|
+
*
|
|
3762
|
+
* @example
|
|
3763
|
+
* ```typescript
|
|
3764
|
+
* "#ABC123";
|
|
3765
|
+
* "rgb(255, 0, 0)";
|
|
3766
|
+
* "hsl(200, 100%, 50%)";
|
|
3767
|
+
* ```
|
|
3768
|
+
*
|
|
3769
|
+
* @default "#C93535"
|
|
3770
|
+
*/
|
|
3771
|
+
color: z.ZodString;
|
|
3772
|
+
/**
|
|
3773
|
+
* The element's name. For elements that can show a label or text on
|
|
3774
|
+
* the map (e.g. a Place or Text element) this is the text that will be shown.
|
|
3775
|
+
*
|
|
3776
|
+
* For elements such as Polygons or Paths, the name is what is shown when
|
|
3777
|
+
* the element is selected by clicking on it.
|
|
3778
|
+
*/
|
|
3779
|
+
name: z.ZodNullable<z.ZodString>;
|
|
3780
|
+
/**
|
|
3781
|
+
* Text describing the element, which is shown in an element's popup when it
|
|
3782
|
+
* is selected.
|
|
3783
|
+
*
|
|
3784
|
+
* Note that some elements are not selectable on the map, such as Notes, Text
|
|
3785
|
+
* and Markers, so their description will not be shown.
|
|
3786
|
+
*/
|
|
3787
|
+
description: z.ZodNullable<z.ZodString>;
|
|
3788
|
+
/**
|
|
3789
|
+
* A set of key-value pairs that can be used to store arbitrary data about the element.
|
|
3790
|
+
*
|
|
3791
|
+
* This is most useful for associating additional data with an element that is not
|
|
3792
|
+
* part of the element's core data, such as a Place's address or some other
|
|
3793
|
+
* data.
|
|
3794
|
+
*/
|
|
3795
|
+
attributes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3796
|
+
/**
|
|
3797
|
+
* Whether the element is interactive.
|
|
3798
|
+
*
|
|
3799
|
+
* The `default` interaction mode means that the element can be selected and edited by
|
|
3800
|
+
* the user, if it was created by the SDK or by the user using a tool.
|
|
3801
|
+
*
|
|
3802
|
+
* If the interaction mode is `locked`, the element will not be editable by the user,
|
|
3803
|
+
* which is often used for elements that you don't want the user to edit or move by
|
|
3804
|
+
* accident.
|
|
3805
|
+
*
|
|
3806
|
+
* Elements that were created by the map author (i.e. not during an SDK "session") are
|
|
3807
|
+
* not editable and have special behaviour depending on their name, description and
|
|
3808
|
+
* attributes.
|
|
3809
|
+
*
|
|
3810
|
+
* @default "default"
|
|
3811
|
+
*/
|
|
3812
|
+
interaction: z.ZodOptional<z.ZodEnum<["default", "locked"]>>;
|
|
3813
|
+
}, {
|
|
3814
|
+
type: z.ZodLiteral<"Image">;
|
|
3815
|
+
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
3816
|
+
/**
|
|
3817
|
+
* The URL of the image that is rendered in this element
|
|
3818
|
+
*/
|
|
3819
|
+
imageUrl: z.ZodString;
|
|
3820
|
+
/**
|
|
3821
|
+
* The opacity of the image, between 0 and 1.
|
|
3822
|
+
*
|
|
3823
|
+
* @default 1
|
|
3824
|
+
*/
|
|
3825
|
+
opacity: z.ZodNumber;
|
|
3826
|
+
}>, "color">, "type" | "id">>, "strip", z.ZodTypeAny, {
|
|
1254
3827
|
type: "Image";
|
|
1255
3828
|
id: string;
|
|
1256
3829
|
coordinates?: [number, number][][] | undefined;
|
|
@@ -1274,16 +3847,22 @@ declare const ImageUpdateSchema: z.ZodObject<{
|
|
|
1274
3847
|
opacity?: number | undefined;
|
|
1275
3848
|
}>;
|
|
1276
3849
|
interface PlaceElementCreate extends zInfer<typeof PlaceCreateSchema> {
|
|
3850
|
+
coordinates: LngLatTuple;
|
|
1277
3851
|
}
|
|
1278
3852
|
interface PathElementCreate extends zInfer<typeof PathCreateSchema> {
|
|
3853
|
+
coordinates: LngLatTuple[][];
|
|
1279
3854
|
}
|
|
1280
3855
|
interface PolygonElementCreate extends zInfer<typeof PolygonCreateSchema> {
|
|
3856
|
+
coordinates: LngLatTuple[][];
|
|
1281
3857
|
}
|
|
1282
3858
|
interface CircleElementCreate extends zInfer<typeof CircleCreateSchema> {
|
|
3859
|
+
center: LngLatTuple;
|
|
1283
3860
|
}
|
|
1284
3861
|
interface MarkerElementCreate extends zInfer<typeof MarkerCreateSchema> {
|
|
3862
|
+
coordinates: LngLatTuple[][];
|
|
1285
3863
|
}
|
|
1286
3864
|
interface HighlighterElementCreate extends zInfer<typeof HighlighterCreateSchema> {
|
|
3865
|
+
coordinates: LngLatTuple[][][];
|
|
1287
3866
|
}
|
|
1288
3867
|
interface TextElementCreate extends zInfer<typeof TextCreateSchema> {
|
|
1289
3868
|
}
|
|
@@ -1292,36 +3871,46 @@ interface NoteElementCreate extends zInfer<typeof NoteCreateSchema> {
|
|
|
1292
3871
|
interface ImageElementCreate extends zInfer<typeof ImageCreateSchema> {
|
|
1293
3872
|
}
|
|
1294
3873
|
interface PlaceElementRead extends zInfer<typeof PlaceReadSchema> {
|
|
3874
|
+
coordinates: LngLatTuple;
|
|
1295
3875
|
}
|
|
1296
3876
|
interface PathElementRead extends zInfer<typeof PathReadSchema> {
|
|
1297
3877
|
}
|
|
1298
3878
|
interface PolygonElementRead extends zInfer<typeof PolygonReadSchema> {
|
|
1299
3879
|
}
|
|
1300
3880
|
interface CircleElementRead extends zInfer<typeof CircleReadSchema> {
|
|
3881
|
+
center: LngLatTuple;
|
|
1301
3882
|
}
|
|
1302
3883
|
interface MarkerElementRead extends zInfer<typeof MarkerReadSchema> {
|
|
1303
3884
|
}
|
|
1304
3885
|
interface HighlighterElementRead extends zInfer<typeof HighlighterReadSchema> {
|
|
1305
3886
|
}
|
|
1306
3887
|
interface TextElementRead extends zInfer<typeof TextReadSchema> {
|
|
3888
|
+
position: LngLatTuple;
|
|
1307
3889
|
}
|
|
1308
3890
|
interface NoteElementRead extends zInfer<typeof NoteReadSchema> {
|
|
3891
|
+
position: LngLatTuple;
|
|
1309
3892
|
}
|
|
1310
3893
|
interface ImageElementRead extends zInfer<typeof ImageReadSchema> {
|
|
1311
3894
|
}
|
|
1312
3895
|
interface LinkElementRead extends zInfer<typeof LinkReadSchema> {
|
|
1313
3896
|
}
|
|
1314
3897
|
interface PlaceElementUpdate extends zInfer<typeof PlaceUpdateSchema> {
|
|
3898
|
+
coordinates?: LngLatTuple;
|
|
1315
3899
|
}
|
|
1316
3900
|
interface PathElementUpdate extends zInfer<typeof PathUpdateSchema> {
|
|
3901
|
+
coordinates?: LngLatTuple[][];
|
|
1317
3902
|
}
|
|
1318
3903
|
interface PolygonElementUpdate extends zInfer<typeof PolygonUpdateSchema> {
|
|
3904
|
+
coordinates?: LngLatTuple[][];
|
|
1319
3905
|
}
|
|
1320
3906
|
interface CircleElementUpdate extends zInfer<typeof CircleUpdateSchema> {
|
|
3907
|
+
center?: LngLatTuple;
|
|
1321
3908
|
}
|
|
1322
3909
|
interface MarkerElementUpdate extends zInfer<typeof MarkerUpdateSchema> {
|
|
3910
|
+
coordinates?: LngLatTuple[][];
|
|
1323
3911
|
}
|
|
1324
3912
|
interface HighlighterElementUpdate extends zInfer<typeof HighlighterUpdateSchema> {
|
|
3913
|
+
coordinates?: LngLatTuple[][][];
|
|
1325
3914
|
}
|
|
1326
3915
|
interface TextElementUpdate extends zInfer<typeof TextUpdateSchema> {
|
|
1327
3916
|
}
|
|
@@ -1355,7 +3944,7 @@ interface ElementGroup {
|
|
|
1355
3944
|
* The ids of the elements in the element group.
|
|
1356
3945
|
*
|
|
1357
3946
|
* @remarks
|
|
1358
|
-
* You can use these ids to get the full element objects via the `getElements` method.
|
|
3947
|
+
* You can use these ids to get the full element objects via the {@link ElementsController.getElements | `getElements`} method.
|
|
1359
3948
|
*/
|
|
1360
3949
|
elementIds: Array<string>;
|
|
1361
3950
|
/**
|
|
@@ -1405,7 +3994,7 @@ declare const GetElementGroupsConstraintSchema: z.ZodObject<{
|
|
|
1405
3994
|
ids?: string[] | undefined;
|
|
1406
3995
|
}>;
|
|
1407
3996
|
/**
|
|
1408
|
-
* The parameters for the `onElementChange` and the `onElementCreate` listeners.
|
|
3997
|
+
* The parameters for the {@link ElementsController.onElementChange | `onElementChange`} and the {@link ElementsController.onElementCreate | `onElementCreate`} listeners.
|
|
1409
3998
|
*
|
|
1410
3999
|
* @group Elements
|
|
1411
4000
|
*/
|
|
@@ -1432,7 +4021,7 @@ interface ElementChangeCallbackParams {
|
|
|
1432
4021
|
isBeingCreated: boolean;
|
|
1433
4022
|
}
|
|
1434
4023
|
/**
|
|
1435
|
-
* The parameters for the `onElementGroupChange` listener.
|
|
4024
|
+
* The parameters for the {@link ElementsController.onElementGroupChange | `onElementGroupChange`} listener.
|
|
1436
4025
|
*
|
|
1437
4026
|
* @group Element Groups
|
|
1438
4027
|
*/
|
|
@@ -1440,210 +4029,6 @@ interface ElementGroupChangeCallbackParams {
|
|
|
1440
4029
|
elementGroup: ElementGroup | null;
|
|
1441
4030
|
}
|
|
1442
4031
|
|
|
1443
|
-
/**
|
|
1444
|
-
* Represents a point in world coordinates.
|
|
1445
|
-
*/
|
|
1446
|
-
interface LatLng {
|
|
1447
|
-
latitude: number;
|
|
1448
|
-
longitude: number;
|
|
1449
|
-
}
|
|
1450
|
-
/**
|
|
1451
|
-
* A tuple representing a longitude and latitude coordinate.
|
|
1452
|
-
*
|
|
1453
|
-
* This is used hen serializing geometry because that's the standard used in
|
|
1454
|
-
* GeoJSON.
|
|
1455
|
-
*/
|
|
1456
|
-
type LngLatTuple = [longitude: number, latitude: number];
|
|
1457
|
-
/**
|
|
1458
|
-
* A GeoJSON properties object.
|
|
1459
|
-
*/
|
|
1460
|
-
type GeoJsonProperties = Record<string, unknown>;
|
|
1461
|
-
/**
|
|
1462
|
-
* A GeoJSON feature object, compliant with:
|
|
1463
|
-
* https://datatracker.ietf.org/doc/html/rfc7946#section-3.2
|
|
1464
|
-
*
|
|
1465
|
-
* @interface
|
|
1466
|
-
*/
|
|
1467
|
-
type GeoJsonFeature = {
|
|
1468
|
-
type: "Feature";
|
|
1469
|
-
/**
|
|
1470
|
-
* The bounding box of the feature.
|
|
1471
|
-
*/
|
|
1472
|
-
bbox?: FeltBoundary;
|
|
1473
|
-
/**
|
|
1474
|
-
* The feature's geometry
|
|
1475
|
-
*/
|
|
1476
|
-
geometry: GeoJsonGeometry;
|
|
1477
|
-
/**
|
|
1478
|
-
* A value that uniquely identifies this feature in a
|
|
1479
|
-
* https://tools.ietf.org/html/rfc7946#section-3.2.
|
|
1480
|
-
*/
|
|
1481
|
-
id?: string | number | undefined;
|
|
1482
|
-
/**
|
|
1483
|
-
* Properties associated with this feature.
|
|
1484
|
-
*/
|
|
1485
|
-
properties: GeoJsonProperties;
|
|
1486
|
-
};
|
|
1487
|
-
interface PointGeometry extends zInfer<typeof PointGeometrySchema> {
|
|
1488
|
-
}
|
|
1489
|
-
/**
|
|
1490
|
-
* A GeoJSON point geometry.
|
|
1491
|
-
*/
|
|
1492
|
-
declare const PointGeometrySchema: z.ZodObject<{
|
|
1493
|
-
type: z.ZodLiteral<"Point">;
|
|
1494
|
-
coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
|
|
1495
|
-
}, "strip", z.ZodTypeAny, {
|
|
1496
|
-
type: "Point";
|
|
1497
|
-
coordinates: [number, number];
|
|
1498
|
-
}, {
|
|
1499
|
-
type: "Point";
|
|
1500
|
-
coordinates: [number, number];
|
|
1501
|
-
}>;
|
|
1502
|
-
/**
|
|
1503
|
-
* A GeoJSON multi-point geometry.
|
|
1504
|
-
*
|
|
1505
|
-
* @remarks
|
|
1506
|
-
* You shouldn't expect this to come from Felt - it is here for completeness
|
|
1507
|
-
* of the GeoJSON spec.
|
|
1508
|
-
*/
|
|
1509
|
-
interface MultiPointGeometry {
|
|
1510
|
-
type: "MultiPoint";
|
|
1511
|
-
coordinates: PointGeometry["coordinates"][];
|
|
1512
|
-
}
|
|
1513
|
-
interface PolygonGeometry extends zInfer<typeof PolygonGeometrySchema> {
|
|
1514
|
-
}
|
|
1515
|
-
/**
|
|
1516
|
-
* A GeoJSON polygon geometry.
|
|
1517
|
-
*/
|
|
1518
|
-
declare const PolygonGeometrySchema: z.ZodObject<{
|
|
1519
|
-
type: z.ZodLiteral<"Polygon">;
|
|
1520
|
-
coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
|
|
1521
|
-
}, "strip", z.ZodTypeAny, {
|
|
1522
|
-
type: "Polygon";
|
|
1523
|
-
coordinates: [number, number][][];
|
|
1524
|
-
}, {
|
|
1525
|
-
type: "Polygon";
|
|
1526
|
-
coordinates: [number, number][][];
|
|
1527
|
-
}>;
|
|
1528
|
-
/**
|
|
1529
|
-
* A GeoJSON multi-polygon geometry.
|
|
1530
|
-
*
|
|
1531
|
-
* @interface
|
|
1532
|
-
*/
|
|
1533
|
-
type MultiPolygonGeometry = {
|
|
1534
|
-
type: "MultiPolygon";
|
|
1535
|
-
coordinates: PolygonGeometry["coordinates"][];
|
|
1536
|
-
};
|
|
1537
|
-
/**
|
|
1538
|
-
* A GeoJSON line string geometry.
|
|
1539
|
-
*
|
|
1540
|
-
* @interface
|
|
1541
|
-
*/
|
|
1542
|
-
type LineStringGeometry = {
|
|
1543
|
-
type: "LineString";
|
|
1544
|
-
coordinates: LngLatTuple[];
|
|
1545
|
-
};
|
|
1546
|
-
/**
|
|
1547
|
-
* A GeoJSON multi-line string geometry.
|
|
1548
|
-
*
|
|
1549
|
-
* @interface
|
|
1550
|
-
*/
|
|
1551
|
-
type MultiLineStringGeometry = {
|
|
1552
|
-
type: "MultiLineString";
|
|
1553
|
-
coordinates: LineStringGeometry["coordinates"][];
|
|
1554
|
-
};
|
|
1555
|
-
/**
|
|
1556
|
-
* A GeoJSON geometry of any type
|
|
1557
|
-
*/
|
|
1558
|
-
type GeoJsonGeometry = PointGeometry | PolygonGeometry | LineStringGeometry | MultiLineStringGeometry | MultiPolygonGeometry | MultiPointGeometry;
|
|
1559
|
-
/**
|
|
1560
|
-
* @ignore
|
|
1561
|
-
* @internal
|
|
1562
|
-
*/
|
|
1563
|
-
declare const FeltZoomSchema: z.ZodNumber;
|
|
1564
|
-
/**
|
|
1565
|
-
* The zoom level of the map.
|
|
1566
|
-
*
|
|
1567
|
-
* It is a floating-point number between 1 and 23, where 1 is the most
|
|
1568
|
-
* zoomed out and 23 is the most zoomed in.
|
|
1569
|
-
*
|
|
1570
|
-
* @group Types
|
|
1571
|
-
* @public
|
|
1572
|
-
*/
|
|
1573
|
-
type FeltZoom = z.infer<typeof FeltZoomSchema>;
|
|
1574
|
-
/**
|
|
1575
|
-
* @ignore
|
|
1576
|
-
* @internal
|
|
1577
|
-
*/
|
|
1578
|
-
declare const FeltBoundarySchema: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
|
|
1579
|
-
/**
|
|
1580
|
-
* The edges of the map in the form of a bounding box.
|
|
1581
|
-
*
|
|
1582
|
-
* The boundary is a tuple of the form `[west, south, east, north]`.
|
|
1583
|
-
*
|
|
1584
|
-
* @group Types
|
|
1585
|
-
* @public
|
|
1586
|
-
*/
|
|
1587
|
-
type FeltBoundary = z.infer<typeof FeltBoundarySchema>;
|
|
1588
|
-
/**
|
|
1589
|
-
* The parameters for the methods that change the visibility of entities.
|
|
1590
|
-
*
|
|
1591
|
-
* @public
|
|
1592
|
-
* @category Visibility
|
|
1593
|
-
*/
|
|
1594
|
-
interface SetVisibilityRequest extends zInfer<typeof SetVisibilityRequestSchema> {
|
|
1595
|
-
}
|
|
1596
|
-
/**
|
|
1597
|
-
* @internal
|
|
1598
|
-
*/
|
|
1599
|
-
declare const SetVisibilityRequestSchema: z.ZodObject<{
|
|
1600
|
-
/**
|
|
1601
|
-
* The ids of the entities you want to change the visibility of.
|
|
1602
|
-
*/
|
|
1603
|
-
show: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1604
|
-
hide: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1605
|
-
}, "strip", z.ZodTypeAny, {
|
|
1606
|
-
show?: string[] | undefined;
|
|
1607
|
-
hide?: string[] | undefined;
|
|
1608
|
-
}, {
|
|
1609
|
-
show?: string[] | undefined;
|
|
1610
|
-
hide?: string[] | undefined;
|
|
1611
|
-
}>;
|
|
1612
|
-
/**
|
|
1613
|
-
* Specifies the direction to sort data in
|
|
1614
|
-
*
|
|
1615
|
-
* @group Types
|
|
1616
|
-
*/
|
|
1617
|
-
type SortDirection = z.infer<typeof SortDirectionSchema>;
|
|
1618
|
-
/** @ignore */
|
|
1619
|
-
declare const SortDirectionSchema: z.ZodEnum<["asc", "desc"]>;
|
|
1620
|
-
/**
|
|
1621
|
-
* Configuration for sorting data by a specific attribute
|
|
1622
|
-
*
|
|
1623
|
-
* @group Types
|
|
1624
|
-
*/
|
|
1625
|
-
interface SortConfig extends zInfer<typeof SortConfigSchema> {
|
|
1626
|
-
}
|
|
1627
|
-
/** @ignore */
|
|
1628
|
-
declare const SortConfigSchema: z.ZodObject<{
|
|
1629
|
-
/**
|
|
1630
|
-
* The attribute to sort by. What this represents depends on the context.
|
|
1631
|
-
* For instance, when sorting features in a data table, the attribute is
|
|
1632
|
-
* the column to sort by.
|
|
1633
|
-
*/
|
|
1634
|
-
attribute: z.ZodString;
|
|
1635
|
-
/**
|
|
1636
|
-
* The direction to sort in
|
|
1637
|
-
*/
|
|
1638
|
-
direction: z.ZodEnum<["asc", "desc"]>;
|
|
1639
|
-
}, "strip", z.ZodTypeAny, {
|
|
1640
|
-
attribute: string;
|
|
1641
|
-
direction: "asc" | "desc";
|
|
1642
|
-
}, {
|
|
1643
|
-
attribute: string;
|
|
1644
|
-
direction: "asc" | "desc";
|
|
1645
|
-
}>;
|
|
1646
|
-
|
|
1647
4032
|
/**
|
|
1648
4033
|
* A LayerFeature is a single geographical item in a layer.
|
|
1649
4034
|
*
|
|
@@ -1791,8 +4176,11 @@ interface Layer {
|
|
|
1791
4176
|
*/
|
|
1792
4177
|
geometryType: string | null;
|
|
1793
4178
|
/**
|
|
1794
|
-
* The bounding box of the layer
|
|
1795
|
-
*
|
|
4179
|
+
* The bounding box of the layer in [west, south, east, north] order
|
|
4180
|
+
*
|
|
4181
|
+
* There are cases where the bounds are not available, such as for layers added to the map
|
|
4182
|
+
* from URL sources, as these are not (depending on their type) processed and analyzed by
|
|
4183
|
+
* Felt.
|
|
1796
4184
|
*
|
|
1797
4185
|
* {@link FeltBoundary}
|
|
1798
4186
|
*/
|
|
@@ -1818,7 +4206,7 @@ interface LayerGroup {
|
|
|
1818
4206
|
* The ids of the layers in the layer group.
|
|
1819
4207
|
*
|
|
1820
4208
|
* @remarks
|
|
1821
|
-
* You can use these ids to get the full layer objects via the `getLayers` method.
|
|
4209
|
+
* You can use these ids to get the full layer objects via the {@link LayersController.getLayers | `getLayers`} method.
|
|
1822
4210
|
*/
|
|
1823
4211
|
layerIds: Array<string>;
|
|
1824
4212
|
/**
|
|
@@ -1830,7 +4218,7 @@ interface LayerGroup {
|
|
|
1830
4218
|
*/
|
|
1831
4219
|
shownInLegend: boolean;
|
|
1832
4220
|
/**
|
|
1833
|
-
* The bounding box of the layer group.
|
|
4221
|
+
* The bounding box of the layer group in [west, south, east, north] order.
|
|
1834
4222
|
*
|
|
1835
4223
|
* {@link FeltBoundary}
|
|
1836
4224
|
*/
|
|
@@ -1877,7 +4265,7 @@ declare const GetLayerGroupsFilterSchema: z.ZodObject<{
|
|
|
1877
4265
|
ids?: string[] | undefined;
|
|
1878
4266
|
}>;
|
|
1879
4267
|
/**
|
|
1880
|
-
* The parameters for the `onLayerChange` listener.
|
|
4268
|
+
* The parameters for the {@link LayersController.onLayerChange | `onLayerChange`} listener.
|
|
1881
4269
|
*
|
|
1882
4270
|
* @group Layers
|
|
1883
4271
|
*/
|
|
@@ -1888,7 +4276,7 @@ interface LayerChangeCallbackParams {
|
|
|
1888
4276
|
layer: Layer | null;
|
|
1889
4277
|
}
|
|
1890
4278
|
/**
|
|
1891
|
-
* The parameters for the `onLayerGroupChange` listener.
|
|
4279
|
+
* The parameters for the {@link LayersController.onLayerGroupChange | `onLayerGroupChange`} listener.
|
|
1892
4280
|
*
|
|
1893
4281
|
* @group Layer Groups
|
|
1894
4282
|
*/
|
|
@@ -1908,10 +4296,10 @@ interface LegendItem extends LegendItemIdentifier {
|
|
|
1908
4296
|
title: string | Array<string>;
|
|
1909
4297
|
/**
|
|
1910
4298
|
* Whether the title depends on the zoom level or not. If it does, you
|
|
1911
|
-
* need to call `getLegendItem` when the zoom level changes.
|
|
4299
|
+
* need to call {@link LayersController.getLegendItem | `getLegendItem`} when the zoom level changes.
|
|
1912
4300
|
*
|
|
1913
|
-
* Note that as the zoom level changes, the `onLegendItemChange` handler
|
|
1914
|
-
* will not be called, so you need to call `getLegendItem` yourself.
|
|
4301
|
+
* Note that as the zoom level changes, the {@link LayersController.onLegendItemChange | `onLegendItemChange`} handler
|
|
4302
|
+
* will not be called, so you need to call {@link LayersController.getLegendItem | `getLegendItem`} yourself.
|
|
1915
4303
|
*/
|
|
1916
4304
|
titleDependsOnZoom: boolean;
|
|
1917
4305
|
/**
|
|
@@ -1990,7 +4378,7 @@ declare const LegendItemsConstraintSchema: z.ZodObject<{
|
|
|
1990
4378
|
layerIds?: string[] | undefined;
|
|
1991
4379
|
}>;
|
|
1992
4380
|
/**
|
|
1993
|
-
* The parameters for the `onLegendItemChange` listener.
|
|
4381
|
+
* The parameters for the {@link LayersController.onLegendItemChange | `onLegendItemChange`} listener.
|
|
1994
4382
|
*
|
|
1995
4383
|
* @group Legend Items
|
|
1996
4384
|
*/
|
|
@@ -2001,7 +4389,7 @@ interface LegendItemChangeCallbackParams {
|
|
|
2001
4389
|
legendItem: LegendItem | null;
|
|
2002
4390
|
}
|
|
2003
4391
|
/**
|
|
2004
|
-
* Constraints for the `getRenderedFeatures` method. This can include layer constriants, spatial constraints, or both. If no constraints are
|
|
4392
|
+
* Constraints for the {@link LayersController.getRenderedFeatures | `getRenderedFeatures`} method. This can include layer constriants, spatial constraints, or both. If no constraints are
|
|
2005
4393
|
* provided, all rendered features will be returned.
|
|
2006
4394
|
*
|
|
2007
4395
|
* @group Layers
|
|
@@ -2440,7 +4828,7 @@ type FilterTernary = [
|
|
|
2440
4828
|
/**
|
|
2441
4829
|
*
|
|
2442
4830
|
* Filters can be used to change which features in a layer are rendered. Filters can be
|
|
2443
|
-
* applied to a layer by the `setLayerFilters` method on the Felt controller.
|
|
4831
|
+
* applied to a layer by the {@link LayersController.setLayerFilters | `setLayerFilters`} method on the Felt controller.
|
|
2444
4832
|
*
|
|
2445
4833
|
* Filters use a tree structure for combining expressions with logical operators, called a
|
|
2446
4834
|
* {@link FilterTernary}. When combining three or more conditions, you must use proper nesting
|
|
@@ -2569,7 +4957,7 @@ interface LayerFilters {
|
|
|
2569
4957
|
/**
|
|
2570
4958
|
* Filters that are set ephemerally by viewers in their own session.
|
|
2571
4959
|
*
|
|
2572
|
-
* These are the filters that are set when the `setLayerFilters` method is
|
|
4960
|
+
* These are the filters that are set when the {@link LayersController.setLayerFilters | `setLayerFilters`} method is
|
|
2573
4961
|
* called. There is no way to set these in the Felt UI - they can only be
|
|
2574
4962
|
* set using the SDK.
|
|
2575
4963
|
*/
|
|
@@ -3337,7 +5725,7 @@ interface PinToolSettings extends zInfer<typeof PinToolSettingsSchema> {
|
|
|
3337
5725
|
*
|
|
3338
5726
|
* - `"enter name"`: Enter a name for the Place, focusing the name input.
|
|
3339
5727
|
* - `"add another"`: Add another Place, leaving the tool still selected.
|
|
3340
|
-
* - `"
|
|
5728
|
+
* - `"select"`: Puts the tool down and selects the new Place element.
|
|
3341
5729
|
*
|
|
3342
5730
|
* @defaultValue `"enter name"`
|
|
3343
5731
|
*/
|
|
@@ -3370,24 +5758,24 @@ declare const RouteToolSettingsSchema: z.ZodObject<{
|
|
|
3370
5758
|
strokeWidth: z.ZodNumber;
|
|
3371
5759
|
strokeStyle: z.ZodEnum<["solid", "dashed", "dotted"]>;
|
|
3372
5760
|
distanceMarker: z.ZodBoolean;
|
|
3373
|
-
endCaps: z.ZodBoolean;
|
|
3374
5761
|
routingMode: z.ZodNullable<z.ZodEnum<["driving", "cycling", "walking", "flying"]>>;
|
|
5762
|
+
endCaps: z.ZodBoolean;
|
|
3375
5763
|
}, "strip", z.ZodTypeAny, {
|
|
3376
5764
|
color: string;
|
|
3377
5765
|
strokeOpacity: number;
|
|
3378
5766
|
strokeWidth: number;
|
|
3379
5767
|
strokeStyle: "solid" | "dashed" | "dotted";
|
|
3380
5768
|
distanceMarker: boolean;
|
|
3381
|
-
endCaps: boolean;
|
|
3382
5769
|
routingMode: "driving" | "cycling" | "walking" | "flying" | null;
|
|
5770
|
+
endCaps: boolean;
|
|
3383
5771
|
}, {
|
|
3384
5772
|
color: string;
|
|
3385
5773
|
strokeOpacity: number;
|
|
3386
5774
|
strokeWidth: number;
|
|
3387
5775
|
strokeStyle: "solid" | "dashed" | "dotted";
|
|
3388
5776
|
distanceMarker: boolean;
|
|
3389
|
-
endCaps: boolean;
|
|
3390
5777
|
routingMode: "driving" | "cycling" | "walking" | "flying" | null;
|
|
5778
|
+
endCaps: boolean;
|
|
3391
5779
|
}>;
|
|
3392
5780
|
interface RouteToolSettings extends zInfer<typeof RouteToolSettingsSchema> {
|
|
3393
5781
|
}
|
|
@@ -3457,15 +5845,18 @@ interface MarkerToolSettings extends zInfer<typeof MarkerToolSettingsSchema> {
|
|
|
3457
5845
|
declare const HighlighterToolSettingsSchema: z.ZodObject<{
|
|
3458
5846
|
color: z.ZodString;
|
|
3459
5847
|
opacity: z.ZodNumber;
|
|
5848
|
+
renderHoles: z.ZodBoolean;
|
|
3460
5849
|
size: z.ZodNumber;
|
|
3461
5850
|
}, "strip", z.ZodTypeAny, {
|
|
3462
5851
|
color: string;
|
|
3463
5852
|
opacity: number;
|
|
3464
5853
|
size: number;
|
|
5854
|
+
renderHoles: boolean;
|
|
3465
5855
|
}, {
|
|
3466
5856
|
color: string;
|
|
3467
5857
|
opacity: number;
|
|
3468
5858
|
size: number;
|
|
5859
|
+
renderHoles: boolean;
|
|
3469
5860
|
}>;
|
|
3470
5861
|
interface HighlighterToolSettings extends zInfer<typeof HighlighterToolSettingsSchema> {
|
|
3471
5862
|
}
|
|
@@ -3475,11 +5866,11 @@ declare const TextToolSettingsSchema: z.ZodObject<{
|
|
|
3475
5866
|
style: z.ZodEnum<["italic", "light", "regular", "caps"]>;
|
|
3476
5867
|
}, "strip", z.ZodTypeAny, {
|
|
3477
5868
|
color: string;
|
|
3478
|
-
align: "
|
|
5869
|
+
align: "center" | "left" | "right";
|
|
3479
5870
|
style: "italic" | "light" | "regular" | "caps";
|
|
3480
5871
|
}, {
|
|
3481
5872
|
color: string;
|
|
3482
|
-
align: "
|
|
5873
|
+
align: "center" | "left" | "right";
|
|
3483
5874
|
style: "italic" | "light" | "regular" | "caps";
|
|
3484
5875
|
}>;
|
|
3485
5876
|
interface TextToolSettings extends zInfer<typeof TextToolSettingsSchema> {
|
|
@@ -3490,11 +5881,11 @@ declare const NoteToolSettingsSchema: z.ZodObject<{
|
|
|
3490
5881
|
style: z.ZodEnum<["italic", "light", "regular", "caps"]>;
|
|
3491
5882
|
}, "strip", z.ZodTypeAny, {
|
|
3492
5883
|
color: string;
|
|
3493
|
-
align: "
|
|
5884
|
+
align: "center" | "left" | "right";
|
|
3494
5885
|
style: "italic" | "light" | "regular" | "caps";
|
|
3495
5886
|
}, {
|
|
3496
5887
|
color: string;
|
|
3497
|
-
align: "
|
|
5888
|
+
align: "center" | "left" | "right";
|
|
3498
5889
|
style: "italic" | "light" | "regular" | "caps";
|
|
3499
5890
|
}>;
|
|
3500
5891
|
interface NoteToolSettings extends zInfer<typeof NoteToolSettingsSchema> {
|
|
@@ -3585,17 +5976,17 @@ declare const ViewportCenterZoomSchema: z.ZodObject<{
|
|
|
3585
5976
|
}>;
|
|
3586
5977
|
zoom: z.ZodNumber;
|
|
3587
5978
|
}, "strip", z.ZodTypeAny, {
|
|
3588
|
-
zoom: number;
|
|
3589
5979
|
center: {
|
|
3590
5980
|
latitude: number;
|
|
3591
5981
|
longitude: number;
|
|
3592
5982
|
};
|
|
3593
|
-
}, {
|
|
3594
5983
|
zoom: number;
|
|
5984
|
+
}, {
|
|
3595
5985
|
center: {
|
|
3596
5986
|
latitude: number;
|
|
3597
5987
|
longitude: number;
|
|
3598
5988
|
};
|
|
5989
|
+
zoom: number;
|
|
3599
5990
|
}>;
|
|
3600
5991
|
/**
|
|
3601
5992
|
* The current state of the viewport, including the derived bounds.
|
|
@@ -3616,7 +6007,7 @@ interface ViewportState {
|
|
|
3616
6007
|
*/
|
|
3617
6008
|
zoom: FeltZoom;
|
|
3618
6009
|
/**
|
|
3619
|
-
* The bounding box of the viewport.
|
|
6010
|
+
* The bounding box of the viewport in [west, south, east, north] order.
|
|
3620
6011
|
*
|
|
3621
6012
|
* This is derived, and depends on the center and zoom of the viewport, as
|
|
3622
6013
|
* well as its size.
|
|
@@ -3626,7 +6017,7 @@ interface ViewportState {
|
|
|
3626
6017
|
bounds: FeltBoundary;
|
|
3627
6018
|
}
|
|
3628
6019
|
/**
|
|
3629
|
-
* The parameters for the `setViewport` method.
|
|
6020
|
+
* The parameters for the {@link ViewportController.setViewport | `setViewport`} method.
|
|
3630
6021
|
*
|
|
3631
6022
|
* @group Types
|
|
3632
6023
|
*/
|
|
@@ -3645,17 +6036,17 @@ declare const SetViewportCenterZoomParamsSchema: z.ZodObject<{
|
|
|
3645
6036
|
}>>;
|
|
3646
6037
|
zoom: z.ZodOptional<z.ZodNumber>;
|
|
3647
6038
|
}, "strip", z.ZodTypeAny, {
|
|
3648
|
-
zoom?: number | undefined;
|
|
3649
6039
|
center?: {
|
|
3650
6040
|
latitude: number;
|
|
3651
6041
|
longitude: number;
|
|
3652
6042
|
} | undefined;
|
|
3653
|
-
}, {
|
|
3654
6043
|
zoom?: number | undefined;
|
|
6044
|
+
}, {
|
|
3655
6045
|
center?: {
|
|
3656
6046
|
latitude: number;
|
|
3657
6047
|
longitude: number;
|
|
3658
6048
|
} | undefined;
|
|
6049
|
+
zoom?: number | undefined;
|
|
3659
6050
|
}>;
|
|
3660
6051
|
/**
|
|
3661
6052
|
* The constraints for the viewport. Used to ensure that the viewport stays
|
|
@@ -3684,7 +6075,7 @@ interface ViewportConstraints {
|
|
|
3684
6075
|
bounds: FeltBoundary | null;
|
|
3685
6076
|
}
|
|
3686
6077
|
/**
|
|
3687
|
-
* The parameters for the `fitViewportToBounds` method.
|
|
6078
|
+
* The parameters for the {@link ViewportController.fitViewportToBounds | `fitViewportToBounds`} method.
|
|
3688
6079
|
*
|
|
3689
6080
|
* @group Types
|
|
3690
6081
|
*/
|