@tomtom-org/maps-sdk 0.51.5 → 0.52.0
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/CHANGELOG.md +26 -0
- package/README.md +2 -2
- package/core/dist/core.es.js +1 -1
- package/core/dist/core.es.js.map +1 -1
- package/core/dist/index.d.ts +295 -360
- package/map/dist/index.d.ts +1315 -764
- package/map/dist/map.es.js +1 -1
- package/map/dist/map.es.js.map +1 -1
- package/package.json +7 -7
- package/services/dist/index.d.ts +238 -437
- package/services/dist/services.es.js +1 -1
- package/services/dist/services.es.js.map +1 -1
package/core/dist/index.d.ts
CHANGED
|
@@ -543,7 +543,7 @@ type Language = (typeof languages)[number];
|
|
|
543
543
|
/**
|
|
544
544
|
* @group Place
|
|
545
545
|
*/
|
|
546
|
-
declare const connectorTypes: readonly ["StandardHouseholdCountrySpecific", "IEC62196Type1", "IEC62196Type1CCS", "IEC62196Type2CableAttached", "IEC62196Type2Outlet", "IEC62196Type2CCS", "IEC62196Type3", "Chademo", "GBT20234Part2", "GBT20234Part3", "IEC60309AC3PhaseRed", "IEC60309AC1PhaseBlue", "IEC60309DCWhite", "Tesla"];
|
|
546
|
+
export declare const connectorTypes: readonly ["StandardHouseholdCountrySpecific", "IEC62196Type1", "IEC62196Type1CCS", "IEC62196Type2CableAttached", "IEC62196Type2Outlet", "IEC62196Type2CCS", "IEC62196Type3", "Chademo", "GBT20234Part2", "GBT20234Part3", "IEC60309AC3PhaseRed", "IEC60309AC1PhaseBlue", "IEC60309DCWhite", "Tesla"];
|
|
547
547
|
/**
|
|
548
548
|
* Electric vehicle charging connector type.
|
|
549
549
|
*
|
|
@@ -567,11 +567,11 @@ declare const connectorTypes: readonly ["StandardHouseholdCountrySpecific", "IEC
|
|
|
567
567
|
*
|
|
568
568
|
* @group Place
|
|
569
569
|
*/
|
|
570
|
-
type ConnectorType = (typeof connectorTypes)[number];
|
|
570
|
+
export type ConnectorType = (typeof connectorTypes)[number];
|
|
571
571
|
/**
|
|
572
572
|
* @group Place
|
|
573
573
|
*/
|
|
574
|
-
declare const currentTypes: readonly ["AC1", "AC3", "DC"];
|
|
574
|
+
export declare const currentTypes: readonly ["AC1", "AC3", "DC"];
|
|
575
575
|
/**
|
|
576
576
|
* Current type for electric vehicle charging.
|
|
577
577
|
*
|
|
@@ -589,7 +589,7 @@ declare const currentTypes: readonly ["AC1", "AC3", "DC"];
|
|
|
589
589
|
*
|
|
590
590
|
* @group Place
|
|
591
591
|
*/
|
|
592
|
-
type CurrentType = (typeof currentTypes)[number];
|
|
592
|
+
export type CurrentType = (typeof currentTypes)[number];
|
|
593
593
|
/**
|
|
594
594
|
* The charging speed classification of this charging connection.
|
|
595
595
|
*
|
|
@@ -599,7 +599,7 @@ type CurrentType = (typeof currentTypes)[number];
|
|
|
599
599
|
* - `fast`: Typically between 50 kW and 150 kW (DC fast charging)
|
|
600
600
|
* - `ultra-fast`: Typically above 150 kW (High-power DC fast charging)
|
|
601
601
|
*/
|
|
602
|
-
type ChargingSpeed = 'slow' | 'regular' | 'fast' | 'ultra-fast';
|
|
602
|
+
export type ChargingSpeed = 'slow' | 'regular' | 'fast' | 'ultra-fast';
|
|
603
603
|
/**
|
|
604
604
|
* Electric vehicle charging connector with specifications.
|
|
605
605
|
*
|
|
@@ -620,7 +620,7 @@ type ChargingSpeed = 'slow' | 'regular' | 'fast' | 'ultra-fast';
|
|
|
620
620
|
*
|
|
621
621
|
* @group Place
|
|
622
622
|
*/
|
|
623
|
-
type Connector = {
|
|
623
|
+
export type Connector = {
|
|
624
624
|
/**
|
|
625
625
|
* Unique identifier for this connector.
|
|
626
626
|
*/
|
|
@@ -674,7 +674,7 @@ type Connector = {
|
|
|
674
674
|
/**
|
|
675
675
|
* @group Place
|
|
676
676
|
*/
|
|
677
|
-
declare const chargingStationAccessTypes: readonly ["Public", "Authorized", "Restricted", "Private", "Unknown"];
|
|
677
|
+
export declare const chargingStationAccessTypes: readonly ["Public", "Authorized", "Restricted", "Private", "Unknown"];
|
|
678
678
|
/**
|
|
679
679
|
* Access type for EV charging stations.
|
|
680
680
|
*
|
|
@@ -694,11 +694,11 @@ declare const chargingStationAccessTypes: readonly ["Public", "Authorized", "Res
|
|
|
694
694
|
*
|
|
695
695
|
* @group Place
|
|
696
696
|
*/
|
|
697
|
-
type ChargingStationsAccessType = (typeof chargingStationAccessTypes)[number];
|
|
697
|
+
export type ChargingStationsAccessType = (typeof chargingStationAccessTypes)[number];
|
|
698
698
|
/**
|
|
699
699
|
* @group Place
|
|
700
700
|
*/
|
|
701
|
-
declare const chargingPointStatus: readonly ["Available", "Reserved", "Occupied", "OutOfService", "Unknown"];
|
|
701
|
+
export declare const chargingPointStatus: readonly ["Available", "Reserved", "Occupied", "OutOfService", "Unknown"];
|
|
702
702
|
/**
|
|
703
703
|
* Real-time operational status of a charging point.
|
|
704
704
|
*
|
|
@@ -716,12 +716,12 @@ declare const chargingPointStatus: readonly ["Available", "Reserved", "Occupied"
|
|
|
716
716
|
*
|
|
717
717
|
* @group Place
|
|
718
718
|
*/
|
|
719
|
-
type ChargingPointStatus = (typeof chargingPointStatus)[number];
|
|
719
|
+
export type ChargingPointStatus = (typeof chargingPointStatus)[number];
|
|
720
720
|
/**
|
|
721
721
|
* Possible capabilities for a charging point.
|
|
722
722
|
* @group Place
|
|
723
723
|
*/
|
|
724
|
-
declare const chargingPointCapabilities: readonly ["ChargingProfileCapable", "ChargingPreferencesCapable", "ChipCardSupport", "ContactlessCardSupport", "CreditCardPayable", "DebitCardPayable", "PedTerminal", "RemoteStartStopCapable", "Reservable", "RfidReader", "StartSessionConnectorRequired", "TokenGroupCapable", "UnlockCapable", "PlugAndCharge", "Unknown"];
|
|
724
|
+
export declare const chargingPointCapabilities: readonly ["ChargingProfileCapable", "ChargingPreferencesCapable", "ChipCardSupport", "ContactlessCardSupport", "CreditCardPayable", "DebitCardPayable", "PedTerminal", "RemoteStartStopCapable", "Reservable", "RfidReader", "StartSessionConnectorRequired", "TokenGroupCapable", "UnlockCapable", "PlugAndCharge", "Unknown"];
|
|
725
725
|
/**
|
|
726
726
|
* Capability of a charging point.
|
|
727
727
|
*
|
|
@@ -756,11 +756,11 @@ declare const chargingPointCapabilities: readonly ["ChargingProfileCapable", "Ch
|
|
|
756
756
|
*
|
|
757
757
|
* @group Place
|
|
758
758
|
*/
|
|
759
|
-
type ChargingPointCapability = (typeof chargingPointCapabilities)[number];
|
|
759
|
+
export type ChargingPointCapability = (typeof chargingPointCapabilities)[number];
|
|
760
760
|
/**
|
|
761
761
|
* @group Place
|
|
762
762
|
*/
|
|
763
|
-
declare const chargingPointRestrictions: readonly ["EvOnly", "Plugged", "Disabled", "Customers", "Motorcycles"];
|
|
763
|
+
export declare const chargingPointRestrictions: readonly ["EvOnly", "Plugged", "Disabled", "Customers", "Motorcycles"];
|
|
764
764
|
/**
|
|
765
765
|
* Parking or usage restrictions for a charging point.
|
|
766
766
|
*
|
|
@@ -780,7 +780,7 @@ declare const chargingPointRestrictions: readonly ["EvOnly", "Plugged", "Disable
|
|
|
780
780
|
*
|
|
781
781
|
* @group Place
|
|
782
782
|
*/
|
|
783
|
-
type ChargingPointRestriction = (typeof chargingPointRestrictions)[number];
|
|
783
|
+
export type ChargingPointRestriction = (typeof chargingPointRestrictions)[number];
|
|
784
784
|
/**
|
|
785
785
|
* Individual charging point (EVSE - Electric Vehicle Supply Equipment).
|
|
786
786
|
*
|
|
@@ -806,7 +806,7 @@ type ChargingPointRestriction = (typeof chargingPointRestrictions)[number];
|
|
|
806
806
|
*
|
|
807
807
|
* @group Place
|
|
808
808
|
*/
|
|
809
|
-
type ChargingPoint = {
|
|
809
|
+
export type ChargingPoint = {
|
|
810
810
|
/**
|
|
811
811
|
* Unique identifier for this charging point (EVSE ID).
|
|
812
812
|
*
|
|
@@ -857,7 +857,7 @@ type ChargingPoint = {
|
|
|
857
857
|
*
|
|
858
858
|
* @group Place
|
|
859
859
|
*/
|
|
860
|
-
type ChargingStation = {
|
|
860
|
+
export type ChargingStation = {
|
|
861
861
|
/**
|
|
862
862
|
* Unique identifier for the charging station.
|
|
863
863
|
*/
|
|
@@ -1223,7 +1223,7 @@ type ChargingStationsAvailability = {
|
|
|
1223
1223
|
/**
|
|
1224
1224
|
* @group Place
|
|
1225
1225
|
*/
|
|
1226
|
-
declare const geographyTypes: readonly ["Country", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTertiarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighbourhood", "PostalCodeArea"];
|
|
1226
|
+
export declare const geographyTypes: readonly ["Country", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTertiarySubdivision", "Municipality", "MunicipalitySubdivision", "MunicipalitySecondarySubdivision", "Neighbourhood", "PostalCodeArea"];
|
|
1227
1227
|
/**
|
|
1228
1228
|
* Type of geographic administrative entity.
|
|
1229
1229
|
*
|
|
@@ -1247,7 +1247,7 @@ declare const geographyTypes: readonly ["Country", "CountrySubdivision", "Countr
|
|
|
1247
1247
|
*
|
|
1248
1248
|
* @group Place
|
|
1249
1249
|
*/
|
|
1250
|
-
type GeographyType = (typeof geographyTypes)[number];
|
|
1250
|
+
export type GeographyType = (typeof geographyTypes)[number];
|
|
1251
1251
|
/**
|
|
1252
1252
|
* Type of mapcode.
|
|
1253
1253
|
*
|
|
@@ -1262,7 +1262,7 @@ type GeographyType = (typeof geographyTypes)[number];
|
|
|
1262
1262
|
*
|
|
1263
1263
|
* @group Place
|
|
1264
1264
|
*/
|
|
1265
|
-
type MapcodeType = 'Local' | 'International' | 'Alternative';
|
|
1265
|
+
export type MapcodeType = 'Local' | 'International' | 'Alternative';
|
|
1266
1266
|
/**
|
|
1267
1267
|
* Mapcode representation of a location.
|
|
1268
1268
|
*
|
|
@@ -1289,11 +1289,14 @@ type MapcodeType = 'Local' | 'International' | 'Alternative';
|
|
|
1289
1289
|
*
|
|
1290
1290
|
* @group Place
|
|
1291
1291
|
*/
|
|
1292
|
-
type Mapcode = {
|
|
1292
|
+
export type Mapcode = {
|
|
1293
1293
|
/**
|
|
1294
|
-
* The
|
|
1294
|
+
* The mapcode without territory.
|
|
1295
|
+
*
|
|
1296
|
+
* Two groups of letters/digits separated by a dot (e.g., "4J.P2").
|
|
1297
|
+
* Uses the response language/alphabet. Not present for International mapcodes.
|
|
1295
1298
|
*/
|
|
1296
|
-
|
|
1299
|
+
code?: string;
|
|
1297
1300
|
/**
|
|
1298
1301
|
* Complete mapcode including territory if applicable.
|
|
1299
1302
|
*
|
|
@@ -1308,12 +1311,9 @@ type Mapcode = {
|
|
|
1308
1311
|
*/
|
|
1309
1312
|
territory?: string;
|
|
1310
1313
|
/**
|
|
1311
|
-
* The mapcode
|
|
1312
|
-
*
|
|
1313
|
-
* Two groups of letters/digits separated by a dot (e.g., "4J.P2").
|
|
1314
|
-
* Uses the response language/alphabet. Not present for International mapcodes.
|
|
1314
|
+
* The type of mapcode (Local, International, or Alternative).
|
|
1315
1315
|
*/
|
|
1316
|
-
|
|
1316
|
+
type: MapcodeType;
|
|
1317
1317
|
};
|
|
1318
1318
|
/**
|
|
1319
1319
|
* Address range information for a street segment.
|
|
@@ -1323,7 +1323,11 @@ type Mapcode = {
|
|
|
1323
1323
|
*
|
|
1324
1324
|
* @group Place
|
|
1325
1325
|
*/
|
|
1326
|
-
type AddressRanges = {
|
|
1326
|
+
export type AddressRanges = {
|
|
1327
|
+
/**
|
|
1328
|
+
* Starting coordinates of the street segment [longitude, latitude].
|
|
1329
|
+
*/
|
|
1330
|
+
from: Position;
|
|
1327
1331
|
/**
|
|
1328
1332
|
* Address range on the left side of the street.
|
|
1329
1333
|
*
|
|
@@ -1336,10 +1340,6 @@ type AddressRanges = {
|
|
|
1336
1340
|
* Looking from the 'from' point toward the 'to' point.
|
|
1337
1341
|
*/
|
|
1338
1342
|
rangeRight: string;
|
|
1339
|
-
/**
|
|
1340
|
-
* Starting coordinates of the street segment [longitude, latitude].
|
|
1341
|
-
*/
|
|
1342
|
-
from: Position;
|
|
1343
1343
|
/**
|
|
1344
1344
|
* Ending coordinates of the street segment [longitude, latitude].
|
|
1345
1345
|
*/
|
|
@@ -1354,7 +1354,7 @@ type AddressRanges = {
|
|
|
1354
1354
|
*
|
|
1355
1355
|
* @group Place
|
|
1356
1356
|
*/
|
|
1357
|
-
type EntryPointType = 'main' | 'minor';
|
|
1357
|
+
export type EntryPointType = 'main' | 'minor';
|
|
1358
1358
|
/**
|
|
1359
1359
|
* Entry point (entrance) for a place.
|
|
1360
1360
|
*
|
|
@@ -1372,11 +1372,7 @@ type EntryPointType = 'main' | 'minor';
|
|
|
1372
1372
|
*
|
|
1373
1373
|
* @group Place
|
|
1374
1374
|
*/
|
|
1375
|
-
type EntryPoint = {
|
|
1376
|
-
/**
|
|
1377
|
-
* Type of entry point (main or minor).
|
|
1378
|
-
*/
|
|
1379
|
-
type: EntryPointType;
|
|
1375
|
+
export type EntryPoint = {
|
|
1380
1376
|
/**
|
|
1381
1377
|
* Functional description of the entry point.
|
|
1382
1378
|
*
|
|
@@ -1387,11 +1383,15 @@ type EntryPoint = {
|
|
|
1387
1383
|
* Geographic coordinates of the entry point [longitude, latitude].
|
|
1388
1384
|
*/
|
|
1389
1385
|
position: Position;
|
|
1386
|
+
/**
|
|
1387
|
+
* Type of entry point (main or minor).
|
|
1388
|
+
*/
|
|
1389
|
+
type: EntryPointType;
|
|
1390
1390
|
};
|
|
1391
1391
|
/**
|
|
1392
1392
|
* @group Place
|
|
1393
1393
|
*/
|
|
1394
|
-
declare const placeTypes: readonly ["POI", "Street", "Geography", "Point Address", "Address Range", "Cross Street"];
|
|
1394
|
+
export declare const placeTypes: readonly ["POI", "Street", "Geography", "Point Address", "Address Range", "Cross Street"];
|
|
1395
1395
|
/**
|
|
1396
1396
|
* Type of place result.
|
|
1397
1397
|
*
|
|
@@ -1412,7 +1412,7 @@ declare const placeTypes: readonly ["POI", "Street", "Geography", "Point Address
|
|
|
1412
1412
|
*
|
|
1413
1413
|
* @group Place
|
|
1414
1414
|
*/
|
|
1415
|
-
type PlaceType = (typeof placeTypes)[number];
|
|
1415
|
+
export type PlaceType = (typeof placeTypes)[number];
|
|
1416
1416
|
/**
|
|
1417
1417
|
* Structured address components for a place.
|
|
1418
1418
|
*
|
|
@@ -1437,77 +1437,61 @@ type PlaceType = (typeof placeTypes)[number];
|
|
|
1437
1437
|
*
|
|
1438
1438
|
* @group Place
|
|
1439
1439
|
*/
|
|
1440
|
-
type AddressProperties = {
|
|
1441
|
-
/**
|
|
1442
|
-
* Complete formatted address string.
|
|
1443
|
-
*
|
|
1444
|
-
* Follows the formatting conventions of the result's country of origin.
|
|
1445
|
-
* For countries, this is the full country name.
|
|
1446
|
-
*/
|
|
1447
|
-
freeformAddress: string;
|
|
1448
|
-
/**
|
|
1449
|
-
* Building or house number on the street.
|
|
1450
|
-
*/
|
|
1451
|
-
streetNumber?: string;
|
|
1440
|
+
export type AddressProperties = {
|
|
1452
1441
|
/**
|
|
1453
|
-
*
|
|
1442
|
+
* Full country name.
|
|
1454
1443
|
*/
|
|
1455
|
-
|
|
1444
|
+
country?: string;
|
|
1456
1445
|
/**
|
|
1457
|
-
*
|
|
1446
|
+
* Two-letter ISO 3166-1 alpha-2 country code.
|
|
1447
|
+
*
|
|
1448
|
+
* Examples: 'US', 'GB', 'NL', 'DE'
|
|
1458
1449
|
*/
|
|
1459
|
-
|
|
1450
|
+
countryCode?: string;
|
|
1460
1451
|
/**
|
|
1461
|
-
*
|
|
1452
|
+
* Three-letter ISO 3166-1 alpha-3 country code.
|
|
1453
|
+
*
|
|
1454
|
+
* Examples: 'USA', 'GBR', 'NLD', 'DEU'
|
|
1455
|
+
*
|
|
1456
|
+
* @see [ISO 3166-1 alpha-3 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
|
|
1462
1457
|
*/
|
|
1463
|
-
|
|
1458
|
+
countryCodeISO3?: string;
|
|
1464
1459
|
/**
|
|
1465
1460
|
* County or second-level administrative subdivision.
|
|
1466
1461
|
*/
|
|
1467
1462
|
countrySecondarySubdivision?: string;
|
|
1468
|
-
/**
|
|
1469
|
-
* Named area or third-level administrative subdivision.
|
|
1470
|
-
*/
|
|
1471
|
-
countryTertiarySubdivision?: string;
|
|
1472
1463
|
/**
|
|
1473
1464
|
* State or province (first-level administrative subdivision).
|
|
1474
1465
|
*/
|
|
1475
1466
|
countrySubdivision?: string;
|
|
1476
1467
|
/**
|
|
1477
|
-
*
|
|
1468
|
+
* ISO code of the first-level administrative subdivision (e.g. "US-CA").
|
|
1478
1469
|
*/
|
|
1479
|
-
|
|
1470
|
+
countrySubdivisionCodeIso?: string;
|
|
1480
1471
|
/**
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1483
|
-
* Availability depends on region. More precise than standard postal code.
|
|
1484
|
-
*/
|
|
1485
|
-
extendedPostalCode?: string;
|
|
1486
|
-
/**
|
|
1487
|
-
* Two-letter ISO 3166-1 alpha-2 country code.
|
|
1472
|
+
* Full name of the first-level administrative subdivision.
|
|
1488
1473
|
*
|
|
1489
|
-
*
|
|
1474
|
+
* Present when countrySubdivision is abbreviated. Supported for USA, Canada, and Great Britain.
|
|
1475
|
+
* Example: "California" when countrySubdivision is "CA"
|
|
1490
1476
|
*/
|
|
1491
|
-
|
|
1477
|
+
countrySubdivisionName?: string;
|
|
1492
1478
|
/**
|
|
1493
|
-
*
|
|
1479
|
+
* Named area or third-level administrative subdivision.
|
|
1494
1480
|
*/
|
|
1495
|
-
|
|
1481
|
+
countryTertiarySubdivision?: string;
|
|
1496
1482
|
/**
|
|
1497
|
-
*
|
|
1498
|
-
*
|
|
1499
|
-
* Examples: 'USA', 'GBR', 'NLD', 'DEU'
|
|
1483
|
+
* Extended postal code.
|
|
1500
1484
|
*
|
|
1501
|
-
*
|
|
1485
|
+
* Availability depends on region. More precise than standard postal code.
|
|
1502
1486
|
*/
|
|
1503
|
-
|
|
1487
|
+
extendedPostalCode?: string;
|
|
1504
1488
|
/**
|
|
1505
|
-
*
|
|
1489
|
+
* Complete formatted address string.
|
|
1506
1490
|
*
|
|
1507
|
-
*
|
|
1508
|
-
*
|
|
1491
|
+
* Follows the formatting conventions of the result's country of origin.
|
|
1492
|
+
* For countries, this is the full country name.
|
|
1509
1493
|
*/
|
|
1510
|
-
|
|
1494
|
+
freeformAddress: string;
|
|
1511
1495
|
/**
|
|
1512
1496
|
* Local area or locality name.
|
|
1513
1497
|
*
|
|
@@ -1515,6 +1499,44 @@ type AddressProperties = {
|
|
|
1515
1499
|
* without being an official administrative unit.
|
|
1516
1500
|
*/
|
|
1517
1501
|
localName?: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* City or town name.
|
|
1504
|
+
*/
|
|
1505
|
+
municipality?: string;
|
|
1506
|
+
/**
|
|
1507
|
+
* District within a municipality subdivision (third-level city administrative division).
|
|
1508
|
+
*/
|
|
1509
|
+
municipalitySecondarySubdivision?: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* Formal administrative subdivision of a municipality (sub-city or super-city area).
|
|
1512
|
+
* Has official boundaries, unlike a neighborhood.
|
|
1513
|
+
*/
|
|
1514
|
+
municipalitySubdivision?: string;
|
|
1515
|
+
/**
|
|
1516
|
+
* Informally-named area within a city, with no official boundaries.
|
|
1517
|
+
* Distinct from municipalitySubdivision, which is a formal administrative division.
|
|
1518
|
+
*/
|
|
1519
|
+
neighborhood?: string;
|
|
1520
|
+
/**
|
|
1521
|
+
* Postal code or ZIP code.
|
|
1522
|
+
*/
|
|
1523
|
+
postalCode?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* Name of the postal code area, when the result is a postal code area itself.
|
|
1526
|
+
*/
|
|
1527
|
+
postalName?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* Route/road numbers associated with the address (e.g. highway numbers).
|
|
1530
|
+
*/
|
|
1531
|
+
routeNumbers?: string[];
|
|
1532
|
+
/**
|
|
1533
|
+
* Street name without the building number.
|
|
1534
|
+
*/
|
|
1535
|
+
streetName?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* Building or house number on the street.
|
|
1538
|
+
*/
|
|
1539
|
+
streetNumber?: string;
|
|
1518
1540
|
};
|
|
1519
1541
|
/**
|
|
1520
1542
|
* Common properties shared by all place types.
|
|
@@ -1524,28 +1546,30 @@ type AddressProperties = {
|
|
|
1524
1546
|
*
|
|
1525
1547
|
* @group Place
|
|
1526
1548
|
*/
|
|
1527
|
-
type CommonPlaceProps = {
|
|
1528
|
-
/**
|
|
1529
|
-
* Type classification of this place.
|
|
1530
|
-
*/
|
|
1531
|
-
type: PlaceType;
|
|
1549
|
+
export type CommonPlaceProps = {
|
|
1532
1550
|
/**
|
|
1533
1551
|
* Structured address components.
|
|
1534
1552
|
*/
|
|
1535
1553
|
address: AddressProperties;
|
|
1536
1554
|
/**
|
|
1537
|
-
*
|
|
1555
|
+
* Address ranges along a street segment.
|
|
1538
1556
|
*
|
|
1539
|
-
* Present only when type === '
|
|
1540
|
-
* Array can contain multiple types for areas with multiple administrative roles.
|
|
1557
|
+
* Present only when type === 'Address Range'.
|
|
1541
1558
|
*/
|
|
1542
|
-
|
|
1559
|
+
addressRanges?: AddressRanges;
|
|
1543
1560
|
/**
|
|
1544
|
-
*
|
|
1561
|
+
* EV charging infrastructure information.
|
|
1545
1562
|
*
|
|
1546
|
-
*
|
|
1563
|
+
* Present only for Electric Vehicle charging station POIs.
|
|
1547
1564
|
*/
|
|
1548
|
-
|
|
1565
|
+
chargingPark?: ChargingPark;
|
|
1566
|
+
/**
|
|
1567
|
+
* References to additional data sources.
|
|
1568
|
+
*
|
|
1569
|
+
* IDs for fetching more detailed information from other services
|
|
1570
|
+
* (geometry, availability, POI details).
|
|
1571
|
+
*/
|
|
1572
|
+
dataSources?: PlaceDataSources;
|
|
1549
1573
|
/**
|
|
1550
1574
|
* Physical entry points (entrances) to the place.
|
|
1551
1575
|
*
|
|
@@ -1553,11 +1577,18 @@ type CommonPlaceProps = {
|
|
|
1553
1577
|
*/
|
|
1554
1578
|
entryPoints?: EntryPoint[];
|
|
1555
1579
|
/**
|
|
1556
|
-
*
|
|
1580
|
+
* Geographic entity type(s).
|
|
1557
1581
|
*
|
|
1558
|
-
* Present only when type === '
|
|
1582
|
+
* Present only when type === 'Geography'.
|
|
1583
|
+
* Array can contain multiple types for areas with multiple administrative roles.
|
|
1559
1584
|
*/
|
|
1560
|
-
|
|
1585
|
+
geographyType?: GeographyType[];
|
|
1586
|
+
/**
|
|
1587
|
+
* Mapcode representations of this location.
|
|
1588
|
+
*
|
|
1589
|
+
* Alternative location codes that can be used instead of coordinates.
|
|
1590
|
+
*/
|
|
1591
|
+
mapcodes?: Mapcode[];
|
|
1561
1592
|
/**
|
|
1562
1593
|
* Point of Interest information.
|
|
1563
1594
|
*
|
|
@@ -1571,29 +1602,10 @@ type CommonPlaceProps = {
|
|
|
1571
1602
|
*/
|
|
1572
1603
|
relatedPois?: RelatedPOI[];
|
|
1573
1604
|
/**
|
|
1574
|
-
*
|
|
1575
|
-
*
|
|
1576
|
-
* Present only for Electric Vehicle charging station POIs.
|
|
1577
|
-
*/
|
|
1578
|
-
chargingPark?: ChargingPark;
|
|
1579
|
-
/**
|
|
1580
|
-
* References to additional data sources.
|
|
1581
|
-
*
|
|
1582
|
-
* IDs for fetching more detailed information from other services
|
|
1583
|
-
* (geometry, availability, POI details).
|
|
1605
|
+
* Type classification of this place.
|
|
1584
1606
|
*/
|
|
1585
|
-
|
|
1607
|
+
type: PlaceType;
|
|
1586
1608
|
};
|
|
1587
|
-
/**
|
|
1588
|
-
* Side of the street indicator.
|
|
1589
|
-
*
|
|
1590
|
-
* @remarks
|
|
1591
|
-
* - `L`: Left side
|
|
1592
|
-
* - `R`: Right side
|
|
1593
|
-
*
|
|
1594
|
-
* @group Place
|
|
1595
|
-
*/
|
|
1596
|
-
type SideOfStreet = 'L' | 'R';
|
|
1597
1609
|
/**
|
|
1598
1610
|
* Properties for reverse geocoded places.
|
|
1599
1611
|
*
|
|
@@ -1602,24 +1614,15 @@ type SideOfStreet = 'L' | 'R';
|
|
|
1602
1614
|
*
|
|
1603
1615
|
* @group Place
|
|
1604
1616
|
*/
|
|
1605
|
-
type RevGeoAddressProps = CommonPlaceProps & {
|
|
1617
|
+
export type RevGeoAddressProps = CommonPlaceProps & {
|
|
1606
1618
|
/**
|
|
1607
|
-
*
|
|
1619
|
+
* Physical access points (e.g. driveway entrances) for the address, when available.
|
|
1608
1620
|
*/
|
|
1609
|
-
|
|
1621
|
+
accessPoints?: Position[];
|
|
1610
1622
|
/**
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1613
|
-
* Present when a street number was specified in the query.
|
|
1614
|
-
* Represents the interpolated position of the specific address number.
|
|
1615
|
-
*/
|
|
1616
|
-
offsetPosition?: Position;
|
|
1617
|
-
/**
|
|
1618
|
-
* Which side of the street the address is located on.
|
|
1619
|
-
*
|
|
1620
|
-
* Present only when a street number was specified in the query.
|
|
1623
|
+
* Original coordinates used in the reverse geocoding query [longitude, latitude].
|
|
1621
1624
|
*/
|
|
1622
|
-
|
|
1625
|
+
originalPosition: Position;
|
|
1623
1626
|
};
|
|
1624
1627
|
/**
|
|
1625
1628
|
* Properties for search result places.
|
|
@@ -1629,7 +1632,13 @@ type RevGeoAddressProps = CommonPlaceProps & {
|
|
|
1629
1632
|
*
|
|
1630
1633
|
* @group Place
|
|
1631
1634
|
*/
|
|
1632
|
-
type SearchPlaceProps = CommonPlaceProps & {
|
|
1635
|
+
export type SearchPlaceProps = CommonPlaceProps & {
|
|
1636
|
+
/**
|
|
1637
|
+
* Distance in meters to this result from the bias position.
|
|
1638
|
+
*
|
|
1639
|
+
* Present only when geoBias (position bias) was provided in the search.
|
|
1640
|
+
*/
|
|
1641
|
+
distance?: number;
|
|
1633
1642
|
/**
|
|
1634
1643
|
* Information about the original data source.
|
|
1635
1644
|
*
|
|
@@ -1643,12 +1652,6 @@ type SearchPlaceProps = CommonPlaceProps & {
|
|
|
1643
1652
|
* Used for ranking search results.
|
|
1644
1653
|
*/
|
|
1645
1654
|
score?: number;
|
|
1646
|
-
/**
|
|
1647
|
-
* Distance in meters to this result from the bias position.
|
|
1648
|
-
*
|
|
1649
|
-
* Present only when geoBias (position bias) was provided in the search.
|
|
1650
|
-
*/
|
|
1651
|
-
distance?: number;
|
|
1652
1655
|
};
|
|
1653
1656
|
/**
|
|
1654
1657
|
* GeoJSON Feature representing a place.
|
|
@@ -1675,19 +1678,19 @@ type SearchPlaceProps = CommonPlaceProps & {
|
|
|
1675
1678
|
*
|
|
1676
1679
|
* @group Place
|
|
1677
1680
|
*/
|
|
1678
|
-
type Place<P extends CommonPlaceProps = CommonPlaceProps> = Omit<Feature<Point, P>, 'id' | 'bbox'> & {
|
|
1679
|
-
/**
|
|
1680
|
-
* Unique identifier for this place.
|
|
1681
|
-
*
|
|
1682
|
-
* Required string ID (stricter than GeoJSON Feature's optional id).
|
|
1683
|
-
*/
|
|
1684
|
-
id: string;
|
|
1681
|
+
export type Place<P extends CommonPlaceProps = CommonPlaceProps> = Omit<Feature<Point, P>, 'id' | 'bbox'> & {
|
|
1685
1682
|
/**
|
|
1686
1683
|
* Bounding box that contains the place.
|
|
1687
1684
|
*
|
|
1688
1685
|
* * Typically significant for places covering wider areas.
|
|
1689
1686
|
*/
|
|
1690
1687
|
bbox?: BBox;
|
|
1688
|
+
/**
|
|
1689
|
+
* Unique identifier for this place.
|
|
1690
|
+
*
|
|
1691
|
+
* Required string ID (stricter than GeoJSON Feature's optional id).
|
|
1692
|
+
*/
|
|
1693
|
+
id: string;
|
|
1691
1694
|
};
|
|
1692
1695
|
/**
|
|
1693
1696
|
* GeoJSON FeatureCollection containing multiple places.
|
|
@@ -1710,17 +1713,17 @@ type Place<P extends CommonPlaceProps = CommonPlaceProps> = Omit<Feature<Point,
|
|
|
1710
1713
|
*
|
|
1711
1714
|
* @group Place
|
|
1712
1715
|
*/
|
|
1713
|
-
type Places<P extends CommonPlaceProps = CommonPlaceProps, FeatureCollectionProps = unknown> = Omit<FeatureCollectionWithProperties<Point, P, FeatureCollectionProps>, 'features' | 'bbox'> & {
|
|
1714
|
-
/**
|
|
1715
|
-
* Array of place features.
|
|
1716
|
-
* * Each place has a required string ID.
|
|
1717
|
-
*/
|
|
1718
|
-
features: Place<P>[];
|
|
1716
|
+
export type Places<P extends CommonPlaceProps = CommonPlaceProps, FeatureCollectionProps = unknown> = Omit<FeatureCollectionWithProperties<Point, P, FeatureCollectionProps>, 'features' | 'bbox'> & {
|
|
1719
1717
|
/**
|
|
1720
1718
|
* Bounding box that contains all the places, including their bounding boxes.
|
|
1721
1719
|
* * Only included if any places are present.
|
|
1722
1720
|
*/
|
|
1723
1721
|
bbox?: BBox;
|
|
1722
|
+
/**
|
|
1723
|
+
* Array of place features.
|
|
1724
|
+
* * Each place has a required string ID.
|
|
1725
|
+
*/
|
|
1726
|
+
features: Place<P>[];
|
|
1724
1727
|
};
|
|
1725
1728
|
//#endregion
|
|
1726
1729
|
//#region src/types/place/ev/evPlaceProps.d.ts
|
|
@@ -1960,11 +1963,11 @@ type PoiDetailsDataSource = {
|
|
|
1960
1963
|
/**
|
|
1961
1964
|
* @group Place
|
|
1962
1965
|
*/
|
|
1963
|
-
declare const poiCategories: readonly ["ACCESS_GATEWAY", "ADVENTURE_SPORTS_FACILITY", "ADVENTURE_VEHICLE_TRAIL", "ADVERTISING_COMPANY", "AFGHAN_RESTAURANT", "AFRICAN_RESTAURANT", "AGRICULTURAL_SUPPLIES", "AGRICULTURAL_TECHNOLOGY", "AGRICULTURE", "AIRFIELD", "AIRLINE_ACCESS", "AIRLINE_COMPANY", "AIRPORT", "AMBULANCE_UNIT", "AMERICAN_RESTAURANT", "AMPHITHEATER", "AMUSEMENT_PARK", "AMUSEMENT_PLACE", "ANIMAL_SERVICES", "ANIMAL_SHELTER", "ANTIQUE_ART_SHOP", "APARTMENT_RENTAL", "AQUATIC_ZOO", "ARABIAN_RESTAURANT", "ARBORETA_BOTANICAL_GARDENS", "ARCH", "ARMENIAN_RESTAURANT", "ART_SCHOOL", "ASIAN_RESTAURANT", "ATHLETICS_TRACK", "ATM", "ATV_DEALER", "AUSTRALIAN_RESTAURANT", "AUSTRIAN_RESTAURANT", "AUTOMOBILE_COMPANY", "AUTOMOBILE_MANUFACTURING", "AUTOMOTIVE_DEALER", "BAGS_LEATHERWEAR", "BAKERY", "BANK", "BANQUET_ROOMS", "BAR", "BARBECUE_RESTAURANT", "BASEBALL_PARK", "BASKETBALL_ARENA", "BASQUE_RESTAURANT", "BATTLEFIELD", "BAY", "BEACH", "BEACH_CLUB", "BEAUTY_SALON", "BEAUTY_SUPPLIES", "BELGIAN_RESTAURANT", "BETTING_STATION", "BISTRO", "BLOOD_BANK", "BOATING_EQUIPMENT_ACCESSORIES", "BOAT_DEALER", "BOAT_LAUNCHING_RAMP", "BODYSHOP", "BOLIVIAN_RESTAURANT", "BOOK_SHOP", "BOWLING_CENTER", "BRAZILIAN_RESTAURANT", "BRIDGE", "BRITISH_RESTAURANT", "BUFFET_RESTAURANT", "BUILDING", "BULGARIAN_RESTAURANT", "BUNGALOW_RENTAL", "BURMESE_RESTAURANT", "BUSINESS_PARK", "BUSINESS_SERVICES", "BUS_CHARTER_COMPANY", "BUS_DEALER", "BUS_LINES", "BUS_STOP", "BUTCHER", "B_B_GUEST_HOUSE", "CABARET_THEATER", "CABINS_LODGES", "CABLE_TELEPHONE_COMPANY", "CAFE", "CAFETERIA", "CAFE_PUB", "CALIFORNIAN_RESTAURANT", "CAMBODIAN_RESTAURANT", "CAMERAS_PHOTOGRAPHY", "CAMPING_GROUND", "CANADIAN_RESTAURANT", "CAPE", "CARAVAN_SITE", "CARIBBEAN_RESTAURANT", "CARPET_FLOOR_COVERINGS", "CAR_DEALER", "CAR_GLASS_REPLACEMENT_SHOP", "CAR_REPAIR_AND_SERVICE", "CAR_WASH", "CASINO", "CATERING_SERVICES", "CAVE", "CEMETERY", "CHALET_RENTAL", "CHEMICAL_COMPANY", "CHICKEN_RESTAURANT", "CHILDRENS_CLOTHES", "CHILD_CARE_FACILITY", "CHINESE_RESTAURANT", "CHRISTMAS_HOLIDAY_SHOP", "CHURCH", "CINEMA", "CLEANING_SERVICES", "CLOTHING_SHOP", "CLUB_ASSOCIATION", "COCKTAIL_BAR", "COFFEE_SHOP", "COLLEGE_OR_UNIVERSITY", "COLLEGE_UNIVERSITY", "COLOMBIAN_RESTAURANT", "COMEDY_CLUB", "COMMERCIAL_BUILDING", "COMMUNITY_CENTER", "COMPANY", "COMPUTER_COMPUTER_SUPPLIES", "COMPUTER_DATA_SERVICES", "CONCERT_HALL", "CONSTRUCTION_COMPANY", "CONSTRUCTION_MATERIAL_EQUIPMENT", "CONSUMER_ELECTRONICS", "CONVENIENCE_STORE", "CORSICAN_RESTAURANT", "COTTAGE_RENTAL", "COURIER_DROP_BOX", "COURTHOUSE", "COVE", "CREOLE_RESTAURANT", "CREPERIE", "CRICKET_GROUND", "CUBAN_RESTAURANT", "CULTURAL_CENTER", "CURRENCY_EXCHANGE", "CURTAINS_TEXTILES", "CZECH_RESTAURANT", "C_DS_DVD_VIDEOS", "DAM", "DANCE_STUDIO_SCHOOL", "DANISH_RESTAURANT", "DELICATESSEN", "DELIVERY_SERVICE", "DENTIST", "DEPARTMENT_STORE", "DINNER_THEATER", "DISCO_CLUB", "DIVERSIFIED_FINANCIALS", "DOCTOR", "DONGBEI_RESTAURANT", "DOUGHNUT_RESTAURANT", "DO_IT_YOURSELF_CENTERS", "DRIVE_IN_MOVIES", "DRIVE_THROUGH_BOTTLE_SHOP", "DRIVING_SCHOOL", "DRUG_STORE", "DRY_CLEANER", "DUNE", "DUTCH_RESTAURANT", "EGYPTIAN_RESTAURANT", "ELECTRICAL_APPLIANCES_SHOP", "ELECTRIC_VEHICLE_STATION", "ELECTRONICS_COMPANY", "EMBASSY", "EMERGENCY_MEDICAL_SERVICE", "EMERGENCY_ROOM", "ENGLISH_RESTAURANT", "ENTERTAINMENT", "EQUIPMENT_RENTAL", "ETHIOPIAN_RESTAURANT", "EXCHANGE", "EXHIBITION_CONVENTION_CENTER", "FACTORY_OUTLET", "FAIRGROUND", "FARM", "FARMERS_MARKET", "FAST_FOOD", "FERRY_TERMINAL", "FINNISH_RESTAURANT", "FIRE_STATION_BRIGADE", "FISHING_HUNTING_AREA", "FISHMONGER", "FITNESS_CLUB_CENTER", "FLATS_APARTMENT_COMPLEX", "FLORISTS", "FONDUE_RESTAURANT", "FOOD_MARKET", "FOOTBALL_STADIUM", "FOOTWEAR_SHOE_REPAIRS", "FOREST_AREA", "FRENCH_RESTAURANT", "FRONTIER_CROSSING", "FUNERAL_SERVICE_MORTUARIES", "FURNITURE_HOME_FURNISHINGS", "FUSION_RESTAURANT", "GARDEN_CENTERS_SERVICES", "GAS_STATION", "GENERAL_HOSPITAL_AND_POLYCLINIC", "GENERAL_PRACTITIONER", "GEOGRAPHIC_FEATURE", "GERMAN_RESTAURANT", "GIFTS_CARDS_NOVELTIES_SOUVENIRS", "GLASSWARE_CERAMIC_SHOP", "GLASS_WINDOWS_STORE", "GOLD_EXCHANGE", "GOLF_COURSE", "GOVERNMENT_OFFICE", "GREEK_RESTAURANT", "GREENGROCER", "GRILL_RESTAURANT", "GROCERY_STORE", "GURUDWARA", "HAIRDRESSER", "HAMBURGER_RESTAURANT", "HARBOR", "HARDWARE_STORE", "HAWAIIAN_RESTAURANT", "HEALTH_CARE_SERVICE", "HELIPAD_HELICOPTER_LANDING", "HIGH_SCHOOL", "HIKING_TRAIL", "HILL", "HISTORICAL_PARK", "HISTORIC_SITE", "HOBBY_SHOP", "HOCKEY_CLUB", "HOLIDAY_RENTAL", "HOME_APPLIANCE_REPAIR", "HORSE_RACING_TRACK", "HORSE_RIDING_CENTER", "HORSE_RIDING_TRAIL", "HORTICULTURE", "HOSPITAL", "HOSPITAL_FOR_WOMEN_AND_CHILDREN", "HOSPITAL_OF_CHINESE_MEDICINE", "HOSTEL", "HOTEL", "HOTEL_MOTEL", "HOT_POT_RESTAURANT", "HOUSE_GARDEN_FURNITURE_FITTINGS", "HUNAN_RESTAURANT", "HUNGARIAN_RESTAURANT", "ICE_CREAM_PARLOR", "ICE_HOCKEY_ARENA", "ICE_SKATING_RINK", "IMPORT_EXPORT_AND_DISTRIBUTION", "INDIAN_RESTAURANT", "INDONESIAN_RESTAURANT", "INDUSTRIAL_BUILDING", "INFORMAL_MARKET", "INSURANCE_COMPANY", "INTERNATIONAL_RAILROAD_STATION", "INTERNATIONAL_RESTAURANT", "INTERNET_CAFE", "INVESTMENT_ADVISOR", "IRANIAN_RESTAURANT", "IRISH_RESTAURANT", "ISLAND", "ISRAELI_RESTAURANT", "ITALIAN_RESTAURANT", "JAMAICAN_RESTAURANT", "JAPANESE_RESTAURANT", "JAZZ_CLUB", "JEWELRY_CLOCKS_WATCHES", "JEWISH_RESTAURANT", "JUNIOR_COLLEGE_COMMUNITY_COLLEGE", "KARAOKE_CLUB", "KITCHENS_BATHROOMS", "KOREAN_RESTAURANT", "KOSHER_RESTAURANT", "LANGUAGE_SCHOOL", "LATIN_AMERICAN_RESTAURANT", "LAUNDRY", "LEBANESE_RESTAURANT", "LEGAL_SERVICES", "LEISURE_CENTER", "LEISURE_SPORTS_CENTER", "LIBRARY", "LIGHTING_SHOPS", "LOCALE", "LOCAL_SPECIALITIES_SHOP", "LOTTERY_SHOP", "MANUFACTURING_COMPANY", "MANUFACTURING_FACILITY", "MARIJUANA_DISPENSARY", "MARINA", "MARKET", "MARSH", "MAUSOLEUM_GRAVE", "MECHANICAL_ENGINEERING", "MEDIA_FACILITY", "MEDICAL_SUPPLIES_EQUIPMENT", "MEDICINAL_MARIJUANA_DISPENSARY", "MEDITERRANEAN_RESTAURANT", "MEMORIAL", "MENS_CLOTHING", "MEXICAN_RESTAURANT", "MICROBREWERY", "MIDDLE_EASTERN_RESTAURANT", "MIDDLE_SCHOOL", "MILITARY_AIRPORT", "MINERAL_HOT_SPRINGS", "MINING_COMPANY", "MOBILE_PHONE_SHOP", "MONGOLIAN_RESTAURANT", "MONUMENT", "MOROCCAN_RESTAURANT", "MOSQUE", "MOTEL", "MOTORCYCLE_DEALER", "MOTORCYCLE_REPAIR", "MOTORING_ORGANIZATION_OFFICE", "MOTOR_RACING_STADIUM", "MOUNTAIN_BIKE_TRAIL", "MOUNTAIN_PASS", "MOUNTAIN_PEAK", "MOVIE_THEATER", "MOVING_STORAGE_COMPANY", "MULTI_PURPOSE_STADIUM", "MUSEUM", "MUSIC_CENTER", "MUSIC_INSTRUMENTS_STORE", "NAIL_SALON", "NATIONAL_RAILROAD_STATION", "NATIVE_RESERVATION", "NATURAL_TOURIST_ATTRACTION", "NEPALESE_RESTAURANT", "NETBALL_STADIUM", "NEWSAGENTS_TOBACCONISTS", "NIGHTLIFE", "NON_GOVERNMENTAL_ORGANIZATION", "NORWEGIAN_RESTAURANT", "OASIS", "OBSERVATORY", "OFFICE_EQUIPMENT", "OIL_NATURAL_GAS", "OPEN_CAR_PARKING_AREA", "OPEN_PARKING_AREA", "OPERA_HOUSE", "OPTICIAN", "ORGANIC_FOOD_RESTAURANT", "ORIENTAL_RESTAURANT", "OTHER_FOOD_SHOPS", "OTHER_WINTER_SPORT", "PAGODA", "PAINTING_DECORATING", "PAKISTANI_RESTAURANT", "PARK", "PARKING_GARAGE", "PARKWAY", "PARK_RECREATION_AREA", "PASSENGER_TRANSPORT_TICKET_OFFICE", "PAWN_SHOP", "PERSONAL_CARE_FACILITY", "PERSONAL_SERVICE", "PERFORMING_ARTS_THEATER", "PERUVIAN_RESTAURANT", "PET_SUPPLIES", "PHARMACEUTICAL_COMPANY", "PHARMACY", "PHILIPPINE_RESTAURANT", "PHOTOCOPY_SHOP", "PHOTO_LAB_DEVELOPMENT", "PICNIC_AREA", "PIZZERIA", "PLACE_OF_WORSHIP", "PLAIN_FLAT", "PLANETARIUM", "PLATEAU", "POLICE_STATION", "POLISH_RESTAURANT", "POLYNESIAN_RESTAURANT", "PORTUGUESE_RESTAURANT", "PORT_WAREHOUSE_FACILITY", "POST_OFFICE", "PRE_SCHOOL", "PRIMARY_PRODUCER", "PRIMARY_RESOURCE_UTILITY", "PRIMARY_SCHOOL", "PRISON_CORRECTIONAL_FACILITY", "PRIVATE_AIRPORT", "PROTECTED_AREA", "PUB", "PUBLIC_AIRPORT", "PUBLIC_AMENITY", "PUBLIC_CALL_BOX", "PUBLIC_MARKET", "PUBLIC_TOILET", "PUBLIC_TRANSPORT_STOP", "PUBLISHING_TECHNOLOGIES", "PUB_FOOD", "QUARRY", "RACE_TRACK", "RAILWAY_STATION", "RAPIDS", "REAL_ESTATE_AGENT", "REAL_ESTATE_COMPANY", "RECREATIONAL_CAMPING_GROUND", "RECREATIONAL_MARIJUANA_DISPENSARY", "RECREATIONAL_VEHICLE_DEALER", "RECREATION_AREA", "RECYCLING_SHOP", "REEF", "RENT_A_CAR_FACILITY", "RENT_A_CAR_PARKING", "REPAIR_FACILITY", "RESEARCH_FACILITY", "RESERVOIR", "RESIDENTIAL_ACCOMMODATION", "RESORT", "RESTAURANT", "RESTAURANT_AREA", "REST_AREA", "REST_CAMP", "RETAIL_OUTLET", "RETIREMENT_COMMUNITY", "RIDGE", "RIVER_CROSSING", "ROAD_RESCUE", "ROAD_TRAFFIC_CONTROL_CENTER", "ROCKS", "ROCK_CLIMBING_TRAIL", "RUGBY_GROUND", "RUSSIAN_RESTAURANT", "SALAD_BAR", "SANDWICH_RESTAURANT", "SAUNA_SOLARIUM_MASSAGE", "SCANDINAVIAN_RESTAURANT", "SCENIC_PANORAMIC_VIEW", "SCHOOL", "SCHOOL_BUS_COMPANY", "SEAFOOD", "SECURED_ENTRANCE", "SECURITY_PRODUCTS", "SENIOR_HIGH_SCHOOL", "SERVICE_COMPANY", "SHANDONG_RESTAURANT", "SHOP", "SHOPPING_CENTER", "SHOPPING_SERVICE", "SICHUAN_RESTAURANT", "SKI_RESORT", "SNACKS_RESTAURANT", "SNOOKER_POOL_BILLIARD", "SOCCER_STADIUM", "SOFTWARE_COMPANY", "SOUL_FOOD", "SOUP_RESTAURANT", "SPANISH_RESTAURANT", "SPECIALIST", "SPECIALTY_CLOTHING_SHOP", "SPECIALTY_FOODS", "SPECIAL_HOSPITAL", "SPORTS_CENTER", "SPORTS_EQUIPMENT_CLOTHING", "SQUASH_COURT", "STADIUM", "STATION_ACCESS", "STATUE", "STEAK_HOUSE", "STOCK_EXCHANGE", "STREETCAR_STOP", "SUBWAY_STATION", "SUPERMARKETS_HYPERMARKETS", "SUSHI_RESTAURANT", "SWEDISH_RESTAURANT", "SWIMMING_POOL", "SWISS_RESTAURANT", "SYNAGOG", "SYRIAN_RESTAURANT", "TAILOR_SHOP", "TAIWANESE_RESTAURANT", "TAKEOUT_FOOD", "TAPAS_RESTAURANT", "TAXI_LIMOUSINE_SHUTTLE_SERVICE", "TAXI_STAND", "TAX_SERVICES", "TEA_HOUSE", "TELECOMMUNICATIONS", "TEMPLE", "TENNIS_COURT", "TEPPANYAKI_RESTAURANT", "THAI_RESTAURANT", "THEATER", "THEMATIC_SPORT_CENTER", "TIBETAN_RESTAURANT", "TIRE_SERVICE", "TOLL_GATE", "TOURIST_ATTRACTION", "TOURIST_INFORMATION_OFFICE", "TOWER", "TOYS_GAMES_SHOP", "TRAFFIC_CONTROL_DEPARTMENT", "TRAIL_SYSTEM", "TRANSPORT_AUTHORITY_VEHICLE_REGISTRATION", "TRANSPORT_COMPANY", "TRAVEL_AGENT", "TRUCK_DEALER", "TRUCK_REPAIR_AND_SERVICE", "TRUCK_STOP", "TUNISIAN_RESTAURANT", "TUNNEL", "TURKISH_RESTAURANT", "URBAN_STATION", "VALLEY", "VAN_DEALER", "VARIETY_STORE", "VEGETARIAN_RESTAURANT", "VENEZUELAN_RESTAURANT", "VETERINARIAN", "VIDEO_RENTAL_SHOP", "VIETNAMESE_RESTAURANT", "VILLA_RENTAL", "VOCATIONAL_SCHOOL", "WATER_HOLE", "WATER_SPORT", "WEDDING_SERVICES", "WEIGH_STATION", "WELFARE_ORGANIZATION", "WELL", "WESTERN_RESTAURANT", "WHOLESALE_CLUB", "WILDERNESS_AREA", "WILDLIFE_PARK", "WINERY", "WINE_SPIRITS", "WOMENS_CLOTHING", "YACHT_BASIN", "YOGURT_JUICE_BAR", "ZOO", "ZOOS_ARBORETA_BOTANICAL_GARDEN"];
|
|
1966
|
+
export declare const poiCategories: readonly ["ACCESS_GATEWAY", "ADVENTURE_SPORTS_FACILITY", "ADVENTURE_VEHICLE_TRAIL", "ADVERTISING_COMPANY", "AFGHAN_RESTAURANT", "AFRICAN_RESTAURANT", "AGRICULTURAL_SUPPLIES", "AGRICULTURAL_TECHNOLOGY", "AGRICULTURE", "AIRFIELD", "AIRLINE_ACCESS", "AIRLINE_COMPANY", "AIRPORT", "AMBULANCE_UNIT", "AMERICAN_RESTAURANT", "AMPHITHEATER", "AMUSEMENT_PARK", "AMUSEMENT_PLACE", "ANIMAL_SERVICES", "ANIMAL_SHELTER", "ANTIQUE_ART_SHOP", "APARTMENT_RENTAL", "AQUATIC_ZOO", "ARABIAN_RESTAURANT", "ARBORETA_BOTANICAL_GARDENS", "ARCH", "ARMENIAN_RESTAURANT", "ART_SCHOOL", "ASIAN_RESTAURANT", "ATHLETICS_TRACK", "ATM", "ATV_DEALER", "AUSTRALIAN_RESTAURANT", "AUSTRIAN_RESTAURANT", "AUTOMOBILE_COMPANY", "AUTOMOBILE_MANUFACTURING", "AUTOMOTIVE_DEALER", "BAGS_LEATHERWEAR", "BAKERY", "BANK", "BANQUET_ROOMS", "BAR", "BARBECUE_RESTAURANT", "BASEBALL_PARK", "BASKETBALL_ARENA", "BASQUE_RESTAURANT", "BATTLEFIELD", "BAY", "BEACH", "BEACH_CLUB", "BEAUTY_SALON", "BEAUTY_SUPPLIES", "BELGIAN_RESTAURANT", "BETTING_STATION", "BISTRO", "BLOOD_BANK", "BOATING_EQUIPMENT_ACCESSORIES", "BOAT_DEALER", "BOAT_LAUNCHING_RAMP", "BODYSHOP", "BOLIVIAN_RESTAURANT", "BOOK_SHOP", "BOWLING_CENTER", "BRAZILIAN_RESTAURANT", "BRIDGE", "BRITISH_RESTAURANT", "BUFFET_RESTAURANT", "BUILDING", "BULGARIAN_RESTAURANT", "BUNGALOW_RENTAL", "BURMESE_RESTAURANT", "BUSINESS_PARK", "BUSINESS_SERVICES", "BUS_CHARTER_COMPANY", "BUS_DEALER", "BUS_LINES", "BUS_STOP", "BUTCHER", "B_B_GUEST_HOUSE", "CABARET_THEATER", "CABINS_LODGES", "CABLE_TELEPHONE_COMPANY", "CAFE", "CAFETERIA", "CAFE_PUB", "CALIFORNIAN_RESTAURANT", "CAMBODIAN_RESTAURANT", "CAMERAS_PHOTOGRAPHY", "CAMPING_GROUND", "CANADIAN_RESTAURANT", "CAPE", "CARAVAN_SITE", "CARIBBEAN_RESTAURANT", "CARPET_FLOOR_COVERINGS", "CAR_DEALER", "CAR_GLASS_REPLACEMENT_SHOP", "CAR_REPAIR_AND_SERVICE", "CAR_WASH", "CASINO", "CATERING_SERVICES", "CAVE", "CEMETERY", "CHALET_RENTAL", "CHEMICAL_COMPANY", "CHICKEN_RESTAURANT", "CHILDRENS_CLOTHES", "CHILD_CARE_FACILITY", "CHINESE_RESTAURANT", "CHRISTMAS_HOLIDAY_SHOP", "CHURCH", "CINEMA", "CLEANING_SERVICES", "CLOTHING_SHOP", "CLUB_ASSOCIATION", "COCKTAIL_BAR", "COFFEE_SHOP", "COLLEGE_OR_UNIVERSITY", "COLLEGE_UNIVERSITY", "COLOMBIAN_RESTAURANT", "COMEDY_CLUB", "COMMERCIAL_BUILDING", "COMMUNITY_CENTER", "COMPANY", "COMPUTER_COMPUTER_SUPPLIES", "COMPUTER_DATA_SERVICES", "CONCERT_HALL", "CONSTRUCTION_COMPANY", "CONSTRUCTION_MATERIAL_EQUIPMENT", "CONSUMER_ELECTRONICS", "CONVENIENCE_STORE", "CORSICAN_RESTAURANT", "COTTAGE_RENTAL", "COURIER_DROP_BOX", "COURTHOUSE", "COVE", "CREOLE_RESTAURANT", "CREPERIE", "CRICKET_GROUND", "CUBAN_RESTAURANT", "CULTURAL_CENTER", "CURRENCY_EXCHANGE", "CURTAINS_TEXTILES", "CZECH_RESTAURANT", "C_DS_DVD_VIDEOS", "DAM", "DANCE_STUDIO_SCHOOL", "DANISH_RESTAURANT", "DELICATESSEN", "DELIVERY_SERVICE", "DENTIST", "DEPARTMENT_STORE", "DINNER_THEATER", "DISCO_CLUB", "DIVERSIFIED_FINANCIALS", "DOCTOR", "DONGBEI_RESTAURANT", "DOUGHNUT_RESTAURANT", "DO_IT_YOURSELF_CENTERS", "DRIVE_IN_MOVIES", "DRIVE_THROUGH_BOTTLE_SHOP", "DRIVING_SCHOOL", "DRUG_STORE", "DRY_CLEANER", "DUNE", "DUTCH_RESTAURANT", "EGYPTIAN_RESTAURANT", "ELECTRICAL_APPLIANCES_SHOP", "ELECTRIC_VEHICLE_STATION", "ELECTRONICS_COMPANY", "EMBASSY", "EMERGENCY_MEDICAL_SERVICE", "EMERGENCY_ROOM", "ENGLISH_RESTAURANT", "ENTERTAINMENT", "EQUIPMENT_RENTAL", "ETHIOPIAN_RESTAURANT", "EXCHANGE", "EXHIBITION_CONVENTION_CENTER", "FACTORY_OUTLET", "FAIRGROUND", "FARM", "FARMERS_MARKET", "FAST_FOOD", "FERRY_TERMINAL", "FINNISH_RESTAURANT", "FIRE_STATION_BRIGADE", "FISHING_HUNTING_AREA", "FISHMONGER", "FITNESS_CLUB_CENTER", "FLATS_APARTMENT_COMPLEX", "FLORISTS", "FONDUE_RESTAURANT", "FOOD_MARKET", "FOOTBALL_STADIUM", "FOOTWEAR_SHOE_REPAIRS", "FOREST_AREA", "FRENCH_RESTAURANT", "FRONTIER_CROSSING", "FUNERAL_SERVICE_MORTUARIES", "FURNITURE_HOME_FURNISHINGS", "FUSION_RESTAURANT", "GARDEN_CENTERS_SERVICES", "GAS_STATION", "GENERAL_HOSPITAL_AND_POLYCLINIC", "GENERAL_PRACTITIONER", "GEOGRAPHIC_FEATURE", "GERMAN_RESTAURANT", "GIFTS_CARDS_NOVELTIES_SOUVENIRS", "GLASSWARE_CERAMIC_SHOP", "GLASS_WINDOWS_STORE", "GOLD_EXCHANGE", "GOLF_COURSE", "GOVERNMENT_OFFICE", "GREEK_RESTAURANT", "GREENGROCER", "GRILL_RESTAURANT", "GROCERY_STORE", "GURUDWARA", "HAIRDRESSER", "HAMBURGER_RESTAURANT", "HARBOR", "HARDWARE_STORE", "HAWAIIAN_RESTAURANT", "HEALTH_CARE_SERVICE", "HELIPAD_HELICOPTER_LANDING", "HIGH_SCHOOL", "HIKING_TRAIL", "HILL", "HISTORICAL_PARK", "HISTORIC_SITE", "HOBBY_SHOP", "HOCKEY_CLUB", "HOLIDAY_RENTAL", "HOME_APPLIANCE_REPAIR", "HORSE_RACING_TRACK", "HORSE_RIDING_CENTER", "HORSE_RIDING_TRAIL", "HORTICULTURE", "HOSPITAL", "HOSPITAL_FOR_WOMEN_AND_CHILDREN", "HOSPITAL_OF_CHINESE_MEDICINE", "HOSTEL", "HOTEL", "HOTEL_MOTEL", "HOT_POT_RESTAURANT", "HOUSE_GARDEN_FURNITURE_FITTINGS", "HUNAN_RESTAURANT", "HUNGARIAN_RESTAURANT", "ICE_CREAM_PARLOR", "ICE_HOCKEY_ARENA", "ICE_SKATING_RINK", "IMPORT_EXPORT_AND_DISTRIBUTION", "INDIAN_RESTAURANT", "INDONESIAN_RESTAURANT", "INDUSTRIAL_BUILDING", "INFORMAL_MARKET", "INSURANCE_COMPANY", "INTERNATIONAL_RAILROAD_STATION", "INTERNATIONAL_RESTAURANT", "INTERNET_CAFE", "INVESTMENT_ADVISOR", "IRANIAN_RESTAURANT", "IRISH_RESTAURANT", "ISLAND", "ISRAELI_RESTAURANT", "ITALIAN_RESTAURANT", "JAMAICAN_RESTAURANT", "JAPANESE_RESTAURANT", "JAZZ_CLUB", "JEWELRY_CLOCKS_WATCHES", "JEWISH_RESTAURANT", "JUNIOR_COLLEGE_COMMUNITY_COLLEGE", "KARAOKE_CLUB", "KITCHENS_BATHROOMS", "KOREAN_RESTAURANT", "KOSHER_RESTAURANT", "LANGUAGE_SCHOOL", "LATIN_AMERICAN_RESTAURANT", "LAUNDRY", "LEBANESE_RESTAURANT", "LEGAL_SERVICES", "LEISURE_CENTER", "LEISURE_SPORTS_CENTER", "LIBRARY", "LIGHTING_SHOPS", "LOCALE", "LOCAL_SPECIALITIES_SHOP", "LOTTERY_SHOP", "MANUFACTURING_COMPANY", "MANUFACTURING_FACILITY", "MARIJUANA_DISPENSARY", "MARINA", "MARKET", "MARSH", "MAUSOLEUM_GRAVE", "MECHANICAL_ENGINEERING", "MEDIA_FACILITY", "MEDICAL_SUPPLIES_EQUIPMENT", "MEDICINAL_MARIJUANA_DISPENSARY", "MEDITERRANEAN_RESTAURANT", "MEMORIAL", "MENS_CLOTHING", "MEXICAN_RESTAURANT", "MICROBREWERY", "MIDDLE_EASTERN_RESTAURANT", "MIDDLE_SCHOOL", "MILITARY_AIRPORT", "MINERAL_HOT_SPRINGS", "MINING_COMPANY", "MOBILE_PHONE_SHOP", "MONGOLIAN_RESTAURANT", "MONUMENT", "MOROCCAN_RESTAURANT", "MOSQUE", "MOTEL", "MOTORCYCLE_DEALER", "MOTORCYCLE_REPAIR", "MOTORING_ORGANIZATION_OFFICE", "MOTOR_RACING_STADIUM", "MOUNTAIN_BIKE_TRAIL", "MOUNTAIN_PASS", "MOUNTAIN_PEAK", "MOVIE_THEATER", "MOVING_STORAGE_COMPANY", "MULTI_PURPOSE_STADIUM", "MUSEUM", "MUSIC_CENTER", "MUSIC_INSTRUMENTS_STORE", "NAIL_SALON", "NATIONAL_RAILROAD_STATION", "NATIVE_RESERVATION", "NATURAL_TOURIST_ATTRACTION", "NEPALESE_RESTAURANT", "NETBALL_STADIUM", "NEWSAGENTS_TOBACCONISTS", "NIGHTLIFE", "NON_GOVERNMENTAL_ORGANIZATION", "NORWEGIAN_RESTAURANT", "OASIS", "OBSERVATORY", "OFFICE_EQUIPMENT", "OIL_NATURAL_GAS", "OPEN_CAR_PARKING_AREA", "OPEN_PARKING_AREA", "OPERA_HOUSE", "OPTICIAN", "ORGANIC_FOOD_RESTAURANT", "ORIENTAL_RESTAURANT", "OTHER_FOOD_SHOPS", "OTHER_WINTER_SPORT", "PAGODA", "PAINTING_DECORATING", "PAKISTANI_RESTAURANT", "PARK", "PARKING_GARAGE", "PARKWAY", "PARK_RECREATION_AREA", "PASSENGER_TRANSPORT_TICKET_OFFICE", "PAWN_SHOP", "PERSONAL_CARE_FACILITY", "PERSONAL_SERVICE", "PERFORMING_ARTS_THEATER", "PERUVIAN_RESTAURANT", "PET_SUPPLIES", "PHARMACEUTICAL_COMPANY", "PHARMACY", "PHILIPPINE_RESTAURANT", "PHOTOCOPY_SHOP", "PHOTO_LAB_DEVELOPMENT", "PICNIC_AREA", "PIZZERIA", "PLACE_OF_WORSHIP", "PLAIN_FLAT", "PLANETARIUM", "PLATEAU", "POLICE_STATION", "POLISH_RESTAURANT", "POLYNESIAN_RESTAURANT", "PORTUGUESE_RESTAURANT", "PORT_WAREHOUSE_FACILITY", "POST_OFFICE", "PRE_SCHOOL", "PRIMARY_PRODUCER", "PRIMARY_RESOURCE_UTILITY", "PRIMARY_SCHOOL", "PRISON_CORRECTIONAL_FACILITY", "PRIVATE_AIRPORT", "PROTECTED_AREA", "PUB", "PUBLIC_AIRPORT", "PUBLIC_AMENITY", "PUBLIC_CALL_BOX", "PUBLIC_MARKET", "PUBLIC_TOILET", "PUBLIC_TRANSPORT_STOP", "PUBLISHING_TECHNOLOGIES", "PUB_FOOD", "QUARRY", "RACE_TRACK", "RAILWAY_STATION", "RAPIDS", "REAL_ESTATE_AGENT", "REAL_ESTATE_COMPANY", "RECREATIONAL_CAMPING_GROUND", "RECREATIONAL_MARIJUANA_DISPENSARY", "RECREATIONAL_VEHICLE_DEALER", "RECREATION_AREA", "RECYCLING_SHOP", "REEF", "RENT_A_CAR_FACILITY", "RENT_A_CAR_PARKING", "REPAIR_FACILITY", "RESEARCH_FACILITY", "RESERVOIR", "RESIDENTIAL_ACCOMMODATION", "RESORT", "RESTAURANT", "RESTAURANT_AREA", "REST_AREA", "REST_CAMP", "RETAIL_OUTLET", "RETIREMENT_COMMUNITY", "RIDGE", "RIVER_CROSSING", "ROAD_RESCUE", "ROAD_TRAFFIC_CONTROL_CENTER", "ROCKS", "ROCK_CLIMBING_TRAIL", "RUGBY_GROUND", "RUSSIAN_RESTAURANT", "SALAD_BAR", "SANDWICH_RESTAURANT", "SAUNA_SOLARIUM_MASSAGE", "SCANDINAVIAN_RESTAURANT", "SCENIC_PANORAMIC_VIEW", "SCHOOL", "SCHOOL_BUS_COMPANY", "SEAFOOD", "SECURED_ENTRANCE", "SECURITY_PRODUCTS", "SENIOR_HIGH_SCHOOL", "SERVICE_COMPANY", "SHANDONG_RESTAURANT", "SHOP", "SHOPPING_CENTER", "SHOPPING_SERVICE", "SICHUAN_RESTAURANT", "SKI_RESORT", "SNACKS_RESTAURANT", "SNOOKER_POOL_BILLIARD", "SOCCER_STADIUM", "SOFTWARE_COMPANY", "SOUL_FOOD", "SOUP_RESTAURANT", "SPANISH_RESTAURANT", "SPECIALIST", "SPECIALTY_CLOTHING_SHOP", "SPECIALTY_FOODS", "SPECIAL_HOSPITAL", "SPORTS_CENTER", "SPORTS_EQUIPMENT_CLOTHING", "SQUASH_COURT", "STADIUM", "STATION_ACCESS", "STATUE", "STEAK_HOUSE", "STOCK_EXCHANGE", "STREETCAR_STOP", "SUBWAY_STATION", "SUPERMARKETS_HYPERMARKETS", "SUSHI_RESTAURANT", "SWEDISH_RESTAURANT", "SWIMMING_POOL", "SWISS_RESTAURANT", "SYNAGOG", "SYRIAN_RESTAURANT", "TAILOR_SHOP", "TAIWANESE_RESTAURANT", "TAKEOUT_FOOD", "TAPAS_RESTAURANT", "TAXI_LIMOUSINE_SHUTTLE_SERVICE", "TAXI_STAND", "TAX_SERVICES", "TEA_HOUSE", "TELECOMMUNICATIONS", "TEMPLE", "TENNIS_COURT", "TEPPANYAKI_RESTAURANT", "THAI_RESTAURANT", "THEATER", "THEMATIC_SPORT_CENTER", "TIBETAN_RESTAURANT", "TIRE_SERVICE", "TOLL_GATE", "TOURIST_ATTRACTION", "TOURIST_INFORMATION_OFFICE", "TOWER", "TOYS_GAMES_SHOP", "TRAFFIC_CONTROL_DEPARTMENT", "TRAIL_SYSTEM", "TRANSPORT_AUTHORITY_VEHICLE_REGISTRATION", "TRANSPORT_COMPANY", "TRAVEL_AGENT", "TRUCK_DEALER", "TRUCK_REPAIR_AND_SERVICE", "TRUCK_STOP", "TUNISIAN_RESTAURANT", "TUNNEL", "TURKISH_RESTAURANT", "URBAN_STATION", "VALLEY", "VAN_DEALER", "VARIETY_STORE", "VEGETARIAN_RESTAURANT", "VENEZUELAN_RESTAURANT", "VETERINARIAN", "VIDEO_RENTAL_SHOP", "VIETNAMESE_RESTAURANT", "VILLA_RENTAL", "VOCATIONAL_SCHOOL", "WATER_HOLE", "WATER_SPORT", "WEDDING_SERVICES", "WEIGH_STATION", "WELFARE_ORGANIZATION", "WELL", "WESTERN_RESTAURANT", "WHOLESALE_CLUB", "WILDERNESS_AREA", "WILDLIFE_PARK", "WINERY", "WINE_SPIRITS", "WOMENS_CLOTHING", "YACHT_BASIN", "YOGURT_JUICE_BAR", "ZOO", "ZOOS_ARBORETA_BOTANICAL_GARDEN"];
|
|
1964
1967
|
/**
|
|
1965
1968
|
* @group Place
|
|
1966
1969
|
*/
|
|
1967
|
-
type POICategory = (typeof poiCategories)[number];
|
|
1970
|
+
export type POICategory = (typeof poiCategories)[number];
|
|
1968
1971
|
//#endregion
|
|
1969
1972
|
//#region src/types/place/poi/fuel.d.ts
|
|
1970
1973
|
/**
|
|
@@ -2141,7 +2144,7 @@ type RelatedPOI = {
|
|
|
2141
2144
|
* Available plug types for EV charging.
|
|
2142
2145
|
* @group Route
|
|
2143
2146
|
*/
|
|
2144
|
-
declare const plugTypes: readonly ["Small_Paddle_Inductive", "Large_Paddle_Inductive", "IEC_60309_1_Phase", "IEC_60309_3_Phase", "IEC_62196_Type_1_Outlet", "IEC_62196_Type_2_Outlet", "IEC_62196_Type_3_Outlet", "IEC_62196_Type_1_Connector_Cable_Attached", "IEC_62196_Type_2_Connector_Cable_Attached", "IEC_62196_Type_3_Connector_Cable_Attached", "Combo_to_IEC_62196_Type_1_Base", "Combo_to_IEC_62196_Type_2_Base", "Type_E_French_Standard_CEE_7_5", "Type_F_Schuko_CEE_7_4", "Type_G_British_Standard_BS_1363", "Type_J_Swiss_Standard_SEV_1011", "China_GB_Part_2", "China_GB_Part_3", "IEC_309_DC_Plug", "AVCON_Connector", "Tesla_Connector", "NEMA_5_20", "CHAdeMO", "SAE_J1772", "TEPCO", "Better_Place_Socket", "Marechal_Socket", "Standard_Household_Country_Specific"];
|
|
2147
|
+
export declare const plugTypes: readonly ["Small_Paddle_Inductive", "Large_Paddle_Inductive", "IEC_60309_1_Phase", "IEC_60309_3_Phase", "IEC_62196_Type_1_Outlet", "IEC_62196_Type_2_Outlet", "IEC_62196_Type_3_Outlet", "IEC_62196_Type_1_Connector_Cable_Attached", "IEC_62196_Type_2_Connector_Cable_Attached", "IEC_62196_Type_3_Connector_Cable_Attached", "Combo_to_IEC_62196_Type_1_Base", "Combo_to_IEC_62196_Type_2_Base", "Type_E_French_Standard_CEE_7_5", "Type_F_Schuko_CEE_7_4", "Type_G_British_Standard_BS_1363", "Type_J_Swiss_Standard_SEV_1011", "China_GB_Part_2", "China_GB_Part_3", "IEC_309_DC_Plug", "AVCON_Connector", "Tesla_Connector", "NEMA_5_20", "CHAdeMO", "SAE_J1772", "TEPCO", "Better_Place_Socket", "Marechal_Socket", "Standard_Household_Country_Specific"];
|
|
2145
2148
|
/**
|
|
2146
2149
|
* Standard plug/connector type for electric vehicle charging.
|
|
2147
2150
|
*
|
|
@@ -2172,7 +2175,7 @@ declare const plugTypes: readonly ["Small_Paddle_Inductive", "Large_Paddle_Induc
|
|
|
2172
2175
|
*
|
|
2173
2176
|
* @group Route
|
|
2174
2177
|
*/
|
|
2175
|
-
type PlugType = (typeof plugTypes)[number];
|
|
2178
|
+
export type PlugType = (typeof plugTypes)[number];
|
|
2176
2179
|
/**
|
|
2177
2180
|
* Information about a specific charging connection at a charging point.
|
|
2178
2181
|
*
|
|
@@ -2181,7 +2184,7 @@ type PlugType = (typeof plugTypes)[number];
|
|
|
2181
2184
|
*
|
|
2182
2185
|
* @group Route
|
|
2183
2186
|
*/
|
|
2184
|
-
type ChargingConnectionInfo = {
|
|
2187
|
+
export type ChargingConnectionInfo = {
|
|
2185
2188
|
/**
|
|
2186
2189
|
* The plug type for this charging connection.
|
|
2187
2190
|
*
|
|
@@ -2239,7 +2242,7 @@ type ChargingConnectionInfo = {
|
|
|
2239
2242
|
*
|
|
2240
2243
|
* @group Route
|
|
2241
2244
|
*/
|
|
2242
|
-
declare const paymentMethods: readonly ["No_Payment", "Subscription", "Direct"];
|
|
2245
|
+
export declare const paymentMethods: readonly ["No_Payment", "Subscription", "Direct"];
|
|
2243
2246
|
/**
|
|
2244
2247
|
* Payment method type for electric vehicle charging stations.
|
|
2245
2248
|
*
|
|
@@ -2252,7 +2255,7 @@ declare const paymentMethods: readonly ["No_Payment", "Subscription", "Direct"];
|
|
|
2252
2255
|
*
|
|
2253
2256
|
* @group Route
|
|
2254
2257
|
*/
|
|
2255
|
-
type PaymentMethod = (typeof paymentMethods)[number];
|
|
2258
|
+
export type PaymentMethod = (typeof paymentMethods)[number];
|
|
2256
2259
|
/**
|
|
2257
2260
|
* Payment option configuration for a charging station.
|
|
2258
2261
|
*
|
|
@@ -2280,7 +2283,7 @@ type PaymentMethod = (typeof paymentMethods)[number];
|
|
|
2280
2283
|
*
|
|
2281
2284
|
* @group Route
|
|
2282
2285
|
*/
|
|
2283
|
-
type ChargingPaymentOption = {
|
|
2286
|
+
export type ChargingPaymentOption = {
|
|
2284
2287
|
/**
|
|
2285
2288
|
* The payment method type accepted at this charging station.
|
|
2286
2289
|
*/
|
|
@@ -2301,7 +2304,7 @@ type ChargingPaymentOption = {
|
|
|
2301
2304
|
*
|
|
2302
2305
|
* @group Route
|
|
2303
2306
|
*/
|
|
2304
|
-
type ChargingStopProps = CommonPlaceProps & {
|
|
2307
|
+
export type ChargingStopProps = CommonPlaceProps & {
|
|
2305
2308
|
/**
|
|
2306
2309
|
* Unique identifier for the charging park.
|
|
2307
2310
|
*/
|
|
@@ -2519,7 +2522,7 @@ type ChargingStopProps = CommonPlaceProps & {
|
|
|
2519
2522
|
*
|
|
2520
2523
|
* @group Route
|
|
2521
2524
|
*/
|
|
2522
|
-
type ChargingStop = Place<ChargingStopProps>;
|
|
2525
|
+
export type ChargingStop = Place<ChargingStopProps>;
|
|
2523
2526
|
//#endregion
|
|
2524
2527
|
//#region src/types/route/guidance.d.ts
|
|
2525
2528
|
/**
|
|
@@ -2923,7 +2926,7 @@ type Guidance = {
|
|
|
2923
2926
|
*
|
|
2924
2927
|
* @group Route
|
|
2925
2928
|
*/
|
|
2926
|
-
declare const avoidableTypes: readonly ["tollRoads", "motorways", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings", "tunnels", "carTrains", "lowEmissionZones"];
|
|
2929
|
+
export declare const avoidableTypes: readonly ["tollRoads", "motorways", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings", "tunnels", "carTrains", "lowEmissionZones"];
|
|
2927
2930
|
/**
|
|
2928
2931
|
* Route features that the routing engine will attempt to avoid when calculating routes.
|
|
2929
2932
|
*
|
|
@@ -2954,7 +2957,7 @@ declare const avoidableTypes: readonly ["tollRoads", "motorways", "ferries", "un
|
|
|
2954
2957
|
*
|
|
2955
2958
|
* @group Route
|
|
2956
2959
|
*/
|
|
2957
|
-
type Avoidable = (typeof avoidableTypes)[number];
|
|
2960
|
+
export type Avoidable = (typeof avoidableTypes)[number];
|
|
2958
2961
|
/**
|
|
2959
2962
|
* Primary mode of transportation for route calculation.
|
|
2960
2963
|
*
|
|
@@ -2971,7 +2974,7 @@ type Avoidable = (typeof avoidableTypes)[number];
|
|
|
2971
2974
|
*
|
|
2972
2975
|
* @group Route
|
|
2973
2976
|
*/
|
|
2974
|
-
type TravelMode = 'car';
|
|
2977
|
+
export type TravelMode = 'car';
|
|
2975
2978
|
/**
|
|
2976
2979
|
* Cumulative distance and time measurements at a position along the route.
|
|
2977
2980
|
*
|
|
@@ -2981,7 +2984,7 @@ type TravelMode = 'car';
|
|
|
2981
2984
|
*
|
|
2982
2985
|
* @group Route
|
|
2983
2986
|
*/
|
|
2984
|
-
type RouteProgress = {
|
|
2987
|
+
export type RouteProgress = {
|
|
2985
2988
|
/**
|
|
2986
2989
|
* Cumulative travel time in seconds from the route start.
|
|
2987
2990
|
*/
|
|
@@ -3012,7 +3015,7 @@ type RouteProgress = {
|
|
|
3012
3015
|
*
|
|
3013
3016
|
* @group Route
|
|
3014
3017
|
*/
|
|
3015
|
-
type RouteProgressPoint = RouteProgress & {
|
|
3018
|
+
export type RouteProgressPoint = RouteProgress & {
|
|
3016
3019
|
/**
|
|
3017
3020
|
* Zero-based index of this point in the route's coordinate array.
|
|
3018
3021
|
*/
|
|
@@ -3026,13 +3029,13 @@ type RouteProgressPoint = RouteProgress & {
|
|
|
3026
3029
|
*
|
|
3027
3030
|
* @group Route
|
|
3028
3031
|
*/
|
|
3029
|
-
type RouteProgressAtPoint = Required<RouteProgress>;
|
|
3032
|
+
export type RouteProgressAtPoint = Required<RouteProgress>;
|
|
3030
3033
|
/**
|
|
3031
3034
|
* Progress measurements for a segment between two arbitrary points on the route path.
|
|
3032
3035
|
*
|
|
3033
3036
|
* @group Route
|
|
3034
3037
|
*/
|
|
3035
|
-
type RouteSegmentProgress = {
|
|
3038
|
+
export type RouteSegmentProgress = {
|
|
3036
3039
|
/** Progress at the start point. */
|
|
3037
3040
|
start: RouteProgressAtPoint;
|
|
3038
3041
|
/** Progress at the end point. */
|
|
@@ -3048,7 +3051,7 @@ type RouteSegmentProgress = {
|
|
|
3048
3051
|
*
|
|
3049
3052
|
* @group Route
|
|
3050
3053
|
*/
|
|
3051
|
-
type RouteProps = {
|
|
3054
|
+
export type RouteProps = {
|
|
3052
3055
|
/**
|
|
3053
3056
|
* Summary statistics for the entire route.
|
|
3054
3057
|
*
|
|
@@ -3114,7 +3117,7 @@ type RouteProps = {
|
|
|
3114
3117
|
*
|
|
3115
3118
|
* @group Route
|
|
3116
3119
|
*/
|
|
3117
|
-
type Route<P extends RouteProps = RouteProps> = Omit<Feature<LineString, P>, 'id' | 'bbox'> & {
|
|
3120
|
+
export type Route<P extends RouteProps = RouteProps> = Omit<Feature<LineString, P>, 'id' | 'bbox'> & {
|
|
3118
3121
|
/**
|
|
3119
3122
|
* Unique identifier for this route.
|
|
3120
3123
|
*
|
|
@@ -3152,7 +3155,7 @@ type Route<P extends RouteProps = RouteProps> = Omit<Feature<LineString, P>, 'id
|
|
|
3152
3155
|
*
|
|
3153
3156
|
* @group Route
|
|
3154
3157
|
*/
|
|
3155
|
-
type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown> = Omit<FeatureCollectionWithProperties<LineString, P, FeatureCollectionProps>, 'features' | 'bbox'> & {
|
|
3158
|
+
export type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown> = Omit<FeatureCollectionWithProperties<LineString, P, FeatureCollectionProps>, 'features' | 'bbox'> & {
|
|
3156
3159
|
/**
|
|
3157
3160
|
* Array of route features.
|
|
3158
3161
|
*/
|
|
@@ -3167,35 +3170,13 @@ type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown>
|
|
|
3167
3170
|
/**
|
|
3168
3171
|
* Properties specific to route waypoints.
|
|
3169
3172
|
*
|
|
3173
|
+
* @remarks
|
|
3174
|
+
* Carries no properties of its own today. A waypoint's own `properties` are merged into it, so
|
|
3175
|
+
* anything you attach to a waypoint Feature survives the round trip.
|
|
3176
|
+
*
|
|
3170
3177
|
* @group Route
|
|
3171
3178
|
*/
|
|
3172
|
-
type WaypointProps = {
|
|
3173
|
-
/**
|
|
3174
|
-
* Radius in meters defining a circle (soft) waypoint.
|
|
3175
|
-
*
|
|
3176
|
-
* When specified, the waypoint becomes a circle waypoint that shapes the route without
|
|
3177
|
-
* generating explicit navigation instructions or creating an additional route leg.
|
|
3178
|
-
*
|
|
3179
|
-
* @remarks
|
|
3180
|
-
* - Circle waypoints influence the route path while providing flexibility to the routing engine
|
|
3181
|
-
* - Larger radius values give more freedom for route optimization
|
|
3182
|
-
* - Smaller radius values force the route to pass closer to the specified point
|
|
3183
|
-
* - Unlike regular waypoints, circle waypoints don't create legs or generate "arrive at waypoint" instructions
|
|
3184
|
-
* - Useful for shaping routes through general areas rather than specific points
|
|
3185
|
-
*
|
|
3186
|
-
* Must be a positive integer with a maximum value of 135000.
|
|
3187
|
-
*
|
|
3188
|
-
* @example
|
|
3189
|
-
* ```typescript
|
|
3190
|
-
* // Circle waypoint with 1km radius - route will pass somewhere within this area
|
|
3191
|
-
* { radiusMeters: 1000 }
|
|
3192
|
-
*
|
|
3193
|
-
* // Small radius - route will pass very close to this point
|
|
3194
|
-
* { radiusMeters: 50 }
|
|
3195
|
-
* ```
|
|
3196
|
-
*/
|
|
3197
|
-
radiusMeters?: number;
|
|
3198
|
-
};
|
|
3179
|
+
type WaypointProps = {};
|
|
3199
3180
|
/**
|
|
3200
3181
|
* GeoJSON Feature representing a route waypoint.
|
|
3201
3182
|
*
|
|
@@ -3205,8 +3186,7 @@ type WaypointProps = {
|
|
|
3205
3186
|
* @typeParam T - Additional custom properties beyond the standard waypoint properties
|
|
3206
3187
|
*
|
|
3207
3188
|
* @remarks
|
|
3208
|
-
*
|
|
3209
|
-
* - Circle waypoints (with radiusMeters) shape the route without creating legs
|
|
3189
|
+
* Every waypoint creates a route leg and an arrival instruction.
|
|
3210
3190
|
*
|
|
3211
3191
|
* @example
|
|
3212
3192
|
* ```typescript
|
|
@@ -3217,11 +3197,11 @@ type WaypointProps = {
|
|
|
3217
3197
|
* properties: {}
|
|
3218
3198
|
* };
|
|
3219
3199
|
*
|
|
3220
|
-
* //
|
|
3221
|
-
* const
|
|
3200
|
+
* // Waypoint with custom properties
|
|
3201
|
+
* const namedWaypoint: Waypoint<{ name: string }> = {
|
|
3222
3202
|
* type: 'Feature',
|
|
3223
3203
|
* geometry: { type: 'Point', coordinates: [4.9041, 52.3676] },
|
|
3224
|
-
* properties: {
|
|
3204
|
+
* properties: { name: 'Amsterdam' }
|
|
3225
3205
|
* };
|
|
3226
3206
|
* ```
|
|
3227
3207
|
*
|
|
@@ -3253,12 +3233,12 @@ type Waypoints<T extends Anything = Anything> = FeatureCollection<Point, Waypoin
|
|
|
3253
3233
|
* Flexible input type for specifying a waypoint location.
|
|
3254
3234
|
*
|
|
3255
3235
|
* Accepts various formats for convenience:
|
|
3256
|
-
* - Full `Waypoint` Feature (for
|
|
3236
|
+
* - Full `Waypoint` Feature (for waypoints carrying custom properties)
|
|
3257
3237
|
* - Any object with coordinates (Position array, Point geometry, or Feature)
|
|
3258
3238
|
*
|
|
3259
3239
|
* @remarks
|
|
3260
|
-
* Waypoints are single points by default.
|
|
3261
|
-
*
|
|
3240
|
+
* Waypoints are single points by default. Use the full Waypoint Feature format to carry
|
|
3241
|
+
* properties of your own alongside the position.
|
|
3262
3242
|
*
|
|
3263
3243
|
* @example
|
|
3264
3244
|
* ```typescript
|
|
@@ -3268,11 +3248,11 @@ type Waypoints<T extends Anything = Anything> = FeatureCollection<Point, Waypoin
|
|
|
3268
3248
|
* // As Point geometry
|
|
3269
3249
|
* const wp2: WaypointLike = { type: 'Point', coordinates: [4.9041, 52.3676] };
|
|
3270
3250
|
*
|
|
3271
|
-
* // As full Waypoint Feature
|
|
3251
|
+
* // As full Waypoint Feature carrying custom properties
|
|
3272
3252
|
* const wp3: WaypointLike = {
|
|
3273
3253
|
* type: 'Feature',
|
|
3274
3254
|
* geometry: { type: 'Point', coordinates: [4.9041, 52.3676] },
|
|
3275
|
-
* properties: {
|
|
3255
|
+
* properties: { name: 'Amsterdam' }
|
|
3276
3256
|
* };
|
|
3277
3257
|
* ```
|
|
3278
3258
|
*
|
|
@@ -3314,14 +3294,15 @@ type PathLike = Position[] | Route;
|
|
|
3314
3294
|
* @remarks
|
|
3315
3295
|
* - Use waypoints for origin, destination, and intermediate stops
|
|
3316
3296
|
* - Use paths for route reconstruction or to force the route along specific roads
|
|
3297
|
+
* - A path's own endpoints are sent as waypoints, so a path between two points adds two of them
|
|
3317
3298
|
*
|
|
3318
3299
|
* @example
|
|
3319
3300
|
* ```typescript
|
|
3320
3301
|
* const locations: RoutePlanningLocation[] = [
|
|
3321
|
-
* [4.9, 52.3],
|
|
3322
|
-
*
|
|
3323
|
-
* existingPathCoordinates,
|
|
3324
|
-
* [5.0, 52.4]
|
|
3302
|
+
* [4.9, 52.3], // Start waypoint
|
|
3303
|
+
* [4.95, 52.35], // Intermediate stop
|
|
3304
|
+
* existingPathCoordinates, // Path to follow
|
|
3305
|
+
* [5.0, 52.4] // End waypoint
|
|
3325
3306
|
* ];
|
|
3326
3307
|
* ```
|
|
3327
3308
|
*
|
|
@@ -3354,7 +3335,7 @@ type RoutePlanningLocationType = 'waypoint' | 'path';
|
|
|
3354
3335
|
*
|
|
3355
3336
|
* @group Traffic
|
|
3356
3337
|
*/
|
|
3357
|
-
type DelayMagnitude = 'unknown' | 'minor' | 'moderate' | 'major' | 'indefinite';
|
|
3338
|
+
export type DelayMagnitude = 'unknown' | 'minor' | 'moderate' | 'major' | 'indefinite';
|
|
3358
3339
|
/**
|
|
3359
3340
|
* Traffic incident categories accepted as `categoryFilter` inputs by the Incident
|
|
3360
3341
|
* Details API.
|
|
@@ -3370,7 +3351,7 @@ type DelayMagnitude = 'unknown' | 'minor' | 'moderate' | 'major' | 'indefinite';
|
|
|
3370
3351
|
* @see https://docs.tomtom.com/traffic-api/documentation/tomtom-orbis-maps/traffic-incidents/incident-details
|
|
3371
3352
|
* @group Traffic
|
|
3372
3353
|
*/
|
|
3373
|
-
declare const trafficIncidentRequestCategories: readonly ["accident", "broken-down-vehicle", "danger", "flooding", "fog", "frost", "jam", "lane-closed", "other", "rain", "road-closed", "roadworks", "wind"];
|
|
3354
|
+
export declare const trafficIncidentRequestCategories: readonly ["accident", "broken-down-vehicle", "danger", "flooding", "fog", "frost", "jam", "lane-closed", "other", "rain", "road-closed", "roadworks", "wind"];
|
|
3374
3355
|
/**
|
|
3375
3356
|
* All possible traffic incident categories.
|
|
3376
3357
|
*
|
|
@@ -3385,7 +3366,7 @@ declare const trafficIncidentRequestCategories: readonly ["accident", "broken-do
|
|
|
3385
3366
|
*
|
|
3386
3367
|
* @group Traffic
|
|
3387
3368
|
*/
|
|
3388
|
-
declare const fullTrafficIncidentCategories: readonly ["accident", "broken-down-vehicle", "danger", "flooding", "fog", "frost", "jam", "lane-closed", "other", "rain", "road-closed", "roadworks", "wind", "animals-on-road", "narrow-lanes"];
|
|
3369
|
+
export declare const fullTrafficIncidentCategories: readonly ["accident", "broken-down-vehicle", "danger", "flooding", "fog", "frost", "jam", "lane-closed", "other", "rain", "road-closed", "roadworks", "wind", "animals-on-road", "narrow-lanes"];
|
|
3389
3370
|
/**
|
|
3390
3371
|
* Simple category classification for traffic incidents.
|
|
3391
3372
|
*
|
|
@@ -3408,7 +3389,7 @@ declare const fullTrafficIncidentCategories: readonly ["accident", "broken-down-
|
|
|
3408
3389
|
*
|
|
3409
3390
|
* @group Traffic
|
|
3410
3391
|
*/
|
|
3411
|
-
type TrafficIncidentCategory = (typeof fullTrafficIncidentCategories)[number];
|
|
3392
|
+
export type TrafficIncidentCategory = (typeof fullTrafficIncidentCategories)[number];
|
|
3412
3393
|
/**
|
|
3413
3394
|
* Categories accepted as `categoryFilter` input to the Incident Details API.
|
|
3414
3395
|
*
|
|
@@ -3418,7 +3399,7 @@ type TrafficIncidentCategory = (typeof fullTrafficIncidentCategories)[number];
|
|
|
3418
3399
|
*
|
|
3419
3400
|
* @group Traffic
|
|
3420
3401
|
*/
|
|
3421
|
-
type TrafficIncidentRequestCategory = (typeof trafficIncidentRequestCategories)[number];
|
|
3402
|
+
export type TrafficIncidentRequestCategory = (typeof trafficIncidentRequestCategories)[number];
|
|
3422
3403
|
/**
|
|
3423
3404
|
* Likelihood that an incident will actually occur.
|
|
3424
3405
|
*
|
|
@@ -3430,7 +3411,7 @@ type TrafficIncidentRequestCategory = (typeof trafficIncidentRequestCategories)[
|
|
|
3430
3411
|
*
|
|
3431
3412
|
* @group Traffic
|
|
3432
3413
|
*/
|
|
3433
|
-
type TrafficIncidentProbability = 'certain' | 'probable' | 'risk_of' | 'improbable';
|
|
3414
|
+
export type TrafficIncidentProbability = 'certain' | 'probable' | 'risk_of' | 'improbable';
|
|
3434
3415
|
/**
|
|
3435
3416
|
* Whether a traffic incident is currently active or anticipated in the future.
|
|
3436
3417
|
*
|
|
@@ -3440,13 +3421,13 @@ type TrafficIncidentProbability = 'certain' | 'probable' | 'risk_of' | 'improbab
|
|
|
3440
3421
|
*
|
|
3441
3422
|
* @group Traffic
|
|
3442
3423
|
*/
|
|
3443
|
-
type TrafficIncidentTimeValidity = 'present' | 'future';
|
|
3424
|
+
export type TrafficIncidentTimeValidity = 'present' | 'future';
|
|
3444
3425
|
/**
|
|
3445
3426
|
* A single TMC (Traffic Message Channel) location point.
|
|
3446
3427
|
*
|
|
3447
3428
|
* @group Traffic
|
|
3448
3429
|
*/
|
|
3449
|
-
type TrafficIncidentTMCPoint = {
|
|
3430
|
+
export type TrafficIncidentTMCPoint = {
|
|
3450
3431
|
/**
|
|
3451
3432
|
* TMC location code.
|
|
3452
3433
|
*/
|
|
@@ -3464,7 +3445,7 @@ type TrafficIncidentTMCPoint = {
|
|
|
3464
3445
|
*
|
|
3465
3446
|
* @group Traffic
|
|
3466
3447
|
*/
|
|
3467
|
-
type TrafficIncidentTMC = {
|
|
3448
|
+
export type TrafficIncidentTMC = {
|
|
3468
3449
|
/**
|
|
3469
3450
|
* ISO 3166-1 alpha-2 country code.
|
|
3470
3451
|
*/
|
|
@@ -3493,7 +3474,7 @@ type TrafficIncidentTMC = {
|
|
|
3493
3474
|
*
|
|
3494
3475
|
* @group Traffic
|
|
3495
3476
|
*/
|
|
3496
|
-
type TrafficIncidentEvent = {
|
|
3477
|
+
export type TrafficIncidentEvent = {
|
|
3497
3478
|
/**
|
|
3498
3479
|
* Human-readable description of the event.
|
|
3499
3480
|
*/
|
|
@@ -3515,7 +3496,7 @@ type TrafficIncidentEvent = {
|
|
|
3515
3496
|
*
|
|
3516
3497
|
* @group Traffic
|
|
3517
3498
|
*/
|
|
3518
|
-
type TrafficIncidentBaseProperties = {
|
|
3499
|
+
export type TrafficIncidentBaseProperties = {
|
|
3519
3500
|
/**
|
|
3520
3501
|
* Unique identifier of the incident.
|
|
3521
3502
|
*/
|
|
@@ -3561,7 +3542,7 @@ type TrafficIncidentBaseProperties = {
|
|
|
3561
3542
|
*
|
|
3562
3543
|
* @group Traffic
|
|
3563
3544
|
*/
|
|
3564
|
-
type TrafficIncidentProperties = TrafficIncidentBaseProperties & {
|
|
3545
|
+
export type TrafficIncidentProperties = TrafficIncidentBaseProperties & {
|
|
3565
3546
|
/**
|
|
3566
3547
|
* One or more events describing the incident in detail.
|
|
3567
3548
|
*/
|
|
@@ -3599,7 +3580,7 @@ type TrafficIncidentProperties = TrafficIncidentBaseProperties & {
|
|
|
3599
3580
|
*
|
|
3600
3581
|
* @group Traffic
|
|
3601
3582
|
*/
|
|
3602
|
-
type TrafficIncident = Feature<Point | LineString, TrafficIncidentProperties>;
|
|
3583
|
+
export type TrafficIncident = Feature<Point | LineString, TrafficIncidentProperties>;
|
|
3603
3584
|
/**
|
|
3604
3585
|
* Response from the Incident Details service.
|
|
3605
3586
|
*
|
|
@@ -3608,7 +3589,7 @@ type TrafficIncident = Feature<Point | LineString, TrafficIncidentProperties>;
|
|
|
3608
3589
|
*
|
|
3609
3590
|
* @group Traffic
|
|
3610
3591
|
*/
|
|
3611
|
-
type TrafficIncidentDetails = FeatureCollection<Point | LineString, TrafficIncidentProperties>;
|
|
3592
|
+
export type TrafficIncidentDetails = FeatureCollection<Point | LineString, TrafficIncidentProperties>;
|
|
3612
3593
|
//#endregion
|
|
3613
3594
|
//#region src/types/route/summary.d.ts
|
|
3614
3595
|
/**
|
|
@@ -3831,7 +3812,7 @@ type RouteSummary = SummaryWithConsumption & {
|
|
|
3831
3812
|
* @remarks
|
|
3832
3813
|
* - An A→B route has 1 leg
|
|
3833
3814
|
* - An A→B→C route has 2 legs (A→B, B→C)
|
|
3834
|
-
* -
|
|
3815
|
+
* - An EV route can hold more legs than the stops asked for, one per charging stop the service adds
|
|
3835
3816
|
*
|
|
3836
3817
|
* @group Route
|
|
3837
3818
|
*/
|
|
@@ -3870,7 +3851,7 @@ type LegSummary = SummaryWithConsumption & {
|
|
|
3870
3851
|
*
|
|
3871
3852
|
* @group Route
|
|
3872
3853
|
*/
|
|
3873
|
-
type SectionProps = {
|
|
3854
|
+
export type SectionProps = {
|
|
3874
3855
|
/**
|
|
3875
3856
|
* Unique identifier for this section.
|
|
3876
3857
|
*
|
|
@@ -3910,7 +3891,7 @@ type SectionProps = {
|
|
|
3910
3891
|
*
|
|
3911
3892
|
* @group Route
|
|
3912
3893
|
*/
|
|
3913
|
-
type CountrySectionProps = SectionProps & {
|
|
3894
|
+
export type CountrySectionProps = SectionProps & {
|
|
3914
3895
|
/**
|
|
3915
3896
|
* Three-letter ISO 3166-1 alpha-3 country code.
|
|
3916
3897
|
*
|
|
@@ -3927,7 +3908,7 @@ type CountrySectionProps = SectionProps & {
|
|
|
3927
3908
|
*
|
|
3928
3909
|
* @group Route
|
|
3929
3910
|
*/
|
|
3930
|
-
type ImportantRoadStretchProps = SectionProps & {
|
|
3911
|
+
export type ImportantRoadStretchProps = SectionProps & {
|
|
3931
3912
|
/**
|
|
3932
3913
|
* The integer value of importance. The index starts from 0, and a lower value means higher importance. The index is needed for two reasons:
|
|
3933
3914
|
* * To understand which stretch is the most important (for example, if it is necessary to display a smaller number of stretches).
|
|
@@ -3956,7 +3937,7 @@ type ImportantRoadStretchProps = SectionProps & {
|
|
|
3956
3937
|
*
|
|
3957
3938
|
* @group Route
|
|
3958
3939
|
*/
|
|
3959
|
-
type CauseTEC = {
|
|
3940
|
+
export type CauseTEC = {
|
|
3960
3941
|
/**
|
|
3961
3942
|
* Main cause code from TPEG2-TEC standard.
|
|
3962
3943
|
*
|
|
@@ -3977,7 +3958,7 @@ type CauseTEC = {
|
|
|
3977
3958
|
*
|
|
3978
3959
|
* @group Route
|
|
3979
3960
|
*/
|
|
3980
|
-
type TrafficIncidentTEC = {
|
|
3961
|
+
export type TrafficIncidentTEC = {
|
|
3981
3962
|
/**
|
|
3982
3963
|
* Effect code describing impact on traffic flow.
|
|
3983
3964
|
*
|
|
@@ -4014,7 +3995,7 @@ type TrafficIncidentTEC = {
|
|
|
4014
3995
|
*
|
|
4015
3996
|
* @group Route
|
|
4016
3997
|
*/
|
|
4017
|
-
type TrafficSectionProps = SectionProps & {
|
|
3998
|
+
export type TrafficSectionProps = SectionProps & {
|
|
4018
3999
|
/**
|
|
4019
4000
|
* Categories of the incident. Based on the 'tec' cause codes.
|
|
4020
4001
|
*/
|
|
@@ -4045,14 +4026,14 @@ type TrafficSectionProps = SectionProps & {
|
|
|
4045
4026
|
/**
|
|
4046
4027
|
* Route section representing a leg between waypoints.
|
|
4047
4028
|
*
|
|
4048
|
-
* A leg is the portion of route between two consecutive
|
|
4029
|
+
* A leg is the portion of route between two consecutive waypoints.
|
|
4049
4030
|
* This is a top-level section that encompasses the entire journey segment.
|
|
4050
4031
|
*
|
|
4051
4032
|
* @remarks
|
|
4052
4033
|
* Leg examples:
|
|
4053
4034
|
* - A→B route: 1 leg (A to B)
|
|
4054
4035
|
* - A→B→C route: 2 legs (A to B, then B to C)
|
|
4055
|
-
* -
|
|
4036
|
+
* - An EV route: one leg per charging stop the service adds, on top of the stops that were asked for
|
|
4056
4037
|
*
|
|
4057
4038
|
* @example
|
|
4058
4039
|
* ```typescript
|
|
@@ -4072,7 +4053,7 @@ type TrafficSectionProps = SectionProps & {
|
|
|
4072
4053
|
*
|
|
4073
4054
|
* @group Route
|
|
4074
4055
|
*/
|
|
4075
|
-
type LegSectionProps = Omit<SectionProps, 'startPointIndex' | 'endPointIndex'> & {
|
|
4056
|
+
export type LegSectionProps = Omit<SectionProps, 'startPointIndex' | 'endPointIndex'> & {
|
|
4076
4057
|
/**
|
|
4077
4058
|
* Index where this leg starts in the route coordinates.
|
|
4078
4059
|
*
|
|
@@ -4100,7 +4081,7 @@ type LegSectionProps = Omit<SectionProps, 'startPointIndex' | 'endPointIndex'> &
|
|
|
4100
4081
|
*
|
|
4101
4082
|
* @group Route
|
|
4102
4083
|
*/
|
|
4103
|
-
type PossibleLaneDirection = 'STRAIGHT' | 'SLIGHT_RIGHT' | 'RIGHT' | 'SHARP_RIGHT' | 'RIGHT_U_TURN' | 'SLIGHT_LEFT' | 'LEFT' | 'SHARP_LEFT' | 'LEFT_U_TURN';
|
|
4084
|
+
export type PossibleLaneDirection = 'STRAIGHT' | 'SLIGHT_RIGHT' | 'RIGHT' | 'SHARP_RIGHT' | 'RIGHT_U_TURN' | 'SLIGHT_LEFT' | 'LEFT' | 'SHARP_LEFT' | 'LEFT_U_TURN';
|
|
4104
4085
|
/**
|
|
4105
4086
|
* Lane guidance information.
|
|
4106
4087
|
*
|
|
@@ -4118,7 +4099,7 @@ type PossibleLaneDirection = 'STRAIGHT' | 'SLIGHT_RIGHT' | 'RIGHT' | 'SHARP_RIGH
|
|
|
4118
4099
|
*
|
|
4119
4100
|
* @group Route
|
|
4120
4101
|
*/
|
|
4121
|
-
type LaneDirection = {
|
|
4102
|
+
export type LaneDirection = {
|
|
4122
4103
|
/**
|
|
4123
4104
|
* All possible directions this lane leads to.
|
|
4124
4105
|
*
|
|
@@ -4136,12 +4117,12 @@ type LaneDirection = {
|
|
|
4136
4117
|
* All the possible lane separators.
|
|
4137
4118
|
* @group Route
|
|
4138
4119
|
*/
|
|
4139
|
-
type PossibleLaneSeparator = 'UNKNOWN' | 'NO_MARKING' | 'LONG_DASHED' | 'DOUBLE_SOLID' | 'SINGLE_SOLID' | 'SOLID_DASHED' | 'DASHED_SOLID' | 'SHORT_DASHED' | 'SHADED_AREA_MARKING' | 'DASHED_BLOCKS' | 'DOUBLE_DASHED' | 'CROSSING_ALERT' | 'PHYSICAL_DIVIDER' | 'PHYSICAL_DIVIDER_LESS_THAN_3M' | 'PHYSICAL_DIVIDER_GUARDRAIL' | 'CURB';
|
|
4120
|
+
export type PossibleLaneSeparator = 'UNKNOWN' | 'NO_MARKING' | 'LONG_DASHED' | 'DOUBLE_SOLID' | 'SINGLE_SOLID' | 'SOLID_DASHED' | 'DASHED_SOLID' | 'SHORT_DASHED' | 'SHADED_AREA_MARKING' | 'DASHED_BLOCKS' | 'DOUBLE_DASHED' | 'CROSSING_ALERT' | 'PHYSICAL_DIVIDER' | 'PHYSICAL_DIVIDER_LESS_THAN_3M' | 'PHYSICAL_DIVIDER_GUARDRAIL' | 'CURB';
|
|
4140
4121
|
/**
|
|
4141
4122
|
* Section representing a lane configuration.
|
|
4142
4123
|
* @group Route
|
|
4143
4124
|
*/
|
|
4144
|
-
type LaneSectionProps = SectionProps & {
|
|
4125
|
+
export type LaneSectionProps = SectionProps & {
|
|
4145
4126
|
/**
|
|
4146
4127
|
* The lane directions for this lane section.
|
|
4147
4128
|
*/
|
|
@@ -4164,7 +4145,7 @@ type LaneSectionProps = SectionProps & {
|
|
|
4164
4145
|
* Section representing a speed limit.
|
|
4165
4146
|
* @group Route
|
|
4166
4147
|
*/
|
|
4167
|
-
type SpeedLimitSectionProps = SectionProps & {
|
|
4148
|
+
export type SpeedLimitSectionProps = SectionProps & {
|
|
4168
4149
|
/**
|
|
4169
4150
|
* The speed limit in km/h for this section.
|
|
4170
4151
|
*/
|
|
@@ -4174,7 +4155,7 @@ type SpeedLimitSectionProps = SectionProps & {
|
|
|
4174
4155
|
* Section representing a road shield.
|
|
4175
4156
|
* @group Route
|
|
4176
4157
|
*/
|
|
4177
|
-
type RoadShieldSectionProps = SectionProps & {
|
|
4158
|
+
export type RoadShieldSectionProps = SectionProps & {
|
|
4178
4159
|
/**
|
|
4179
4160
|
* The road shield code for this section.
|
|
4180
4161
|
*/
|
|
@@ -4186,7 +4167,7 @@ type RoadShieldSectionProps = SectionProps & {
|
|
|
4186
4167
|
* Using sections, you can show users where these things lie on a planned route.
|
|
4187
4168
|
* @group Route
|
|
4188
4169
|
*/
|
|
4189
|
-
type SectionsProps = {
|
|
4170
|
+
export type SectionsProps = {
|
|
4190
4171
|
carpool?: SectionProps[];
|
|
4191
4172
|
carTrain?: SectionProps[];
|
|
4192
4173
|
country?: CountrySectionProps[];
|
|
@@ -4211,21 +4192,21 @@ type SectionsProps = {
|
|
|
4211
4192
|
/**
|
|
4212
4193
|
* @group Route
|
|
4213
4194
|
*/
|
|
4214
|
-
type SectionType = keyof SectionsProps;
|
|
4195
|
+
export type SectionType = keyof SectionsProps;
|
|
4215
4196
|
/**
|
|
4216
4197
|
* Route calculation request section types so they can be included in response.
|
|
4217
4198
|
* @group Route
|
|
4218
4199
|
*/
|
|
4219
|
-
declare const inputSectionTypes: SectionType[];
|
|
4200
|
+
export declare const inputSectionTypes: SectionType[];
|
|
4220
4201
|
/**
|
|
4221
4202
|
* Route calculation request section types, including guidance-related ones, so they can be included in response.
|
|
4222
4203
|
* @group Route
|
|
4223
4204
|
*/
|
|
4224
|
-
declare const inputSectionTypesWithGuidance: SectionType[];
|
|
4205
|
+
export declare const inputSectionTypesWithGuidance: SectionType[];
|
|
4225
4206
|
/**
|
|
4226
4207
|
* @group Route
|
|
4227
4208
|
*/
|
|
4228
|
-
declare const sectionTypes: SectionType[];
|
|
4209
|
+
export declare const sectionTypes: SectionType[];
|
|
4229
4210
|
//#endregion
|
|
4230
4211
|
//#region src/types/traffic/areaAnalytics.d.ts
|
|
4231
4212
|
/**
|
|
@@ -4233,7 +4214,7 @@ declare const sectionTypes: SectionType[];
|
|
|
4233
4214
|
*
|
|
4234
4215
|
* @group Traffic
|
|
4235
4216
|
*/
|
|
4236
|
-
type AreaAnalyticsMetricRange = {
|
|
4217
|
+
export type AreaAnalyticsMetricRange = {
|
|
4237
4218
|
min: number;
|
|
4238
4219
|
max: number;
|
|
4239
4220
|
};
|
|
@@ -4242,13 +4223,13 @@ type AreaAnalyticsMetricRange = {
|
|
|
4242
4223
|
*
|
|
4243
4224
|
* @group Traffic
|
|
4244
4225
|
*/
|
|
4245
|
-
declare const areaAnalyticsMetricKeys: readonly ["speed", "freeFlowSpeed", "congestionLevel", "travelTime", "networkLength"];
|
|
4226
|
+
export declare const areaAnalyticsMetricKeys: readonly ["speed", "freeFlowSpeed", "congestionLevel", "travelTime", "networkLength"];
|
|
4246
4227
|
/**
|
|
4247
4228
|
* Identifies a single traffic metric — a key of {@link AreaAnalyticsMetrics}.
|
|
4248
4229
|
*
|
|
4249
4230
|
* @group Traffic
|
|
4250
4231
|
*/
|
|
4251
|
-
type AreaAnalyticsMetricKey = (typeof areaAnalyticsMetricKeys)[number];
|
|
4232
|
+
export type AreaAnalyticsMetricKey = (typeof areaAnalyticsMetricKeys)[number];
|
|
4252
4233
|
/**
|
|
4253
4234
|
* Traffic metric values for an area or time period.
|
|
4254
4235
|
*
|
|
@@ -4257,7 +4238,7 @@ type AreaAnalyticsMetricKey = (typeof areaAnalyticsMetricKeys)[number];
|
|
|
4257
4238
|
*
|
|
4258
4239
|
* @group Traffic
|
|
4259
4240
|
*/
|
|
4260
|
-
type AreaAnalyticsMetrics = {
|
|
4241
|
+
export type AreaAnalyticsMetrics = {
|
|
4261
4242
|
/**
|
|
4262
4243
|
* Average speed on the road network (km/h).
|
|
4263
4244
|
*/
|
|
@@ -4295,7 +4276,7 @@ type AreaAnalyticsMetrics = {
|
|
|
4295
4276
|
*
|
|
4296
4277
|
* @group Traffic
|
|
4297
4278
|
*/
|
|
4298
|
-
type AreaAnalyticsTimedEntry = AreaAnalyticsMetrics & {
|
|
4279
|
+
export type AreaAnalyticsTimedEntry = AreaAnalyticsMetrics & {
|
|
4299
4280
|
/**
|
|
4300
4281
|
* Date for daily and hourly entries.
|
|
4301
4282
|
*/
|
|
@@ -4326,7 +4307,7 @@ type AreaAnalyticsTimedEntry = AreaAnalyticsMetrics & {
|
|
|
4326
4307
|
*
|
|
4327
4308
|
* @group Traffic
|
|
4328
4309
|
*/
|
|
4329
|
-
type AreaAnalyticsTimedData = {
|
|
4310
|
+
export type AreaAnalyticsTimedData = {
|
|
4330
4311
|
/**
|
|
4331
4312
|
* Yearly aggregated data.
|
|
4332
4313
|
*/
|
|
@@ -4362,7 +4343,7 @@ type AreaAnalyticsTimedData = {
|
|
|
4362
4343
|
*
|
|
4363
4344
|
* @group Traffic
|
|
4364
4345
|
*/
|
|
4365
|
-
type AreaAnalyticsTileEntry = AreaAnalyticsMetrics & {
|
|
4346
|
+
export type AreaAnalyticsTileEntry = AreaAnalyticsMetrics & {
|
|
4366
4347
|
/**
|
|
4367
4348
|
* Centre of the tile as a GeoJSON position `[longitude, latitude]`.
|
|
4368
4349
|
*/
|
|
@@ -4373,7 +4354,7 @@ type AreaAnalyticsTileEntry = AreaAnalyticsMetrics & {
|
|
|
4373
4354
|
*
|
|
4374
4355
|
* @group Traffic
|
|
4375
4356
|
*/
|
|
4376
|
-
type AreaAnalyticsAnomaly = {
|
|
4357
|
+
export type AreaAnalyticsAnomaly = {
|
|
4377
4358
|
/**
|
|
4378
4359
|
* Start of the anomaly period.
|
|
4379
4360
|
*/
|
|
@@ -4392,7 +4373,7 @@ type AreaAnalyticsAnomaly = {
|
|
|
4392
4373
|
*
|
|
4393
4374
|
* @group Traffic
|
|
4394
4375
|
*/
|
|
4395
|
-
type AreaAnalyticsFeatureProperties = {
|
|
4376
|
+
export type AreaAnalyticsFeatureProperties = {
|
|
4396
4377
|
/**
|
|
4397
4378
|
* Name of the analysis region.
|
|
4398
4379
|
*/
|
|
@@ -4429,7 +4410,7 @@ type AreaAnalyticsFeatureProperties = {
|
|
|
4429
4410
|
*
|
|
4430
4411
|
* @group Traffic
|
|
4431
4412
|
*/
|
|
4432
|
-
type AreaAnalyticsFeature = Omit<Feature<Polygon, AreaAnalyticsFeatureProperties>, 'id' | 'bbox'> & {
|
|
4413
|
+
export type AreaAnalyticsFeature = Omit<Feature<Polygon, AreaAnalyticsFeatureProperties>, 'id' | 'bbox'> & {
|
|
4433
4414
|
/**
|
|
4434
4415
|
* Unique identifier for this feature.
|
|
4435
4416
|
*/
|
|
@@ -4444,7 +4425,7 @@ type AreaAnalyticsFeature = Omit<Feature<Polygon, AreaAnalyticsFeatureProperties
|
|
|
4444
4425
|
*
|
|
4445
4426
|
* @group Traffic Analytics
|
|
4446
4427
|
*/
|
|
4447
|
-
type AreaAnalyticsCollectionProperties = {
|
|
4428
|
+
export type AreaAnalyticsCollectionProperties = {
|
|
4448
4429
|
/**
|
|
4449
4430
|
* Start of the analysis period.
|
|
4450
4431
|
*/
|
|
@@ -4502,7 +4483,7 @@ type AreaAnalyticsCollectionProperties = {
|
|
|
4502
4483
|
*
|
|
4503
4484
|
* @group Traffic
|
|
4504
4485
|
*/
|
|
4505
|
-
type TrafficAreaAnalytics = {
|
|
4486
|
+
export type TrafficAreaAnalytics = {
|
|
4506
4487
|
type: 'FeatureCollection';
|
|
4507
4488
|
/**
|
|
4508
4489
|
* Collection-level metadata for the analysis.
|
|
@@ -4519,7 +4500,7 @@ type TrafficAreaAnalytics = {
|
|
|
4519
4500
|
* List of available views for geopolitical context.
|
|
4520
4501
|
* @group Shared
|
|
4521
4502
|
*/
|
|
4522
|
-
declare const views: readonly ["Unified", "AR", "IN", "PK", "IL", "MA", "RU", "TR", "CN"];
|
|
4503
|
+
export declare const views: readonly ["Unified", "AR", "IN", "PK", "IL", "MA", "RU", "TR", "CN", "TW", "RS"];
|
|
4523
4504
|
/**
|
|
4524
4505
|
* Geopolitical view context for map display and data.
|
|
4525
4506
|
*
|
|
@@ -4544,7 +4525,7 @@ declare const views: readonly ["Unified", "AR", "IN", "PK", "IL", "MA", "RU", "T
|
|
|
4544
4525
|
*
|
|
4545
4526
|
* @group Shared
|
|
4546
4527
|
*/
|
|
4547
|
-
type View = (typeof views)[number];
|
|
4528
|
+
export type View = (typeof views)[number];
|
|
4548
4529
|
//#endregion
|
|
4549
4530
|
//#region src/util/bbox.d.ts
|
|
4550
4531
|
/**
|
|
@@ -4552,13 +4533,13 @@ type View = (typeof views)[number];
|
|
|
4552
4533
|
* @ignore
|
|
4553
4534
|
* @param bbox The BBox to verify. If undefined, false is returned.
|
|
4554
4535
|
*/
|
|
4555
|
-
declare const isBBoxWithArea: (bbox: OptionalBBox) => boolean;
|
|
4536
|
+
export declare const isBBoxWithArea: (bbox: OptionalBBox) => boolean;
|
|
4556
4537
|
/**
|
|
4557
4538
|
* Returns the given bbox if it has area, or undefined otherwise.
|
|
4558
4539
|
* @ignore
|
|
4559
4540
|
* @param bbox The BBox to verify. If undefined, undefined is returned.
|
|
4560
4541
|
*/
|
|
4561
|
-
declare const bboxOnlyIfWithArea: (bbox: OptionalBBox) => OptionalBBox;
|
|
4542
|
+
export declare const bboxOnlyIfWithArea: (bbox: OptionalBBox) => OptionalBBox;
|
|
4562
4543
|
/**
|
|
4563
4544
|
* Expands the given bounding box with the given position.
|
|
4564
4545
|
* * If the given bounding box is undefined, the given position is considered alone.
|
|
@@ -4567,19 +4548,19 @@ declare const bboxOnlyIfWithArea: (bbox: OptionalBBox) => OptionalBBox;
|
|
|
4567
4548
|
* @param positionToContain
|
|
4568
4549
|
* @param bboxToExpand
|
|
4569
4550
|
*/
|
|
4570
|
-
declare const bboxExpandedWithPosition: (positionToContain: Position, bboxToExpand?: BBox) => OptionalBBox;
|
|
4551
|
+
export declare const bboxExpandedWithPosition: (positionToContain: Position, bboxToExpand?: BBox) => OptionalBBox;
|
|
4571
4552
|
/**
|
|
4572
4553
|
* @ignore
|
|
4573
4554
|
* @param bboxToContain
|
|
4574
4555
|
* @param bboxToExpand
|
|
4575
4556
|
*/
|
|
4576
|
-
declare const bboxExpandedWithBBox: (bboxToContain: OptionalBBox, bboxToExpand?: BBox) => OptionalBBox;
|
|
4557
|
+
export declare const bboxExpandedWithBBox: (bboxToContain: OptionalBBox, bboxToExpand?: BBox) => OptionalBBox;
|
|
4577
4558
|
/**
|
|
4578
4559
|
* Calculates the bounding box which contains all the given bounding boxes.
|
|
4579
4560
|
* @ignore
|
|
4580
4561
|
* @param bboxes
|
|
4581
4562
|
*/
|
|
4582
|
-
declare const bboxFromBBoxes: (bboxes: OptionalBBox[]) => OptionalBBox;
|
|
4563
|
+
export declare const bboxFromBBoxes: (bboxes: OptionalBBox[]) => OptionalBBox;
|
|
4583
4564
|
/**
|
|
4584
4565
|
* Calculates a bounding box from an array of coordinates.
|
|
4585
4566
|
* * If the array is beyond a certain size, it doesn't scan it fully,
|
|
@@ -4588,7 +4569,7 @@ declare const bboxFromBBoxes: (bboxes: OptionalBBox[]) => OptionalBBox;
|
|
|
4588
4569
|
* @ignore
|
|
4589
4570
|
* @param coordinates Should always be passed, but undefined is also supported, resulting in undefined bbox.
|
|
4590
4571
|
*/
|
|
4591
|
-
declare const bboxFromCoordsArray: (coordinates: Position[] | undefined) => OptionalBBox;
|
|
4572
|
+
export declare const bboxFromCoordsArray: (coordinates: Position[] | undefined) => OptionalBBox;
|
|
4592
4573
|
/**
|
|
4593
4574
|
* Extracts or calculates a bounding box from GeoJSON objects.
|
|
4594
4575
|
*
|
|
@@ -4647,7 +4628,7 @@ declare const bboxFromCoordsArray: (coordinates: Position[] | undefined) => Opti
|
|
|
4647
4628
|
*
|
|
4648
4629
|
* @group Utils
|
|
4649
4630
|
*/
|
|
4650
|
-
declare const bboxFromGeoJSON: (hasBBox: HasBBox) => OptionalBBox;
|
|
4631
|
+
export declare const bboxFromGeoJSON: (hasBBox: HasBBox) => OptionalBBox;
|
|
4651
4632
|
/**
|
|
4652
4633
|
* Expands the given bounding box with the given GeoJSON.
|
|
4653
4634
|
* * If the feature has also a bounding box, the latter is considered instead.
|
|
@@ -4657,39 +4638,39 @@ declare const bboxFromGeoJSON: (hasBBox: HasBBox) => OptionalBBox;
|
|
|
4657
4638
|
* @param geoJson
|
|
4658
4639
|
* @param bboxToExpand
|
|
4659
4640
|
*/
|
|
4660
|
-
declare const bboxExpandedWithGeoJSON: (geoJson: GeoJSON, bboxToExpand?: BBox) => OptionalBBox;
|
|
4641
|
+
export declare const bboxExpandedWithGeoJSON: (geoJson: GeoJSON, bboxToExpand?: BBox) => OptionalBBox;
|
|
4661
4642
|
/**
|
|
4662
4643
|
* Calculate the center of bbox
|
|
4663
4644
|
* @ignore
|
|
4664
4645
|
* @param bbox
|
|
4665
4646
|
* */
|
|
4666
|
-
declare const bboxCenter: (bbox: BBox) => Position;
|
|
4647
|
+
export declare const bboxCenter: (bbox: BBox) => Position;
|
|
4667
4648
|
/**
|
|
4668
4649
|
* Creates a GeoJSON Polygon Feature representing the area of the given bounding box.
|
|
4669
4650
|
* @param bbox The bounding box defined as [west, south, east, north]
|
|
4670
4651
|
*/
|
|
4671
|
-
declare const polygonFromBBox: (bbox: BBox) => Feature<Polygon>;
|
|
4652
|
+
export declare const polygonFromBBox: (bbox: BBox) => Feature<Polygon>;
|
|
4672
4653
|
//#endregion
|
|
4673
4654
|
//#region src/util/generateId.d.ts
|
|
4674
4655
|
/**
|
|
4675
4656
|
* Generate random id for map features
|
|
4676
4657
|
* @ignore
|
|
4677
4658
|
*/
|
|
4678
|
-
declare const generateId: () => string;
|
|
4659
|
+
export declare const generateId: () => string;
|
|
4679
4660
|
//#endregion
|
|
4680
4661
|
//#region src/util/headers.d.ts
|
|
4681
4662
|
/**
|
|
4682
4663
|
* SDK name used TomTom custom header tomtom-user-agent
|
|
4683
4664
|
* @ignore
|
|
4684
4665
|
*/
|
|
4685
|
-
declare const TOMTOM_USER_AGENT_SDK_NAME = "MapsSDKJS";
|
|
4666
|
+
export declare const TOMTOM_USER_AGENT_SDK_NAME = "MapsSDKJS";
|
|
4686
4667
|
/**
|
|
4687
4668
|
* Generates an object with TomTom custom header values for the given common parameters.
|
|
4688
4669
|
*
|
|
4689
4670
|
* @ignore
|
|
4690
4671
|
* @param params Global SDK configuration
|
|
4691
4672
|
*/
|
|
4692
|
-
declare const generateTomTomHeaders: (params: Partial<GlobalConfig>) => TomTomHeaders;
|
|
4673
|
+
export declare const generateTomTomHeaders: (params: Partial<GlobalConfig>) => TomTomHeaders;
|
|
4693
4674
|
//#endregion
|
|
4694
4675
|
//#region src/util/lngLat.d.ts
|
|
4695
4676
|
/**
|
|
@@ -4742,7 +4723,7 @@ declare const generateTomTomHeaders: (params: Partial<GlobalConfig>) => TomTomHe
|
|
|
4742
4723
|
*
|
|
4743
4724
|
* @group Utils
|
|
4744
4725
|
*/
|
|
4745
|
-
declare const getPosition: (hasLngLat: HasLngLat | undefined, options?: GetPositionOptions) => Position | null;
|
|
4726
|
+
export declare const getPosition: (hasLngLat: HasLngLat | undefined, options?: GetPositionOptions) => Position | null;
|
|
4746
4727
|
/**
|
|
4747
4728
|
* Extracts the lng-lat position from various input formats (strict version).
|
|
4748
4729
|
*
|
|
@@ -4779,15 +4760,15 @@ declare const getPosition: (hasLngLat: HasLngLat | undefined, options?: GetPosit
|
|
|
4779
4760
|
*
|
|
4780
4761
|
* @ignore
|
|
4781
4762
|
*/
|
|
4782
|
-
declare const getPositionStrict: (hasLngLat: HasLngLat, options?: GetPositionOptions) => Position;
|
|
4763
|
+
export declare const getPositionStrict: (hasLngLat: HasLngLat, options?: GetPositionOptions) => Position;
|
|
4783
4764
|
/**
|
|
4784
4765
|
* @ignore
|
|
4785
4766
|
*/
|
|
4786
|
-
declare const toPointGeometry: (coordinates: Position) => Point;
|
|
4767
|
+
export declare const toPointGeometry: (coordinates: Position) => Point;
|
|
4787
4768
|
/**
|
|
4788
4769
|
* @ignore
|
|
4789
4770
|
*/
|
|
4790
|
-
declare const toPointFeature: (coordinates: Position) => Feature<Point>;
|
|
4771
|
+
export declare const toPointFeature: (coordinates: Position) => Feature<Point>;
|
|
4791
4772
|
//#endregion
|
|
4792
4773
|
//#region src/util/poiCategoriesToID.d.ts
|
|
4793
4774
|
/**
|
|
@@ -4798,19 +4779,19 @@ declare const toPointFeature: (coordinates: Position) => Feature<Point>;
|
|
|
4798
4779
|
*
|
|
4799
4780
|
* @ignore
|
|
4800
4781
|
*/
|
|
4801
|
-
declare const poiCategoriesToIDs: Record<POICategory$1, number[]>;
|
|
4782
|
+
export declare const poiCategoriesToIDs: Record<POICategory$1, number[]>;
|
|
4802
4783
|
/**
|
|
4803
4784
|
* Derived mapping: POICategory names to their primary numeric ID (first/smallest in the array).
|
|
4804
4785
|
*
|
|
4805
4786
|
* @ignore
|
|
4806
4787
|
*/
|
|
4807
|
-
declare const poiCategoriesToID: Record<POICategory$1, number>;
|
|
4788
|
+
export declare const poiCategoriesToID: Record<POICategory$1, number>;
|
|
4808
4789
|
/**
|
|
4809
4790
|
* Derived mapping: all TomTom POI category numeric IDs to their POICategory name.
|
|
4810
4791
|
*
|
|
4811
4792
|
* @ignore
|
|
4812
4793
|
*/
|
|
4813
|
-
declare const poiIDsToCategories: Record<number, POICategory$1>;
|
|
4794
|
+
export declare const poiIDsToCategories: Record<number, POICategory$1>;
|
|
4814
4795
|
//#endregion
|
|
4815
4796
|
//#region src/util/route.d.ts
|
|
4816
4797
|
/**
|
|
@@ -4866,7 +4847,7 @@ declare const poiIDsToCategories: Record<number, POICategory$1>;
|
|
|
4866
4847
|
*
|
|
4867
4848
|
* @group Utils
|
|
4868
4849
|
*/
|
|
4869
|
-
declare const findBestWaypointInsertionIndex: (route: Route, existingWaypoints: WaypointLike[], newWaypoint: WaypointLike) => number;
|
|
4850
|
+
export declare const findBestWaypointInsertionIndex: (route: Route, existingWaypoints: WaypointLike[], newWaypoint: WaypointLike) => number;
|
|
4870
4851
|
/**
|
|
4871
4852
|
* Multi-waypoint variant of {@link findBestWaypointInsertionIndex}.
|
|
4872
4853
|
*
|
|
@@ -4893,7 +4874,7 @@ declare const findBestWaypointInsertionIndex: (route: Route, existingWaypoints:
|
|
|
4893
4874
|
*
|
|
4894
4875
|
* @group Utils
|
|
4895
4876
|
*/
|
|
4896
|
-
declare const findBestWaypointInsertionIndices: (route: Route, existingWaypoints: WaypointLike[], newWaypoints: WaypointLike[]) => number[];
|
|
4877
|
+
export declare const findBestWaypointInsertionIndices: (route: Route, existingWaypoints: WaypointLike[], newWaypoints: WaypointLike[]) => number[];
|
|
4897
4878
|
/**
|
|
4898
4879
|
* Returns a new array of waypoints with the new waypoint inserted at the optimal position.
|
|
4899
4880
|
*
|
|
@@ -4937,7 +4918,7 @@ declare const findBestWaypointInsertionIndices: (route: Route, existingWaypoints
|
|
|
4937
4918
|
*
|
|
4938
4919
|
* @group Utils
|
|
4939
4920
|
*/
|
|
4940
|
-
declare const withInsertedWaypoint: (route: Route, existingWaypoints: WaypointLike[], newWaypoint: WaypointLike) => WaypointLike[];
|
|
4921
|
+
export declare const withInsertedWaypoint: (route: Route, existingWaypoints: WaypointLike[], newWaypoint: WaypointLike) => WaypointLike[];
|
|
4941
4922
|
/**
|
|
4942
4923
|
* Returns a new array of waypoints with each new waypoint inserted at its optimal position.
|
|
4943
4924
|
*
|
|
@@ -4976,7 +4957,7 @@ declare const withInsertedWaypoint: (route: Route, existingWaypoints: WaypointLi
|
|
|
4976
4957
|
*
|
|
4977
4958
|
* @group Utils
|
|
4978
4959
|
*/
|
|
4979
|
-
declare const withInsertedWaypoints: (route: Route, existingWaypoints: WaypointLike[], newWaypoints: WaypointLike[]) => WaypointLike[];
|
|
4960
|
+
export declare const withInsertedWaypoints: (route: Route, existingWaypoints: WaypointLike[], newWaypoints: WaypointLike[]) => WaypointLike[];
|
|
4980
4961
|
/**
|
|
4981
4962
|
* Interpolates the cumulative traveled distance and time at an arbitrary point on the route path.
|
|
4982
4963
|
*
|
|
@@ -5008,7 +4989,7 @@ declare const withInsertedWaypoints: (route: Route, existingWaypoints: WaypointL
|
|
|
5008
4989
|
*
|
|
5009
4990
|
* @group Utils
|
|
5010
4991
|
*/
|
|
5011
|
-
declare const calculateProgressAtRoutePoint: (route: Route, pathIndex: number) => RouteProgressAtPoint | undefined;
|
|
4992
|
+
export declare const calculateProgressAtRoutePoint: (route: Route, pathIndex: number) => RouteProgressAtPoint | undefined;
|
|
5012
4993
|
/**
|
|
5013
4994
|
* Calculates progress measurements for a segment between two arbitrary points on the route path.
|
|
5014
4995
|
*
|
|
@@ -5034,7 +5015,7 @@ declare const calculateProgressAtRoutePoint: (route: Route, pathIndex: number) =
|
|
|
5034
5015
|
*
|
|
5035
5016
|
* @group Utils
|
|
5036
5017
|
*/
|
|
5037
|
-
declare const getRouteProgressBetween: (route: Route, startPathIndex: number, endPathIndex: number) => RouteSegmentProgress | undefined;
|
|
5018
|
+
export declare const getRouteProgressBetween: (route: Route, startPathIndex: number, endPathIndex: number) => RouteSegmentProgress | undefined;
|
|
5038
5019
|
/**
|
|
5039
5020
|
* Calculates progress measurements for a route section.
|
|
5040
5021
|
*
|
|
@@ -5060,7 +5041,7 @@ declare const getRouteProgressBetween: (route: Route, startPathIndex: number, en
|
|
|
5060
5041
|
*
|
|
5061
5042
|
* @group Utils
|
|
5062
5043
|
*/
|
|
5063
|
-
declare const getRouteProgressForSection: (route: Route, section: SectionProps) => RouteSegmentProgress | undefined;
|
|
5044
|
+
export declare const getRouteProgressForSection: (route: Route, section: SectionProps) => RouteSegmentProgress | undefined;
|
|
5064
5045
|
/**
|
|
5065
5046
|
* Calculates the bounding box for a route section.
|
|
5066
5047
|
*
|
|
@@ -5089,13 +5070,13 @@ declare const getRouteProgressForSection: (route: Route, section: SectionProps)
|
|
|
5089
5070
|
*
|
|
5090
5071
|
* @group Utils
|
|
5091
5072
|
*/
|
|
5092
|
-
declare const getSectionBBox: (route: Route, section: SectionProps) => OptionalBBox;
|
|
5073
|
+
export declare const getSectionBBox: (route: Route, section: SectionProps) => OptionalBBox;
|
|
5093
5074
|
/**
|
|
5094
5075
|
* Geographic coordinate and cumulative progress values at a specific point along a route.
|
|
5095
5076
|
*
|
|
5096
5077
|
* @group Utils
|
|
5097
5078
|
*/
|
|
5098
|
-
type RouteCoordinateAtProgress = {
|
|
5079
|
+
export type RouteCoordinateAtProgress = {
|
|
5099
5080
|
/** Geographic position as a GeoJSON `[longitude, latitude]` coordinate. */
|
|
5100
5081
|
position: Position;
|
|
5101
5082
|
/** Cumulative travel time in seconds from the route start. */
|
|
@@ -5109,7 +5090,7 @@ type RouteCoordinateAtProgress = {
|
|
|
5109
5090
|
*
|
|
5110
5091
|
* @group Utils
|
|
5111
5092
|
*/
|
|
5112
|
-
type RouteProgressQuery = {
|
|
5093
|
+
export type RouteProgressQuery = {
|
|
5113
5094
|
traveledTimeInSeconds: number;
|
|
5114
5095
|
} | {
|
|
5115
5096
|
traveledDistanceInMeters: number;
|
|
@@ -5144,7 +5125,7 @@ type RouteProgressQuery = {
|
|
|
5144
5125
|
*
|
|
5145
5126
|
* @group Utils
|
|
5146
5127
|
*/
|
|
5147
|
-
declare const getCoordinateAtRouteProgress: (route: Route, query: RouteProgressQuery) => RouteCoordinateAtProgress | undefined;
|
|
5128
|
+
export declare const getCoordinateAtRouteProgress: (route: Route, query: RouteProgressQuery) => RouteCoordinateAtProgress | undefined;
|
|
5148
5129
|
/**
|
|
5149
5130
|
* Returns the geographic coordinate and cumulative progress values at the point on a route
|
|
5150
5131
|
* nearest to the given location.
|
|
@@ -5171,55 +5152,9 @@ declare const getCoordinateAtRouteProgress: (route: Route, query: RouteProgressQ
|
|
|
5171
5152
|
*
|
|
5172
5153
|
* @group Utils
|
|
5173
5154
|
*/
|
|
5174
|
-
declare const getProgressAtNearestRoutePoint: (route: Route, point: HasLngLat) => RouteCoordinateAtProgress | undefined;
|
|
5155
|
+
export declare const getProgressAtNearestRoutePoint: (route: Route, point: HasLngLat) => RouteCoordinateAtProgress | undefined;
|
|
5175
5156
|
//#endregion
|
|
5176
5157
|
//#region src/util/routePlanningLocations.d.ts
|
|
5177
|
-
/**
|
|
5178
|
-
* Creates a soft waypoint with a flexible radius for route calculation.
|
|
5179
|
-
*
|
|
5180
|
-
* A soft waypoint allows the routing algorithm to find the optimal path within
|
|
5181
|
-
* a specified radius of the target location, rather than forcing the route to
|
|
5182
|
-
* pass through the exact point. This is useful for:
|
|
5183
|
-
* - Allowing the router to stay on major roads instead of detouring
|
|
5184
|
-
* - Creating more efficient routes when exact location isn't critical
|
|
5185
|
-
* - Simulating "pass near" behavior in route planning
|
|
5186
|
-
*
|
|
5187
|
-
* The resulting waypoint is a GeoJSON Point Feature with a `radiusMeters` property
|
|
5188
|
-
* that the routing service uses to optimize the path.
|
|
5189
|
-
*
|
|
5190
|
-
* @param hasLngLat The location to extract coordinates from. Can be a coordinate array,
|
|
5191
|
-
* Point geometry, or Point Feature.
|
|
5192
|
-
* @param radiusMeters The radius in meters within which the route can pass.
|
|
5193
|
-
* The routing service will find the optimal point within this radius.
|
|
5194
|
-
* @returns A waypoint Feature with the radiusMeters property set.
|
|
5195
|
-
*
|
|
5196
|
-
* @example
|
|
5197
|
-
* ```typescript
|
|
5198
|
-
* // Create a soft waypoint from coordinates
|
|
5199
|
-
* // Route can pass anywhere within 500m of this point
|
|
5200
|
-
* const softWaypoint = asSoftWaypoint([4.9, 52.3], 500);
|
|
5201
|
-
*
|
|
5202
|
-
* // Use in route calculation
|
|
5203
|
-
* const route = await calculateRoute({
|
|
5204
|
-
* key: 'your-api-key',
|
|
5205
|
-
* locations: [
|
|
5206
|
-
* [4.9, 52.3], // Hard waypoint (exact location)
|
|
5207
|
-
* asSoftWaypoint([5.1, 52.5], 1000), // Soft waypoint (within 1km)
|
|
5208
|
-
* [5.3, 52.7] // Hard waypoint (exact location)
|
|
5209
|
-
* ]
|
|
5210
|
-
* });
|
|
5211
|
-
*
|
|
5212
|
-
* // Create soft waypoint from a Place Feature
|
|
5213
|
-
* const place = await geocode({ key: 'your-api-key', query: 'Amsterdam' });
|
|
5214
|
-
* const softPlace = asSoftWaypoint(place, 2000);
|
|
5215
|
-
* // Route will pass within 2km of Amsterdam center
|
|
5216
|
-
* ```
|
|
5217
|
-
*
|
|
5218
|
-
* @see [Locations Guide](https://docs.tomtom.com/maps-sdk-js/guides/services/routing/locations)
|
|
5219
|
-
*
|
|
5220
|
-
* @group Route
|
|
5221
|
-
*/
|
|
5222
|
-
declare const asSoftWaypoint: (hasLngLat: HasLngLat, radiusMeters: number) => Waypoint;
|
|
5223
5158
|
/**
|
|
5224
5159
|
* Determines the type of geographic input (waypoint or path).
|
|
5225
5160
|
*
|
|
@@ -5232,13 +5167,13 @@ declare const asSoftWaypoint: (hasLngLat: HasLngLat, radiusMeters: number) => Wa
|
|
|
5232
5167
|
*
|
|
5233
5168
|
* @ignore
|
|
5234
5169
|
*/
|
|
5235
|
-
declare const getRoutePlanningLocationType: (routePlanningLocation: RoutePlanningLocation) => RoutePlanningLocationType;
|
|
5170
|
+
export declare const getRoutePlanningLocationType: (routePlanningLocation: RoutePlanningLocation) => RoutePlanningLocationType;
|
|
5236
5171
|
//#endregion
|
|
5237
5172
|
//#region src/util/traffic.d.ts
|
|
5238
5173
|
/**
|
|
5239
5174
|
* @ignore
|
|
5240
5175
|
*/
|
|
5241
|
-
declare const indexedMagnitudes: DelayMagnitude[];
|
|
5176
|
+
export declare const indexedMagnitudes: DelayMagnitude[];
|
|
5242
5177
|
/**
|
|
5243
5178
|
* Maps an `iconCategory` integer from the Incident Details API to a {@link TrafficIncidentCategory}.
|
|
5244
5179
|
* Integer values that do not correspond to a known category are mapped to `'other'`.
|
|
@@ -5248,7 +5183,7 @@ declare const indexedMagnitudes: DelayMagnitude[];
|
|
|
5248
5183
|
*
|
|
5249
5184
|
* @ignore
|
|
5250
5185
|
*/
|
|
5251
|
-
declare const iconToTrafficIncidentCategory: (iconCategory: number) => TrafficIncidentCategory;
|
|
5186
|
+
export declare const iconToTrafficIncidentCategory: (iconCategory: number) => TrafficIncidentCategory;
|
|
5252
5187
|
/**
|
|
5253
5188
|
* Maps a {@link TrafficIncidentCategory} string to the `iconCategory` integer used by the API.
|
|
5254
5189
|
* `'other'` and any unrecognised values map to `0`.
|
|
@@ -5258,7 +5193,7 @@ declare const iconToTrafficIncidentCategory: (iconCategory: number) => TrafficIn
|
|
|
5258
5193
|
*
|
|
5259
5194
|
* @ignore
|
|
5260
5195
|
*/
|
|
5261
|
-
declare const trafficIncidentToIconCategory: (category: TrafficIncidentCategory) => number;
|
|
5196
|
+
export declare const trafficIncidentToIconCategory: (category: TrafficIncidentCategory) => number;
|
|
5262
5197
|
//#endregion
|
|
5263
5198
|
//#region src/util/unitFormatters.d.ts
|
|
5264
5199
|
/**
|
|
@@ -5314,7 +5249,7 @@ declare const trafficIncidentToIconCategory: (category: TrafficIncidentCategory)
|
|
|
5314
5249
|
*
|
|
5315
5250
|
* @group Utils
|
|
5316
5251
|
*/
|
|
5317
|
-
declare const formatDuration: (seconds: number | undefined, options?: TimeDisplayUnits) => string | undefined;
|
|
5252
|
+
export declare const formatDuration: (seconds: number | undefined, options?: TimeDisplayUnits) => string | undefined;
|
|
5318
5253
|
/**
|
|
5319
5254
|
* Distance unit system types supported by the SDK formatters.
|
|
5320
5255
|
*
|
|
@@ -5355,7 +5290,7 @@ declare const formatDuration: (seconds: number | undefined, options?: TimeDispla
|
|
|
5355
5290
|
*
|
|
5356
5291
|
* @group Utils
|
|
5357
5292
|
*/
|
|
5358
|
-
type DistanceUnitsType = 'metric' | 'imperial_us' | 'imperial_uk';
|
|
5293
|
+
export type DistanceUnitsType = 'metric' | 'imperial_us' | 'imperial_uk';
|
|
5359
5294
|
/**
|
|
5360
5295
|
* Formatting is based on the number of meters passed and unit type. Less meters more precision.
|
|
5361
5296
|
* @example
|
|
@@ -5385,7 +5320,7 @@ type DistanceUnitsType = 'metric' | 'imperial_us' | 'imperial_uk';
|
|
|
5385
5320
|
* @param options Options for the display units, including their type and custom ways to display them.
|
|
5386
5321
|
* @group Utils
|
|
5387
5322
|
*/
|
|
5388
|
-
declare const formatDistance: (meters: number, options?: DistanceDisplayUnits) => string;
|
|
5323
|
+
export declare const formatDistance: (meters: number, options?: DistanceDisplayUnits) => string;
|
|
5389
5324
|
//#endregion
|
|
5390
5325
|
//#region src/config/globalConfig.d.ts
|
|
5391
5326
|
/**
|
|
@@ -5396,7 +5331,7 @@ declare const formatDistance: (meters: number, options?: DistanceDisplayUnits) =
|
|
|
5396
5331
|
*
|
|
5397
5332
|
* @group Configuration
|
|
5398
5333
|
*/
|
|
5399
|
-
type DistanceDisplayUnits = {
|
|
5334
|
+
export type DistanceDisplayUnits = {
|
|
5400
5335
|
/**
|
|
5401
5336
|
* Type of distance unit system.
|
|
5402
5337
|
*
|
|
@@ -5443,7 +5378,7 @@ type DistanceDisplayUnits = {
|
|
|
5443
5378
|
*
|
|
5444
5379
|
* @group Configuration
|
|
5445
5380
|
*/
|
|
5446
|
-
type TimeDisplayUnits = {
|
|
5381
|
+
export type TimeDisplayUnits = {
|
|
5447
5382
|
/**
|
|
5448
5383
|
* Custom label for hour units.
|
|
5449
5384
|
*
|
|
@@ -5465,7 +5400,7 @@ type TimeDisplayUnits = {
|
|
|
5465
5400
|
*
|
|
5466
5401
|
* @group Configuration
|
|
5467
5402
|
*/
|
|
5468
|
-
type DisplayUnits = {
|
|
5403
|
+
export type DisplayUnits = {
|
|
5469
5404
|
/**
|
|
5470
5405
|
* Distance unit configuration.
|
|
5471
5406
|
*
|
|
@@ -5499,7 +5434,7 @@ type DisplayUnits = {
|
|
|
5499
5434
|
*
|
|
5500
5435
|
* @group Configuration
|
|
5501
5436
|
*/
|
|
5502
|
-
type RetryConfig = {
|
|
5437
|
+
export type RetryConfig = {
|
|
5503
5438
|
/**
|
|
5504
5439
|
* Initial wait time in milliseconds before the first retry.
|
|
5505
5440
|
*
|
|
@@ -5553,7 +5488,7 @@ type RetryConfig = {
|
|
|
5553
5488
|
*
|
|
5554
5489
|
* @group Configuration
|
|
5555
5490
|
*/
|
|
5556
|
-
type GlobalConfig = {
|
|
5491
|
+
export type GlobalConfig = {
|
|
5557
5492
|
/**
|
|
5558
5493
|
* TomTom API key for authentication.
|
|
5559
5494
|
*
|
|
@@ -5634,7 +5569,7 @@ type GlobalConfig = {
|
|
|
5634
5569
|
*
|
|
5635
5570
|
* @group Configuration
|
|
5636
5571
|
*/
|
|
5637
|
-
declare const DEFAULT_COMMON_BASE_URL = "https://api.tomtom.com";
|
|
5572
|
+
export declare const DEFAULT_COMMON_BASE_URL = "https://api.tomtom.com";
|
|
5638
5573
|
/**
|
|
5639
5574
|
* Default global configuration values.
|
|
5640
5575
|
*
|
|
@@ -5643,7 +5578,7 @@ declare const DEFAULT_COMMON_BASE_URL = "https://api.tomtom.com";
|
|
|
5643
5578
|
*
|
|
5644
5579
|
* @group Configuration
|
|
5645
5580
|
*/
|
|
5646
|
-
declare const defaultConfig: GlobalConfig;
|
|
5581
|
+
export declare const defaultConfig: GlobalConfig;
|
|
5647
5582
|
/**
|
|
5648
5583
|
* Global configuration singleton for the TomTom Maps SDK.
|
|
5649
5584
|
*
|
|
@@ -5671,7 +5606,7 @@ declare const defaultConfig: GlobalConfig;
|
|
|
5671
5606
|
*
|
|
5672
5607
|
* @group Configuration
|
|
5673
5608
|
*/
|
|
5674
|
-
declare class TomTomConfig {
|
|
5609
|
+
export declare class TomTomConfig {
|
|
5675
5610
|
/**
|
|
5676
5611
|
* Singleton instance of the configuration.
|
|
5677
5612
|
*/
|
|
@@ -5724,7 +5659,7 @@ declare class TomTomConfig {
|
|
|
5724
5659
|
* Merges the global configuration into the given one, with the latter having priority.
|
|
5725
5660
|
* @ignore
|
|
5726
5661
|
*/
|
|
5727
|
-
declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenConfig?: T) => GlobalConfig & T;
|
|
5662
|
+
export declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenConfig?: T) => GlobalConfig & T;
|
|
5728
5663
|
/**
|
|
5729
5664
|
* Whether the SDK is configured for a credentials proxy such as the demos proxy
|
|
5730
5665
|
* — no `apiKey` (the
|
|
@@ -5748,6 +5683,6 @@ declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenConfig?: T
|
|
|
5748
5683
|
* @param config - Config to inspect; defaults to the global {@link TomTomConfig}.
|
|
5749
5684
|
* @group Configuration
|
|
5750
5685
|
*/
|
|
5751
|
-
declare const isProxyCredentialsMode: (config?: Partial<Pick<GlobalConfig, "apiKey" | "commonBaseURL">>) => boolean;
|
|
5686
|
+
export declare const isProxyCredentialsMode: (config?: Partial<Pick<GlobalConfig, "apiKey" | "commonBaseURL">>) => boolean;
|
|
5752
5687
|
//#endregion
|
|
5753
|
-
export {
|
|
5688
|
+
export type { Anything, BBox, ChargingAvailabilityDataSource, ChargingPark, ChargingParkWithAvailability, ChargingPointAvailability, ChargingStationsAvailability, CombustionSummary, ConnectorAvailability, ConnectorCount, DrivingSide, EVChargingStationWithAvailabilityPlaceProps, ElectricSummary, FeatureCollectionWithProperties, Fuel, GeometryDataSource, GetPositionEntryPointOption, GetPositionOptions, Guidance, HasBBox, HasConnector, HasCount, HasLngLat, Instruction, Landmark, Language, LegSummary, Maneuver, Moment, OpeningHours, OpeningHoursMode, OptionalBBox, POI, PathLike, PlaceDataSources, PoiDetailsDataSource, PolygonFeature, PolygonFeatures, RelatedPOI, RoadInformation, RoadInformationProperty, RoadShield, RoadShieldReference, RoutePathPoint, RoutePlanningLocation, RoutePlanningLocationType, RouteSummary, SideRoad, SideRoadSide, Signpost, SummaryBase, SummaryWithConsumption, TextWithPhonetics, TimeRange, TimeZone, TollPaymentType, TomTomAPIHeaders, TomTomHeaders, Waypoint, WaypointLike, WaypointProps, Waypoints, languages };
|