From 9a26cd8b8336d57306544d086d5a8f875b178741 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 11 Jan 2024 19:24:02 +0000 Subject: [PATCH] Deploy to GitHub pages --- .nojekyll | 0 404.html | 16 +++++ assets/css/styles.1724d6e7.css | 1 + assets/js/06aa6e93.e3ab1d1f.js | 1 + assets/js/08932d0c.41ecc58a.js | 1 + assets/js/1291376a.47701dfe.js | 1 + assets/js/1745c884.31ca9265.js | 1 + assets/js/176abf51.20663a38.js | 1 + assets/js/17896441.01530e94.js | 1 + assets/js/1b3415a5.5a55eebb.js | 1 + assets/js/1be78505.5e726ffb.js | 1 + assets/js/1cd93e92.e54ec8a4.js | 1 + assets/js/1df93b7f.f73b5933.js | 1 + assets/js/1f391b9e.c498ac94.js | 1 + assets/js/23817249.2b67b94e.js | 1 + assets/js/2666.ce488b35.js | 1 + assets/js/27302741.23bac3b0.js | 1 + assets/js/2fbe5889.a6fde2fd.js | 1 + assets/js/31c5dceb.27072439.js | 1 + assets/js/35a07047.b08de4a7.js | 1 + assets/js/360d8d70.3410e1f1.js | 1 + assets/js/393be207.9fbb9d65.js | 1 + assets/js/3ebc895b.1f1b94eb.js | 1 + assets/js/4105c75d.a91d4a6a.js | 1 + assets/js/43063e81.8d1a3974.js | 1 + assets/js/45d0475c.30a21dfa.js | 1 + assets/js/481e471a.726e49b0.js | 1 + assets/js/484329c4.102fb0cd.js | 1 + assets/js/4972.9fc7005b.js | 1 + assets/js/4aa12286.b5f66a60.js | 1 + assets/js/4ae4fd96.ec60fc41.js | 1 + assets/js/5b8d0eef.bf78469c.js | 1 + assets/js/5ceb730d.364ede46.js | 1 + assets/js/5e5ac311.a22b72ee.js | 1 + assets/js/5e8c322a.55775b71.js | 1 + assets/js/5ffeac76.c3005cc5.js | 1 + assets/js/60784167.b1cb172b.js | 1 + assets/js/629bdd40.7e90bfdd.js | 1 + assets/js/6b9ea5a6.b5a80d15.js | 1 + assets/js/6ef32316.a297b114.js | 1 + assets/js/6ffa1466.8c205006.js | 1 + assets/js/705151d0.0b912d8e.js | 1 + assets/js/7a832ccb.67f95331.js | 1 + assets/js/84af600f.1020d227.js | 1 + assets/js/855fb381.8c218cb5.js | 1 + assets/js/88cbaf7a.5df204b2.js | 1 + assets/js/8f93cbcd.615cc490.js | 1 + assets/js/8fc6b66b.31d71cf9.js | 1 + assets/js/935f2afb.6170d225.js | 1 + assets/js/94bca0b8.da649158.js | 1 + assets/js/9ae98e8e.84b27e6a.js | 1 + assets/js/9e00c705.62314703.js | 1 + assets/js/9e3cb6c3.49ec0a48.js | 1 + assets/js/a063e0e3.4c88e1cc.js | 1 + assets/js/a557ae41.12866256.js | 1 + assets/js/aa082b57.519bb473.js | 1 + assets/js/acc2462d.9d970edb.js | 1 + assets/js/b009f941.3423c09d.js | 1 + assets/js/b45c6e46.e5ecd680.js | 1 + assets/js/b4f090cd.61d7a88c.js | 1 + assets/js/b567fbc2.889188ad.js | 1 + assets/js/b5c59fa7.efc789c1.js | 1 + assets/js/bc512349.1db77f72.js | 1 + assets/js/c1888b50.bd558eb1.js | 1 + assets/js/c7a53f27.453117d5.js | 1 + assets/js/cb9481a5.d3c8ed64.js | 1 + assets/js/d08d5db0.9bc72761.js | 1 + assets/js/d17d046f.6cd65e6a.js | 1 + assets/js/d1df3a82.d57692bb.js | 1 + assets/js/d829a3a8.f55ffe4f.js | 1 + assets/js/da631d65.afcd01b7.js | 1 + assets/js/dd4f9bad.62095289.js | 1 + assets/js/dd6706b8.2ce48e5c.js | 1 + assets/js/e33a542e.a0c64b08.js | 1 + assets/js/e356c530.7fc81d28.js | 1 + assets/js/e4e8843d.9a39db58.js | 1 + assets/js/e69ab7fa.3303323d.js | 1 + assets/js/e6bf94c2.f8f565f8.js | 1 + assets/js/ea776caf.0adea3b3.js | 1 + assets/js/ebfbfacf.f056dca4.js | 1 + assets/js/eca7e322.e29f95f5.js | 1 + assets/js/eff1c6c7.1faf84b4.js | 1 + assets/js/f6aebfbf.9650982f.js | 1 + assets/js/faa0839e.93935c9e.js | 1 + assets/js/fc4d9247.f9c3605e.js | 1 + assets/js/fd3e4606.7d6fa593.js | 1 + assets/js/ff78c6e0.03da1022.js | 1 + assets/js/ffa310cd.bcb9ea08.js | 1 + assets/js/main.e8b73010.js | 2 + assets/js/main.e8b73010.js.LICENSE.txt | 53 +++++++++++++++ assets/js/runtime~main.f9709a1b.js | 1 + docs/api.html | 18 +++++ docs/api/classes/core.Client.html | 18 +++++ docs/api/classes/core.Direction.html | 16 +++++ docs/api/classes/core.Directions.html | 16 +++++ docs/api/classes/core.Isochrone.html | 16 +++++ docs/api/classes/core.Isochrones.html | 16 +++++ docs/api/classes/core.Matrix.html | 16 +++++ docs/api/classes/core.RoutingJSAPIError.html | 17 +++++ docs/api/classes/graphhopper.GraphHopper.html | 17 +++++ docs/api/classes/ors.ORS.html | 16 +++++ docs/api/classes/osrm.OSRM.html | 16 +++++ docs/api/classes/valhalla.Valhalla.html | 16 +++++ docs/api/interfaces/core.BaseRouter.html | 16 +++++ .../core.ClientConstructorArgs.html | 17 +++++ docs/api/interfaces/core.ErrorProps.html | 17 +++++ docs/api/interfaces/core.JSONObject.html | 16 +++++ .../graphhopper.GraphHopperErrorProps.html | 18 +++++ .../graphhopper.GraphHopperIsochroneOpts.html | 18 +++++ ...raphhopper.GraphHopperIsochroneParams.html | 18 +++++ ...phhopper.GraphHopperIsochroneResponse.html | 16 +++++ .../graphhopper.GraphHopperMatrixOpts.html | 35 ++++++++++ .../graphhopper.GraphHopperMatrixParams.html | 37 ++++++++++ ...graphhopper.GraphHopperMatrixResponse.html | 22 ++++++ .../graphhopper.GraphHopperRouteParams.html | 49 ++++++++++++++ .../graphhopper.GraphHopperRoutePath.html | 22 ++++++ .../graphhopper.GraphHopperRouteResponse.html | 16 +++++ .../ors.ORSAlternateRouteParam.html | 16 +++++ docs/api/interfaces/ors.ORSErrorProps.html | 19 ++++++ .../interfaces/ors.ORSIsochroneParams.html | 19 ++++++ .../interfaces/ors.ORSIsochroneResponse.html | 16 +++++ docs/api/interfaces/ors.ORSMatrixParams.html | 22 ++++++ .../api/interfaces/ors.ORSMatrixResponse.html | 16 +++++ docs/api/interfaces/ors.ORSRoute.html | 16 +++++ docs/api/interfaces/ors.ORSRouteParams.html | 25 +++++++ docs/api/interfaces/ors.ORSRouteResponse.html | 16 +++++ .../interfaces/osrm.OSRMDirectionsOpts.html | 19 ++++++ docs/api/interfaces/osrm.OSRMErrorProps.html | 18 +++++ .../interfaces/osrm.OSRMGeometryObject.html | 16 +++++ docs/api/interfaces/osrm.OSRMMatrixOpts.html | 19 ++++++ docs/api/interfaces/osrm.OSRMRoute.html | 17 +++++ docs/api/interfaces/osrm.OSRMRouteParams.html | 21 ++++++ .../interfaces/osrm.OSRMRouteResponse.html | 17 +++++ docs/api/interfaces/osrm.OSRMTableParams.html | 19 ++++++ .../interfaces/osrm.OSRMTableResponse.html | 18 +++++ .../interfaces/valhalla.MapboxAuthParams.html | 16 +++++ .../interfaces/valhalla.ValhallaContours.html | 18 +++++ .../valhalla.ValhallaCostingOptsAuto.html | 52 +++++++++++++++ .../valhalla.ValhallaCostingOptsBicycle.html | 51 ++++++++++++++ ...alhalla.ValhallaCostingOptsMotorcycle.html | 54 +++++++++++++++ ...alhalla.ValhallaCostingOptsPedestrian.html | 39 +++++++++++ .../valhalla.ValhallaCostingOptsTruck.html | 52 +++++++++++++++ .../interfaces/valhalla.ValhallaDateTime.html | 16 +++++ .../valhalla.ValhallaDirectionOpts.html | 34 ++++++++++ .../valhalla.ValhallaErrorProps.html | 18 +++++ .../valhalla.ValhallaIsochroneOpts.html | 32 +++++++++ .../valhalla.ValhallaIsochroneParams.html | 35 ++++++++++ .../valhalla.ValhallaIsochroneResponse.html | 22 ++++++ docs/api/interfaces/valhalla.ValhallaLeg.html | 16 +++++ .../interfaces/valhalla.ValhallaLocation.html | 63 ++++++++++++++++++ .../valhalla.ValhallaManeuvers.html | 22 ++++++ .../valhalla.ValhallaMatrixOpts.html | 26 ++++++++ .../valhalla.ValhallaMatrixParams.html | 26 ++++++++ .../valhalla.ValhallaMatrixResponse.html | 16 +++++ .../valhalla.ValhallaRouteParams.html | 35 ++++++++++ .../valhalla.ValhallaRouteResponse.html | 18 +++++ .../valhalla.ValhallaTraceRouteOpts.html | 33 +++++++++ .../valhalla.ValhallaTraceRouteParams.html | 34 ++++++++++ .../api/interfaces/valhalla.ValhallaTrip.html | 20 ++++++ docs/api/modules.html | 16 +++++ docs/api/modules/core.html | 16 +++++ docs/api/modules/graphhopper.html | 19 ++++++ docs/api/modules/ors.html | 16 +++++ docs/api/modules/osrm.html | 16 +++++ docs/api/modules/valhalla.html | 18 +++++ docs/quickstart.html | 16 +++++ img/braces.svg | 7 ++ img/docusaurus.png | Bin 0 -> 5142 bytes img/settings-off.svg | 8 +++ img/switch-3.svg | 9 +++ index.html | 16 +++++ markdown-page.html | 16 +++++ sitemap.xml | 1 + 173 files changed, 1924 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 assets/css/styles.1724d6e7.css create mode 100644 assets/js/06aa6e93.e3ab1d1f.js create mode 100644 assets/js/08932d0c.41ecc58a.js create mode 100644 assets/js/1291376a.47701dfe.js create mode 100644 assets/js/1745c884.31ca9265.js create mode 100644 assets/js/176abf51.20663a38.js create mode 100644 assets/js/17896441.01530e94.js create mode 100644 assets/js/1b3415a5.5a55eebb.js create mode 100644 assets/js/1be78505.5e726ffb.js create mode 100644 assets/js/1cd93e92.e54ec8a4.js create mode 100644 assets/js/1df93b7f.f73b5933.js create mode 100644 assets/js/1f391b9e.c498ac94.js create mode 100644 assets/js/23817249.2b67b94e.js create mode 100644 assets/js/2666.ce488b35.js create mode 100644 assets/js/27302741.23bac3b0.js create mode 100644 assets/js/2fbe5889.a6fde2fd.js create mode 100644 assets/js/31c5dceb.27072439.js create mode 100644 assets/js/35a07047.b08de4a7.js create mode 100644 assets/js/360d8d70.3410e1f1.js create mode 100644 assets/js/393be207.9fbb9d65.js create mode 100644 assets/js/3ebc895b.1f1b94eb.js create mode 100644 assets/js/4105c75d.a91d4a6a.js create mode 100644 assets/js/43063e81.8d1a3974.js create mode 100644 assets/js/45d0475c.30a21dfa.js create mode 100644 assets/js/481e471a.726e49b0.js create mode 100644 assets/js/484329c4.102fb0cd.js create mode 100644 assets/js/4972.9fc7005b.js create mode 100644 assets/js/4aa12286.b5f66a60.js create mode 100644 assets/js/4ae4fd96.ec60fc41.js create mode 100644 assets/js/5b8d0eef.bf78469c.js create mode 100644 assets/js/5ceb730d.364ede46.js create mode 100644 assets/js/5e5ac311.a22b72ee.js create mode 100644 assets/js/5e8c322a.55775b71.js create mode 100644 assets/js/5ffeac76.c3005cc5.js create mode 100644 assets/js/60784167.b1cb172b.js create mode 100644 assets/js/629bdd40.7e90bfdd.js create mode 100644 assets/js/6b9ea5a6.b5a80d15.js create mode 100644 assets/js/6ef32316.a297b114.js create mode 100644 assets/js/6ffa1466.8c205006.js create mode 100644 assets/js/705151d0.0b912d8e.js create mode 100644 assets/js/7a832ccb.67f95331.js create mode 100644 assets/js/84af600f.1020d227.js create mode 100644 assets/js/855fb381.8c218cb5.js create mode 100644 assets/js/88cbaf7a.5df204b2.js create mode 100644 assets/js/8f93cbcd.615cc490.js create mode 100644 assets/js/8fc6b66b.31d71cf9.js create mode 100644 assets/js/935f2afb.6170d225.js create mode 100644 assets/js/94bca0b8.da649158.js create mode 100644 assets/js/9ae98e8e.84b27e6a.js create mode 100644 assets/js/9e00c705.62314703.js create mode 100644 assets/js/9e3cb6c3.49ec0a48.js create mode 100644 assets/js/a063e0e3.4c88e1cc.js create mode 100644 assets/js/a557ae41.12866256.js create mode 100644 assets/js/aa082b57.519bb473.js create mode 100644 assets/js/acc2462d.9d970edb.js create mode 100644 assets/js/b009f941.3423c09d.js create mode 100644 assets/js/b45c6e46.e5ecd680.js create mode 100644 assets/js/b4f090cd.61d7a88c.js create mode 100644 assets/js/b567fbc2.889188ad.js create mode 100644 assets/js/b5c59fa7.efc789c1.js create mode 100644 assets/js/bc512349.1db77f72.js create mode 100644 assets/js/c1888b50.bd558eb1.js create mode 100644 assets/js/c7a53f27.453117d5.js create mode 100644 assets/js/cb9481a5.d3c8ed64.js create mode 100644 assets/js/d08d5db0.9bc72761.js create mode 100644 assets/js/d17d046f.6cd65e6a.js create mode 100644 assets/js/d1df3a82.d57692bb.js create mode 100644 assets/js/d829a3a8.f55ffe4f.js create mode 100644 assets/js/da631d65.afcd01b7.js create mode 100644 assets/js/dd4f9bad.62095289.js create mode 100644 assets/js/dd6706b8.2ce48e5c.js create mode 100644 assets/js/e33a542e.a0c64b08.js create mode 100644 assets/js/e356c530.7fc81d28.js create mode 100644 assets/js/e4e8843d.9a39db58.js create mode 100644 assets/js/e69ab7fa.3303323d.js create mode 100644 assets/js/e6bf94c2.f8f565f8.js create mode 100644 assets/js/ea776caf.0adea3b3.js create mode 100644 assets/js/ebfbfacf.f056dca4.js create mode 100644 assets/js/eca7e322.e29f95f5.js create mode 100644 assets/js/eff1c6c7.1faf84b4.js create mode 100644 assets/js/f6aebfbf.9650982f.js create mode 100644 assets/js/faa0839e.93935c9e.js create mode 100644 assets/js/fc4d9247.f9c3605e.js create mode 100644 assets/js/fd3e4606.7d6fa593.js create mode 100644 assets/js/ff78c6e0.03da1022.js create mode 100644 assets/js/ffa310cd.bcb9ea08.js create mode 100644 assets/js/main.e8b73010.js create mode 100644 assets/js/main.e8b73010.js.LICENSE.txt create mode 100644 assets/js/runtime~main.f9709a1b.js create mode 100644 docs/api.html create mode 100644 docs/api/classes/core.Client.html create mode 100644 docs/api/classes/core.Direction.html create mode 100644 docs/api/classes/core.Directions.html create mode 100644 docs/api/classes/core.Isochrone.html create mode 100644 docs/api/classes/core.Isochrones.html create mode 100644 docs/api/classes/core.Matrix.html create mode 100644 docs/api/classes/core.RoutingJSAPIError.html create mode 100644 docs/api/classes/graphhopper.GraphHopper.html create mode 100644 docs/api/classes/ors.ORS.html create mode 100644 docs/api/classes/osrm.OSRM.html create mode 100644 docs/api/classes/valhalla.Valhalla.html create mode 100644 docs/api/interfaces/core.BaseRouter.html create mode 100644 docs/api/interfaces/core.ClientConstructorArgs.html create mode 100644 docs/api/interfaces/core.ErrorProps.html create mode 100644 docs/api/interfaces/core.JSONObject.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperErrorProps.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperIsochroneParams.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperMatrixOpts.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperMatrixParams.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperMatrixResponse.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperRouteParams.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperRoutePath.html create mode 100644 docs/api/interfaces/graphhopper.GraphHopperRouteResponse.html create mode 100644 docs/api/interfaces/ors.ORSAlternateRouteParam.html create mode 100644 docs/api/interfaces/ors.ORSErrorProps.html create mode 100644 docs/api/interfaces/ors.ORSIsochroneParams.html create mode 100644 docs/api/interfaces/ors.ORSIsochroneResponse.html create mode 100644 docs/api/interfaces/ors.ORSMatrixParams.html create mode 100644 docs/api/interfaces/ors.ORSMatrixResponse.html create mode 100644 docs/api/interfaces/ors.ORSRoute.html create mode 100644 docs/api/interfaces/ors.ORSRouteParams.html create mode 100644 docs/api/interfaces/ors.ORSRouteResponse.html create mode 100644 docs/api/interfaces/osrm.OSRMDirectionsOpts.html create mode 100644 docs/api/interfaces/osrm.OSRMErrorProps.html create mode 100644 docs/api/interfaces/osrm.OSRMGeometryObject.html create mode 100644 docs/api/interfaces/osrm.OSRMMatrixOpts.html create mode 100644 docs/api/interfaces/osrm.OSRMRoute.html create mode 100644 docs/api/interfaces/osrm.OSRMRouteParams.html create mode 100644 docs/api/interfaces/osrm.OSRMRouteResponse.html create mode 100644 docs/api/interfaces/osrm.OSRMTableParams.html create mode 100644 docs/api/interfaces/osrm.OSRMTableResponse.html create mode 100644 docs/api/interfaces/valhalla.MapboxAuthParams.html create mode 100644 docs/api/interfaces/valhalla.ValhallaContours.html create mode 100644 docs/api/interfaces/valhalla.ValhallaCostingOptsAuto.html create mode 100644 docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle.html create mode 100644 docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle.html create mode 100644 docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian.html create mode 100644 docs/api/interfaces/valhalla.ValhallaCostingOptsTruck.html create mode 100644 docs/api/interfaces/valhalla.ValhallaDateTime.html create mode 100644 docs/api/interfaces/valhalla.ValhallaDirectionOpts.html create mode 100644 docs/api/interfaces/valhalla.ValhallaErrorProps.html create mode 100644 docs/api/interfaces/valhalla.ValhallaIsochroneOpts.html create mode 100644 docs/api/interfaces/valhalla.ValhallaIsochroneParams.html create mode 100644 docs/api/interfaces/valhalla.ValhallaIsochroneResponse.html create mode 100644 docs/api/interfaces/valhalla.ValhallaLeg.html create mode 100644 docs/api/interfaces/valhalla.ValhallaLocation.html create mode 100644 docs/api/interfaces/valhalla.ValhallaManeuvers.html create mode 100644 docs/api/interfaces/valhalla.ValhallaMatrixOpts.html create mode 100644 docs/api/interfaces/valhalla.ValhallaMatrixParams.html create mode 100644 docs/api/interfaces/valhalla.ValhallaMatrixResponse.html create mode 100644 docs/api/interfaces/valhalla.ValhallaRouteParams.html create mode 100644 docs/api/interfaces/valhalla.ValhallaRouteResponse.html create mode 100644 docs/api/interfaces/valhalla.ValhallaTraceRouteOpts.html create mode 100644 docs/api/interfaces/valhalla.ValhallaTraceRouteParams.html create mode 100644 docs/api/interfaces/valhalla.ValhallaTrip.html create mode 100644 docs/api/modules.html create mode 100644 docs/api/modules/core.html create mode 100644 docs/api/modules/graphhopper.html create mode 100644 docs/api/modules/ors.html create mode 100644 docs/api/modules/osrm.html create mode 100644 docs/api/modules/valhalla.html create mode 100644 docs/quickstart.html create mode 100644 img/braces.svg create mode 100644 img/docusaurus.png create mode 100644 img/settings-off.svg create mode 100644 img/switch-3.svg create mode 100644 index.html create mode 100644 markdown-page.html create mode 100644 sitemap.xml diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..7d4c6af --- /dev/null +++ b/404.html @@ -0,0 +1,16 @@ + + + + + +Page Not Found | RoutingJS Documentation + + + + +
+
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

+ + + + \ No newline at end of file diff --git a/assets/css/styles.1724d6e7.css b/assets/css/styles.1724d6e7.css new file mode 100644 index 0000000..b5e4ba1 --- /dev/null +++ b/assets/css/styles.1724d6e7.css @@ -0,0 +1 @@ +.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--ifm-color-primary:#852e7e;--ifm-color-primary-dark:#29784c;--ifm-color-primary-darker:#277148;--ifm-color-primary-darkest:#205d3b;--ifm-color-primary-light:#33925d;--ifm-color-primary-lighter:#a64aa6;--ifm-color-primary-lightest:#3cad6e;--ifm-code-font-size:95%;--docusaurus-highlighted-code-line-bg:#0000001a;--docusaurus-announcement-bar-height:auto;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}*{box-sizing:border-box}html{-webkit-font-smoothing:antialiased;-webkit-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area.breadcrumbs__link[href]:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_S0QG>:last-child,.collapsibleContent_i85q>:last-child,.footer__items{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;filter:var(--ifm-menu-link-sublist-icon-filter);content:""}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.docsWrapper_BCFX,.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;position:fixed;transition-timing-function:ease-in-out;left:0;top:0;visibility:hidden}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);transform:translate3d(-100%,0,0);transition-duration:.25s;transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;right:0;transition-duration:.1s;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}[data-theme=dark]{--ifm-color-primary:#25c2a0;--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#29d5b0;--ifm-color-primary-lighter:#32d8b4;--ifm-color-primary-lightest:#4fddbf;--docusaurus-highlighted-code-line-bg:#0000004d}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#docusaurus-base-url-issue-banner-container,.collapseSidebarButton_PEFL,.docSidebarContainer_b6E3,.sidebarLogo_isFc,.themedImage_ToTc,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA{display:initial}.iconExternalLink_nPIU{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.mainWrapper_z2l0{flex:1 0 auto}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.buttons_AeoN,.features_t9lD{align-items:center;display:flex}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.features_t9lD{padding:2rem 0;width:100%}.featureSvg_GfXr{height:65px;width:65px}.smallprint_z2jB{display:flex;font-size:.85em;justify-content:center}.heroBanner_qdFl{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_AeoN{justify-content:center}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity .2s ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:.15s;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.img_ev3q{height:auto}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionHeading_tbUL code{text-transform:none}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.breadcrumbHomeIcon_OVgt{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.mdxPageWrapper_j9I6{justify-content:center}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg);position:sticky}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_vwxv{text-align:right}.tocMobile_ITEo{display:none}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;max-height:100vh;padding-top:var(--ifm-navbar-height);position:sticky;top:0;transition:opacity 50ms;width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{height:0;opacity:0;overflow:hidden;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;max-height:100vh;top:0;transition:background-color var(--ifm-transition-fast) ease}[dir=rtl] .expandButtonIcon_BlDH{transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.docItemCol_VOVn{max-width:75%!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media screen and (max-width:996px){.heroBanner_qdFl{padding:2rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/06aa6e93.e3ab1d1f.js b/assets/js/06aa6e93.e3ab1d1f.js new file mode 100644 index 0000000..d962886 --- /dev/null +++ b/assets/js/06aa6e93.e3ab1d1f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[691],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=p(n),k=a,f=m["".concat(l,".").concat(k)]||m[k]||u[k]||i;return n?r.createElement(f,o(o({ref:t},d),{},{components:n})):r.createElement(f,o({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={id:"osrm.OSRMRouteParams",title:"Interface: OSRMRouteParams",sidebar_label:"OSRMRouteParams",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/osrm.OSRMRouteParams",id:"api/interfaces/osrm.OSRMRouteParams",title:"Interface: OSRMRouteParams",description:"osrm.OSRMRouteParams",source:"@site/docs/api/interfaces/osrm.OSRMRouteParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMRouteParams",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMRouteParams",title:"Interface: OSRMRouteParams",sidebar_label:"OSRMRouteParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMRoute",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRoute"},next:{title:"OSRMRouteResponse",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alternatives",id:"alternatives",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"annotations",id:"annotations",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"bearings",id:"bearings",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"continue_straight",id:"continue_straight",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"coordinates",id:"coordinates",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"geometries",id:"geometries",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"hint",id:"hint",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"overview",id:"overview",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"profile",id:"profile",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"radiuses",id:"radiuses",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"steps",id:"steps",level:3},{value:"Defined in",id:"defined-in-10",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMRouteParams"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"OSRMBaseParams")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"OSRMRouteParams"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"alternatives"},"alternatives"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"alternatives"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Search for alternative routes and return as well."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,a.kt)("p",null,"Please note that even if an alternative route is requested, a result cannot be guaranteed."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L32"},"packages/osrm/parameters.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"annotations"},"annotations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"annotations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Returns additional metadata for each coordinate along the route geometry."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L36"},"packages/osrm/parameters.ts:36")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"bearings"},"bearings"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"bearings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Limits the search to segments with given bearing in degrees towards true north in\nclockwise direction."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseParams.bearings"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L18"},"packages/osrm/parameters.ts:18")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"continue_straight"},"continue","_","straight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"continue","_","straight"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Forces the route to keep going straight at waypoints constraining uturns there even if\nit would be faster. Default value depends on the profile."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L48"},"packages/osrm/parameters.ts:48")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"coordinates"},"coordinates"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"coordinates"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"String of format ",(0,a.kt)("inlineCode",{parentName:"p"},"{longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...]"),"\nor ",(0,a.kt)("inlineCode",{parentName:"p"},"polyline({polyline})"),"."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseParams.coordinates"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L8"},"packages/osrm/parameters.ts:8")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"geometries"},"geometries"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"geometries"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmgeometrytype"},(0,a.kt)("inlineCode",{parentName:"a"},"OSRMGeometryType"))),(0,a.kt)("p",null,"Returned route geometry format (influences overview and per step)"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L38"},"packages/osrm/parameters.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hint"},"hint"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"hint"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Hint from previous request to derive position in street network."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseParams.hint"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L22"},"packages/osrm/parameters.ts:22")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"overview"},"overview"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"overview"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmoverviewtype"},(0,a.kt)("inlineCode",{parentName:"a"},"OSRMOverviewType"))),(0,a.kt)("p",null,"Add overview geometry either full, simplified according to highest zoom level it\ncould be display on, or not at all."),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L43"},"packages/osrm/parameters.ts:43")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"profile"},"profile"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"profile"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Mode of transportation, is determined statically by the Lua profile that is used to prepare\nthe data using osrm-extract. Typically car, bike or foot if using one of the supplied profiles."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseParams.profile"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L13"},"packages/osrm/parameters.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"radiuses"},"radiuses"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"radiuses"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Limits the search to given radius in meters."),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseParams.radiuses"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L20"},"packages/osrm/parameters.ts:20")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"steps"},"steps"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"steps"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Return route steps for each route leg"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L34"},"packages/osrm/parameters.ts:34")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/08932d0c.41ecc58a.js b/assets/js/08932d0c.41ecc58a.js new file mode 100644 index 0000000..fc7b3c8 --- /dev/null +++ b/assets/js/08932d0c.41ecc58a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6070],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>k});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(n),k=i,m=c["".concat(s,".").concat(k)]||c[k]||d[k]||a;return n?r.createElement(m,o(o({ref:t},u),{},{components:n})):r.createElement(m,o({ref:t},u))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var r=n(7462),i=(n(7294),n(3905));const a={id:"core.ClientConstructorArgs",title:"Interface: ClientConstructorArgs",sidebar_label:"ClientConstructorArgs",custom_edit_url:null},o=void 0,l={unversionedId:"api/interfaces/core.ClientConstructorArgs",id:"api/interfaces/core.ClientConstructorArgs",title:"Interface: ClientConstructorArgs",description:"core.ClientConstructorArgs",source:"@site/docs/api/interfaces/core.ClientConstructorArgs.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/core.ClientConstructorArgs",permalink:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.ClientConstructorArgs",title:"Interface: ClientConstructorArgs",sidebar_label:"ClientConstructorArgs",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"BaseRouter",permalink:"/routingjs/docs/api/interfaces/core.BaseRouter"},next:{title:"ErrorProps",permalink:"/routingjs/docs/api/interfaces/core.ErrorProps"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"axiosOpts",id:"axiosopts",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"baseUrl",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"headers",id:"headers",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"maxRetries",id:"maxretries",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"retryOverQueryLimit",id:"retryoverquerylimit",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"timeout",id:"timeout",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"userAgent",id:"useragent",level:3},{value:"Defined in",id:"defined-in-7",level:4}],u={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".ClientConstructorArgs"),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"apikey"},"apiKey"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"apiKey"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Optional API key that is passed as part of the URL params"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L18"},"packages/core/BaseRouter.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"axiosopts"},"axiosOpts"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"axiosOpts"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"AxiosRequestConfig"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"other options passed to the axios instance"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L48"},"packages/core/BaseRouter.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"baseurl"},"baseUrl"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"baseUrl"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Base URL that all requests are directed to. If not specified,\nthe router's default public API at is used (API key may be required)"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L13"},"packages/core/BaseRouter.ts:13")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"headers"},"headers"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"headers"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"additional headers passed to be passed in the request"),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[k: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L28"},"packages/core/BaseRouter.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxretries"},"maxRetries"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"maxRetries"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"maximum number of retries performed by axios-retry"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L43"},"packages/core/BaseRouter.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"retryoverquerylimit"},"retryOverQueryLimit"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"retryOverQueryLimit"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether requests should be retried on status code 429 responses"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L38"},"packages/core/BaseRouter.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"timeout"},"timeout"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"timeout"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Custom request timeout"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L33"},"packages/core/BaseRouter.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"useragent"},"userAgent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"userAgent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"overwrites the default user agent header."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L23"},"packages/core/BaseRouter.ts:23")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1291376a.47701dfe.js b/assets/js/1291376a.47701dfe.js new file mode 100644 index 0000000..3a1de50 --- /dev/null +++ b/assets/js/1291376a.47701dfe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9455],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,p=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),m=l(n),k=i,f=m["".concat(p,".").concat(k)]||m[k]||d[k]||r;return n?a.createElement(f,s(s({ref:t},u),{},{components:n})):a.createElement(f,s({ref:t},u))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,s=new Array(r);s[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(7462),i=(n(7294),n(3905));const r={id:"ors.ORSRouteParams",title:"Interface: ORSRouteParams",sidebar_label:"ORSRouteParams",custom_edit_url:null},s=void 0,o={unversionedId:"api/interfaces/ors.ORSRouteParams",id:"api/interfaces/ors.ORSRouteParams",title:"Interface: ORSRouteParams",description:"ors.ORSRouteParams",source:"@site/docs/api/interfaces/ors.ORSRouteParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSRouteParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSRouteParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSRouteParams",title:"Interface: ORSRouteParams",sidebar_label:"ORSRouteParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSRoute",permalink:"/routingjs/docs/api/interfaces/ors.ORSRoute"},next:{title:"ORSRouteResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alternative_routes",id:"alternative_routes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attrributes",id:"attrributes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"continue_straight",id:"continue_straight",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"coordinates",id:"coordinates",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"elevation",id:"elevation",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"extra_info",id:"extra_info",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"geometry",id:"geometry",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"geometry_simplify",id:"geometry_simplify",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"instructions",id:"instructions",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"instructions_format",id:"instructions_format",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"language",id:"language",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"maneuvers",id:"maneuvers",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"maximum_speed",id:"maximum_speed",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"preference",id:"preference",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"radiuses",id:"radiuses",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"roundabout_exits",id:"roundabout_exits",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"skip_segments",id:"skip_segments",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"suppress_warnings",id:"suppress_warnings",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"units",id:"units",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-20",level:4}],u={toc:l};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSRouteParams"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"ORSBaseParams")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ORSRouteParams"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"alternative_routes"},"alternative","_","routes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"alternative","_","routes"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam"},(0,i.kt)("inlineCode",{parentName:"a"},"ORSAlternateRouteParam"))),(0,i.kt)("p",null,"Specifies whether alternative routes are computed, and parameters for the algorithm determining\nsuitable alternatives."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L33"},"packages/ors/parameters.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"attrributes"},"attrributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attrributes"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsattribute"},(0,i.kt)("inlineCode",{parentName:"a"},"ORSAttribute")),"[]"),(0,i.kt)("p",null,"List of route attributes"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L35"},"packages/ors/parameters.ts:35")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"continue_straight"},"continue","_","straight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"continue","_","straight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Forces the route to keep going straight at waypoints restricting uturns there even if it would be faster."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L37"},"packages/ors/parameters.ts:37")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"coordinates"},"coordinates"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"coordinates"),": ","[",(0,i.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,i.kt)("p",null,"The locations to use for the route as an array of longitude/latitude pairs"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L28"},"packages/ors/parameters.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"elevation"},"elevation"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"elevation"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Specifies whether to return elevation values for points. Please note that elevation also gets\nencoded for json response encoded polyline."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L48"},"packages/ors/parameters.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"extra_info"},"extra","_","info"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"extra","_","info"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsextrainfo"},(0,i.kt)("inlineCode",{parentName:"a"},"ORSExtraInfo")),"[]"),(0,i.kt)("p",null,"The extra info items to include in the response"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L50"},"packages/ors/parameters.ts:50")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"geometry"},"geometry"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"geometry"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Specifies whether to return geometry."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"true"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L102"},"packages/ors/parameters.ts:102")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"geometry_simplify"},"geometry","_","simplify"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"geometry","_","simplify"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Specifies whether to simplify the geometry. Simplify geometry cannot be applied to routes\nwith more than one segment and when extra_info is required."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L55"},"packages/ors/parameters.ts:55")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Arbitrary identification string of the request reflected in the meta information."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"ORSBaseParams.id"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L16"},"packages/ors/parameters.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"instructions"},"instructions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"instructions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Specifies whether to return instructions."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L57"},"packages/ors/parameters.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"instructions_format"},"instructions","_","format"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"instructions","_","format"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsinstructionformat"},(0,i.kt)("inlineCode",{parentName:"a"},"ORSInstructionFormat"))),(0,i.kt)("p",null,"Select html for more verbose instructions."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L59"},"packages/ors/parameters.ts:59")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"language"},"language"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"language"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Language for the route instructions."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L61"},"packages/ors/parameters.ts:61")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maneuvers"},"maneuvers"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maneuvers"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Specifies whether the maneuver object is included into the step object or not."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"false"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L68"},"packages/ors/parameters.ts:68")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maximum_speed"},"maximum","_","speed"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maximum","_","speed"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The maximum speed specified by user."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L106"},"packages/ors/parameters.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"options"},"options"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"options"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("p",null,"For advanced options formatted as json object."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"See"))),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://giscience.github.io/openrouteservice/documentation/routing-options/Examples.html"},"https://giscience.github.io/openrouteservice/documentation/routing-options/Examples.html")," for examples."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L43"},"packages/ors/parameters.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"preference"},"preference"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"preference"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orspreference"},(0,i.kt)("inlineCode",{parentName:"a"},"ORSPreference"))),(0,i.kt)("p",null,"Specifies the route preference."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L70"},"packages/ors/parameters.ts:70")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"radiuses"},"radiuses"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"radiuses"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"A list of maximum distances (measured in metres) that limit the search of nearby road segments\nto every given waypoint. The values must be greater than 0, the value of -1 specifies using the\nmaximum possible search radius. The number of radiuses correspond to the number of waypoints.\nIf only a single value is given, it will be applied to all waypoints."),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L77"},"packages/ors/parameters.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"roundabout_exits"},"roundabout","_","exits"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"roundabout","_","exits"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Provides bearings of the entrance and all passed roundabout exits. Adds the exit_bearings\narray to the step object in the response."),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L82"},"packages/ors/parameters.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"skip_segments"},"skip","_","segments"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"skip","_","segments"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"Specifies the segments that should be skipped in the route calculation. A segment is the\nconnection between two given coordinates and the counting starts with 1 for the connection\nbetween the first and second coordinate."),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L88"},"packages/ors/parameters.ts:88")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"suppress_warnings"},"suppress","_","warnings"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"suppress","_","warnings"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Suppress warning messages in the response"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"false"),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L95"},"packages/ors/parameters.ts:95")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"units"},"units"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"units"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsunit"},(0,i.kt)("inlineCode",{parentName:"a"},"ORSUnit"))),(0,i.kt)("p",null,"Specifies the distance units only if range_type is set to distance."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"Default: m."),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"ORSBaseParams.units"),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L23"},"packages/ors/parameters.ts:23")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1745c884.31ca9265.js b/assets/js/1745c884.31ca9265.js new file mode 100644 index 0000000..21bf54b --- /dev/null +++ b/assets/js/1745c884.31ca9265.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4745],{3905:(e,t,a)=>{a.d(t,{Zo:()=>u,kt:()=>h});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function r(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),o=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},u=function(e){var t=o(e.components);return n.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,l=e.originalType,s=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),k=o(a),h=i,m=k["".concat(s,".").concat(h)]||k[h]||d[h]||l;return a?n.createElement(m,r(r({ref:t},u),{},{components:a})):n.createElement(m,r({ref:t},u))}));function h(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=a.length,r=new Array(l);r[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:i,r[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>d,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var n=a(7462),i=(a(7294),a(3905));const l={id:"valhalla.ValhallaManeuvers",title:"Interface: ValhallaManeuvers",sidebar_label:"ValhallaManeuvers",custom_edit_url:null},r=void 0,p={unversionedId:"api/interfaces/valhalla.ValhallaManeuvers",id:"api/interfaces/valhalla.ValhallaManeuvers",title:"Interface: ValhallaManeuvers",description:"valhalla.ValhallaManeuvers",source:"@site/docs/api/interfaces/valhalla.ValhallaManeuvers.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaManeuvers",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaManeuvers",title:"Interface: ValhallaManeuvers",sidebar_label:"ValhallaManeuvers",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaLocation",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},next:{title:"ValhallaMatrixOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts"}},s={},o=[{value:"Properties",id:"properties",level:2},{value:"arrive_instruction",id:"arrive_instruction",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"begin_shape_index",id:"begin_shape_index",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"begin_street_names",id:"begin_street_names",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"bss_maneuver_type",id:"bss_maneuver_type",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"depart_instruction",id:"depart_instruction",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"end_shape_index",id:"end_shape_index",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"ferry",id:"ferry",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"gate",id:"gate",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"highway",id:"highway",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"instruction",id:"instruction",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"length",id:"length",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"rough",id:"rough",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"roundabout_exit_count",id:"roundabout_exit_count",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"sign",id:"sign",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"street_names",id:"street_names",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"time",id:"time",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"toll",id:"toll",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"transit_info",id:"transit_info",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"travel_mode",id:"travel_mode",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"travel_type",id:"travel_type",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"verbal_arrive_instruction",id:"verbal_arrive_instruction",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"verbal_depart_instruction",id:"verbal_depart_instruction",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"verbal_multi_cue",id:"verbal_multi_cue",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"verbal_post_transition_instruction",id:"verbal_post_transition_instruction",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"verbal_pre_transition_instruction",id:"verbal_pre_transition_instruction",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"verbal_transition_alert_instruction",id:"verbal_transition_alert_instruction",level:3},{value:"Defined in",id:"defined-in-26",level:4}],u={toc:o};function d(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},u,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaManeuvers"),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"arrive_instruction"},"arrive","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"arrive","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Written arrive time instruction. Typically used with a transit maneuver."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Arrive: 8:10 AM at 34 St - Herald Sq"\n')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L323"},"packages/valhalla/parameters.ts:323")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"begin_shape_index"},"begin","_","shape","_","index"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"begin","_","shape","_","index"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Index into the list of shape points for the start of the maneuver."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L284"},"packages/valhalla/parameters.ts:284")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"begin_street_names"},"begin","_","street","_","names"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"begin","_","street","_","names"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"When present, these are the street names at the beginning (transition point) of the\nnonobvious maneuver (if they are different than the names that are consistent along the\nentire nonobvious maneuver)."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L278"},"packages/valhalla/parameters.ts:278")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"bss_maneuver_type"},"bss","_","maneuver","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"bss","_","maneuver","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"NoneAction"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"RentBikeAtBikeShare"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"ReturnBikeAtBikeShare"')),(0,i.kt)("p",null,"Used when travel_mode is bikeshare. Describes bike share maneuver."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,'The default value is "NoneAction".'),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L353"},"packages/valhalla/parameters.ts:353")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"depart_instruction"},"depart","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"depart","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Written depart time instruction. Typically used with a transit maneuver,"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Depart: 8:04 AM from 8 St - NYU"\n')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L310"},"packages/valhalla/parameters.ts:310")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"end_shape_index"},"end","_","shape","_","index"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"end","_","shape","_","index"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Index into the list of shape points for the end of the maneuver."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L286"},"packages/valhalla/parameters.ts:286")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ferry"},"ferry"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"ferry"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"True if a ferry is encountered on this maneuver."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L296"},"packages/valhalla/parameters.ts:296")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"gate"},"gate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"gate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"True if a gate is encountered on this maneuver."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L294"},"packages/valhalla/parameters.ts:294")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"highway"},"highway"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"highway"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"True if a highway is encountered on this maneuver."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L290"},"packages/valhalla/parameters.ts:290")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"instruction"},"instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Written maneuver instruction. Describes the maneuver."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Turn right onto Main Street"\n')),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L247"},"packages/valhalla/parameters.ts:247")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"length"},"length"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"length"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Maneuver length in the units specified."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L282"},"packages/valhalla/parameters.ts:282")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"rough"},"rough"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"rough"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"True if the maneuver is unpaved or rough pavement, or has any portions that have rough pavement."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L292"},"packages/valhalla/parameters.ts:292")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"roundabout_exit_count"},"roundabout","_","exit","_","count"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"roundabout","_","exit","_","count"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The spoke to exit roundabout after entering."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L303"},"packages/valhalla/parameters.ts:303")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sign"},"sign"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"sign"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Contains the interchange guide information at a road junction associated with this maneuver."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"See"))),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#trip-legs-and-maneuvers"},"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#trip-legs-and-maneuvers")," the list of maneuver types for details."),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[k: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L301"},"packages/valhalla/parameters.ts:301")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"street_names"},"street","_","names"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"street","_","names"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"List of street names that are consistent along the entire nonobvious maneuver."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L272"},"packages/valhalla/parameters.ts:272")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"time"},"time"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"time"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Estimated time along the maneuver in seconds."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L280"},"packages/valhalla/parameters.ts:280")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toll"},"toll"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"toll"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"True if the maneuver has any toll, or portions of the maneuver are subject to a toll."),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L288"},"packages/valhalla/parameters.ts:288")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"transit_info"},"transit","_","info"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"transit","_","info"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Contains the attributes that describe a specific transit route."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"See"))),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#trip-legs-and-maneuvers"},"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#trip-legs-and-maneuvers")," the list of maneuver types for details."),(0,i.kt)("h4",{id:"index-signature-1"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[k: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L336"},"packages/valhalla/parameters.ts:336")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"travel_mode"},"travel","_","mode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"travel","_","mode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaTravelMode")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L342"},"packages/valhalla/parameters.ts:342")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"travel_type"},"travel","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"travel","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaTravelType")),(0,i.kt)("p",null,"Travel type for drive."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L346"},"packages/valhalla/parameters.ts:346")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L239"},"packages/valhalla/parameters.ts:239")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"verbal_arrive_instruction"},"verbal","_","arrive","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"verbal","_","arrive","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Text suitable for use as a verbal arrive time instruction. Typically used with a transit\nmaneuver."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Arrive at 8:10 AM at 34 St - Herald Sq"\n')),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L330"},"packages/valhalla/parameters.ts:330")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"verbal_depart_instruction"},"verbal","_","depart","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"verbal","_","depart","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Text suitable for use as a verbal depart time instruction. Typically used with a\ntransit maneuver."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Depart at 8:04 AM from 8 St - NYU"\n')),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L317"},"packages/valhalla/parameters.ts:317")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"verbal_multi_cue"},"verbal","_","multi","_","cue"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"verbal","_","multi","_","cue"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"True if the verbal_pre_transition_instruction has been appended with the verbal\ninstruction of the next maneuver."),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L341"},"packages/valhalla/parameters.ts:341")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"verbal_post_transition_instruction"},"verbal","_","post","_","transition","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"verbal","_","post","_","transition","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Text suitable for use as a verbal message immediately after the maneuver transition."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Continue on U.S. 2 22 for 3.9 miles"\n')),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L270"},"packages/valhalla/parameters.ts:270")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"verbal_pre_transition_instruction"},"verbal","_","pre","_","transition","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"verbal","_","pre","_","transition","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Text suitable for use as a verbal message immediately prior to the maneuver transition."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Turn right onto North Prince Street, U.S. 2 22"\n')),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L262"},"packages/valhalla/parameters.ts:262")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"verbal_transition_alert_instruction"},"verbal","_","transition","_","alert","_","instruction"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"verbal","_","transition","_","alert","_","instruction"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Text suitable for use as a verbal alert in a navigation application. The transition alert\ninstruction will prepare the user for the forthcoming transition."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'"Turn right onto North Prince Street"\n')),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L255"},"packages/valhalla/parameters.ts:255")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/176abf51.20663a38.js b/assets/js/176abf51.20663a38.js new file mode 100644 index 0000000..8160a78 --- /dev/null +++ b/assets/js/176abf51.20663a38.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8710],{3905:(e,r,t)=>{t.d(r,{Zo:()=>d,kt:()=>h});var a=t(7294);function n(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function o(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);r&&(a=a.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,a)}return t}function l(e){for(var r=1;r=0||(n[t]=e[t]);return n}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var s=a.createContext({}),p=function(e){var r=a.useContext(s),t=r;return e&&(t="function"==typeof e?e(r):l(l({},r),e)),t},d=function(e){var r=p(e.components);return a.createElement(s.Provider,{value:r},e.children)},c={inlineCode:"code",wrapper:function(e){var r=e.children;return a.createElement(a.Fragment,{},r)}},u=a.forwardRef((function(e,r){var t=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(t),h=n,f=u["".concat(s,".").concat(h)]||u[h]||c[h]||o;return t?a.createElement(f,l(l({ref:r},d),{},{components:t})):a.createElement(f,l({ref:r},d))}));function h(e,r){var t=arguments,n=r&&r.mdxType;if("string"==typeof e||n){var o=t.length,l=new Array(o);l[0]=u;var i={};for(var s in r)hasOwnProperty.call(r,s)&&(i[s]=r[s]);i.originalType=e,i.mdxType="string"==typeof e?e:n,l[1]=i;for(var p=2;p{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=t(7462),n=(t(7294),t(3905));const o={id:"valhalla.ValhallaErrorProps",title:"Interface: ValhallaErrorProps",sidebar_label:"ValhallaErrorProps",custom_edit_url:null},l=void 0,i={unversionedId:"api/interfaces/valhalla.ValhallaErrorProps",id:"api/interfaces/valhalla.ValhallaErrorProps",title:"Interface: ValhallaErrorProps",description:"valhalla.ValhallaErrorProps",source:"@site/docs/api/interfaces/valhalla.ValhallaErrorProps.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaErrorProps",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaErrorProps",title:"Interface: ValhallaErrorProps",sidebar_label:"ValhallaErrorProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaDirectionOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"},next:{title:"ValhallaIsochroneOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"errorCode",id:"errorcode",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"errorMessage",id:"errormessage",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"statusCode",id:"statuscode",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:p};function c(e){let{components:r,...t}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,t,{components:r,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaErrorProps"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaErrorProps")," returns additional information about the error thrown by the\nValhalla routing engine. It sends back the status_code, status, error_code and error\nmessage where the error_code is specific to Valhalla."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ErrorProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ValhallaErrorProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"errorcode"},"errorCode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"errorCode"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L53"},"packages/valhalla/index.ts:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"errormessage"},"errorMessage"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"errorMessage"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"errorMessage")," explains the error specific to that routing engine"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#errormessage"},"errorMessage")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L11"},"packages/core/error.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"status"},"status"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"status"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"status")," gives detailed info about that response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#status"},"status")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L9"},"packages/core/error.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"statuscode"},"statusCode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"statusCode"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"statusCode")," stands for the HTTP response status code"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#statuscode"},"statusCode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L7"},"packages/core/error.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/17896441.01530e94.js b/assets/js/17896441.01530e94.js new file mode 100644 index 0000000..82d1b3b --- /dev/null +++ b/assets/js/17896441.01530e94.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7918],{3332:(e,t,a)=>{a.r(t),a.d(t,{default:()=>_e});var n=a(7294),l=a(1944),r=a(902);const s=n.createContext(null);function o(e){let{children:t,content:a}=e;const l=function(e){return(0,n.useMemo)((()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc})),[e])}(a);return n.createElement(s.Provider,{value:l},t)}function c(){const e=(0,n.useContext)(s);if(null===e)throw new r.i6("DocProvider");return e}function i(){const{metadata:e,frontMatter:t,assets:a}=c();return n.createElement(l.d,{title:e.title,description:e.description,keywords:t.keywords,image:a.image??t.image})}var d=a(6010),m=a(7524),u=a(7462),b=a(5999),p=a(9960);function h(e){const{permalink:t,title:a,subLabel:l,isNext:r}=e;return n.createElement(p.Z,{className:(0,d.Z)("pagination-nav__link",r?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t},l&&n.createElement("div",{className:"pagination-nav__sublabel"},l),n.createElement("div",{className:"pagination-nav__label"},a))}function E(e){const{previous:t,next:a}=e;return n.createElement("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,b.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages navigation",description:"The ARIA label for the docs pagination"})},t&&n.createElement(h,(0,u.Z)({},t,{subLabel:n.createElement(b.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc"},"Previous")})),a&&n.createElement(h,(0,u.Z)({},a,{subLabel:n.createElement(b.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc"},"Next"),isNext:!0})))}function v(){const{metadata:e}=c();return n.createElement(E,{previous:e.previous,next:e.next})}var g=a(2263),f=a(143),_=a(5281),N=a(373),Z=a(4477);const k={unreleased:function(e){let{siteTitle:t,versionMetadata:a}=e;return n.createElement(b.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is unreleased documentation for {siteTitle} {versionLabel} version.")},unmaintained:function(e){let{siteTitle:t,versionMetadata:a}=e;return n.createElement(b.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.")}};function L(e){const t=k[e.versionMetadata.banner];return n.createElement(t,e)}function T(e){let{versionLabel:t,to:a,onClick:l}=e;return n.createElement(b.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:n.createElement("b",null,n.createElement(p.Z,{to:a,onClick:l},n.createElement(b.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label"},"latest version")))}},"For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).")}function U(e){let{className:t,versionMetadata:a}=e;const{siteConfig:{title:l}}=(0,g.Z)(),{pluginId:r}=(0,f.gA)({failfast:!0}),{savePreferredVersionName:s}=(0,N.J)(r),{latestDocSuggestion:o,latestVersionSuggestion:c}=(0,f.Jo)(r),i=o??(m=c).docs.find((e=>e.id===m.mainDocId));var m;return n.createElement("div",{className:(0,d.Z)(t,_.k.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert"},n.createElement("div",null,n.createElement(L,{siteTitle:l,versionMetadata:a})),n.createElement("div",{className:"margin-top--md"},n.createElement(T,{versionLabel:c.label,to:i.path,onClick:()=>s(c.name)})))}function w(e){let{className:t}=e;const a=(0,Z.E)();return a.banner?n.createElement(U,{className:t,versionMetadata:a}):null}function C(e){let{className:t}=e;const a=(0,Z.E)();return a.badge?n.createElement("span",{className:(0,d.Z)(t,_.k.docs.docVersionBadge,"badge badge--secondary")},n.createElement(b.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:a.label}},"Version: {versionLabel}")):null}function x(e){let{lastUpdatedAt:t,formattedLastUpdatedAt:a}=e;return n.createElement(b.Z,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:n.createElement("b",null,n.createElement("time",{dateTime:new Date(1e3*t).toISOString()},a))}}," on {date}")}function y(e){let{lastUpdatedBy:t}=e;return n.createElement(b.Z,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:n.createElement("b",null,t)}}," by {user}")}function A(e){let{lastUpdatedAt:t,formattedLastUpdatedAt:a,lastUpdatedBy:l}=e;return n.createElement("span",{className:_.k.common.lastUpdated},n.createElement(b.Z,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:t&&a?n.createElement(x,{lastUpdatedAt:t,formattedLastUpdatedAt:a}):"",byUser:l?n.createElement(y,{lastUpdatedBy:l}):""}},"Last updated{atDate}{byUser}"),!1)}const M="iconEdit_Z9Sw";function B(e){let{className:t,...a}=e;return n.createElement("svg",(0,u.Z)({fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,d.Z)(M,t),"aria-hidden":"true"},a),n.createElement("g",null,n.createElement("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})))}function I(e){let{editUrl:t}=e;return n.createElement("a",{href:t,target:"_blank",rel:"noreferrer noopener",className:_.k.common.editThisPage},n.createElement(B,null),n.createElement(b.Z,{id:"theme.common.editThisPage",description:"The link label to edit the current page"},"Edit this page"))}const V="tag_zVej",H="tagRegular_sFm0",P="tagWithCount_h2kH";function D(e){let{permalink:t,label:a,count:l}=e;return n.createElement(p.Z,{href:t,className:(0,d.Z)(V,l?P:H)},a,l&&n.createElement("span",null,l))}const S="tags_jXut",F="tag_QGVx";function O(e){let{tags:t}=e;return n.createElement(n.Fragment,null,n.createElement("b",null,n.createElement(b.Z,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list"},"Tags:")),n.createElement("ul",{className:(0,d.Z)(S,"padding--none","margin-left--sm")},t.map((e=>{let{label:t,permalink:a}=e;return n.createElement("li",{key:a,className:F},n.createElement(D,{label:t,permalink:a}))}))))}const z="lastUpdated_vwxv";function R(e){return n.createElement("div",{className:(0,d.Z)(_.k.docs.docFooterTagsRow,"row margin-bottom--sm")},n.createElement("div",{className:"col"},n.createElement(O,e)))}function j(e){let{editUrl:t,lastUpdatedAt:a,lastUpdatedBy:l,formattedLastUpdatedAt:r}=e;return n.createElement("div",{className:(0,d.Z)(_.k.docs.docFooterEditMetaRow,"row")},n.createElement("div",{className:"col"},t&&n.createElement(I,{editUrl:t})),n.createElement("div",{className:(0,d.Z)("col",z)},(a||l)&&n.createElement(A,{lastUpdatedAt:a,formattedLastUpdatedAt:r,lastUpdatedBy:l})))}function q(){const{metadata:e}=c(),{editUrl:t,lastUpdatedAt:a,formattedLastUpdatedAt:l,lastUpdatedBy:r,tags:s}=e,o=s.length>0,i=!!(t||a||r);return o||i?n.createElement("footer",{className:(0,d.Z)(_.k.docs.docFooter,"docusaurus-mt-lg")},o&&n.createElement(R,{tags:s}),i&&n.createElement(j,{editUrl:t,lastUpdatedAt:a,lastUpdatedBy:r,formattedLastUpdatedAt:l})):null}var G=a(6043),J=a(3743);const Q="tocCollapsibleButton_TO0P",W="tocCollapsibleButtonExpanded_MG3E";function X(e){let{collapsed:t,...a}=e;return n.createElement("button",(0,u.Z)({type:"button"},a,{className:(0,d.Z)("clean-btn",Q,!t&&W,a.className)}),n.createElement(b.Z,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component"},"On this page"))}const $="tocCollapsible_ETCw",K="tocCollapsibleContent_vkbj",Y="tocCollapsibleExpanded_sAul";function ee(e){let{toc:t,className:a,minHeadingLevel:l,maxHeadingLevel:r}=e;const{collapsed:s,toggleCollapsed:o}=(0,G.u)({initialState:!0});return n.createElement("div",{className:(0,d.Z)($,!s&&Y,a)},n.createElement(X,{collapsed:s,onClick:o}),n.createElement(G.z,{lazy:!0,className:K,collapsed:s},n.createElement(J.Z,{toc:t,minHeadingLevel:l,maxHeadingLevel:r})))}const te="tocMobile_ITEo";function ae(){const{toc:e,frontMatter:t}=c();return n.createElement(ee,{toc:e,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:(0,d.Z)(_.k.docs.docTocMobile,te)})}var ne=a(9407);function le(){const{toc:e,frontMatter:t}=c();return n.createElement(ne.Z,{toc:e,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:_.k.docs.docTocDesktop})}var re=a(2503),se=a(210);function oe(e){let{children:t}=e;const a=function(){const{metadata:e,frontMatter:t,contentTitle:a}=c();return t.hide_title||void 0!==a?null:e.title}();return n.createElement("div",{className:(0,d.Z)(_.k.docs.docMarkdown,"markdown")},a&&n.createElement("header",null,n.createElement(re.Z,{as:"h1"},a)),n.createElement(se.Z,null,t))}var ce=a(2802),ie=a(8596),de=a(4996);function me(e){return n.createElement("svg",(0,u.Z)({viewBox:"0 0 24 24"},e),n.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}const ue={breadcrumbsContainer:"breadcrumbsContainer_Z_bl",breadcrumbHomeIcon:"breadcrumbHomeIcon_OVgt"};function be(e){let{children:t,href:a,isLast:l}=e;const r="breadcrumbs__link";return l?n.createElement("span",{className:r,itemProp:"name"},t):a?n.createElement(p.Z,{className:r,href:a,itemProp:"item"},n.createElement("span",{itemProp:"name"},t)):n.createElement("span",{className:r},t)}function pe(e){let{children:t,active:a,index:l,addMicrodata:r}=e;return n.createElement("li",(0,u.Z)({},r&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,d.Z)("breadcrumbs__item",{"breadcrumbs__item--active":a})}),t,n.createElement("meta",{itemProp:"position",content:String(l+1)}))}function he(){const e=(0,de.Z)("/");return n.createElement("li",{className:"breadcrumbs__item"},n.createElement(p.Z,{"aria-label":(0,b.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:(0,d.Z)("breadcrumbs__link",ue.breadcrumbsItemLink),href:e},n.createElement(me,{className:ue.breadcrumbHomeIcon})))}function Ee(){const e=(0,ce.s1)(),t=(0,ie.Ns)();return e?n.createElement("nav",{className:(0,d.Z)(_.k.docs.docBreadcrumbs,ue.breadcrumbsContainer),"aria-label":(0,b.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},n.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&n.createElement(he,null),e.map(((t,a)=>{const l=a===e.length-1;return n.createElement(pe,{key:a,active:l,index:a,addMicrodata:!!t.href},n.createElement(be,{href:t.href,isLast:l},t.label))})))):null}const ve="docItemContainer_Djhp",ge="docItemCol_VOVn";function fe(e){let{children:t}=e;const a=function(){const{frontMatter:e,toc:t}=c(),a=(0,m.i)(),l=e.hide_table_of_contents,r=!l&&t.length>0;return{hidden:l,mobile:r?n.createElement(ae,null):void 0,desktop:!r||"desktop"!==a&&"ssr"!==a?void 0:n.createElement(le,null)}}();return n.createElement("div",{className:"row"},n.createElement("div",{className:(0,d.Z)("col",!a.hidden&&ge)},n.createElement(w,null),n.createElement("div",{className:ve},n.createElement("article",null,n.createElement(Ee,null),n.createElement(C,null),a.mobile,n.createElement(oe,null,t),n.createElement(q,null)),n.createElement(v,null))),a.desktop&&n.createElement("div",{className:"col col--3"},a.desktop))}function _e(e){const t=`docs-doc-id-${e.content.metadata.unversionedId}`,a=e.content;return n.createElement(o,{content:e.content},n.createElement(l.FG,{className:t},n.createElement(i,null),n.createElement(fe,null,n.createElement(a,null))))}},4477:(e,t,a)=>{a.d(t,{E:()=>o,q:()=>s});var n=a(7294),l=a(902);const r=n.createContext(null);function s(e){let{children:t,version:a}=e;return n.createElement(r.Provider,{value:a},t)}function o(){const e=(0,n.useContext)(r);if(null===e)throw new l.i6("DocsVersionProvider");return e}}}]); \ No newline at end of file diff --git a/assets/js/1b3415a5.5a55eebb.js b/assets/js/1b3415a5.5a55eebb.js new file mode 100644 index 0000000..0c18790 --- /dev/null +++ b/assets/js/1b3415a5.5a55eebb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[917],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var l=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);t&&(l=l.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,l)}return a}function r(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(l=0;l=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=l.createContext({}),p=function(e){var t=l.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=p(e.components);return l.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return l.createElement(l.Fragment,{},t)}},k=l.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),k=p(a),h=n,f=k["".concat(o,".").concat(h)]||k[h]||u[h]||i;return a?l.createElement(f,r(r({ref:t},d),{},{components:a})):l.createElement(f,r({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,r=new Array(i);r[0]=k;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:n,r[1]=s;for(var p=2;p{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var l=a(7462),n=(a(7294),a(3905));const i={id:"valhalla.ValhallaCostingOptsPedestrian",title:"Interface: ValhallaCostingOptsPedestrian",sidebar_label:"ValhallaCostingOptsPedestrian",custom_edit_url:null},r=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaCostingOptsPedestrian",id:"api/interfaces/valhalla.ValhallaCostingOptsPedestrian",title:"Interface: ValhallaCostingOptsPedestrian",description:"valhalla.ValhallaCostingOptsPedestrian",source:"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaCostingOptsPedestrian",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaCostingOptsPedestrian",title:"Interface: ValhallaCostingOptsPedestrian",sidebar_label:"ValhallaCostingOptsPedestrian",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaCostingOptsMotorcycle",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},next:{title:"ValhallaCostingOptsTruck",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alley_factor",id:"alley_factor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"bss_rent_cost",id:"bss_rent_cost",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"bss_rent_penalty",id:"bss_rent_penalty",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"driveway_factor",id:"driveway_factor",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"max_hiking_difficulty",id:"max_hiking_difficulty",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"service_factor",id:"service_factor",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"service_penalty",id:"service_penalty",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"shortest",id:"shortest",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"sidewalk_factor",id:"sidewalk_factor",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"step_penalty",id:"step_penalty",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"use_ferry",id:"use_ferry",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"use_hills",id:"use_hills",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"use_living_streets",id:"use_living_streets",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"use_tracks",id:"use_tracks",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"walking_speed",id:"walking_speed",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"walkway_factor",id:"walkway_factor",level:3},{value:"Defined in",id:"defined-in-15",level:4}],d={toc:p};function u(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,l.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaCostingOptsPedestrian"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptsBase")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ValhallaCostingOptsPedestrian"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alley_factor"},"alley","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alley","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies (multiplies) the cost when alleys are encountered. Pedestrian routes\ngenerally want to avoid alleys or narrow service roads between buildings."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default alley_factor is 2.0."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L789"},"packages/valhalla/parameters.ts:789")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bss_rent_cost"},"bss","_","rent","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"bss","_","rent","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value is useful when bikeshare is chosen as travel mode. It is meant to give the time will\nbe used to rent a bike from a bike share station. This value will be displayed in the final\ndirections and used to calculate the whole duation."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 120 seconds."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L851"},"packages/valhalla/parameters.ts:851")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bss_rent_penalty"},"bss","_","rent","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"bss","_","rent","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value is useful when bikeshare is chosen as travel mode. It is meant to describe\nthe potential effort to rent a bike from a bike share station. This value won't be\ndisplayed and used only inside of the algorithm."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L857"},"packages/valhalla/parameters.ts:857")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"driveway_factor"},"driveway","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"driveway","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies (multiplies) the cost when encountering a driveway, which is often a\nprivate, service road. Pedestrian routes generally want to avoid driveways (private)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default driveway factor is 5.0."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L797"},"packages/valhalla/parameters.ts:797")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"max_hiking_difficulty"},"max","_","hiking","_","difficulty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"max","_","hiking","_","difficulty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the maximum difficulty of hiking trails that is allowed. Values between 0\nand 6 are allowed."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://wiki.openstreetmap.org/wiki/Key:sac_scale"},"https://wiki.openstreetmap.org/wiki/Key:sac_scale")," the corresponding sac_scale values within OpenStreetMap."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 1 which means that well cleared trails that are mostly flat or slightly sloped are allowed. Higher difficulty trails can be allowed by specifying a higher value for max_hiking_difficulty."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L842"},"packages/valhalla/parameters.ts:842")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"service_factor"},"service","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"service","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies (multiplies) the cost when generic service roads are encountered."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default service_factor is 1."),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L832"},"packages/valhalla/parameters.ts:832")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"service_penalty"},"service","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"service","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied for transition to generic service road."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default penalty is 0."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"ValhallaCostingOptsBase.service","_","penalty"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L825"},"packages/valhalla/parameters.ts:825")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shortest"},"shortest"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shortest"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Changes the metric to quasi-shortest, i.e. purely distance-based costing."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note, this will disable all other costings & penalties. Also note, shortest will not\ndisable hierarchy pruning, leading to potentially sub-optimal routes for some costing\nmodels."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default is false."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"ValhallaCostingOptsBase.shortest"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L732"},"packages/valhalla/parameters.ts:732")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sidewalk_factor"},"sidewalk","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"sidewalk","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies the cost when encountering roads with dedicated sidewalks. Pedestrian\nroutes generally attempt to favor using sidewalks."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default sidewalk_factor is 1.0."),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L781"},"packages/valhalla/parameters.ts:781")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"step_penalty"},"step","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"step","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty in seconds added to each transition onto a path with steps or stairs. Higher values\napply larger cost penalties to avoid paths that contain flights of steps."),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L802"},"packages/valhalla/parameters.ts:802")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_ferry"},"use","_","ferry"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","ferry"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take ferries. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.5."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"ValhallaCostingOptsBase.use","_","ferry"),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L700"},"packages/valhalla/parameters.ts:700")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_hills"},"use","_","hills"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","hills"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This is a range of values from 0 to 1, where 0 attempts to avoid hills and steep grades even if\nit means a longer (time and distance) path, while 1 indicates the pedestrian does not fear\nhills and steeper grades. Based on the use_hills factor, penalties are applied to roads based\non elevation change and grade. These penalties help the path avoid hilly roads in favor of flatter roads or less steep grades where available. Note that it is not always possible to find alternate paths to avoid hills (for example when route locations are in mountainous areas). The default value is 0.5."),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L818"},"packages/valhalla/parameters.ts:818")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_living_streets"},"use","_","living","_","streets"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","living","_","streets"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take living streets. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will\nfavor living streets."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 for trucks, 0.1 for cars, buses, motor\nscooters and motorcycles."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes living streets are required to complete\na route so values of 0 are not guaranteed to avoid living streets entirely."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"ValhallaCostingOptsBase.use","_","living","_","streets"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L714"},"packages/valhalla/parameters.ts:714")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_tracks"},"use","_","tracks"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","tracks"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take track roads. This is a range of values between\n0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a\nlittle bit."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.5. Note that sometimes tracks are required to complete a route so values of 0 are not guaranteed to avoid tracks entirely."),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L811"},"packages/valhalla/parameters.ts:811")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"walking_speed"},"walking","_","speed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"walking","_","speed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Walking speed in kilometers per hour. Must be between 0.5 and 25 km/hr."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Defaults to 5.1 km/hr (3.1 miles/hour)."),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L764"},"packages/valhalla/parameters.ts:764")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"walkway_factor"},"walkway","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"walkway","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies the cost when encountering roads classified as footway (no motorized\nvehicles allowed), which may be designated footpaths or designated sidewalks along residential\nroads. Pedestrian routes generally attempt to favor using these walkways and sidewalks."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default walkway_factor is 1.0."),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L773"},"packages/valhalla/parameters.ts:773")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1be78505.5e726ffb.js b/assets/js/1be78505.5e726ffb.js new file mode 100644 index 0000000..4f02551 --- /dev/null +++ b/assets/js/1be78505.5e726ffb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9514,4972],{9963:(e,t,n)=>{n.r(t),n.d(t,{default:()=>Ie});var a=n(7294),l=n(6010),o=n(1944),r=n(5281),c=n(3320),i=n(2802),s=n(4477),d=n(1116),m=n(3285),u=n(5999),b=n(2466),p=n(5936);const h="backToTopButton_sjWU",E="backToTopButtonShow_xfvO";function f(){const{shown:e,scrollToTop:t}=function(e){let{threshold:t}=e;const[n,l]=(0,a.useState)(!1),o=(0,a.useRef)(!1),{startScroll:r,cancelScroll:c}=(0,b.Ct)();return(0,b.RF)(((e,n)=>{let{scrollY:a}=e;const r=null==n?void 0:n.scrollY;r&&(o.current?o.current=!1:a>=r?(c(),l(!1)):a{e.location.hash&&(o.current=!0,l(!1))})),{shown:n,scrollToTop:()=>r(0)}}({threshold:300});return a.createElement("button",{"aria-label":(0,u.I)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,l.Z)("clean-btn",r.k.common.backToTopButton,h,e&&E),type:"button",onClick:t})}var v=n(6550),g=n(7524),_=n(6668),k=n(1327),C=n(7462);function I(e){return a.createElement("svg",(0,C.Z)({width:"20",height:"20","aria-hidden":"true"},e),a.createElement("g",{fill:"#7a7a7a"},a.createElement("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),a.createElement("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})))}const N="collapseSidebarButton_PEFL",S="collapseSidebarButtonIcon_kv0_";function Z(e){let{onClick:t}=e;return a.createElement("button",{type:"button",title:(0,u.I)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,u.I)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,l.Z)("button button--secondary button--outline",N),onClick:t},a.createElement(I,{className:S}))}var x=n(9689),y=n(902);const T=Symbol("EmptyContext"),w=a.createContext(T);function L(e){let{children:t}=e;const[n,l]=(0,a.useState)(null),o=(0,a.useMemo)((()=>({expandedItem:n,setExpandedItem:l})),[n]);return a.createElement(w.Provider,{value:o},t)}var M=n(6043),A=n(8596),B=n(9960),F=n(2389);function P(e){let{categoryLabel:t,onClick:n}=e;return a.createElement("button",{"aria-label":(0,u.I)({id:"theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel",message:"Toggle the collapsible sidebar category '{label}'",description:"The ARIA label to toggle the collapsible sidebar category"},{label:t}),type:"button",className:"clean-btn menu__caret",onClick:n})}function H(e){let{item:t,onItemClick:n,activePath:o,level:c,index:s,...d}=e;const{items:m,label:u,collapsible:b,className:p,href:h}=t,{docs:{sidebar:{autoCollapseCategories:E}}}=(0,_.L)(),f=function(e){const t=(0,F.Z)();return(0,a.useMemo)((()=>e.href?e.href:!t&&e.collapsible?(0,i.Wl)(e):void 0),[e,t])}(t),v=(0,i._F)(t,o),g=(0,A.Mg)(h,o),{collapsed:k,setCollapsed:I}=(0,M.u)({initialState:()=>!!b&&(!v&&t.collapsed)}),{expandedItem:N,setExpandedItem:S}=function(){const e=(0,a.useContext)(w);if(e===T)throw new y.i6("DocSidebarItemsExpandedStateProvider");return e}(),Z=function(e){void 0===e&&(e=!k),S(e?null:s),I(e)};return function(e){let{isActive:t,collapsed:n,updateCollapsed:l}=e;const o=(0,y.D9)(t);(0,a.useEffect)((()=>{t&&!o&&n&&l(!1)}),[t,o,n,l])}({isActive:v,collapsed:k,updateCollapsed:Z}),(0,a.useEffect)((()=>{b&&null!=N&&N!==s&&E&&I(!0)}),[b,N,s,I,E]),a.createElement("li",{className:(0,l.Z)(r.k.docs.docSidebarItemCategory,r.k.docs.docSidebarItemCategoryLevel(c),"menu__list-item",{"menu__list-item--collapsed":k},p)},a.createElement("div",{className:(0,l.Z)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":g})},a.createElement(B.Z,(0,C.Z)({className:(0,l.Z)("menu__link",{"menu__link--sublist":b,"menu__link--sublist-caret":!h&&b,"menu__link--active":v}),onClick:b?e=>{null==n||n(t),h?Z(!1):(e.preventDefault(),Z())}:()=>{null==n||n(t)},"aria-current":g?"page":void 0,"aria-expanded":b?!k:void 0,href:b?f??"#":f},d),u),h&&b&&a.createElement(P,{categoryLabel:u,onClick:e=>{e.preventDefault(),Z()}})),a.createElement(M.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:k},a.createElement(q,{items:m,tabIndex:k?-1:0,onItemClick:n,activePath:o,level:c+1})))}var W=n(3919),D=n(9471);const R="menuExternalLink_NmtK";function z(e){let{item:t,onItemClick:n,activePath:o,level:c,index:s,...d}=e;const{href:m,label:u,className:b,autoAddBaseUrl:p}=t,h=(0,i._F)(t,o),E=(0,W.Z)(m);return a.createElement("li",{className:(0,l.Z)(r.k.docs.docSidebarItemLink,r.k.docs.docSidebarItemLinkLevel(c),"menu__list-item",b),key:u},a.createElement(B.Z,(0,C.Z)({className:(0,l.Z)("menu__link",!E&&R,{"menu__link--active":h}),autoAddBaseUrl:p,"aria-current":h?"page":void 0,to:m},E&&{onClick:n?()=>n(t):void 0},d),u,!E&&a.createElement(D.Z,null)))}const U="menuHtmlItem_M9Kj";function V(e){let{item:t,level:n,index:o}=e;const{value:c,defaultStyle:i,className:s}=t;return a.createElement("li",{className:(0,l.Z)(r.k.docs.docSidebarItemLink,r.k.docs.docSidebarItemLinkLevel(n),i&&[U,"menu__list-item"],s),key:o,dangerouslySetInnerHTML:{__html:c}})}function K(e){let{item:t,...n}=e;switch(t.type){case"category":return a.createElement(H,(0,C.Z)({item:t},n));case"html":return a.createElement(V,(0,C.Z)({item:t},n));default:return a.createElement(z,(0,C.Z)({item:t},n))}}function j(e){let{items:t,...n}=e;return a.createElement(L,null,t.map(((e,t)=>a.createElement(K,(0,C.Z)({key:t,item:e,index:t},n)))))}const q=(0,a.memo)(j),G="menu_SIkG",Y="menuWithAnnouncementBar_GW3s";function O(e){let{path:t,sidebar:n,className:o}=e;const c=function(){const{isActive:e}=(0,x.nT)(),[t,n]=(0,a.useState)(e);return(0,b.RF)((t=>{let{scrollY:a}=t;e&&n(0===a)}),[e]),e&&t}();return a.createElement("nav",{className:(0,l.Z)("menu thin-scrollbar",G,c&&Y,o)},a.createElement("ul",{className:(0,l.Z)(r.k.docs.docSidebarMenu,"menu__list")},a.createElement(q,{items:n,activePath:t,level:1})))}const X="sidebar_njMd",J="sidebarWithHideableNavbar_wUlq",Q="sidebarHidden_VK0M",$="sidebarLogo_isFc";function ee(e){let{path:t,sidebar:n,onCollapse:o,isHidden:r}=e;const{navbar:{hideOnScroll:c},docs:{sidebar:{hideable:i}}}=(0,_.L)();return a.createElement("div",{className:(0,l.Z)(X,c&&J,r&&Q)},c&&a.createElement(k.Z,{tabIndex:-1,className:$}),a.createElement(O,{path:t,sidebar:n}),i&&a.createElement(Z,{onClick:o}))}const te=a.memo(ee);var ne=n(3102),ae=n(2961);const le=e=>{let{sidebar:t,path:n}=e;const o=(0,ae.e)();return a.createElement("ul",{className:(0,l.Z)(r.k.docs.docSidebarMenu,"menu__list")},a.createElement(q,{items:t,activePath:n,onItemClick:e=>{"category"===e.type&&e.href&&o.toggle(),"link"===e.type&&o.toggle()},level:1}))};function oe(e){return a.createElement(ne.Zo,{component:le,props:e})}const re=a.memo(oe);function ce(e){const t=(0,g.i)(),n="desktop"===t||"ssr"===t,l="mobile"===t;return a.createElement(a.Fragment,null,n&&a.createElement(te,e),l&&a.createElement(re,e))}const ie="expandButton_m80_",se="expandButtonIcon_BlDH";function de(e){let{toggleSidebar:t}=e;return a.createElement("div",{className:ie,title:(0,u.I)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,u.I)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:t,onClick:t},a.createElement(I,{className:se}))}const me="docSidebarContainer_b6E3",ue="docSidebarContainerHidden_b3ry";function be(e){let{children:t}=e;const n=(0,d.V)();return a.createElement(a.Fragment,{key:(null==n?void 0:n.name)??"noSidebar"},t)}function pe(e){let{sidebar:t,hiddenSidebarContainer:n,setHiddenSidebarContainer:o}=e;const{pathname:c}=(0,v.TH)(),[i,s]=(0,a.useState)(!1),d=(0,a.useCallback)((()=>{i&&s(!1),o((e=>!e))}),[o,i]);return a.createElement("aside",{className:(0,l.Z)(r.k.docs.docSidebarContainer,me,n&&ue),onTransitionEnd:e=>{e.currentTarget.classList.contains(me)&&n&&s(!0)}},a.createElement(be,null,a.createElement(ce,{sidebar:t,path:c,onCollapse:d,isHidden:i})),i&&a.createElement(de,{toggleSidebar:d}))}const he={docMainContainer:"docMainContainer_gTbr",docMainContainerEnhanced:"docMainContainerEnhanced_Uz_u",docItemWrapperEnhanced:"docItemWrapperEnhanced_czyv"};function Ee(e){let{hiddenSidebarContainer:t,children:n}=e;const o=(0,d.V)();return a.createElement("main",{className:(0,l.Z)(he.docMainContainer,(t||!o)&&he.docMainContainerEnhanced)},a.createElement("div",{className:(0,l.Z)("container padding-top--md padding-bottom--lg",he.docItemWrapper,t&&he.docItemWrapperEnhanced)},n))}const fe="docPage__5DB",ve="docsWrapper_BCFX";function ge(e){let{children:t}=e;const n=(0,d.V)(),[l,o]=(0,a.useState)(!1);return a.createElement(m.Z,{wrapperClassName:ve},a.createElement(f,null),a.createElement("div",{className:fe},n&&a.createElement(pe,{sidebar:n.items,hiddenSidebarContainer:l,setHiddenSidebarContainer:o}),a.createElement(Ee,{hiddenSidebarContainer:l},t)))}var _e=n(4972),ke=n(197);function Ce(e){const{versionMetadata:t}=e;return a.createElement(a.Fragment,null,a.createElement(ke.Z,{version:t.version,tag:(0,c.os)(t.pluginId,t.version)}),a.createElement(o.d,null,t.noIndex&&a.createElement("meta",{name:"robots",content:"noindex, nofollow"})))}function Ie(e){const{versionMetadata:t}=e,n=(0,i.hI)(e);if(!n)return a.createElement(_e.default,null);const{docElement:c,sidebarName:m,sidebarItems:u}=n;return a.createElement(a.Fragment,null,a.createElement(Ce,e),a.createElement(o.FG,{className:(0,l.Z)(r.k.wrapper.docsPages,r.k.page.docsDocPage,e.versionMetadata.className)},a.createElement(s.q,{version:t},a.createElement(d.b,{name:m,items:u},a.createElement(ge,null,c)))))}},4972:(e,t,n)=>{n.r(t),n.d(t,{default:()=>c});var a=n(7294),l=n(5999),o=n(1944),r=n(3285);function c(){return a.createElement(a.Fragment,null,a.createElement(o.d,{title:(0,l.I)({id:"theme.NotFound.title",message:"Page Not Found"})}),a.createElement(r.Z,null,a.createElement("main",{className:"container margin-vert--xl"},a.createElement("div",{className:"row"},a.createElement("div",{className:"col col--6 col--offset-3"},a.createElement("h1",{className:"hero__title"},a.createElement(l.Z,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),a.createElement("p",null,a.createElement(l.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page"},"We could not find what you were looking for.")),a.createElement("p",null,a.createElement(l.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page"},"Please contact the owner of the site that linked you to the original URL and let them know their link is broken.")))))))}},4477:(e,t,n)=>{n.d(t,{E:()=>c,q:()=>r});var a=n(7294),l=n(902);const o=a.createContext(null);function r(e){let{children:t,version:n}=e;return a.createElement(o.Provider,{value:n},t)}function c(){const e=(0,a.useContext)(o);if(null===e)throw new l.i6("DocsVersionProvider");return e}}}]); \ No newline at end of file diff --git a/assets/js/1cd93e92.e54ec8a4.js b/assets/js/1cd93e92.e54ec8a4.js new file mode 100644 index 0000000..0a52b0c --- /dev/null +++ b/assets/js/1cd93e92.e54ec8a4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5124],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,s=e.parentName,h=o(e,["components","mdxType","originalType","parentName"]),u=l(r),m=n,f=u["".concat(s,".").concat(m)]||u[m]||d[m]||p;return r?a.createElement(f,i(i({ref:t},h),{},{components:r})):a.createElement(f,i({ref:t},h))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,i=new Array(p);i[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:n,i[1]=o;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const p={id:"graphhopper.GraphHopperMatrixParams",title:"Interface: GraphHopperMatrixParams",sidebar_label:"GraphHopperMatrixParams",custom_edit_url:null},i=void 0,o={unversionedId:"api/interfaces/graphhopper.GraphHopperMatrixParams",id:"api/interfaces/graphhopper.GraphHopperMatrixParams",title:"Interface: GraphHopperMatrixParams",description:"graphhopper.GraphHopperMatrixParams",source:"@site/docs/api/interfaces/graphhopper.GraphHopperMatrixParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperMatrixParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperMatrixParams",title:"Interface: GraphHopperMatrixParams",sidebar_label:"GraphHopperMatrixParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperMatrixOpts",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts"},next:{title:"GraphHopperMatrixResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"fail_fast",id:"fail_fast",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"from_curbsides",id:"from_curbsides",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"from_point_hints",id:"from_point_hints",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"from_points",id:"from_points",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"out_arrays",id:"out_arrays",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"profile",id:"profile",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"snap_preventions",id:"snap_preventions",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"to_curbsides",id:"to_curbsides",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"to_point_hints",id:"to_point_hints",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"to_points",id:"to_points",level:3},{value:"Defined in",id:"defined-in-9",level:4}],h={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperMatrixParams"),(0,n.kt)("p",null,"All parameters accepted by the ",(0,n.kt)("inlineCode",{parentName:"p"},"/matrix")," endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"GraphHopperBaseParams")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"GraphHopperMatrixParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fail_fast"},"fail","_","fast"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fail","_","fast"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Specifies whether or not the matrix calculation should return with an error as soon as\npossible in case some points cannot be found or some points are not connected. If set\nto false the time/weight/distance matrix will be calculated for all valid points and contain\nthe null value for all entries that could not be calculated. The hint field of the response\nwill also contain additional information about what went wrong."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Defaults to true."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L336"},"packages/graphhopper/parameters.ts:336")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"from_curbsides"},"from","_","curbsides"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"from","_","curbsides"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"GraphHopperCurbside"),"[]"),(0,n.kt)("p",null,"Specifies on which side a point should be relative to the driver when she leaves/arrives\nat a start/target/via point. You need to specify this parameter for either none or all points.\nOnly supported for motor vehicles and OpenStreetMap."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Array length needs to match ",(0,n.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L308"},"packages/graphhopper/parameters.ts:308")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"from_point_hints"},"from","_","point","_","hints"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"from","_","point","_","hints"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Specifies a hint for each ",(0,n.kt)("inlineCode",{parentName:"p"},"from_point")," parameter to prefer a certain street for the closest\nlocation lookup. E.g. if there is an address or house with two or more neighboring streets\nyou can control for which street the closest location is looked up."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Array length needs to match ",(0,n.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L280"},"packages/graphhopper/parameters.ts:280")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"from_points"},"from","_","points"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"from","_","points"),": ","[",(0,n.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,n.kt)("p",null,"The starting points for the routes in an array of ","[longitude,latitude]",".\nFor instance, if you want to calculate three routes from point A such as A-",">","1, A-",">","2, A-",">","3\nthen you have one from_point parameter and three to_point parameters."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L267"},"packages/graphhopper/parameters.ts:267")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"out_arrays"},"out","_","arrays"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"out","_","arrays"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"GraphHopperMatrixOut"),"[]"),(0,n.kt)("p",null,"Specifies which arrays should be included in the response. Specify one or more of\nthe following options 'weights', 'times', 'distances'. To specify more than one array\nuse e.g. out_array=times&out_array=distances. The units of the entries of distances\nare meters, of times are seconds and of weights is arbitrary and it can differ for different\nvehicles or versions of this API."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L325"},"packages/graphhopper/parameters.ts:325")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"profile"},"profile"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"profile"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile"))),(0,n.kt)("p",null,"The vehicle for which the route should be calculated."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"GraphHopperBaseParams.profile"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L9"},"packages/graphhopper/parameters.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"snap_preventions"},"snap","_","preventions"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"snap","_","preventions"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Optional parameter to avoid snapping to a certain road class or road environment.\nMultiple values are specified like ",(0,n.kt)("inlineCode",{parentName:"p"},"snap_prevention=ferry&snap_prevention=motorway"),'.\nPlease note that this feature does not e.g. avoid motorways for the route - it\nonly avoids it for the "location snap".'),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Array length needs to match ",(0,n.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L299"},"packages/graphhopper/parameters.ts:299")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"to_curbsides"},"to","_","curbsides"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"to","_","curbsides"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"GraphHopperCurbside"),"[]"),(0,n.kt)("p",null,"Specifies on which side a point should be relative to the driver when she leaves/arrives\nat a start/target/via point. You need to specify this parameter for either none or all points.\nOnly supported for motor vehicles and OpenStreetMap."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Array length needs to match ",(0,n.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L317"},"packages/graphhopper/parameters.ts:317")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"to_point_hints"},"to","_","point","_","hints"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"to","_","point","_","hints"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Specifies a hint for each ",(0,n.kt)("inlineCode",{parentName:"p"},"from_point")," parameter to prefer a certain street for the closest\nlocation lookup. E.g. if there is an address or house with two or more neighboring streets\nyou can control for which street the closest location is looked up."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Array length needs to match ",(0,n.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L289"},"packages/graphhopper/parameters.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"to_points"},"to","_","points"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"to","_","points"),": ","[",(0,n.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,n.kt)("p",null,"The destination points for the routes in an array of ","[longitude,latitude]","."),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L271"},"packages/graphhopper/parameters.ts:271")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1df93b7f.f73b5933.js b/assets/js/1df93b7f.f73b5933.js new file mode 100644 index 0000000..c42eb36 --- /dev/null +++ b/assets/js/1df93b7f.f73b5933.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3237],{6535:(e,t,n)=>{n.d(t,{Z:()=>i});var r,a,l=n(7294);function c(){return c=Object.assign?Object.assign.bind():function(e){for(var t=1;t{let{title:t,titleId:n,...i}=e;return l.createElement("svg",c({xmlns:"http://www.w3.org/2000/svg",className:"icon icon-tabler icon-tabler-braces",width:24,height:24,viewBox:"0 0 24 24",strokeWidth:2,stroke:"currentColor",fill:"none",strokeLinecap:"round",strokeLinejoin:"round","aria-labelledby":n},i),t?l.createElement("title",{id:n},t):null,r||(r=l.createElement("path",{d:"M0 0h24v24H0z",stroke:"none"})),a||(a=l.createElement("path",{d:"M7 4a2 2 0 0 0-2 2v3a2 3 0 0 1-2 3 2 3 0 0 1 2 3v3a2 2 0 0 0 2 2M17 4a2 2 0 0 1 2 2v3a2 3 0 0 0 2 3 2 3 0 0 0-2 3v3a2 2 0 0 1-2 2"})))}},5028:(e,t,n)=>{n.d(t,{Z:()=>o});var r,a,l,c=n(7294);function i(){return i=Object.assign?Object.assign.bind():function(e){for(var t=1;t{let{title:t,titleId:n,...o}=e;return c.createElement("svg",i({xmlns:"http://www.w3.org/2000/svg",className:"icon icon-tabler icon-tabler-settings-off",width:24,height:24,viewBox:"0 0 24 24",strokeWidth:2,stroke:"currentColor",fill:"none",strokeLinecap:"round",strokeLinejoin:"round","aria-labelledby":n},o),t?c.createElement("title",{id:n},t):null,r||(r=c.createElement("path",{d:"M0 0h24v24H0z",stroke:"none"})),a||(a=c.createElement("path",{d:"M9.456 5.435c.416-.22.745-.609.869-1.118.426-1.756 2.924-1.756 3.35 0a1.724 1.724 0 0 0 2.573 1.066c1.543-.94 3.31.826 2.37 2.37a1.724 1.724 0 0 0 1.065 2.572c1.756.426 1.756 2.924 0 3.35a1.724 1.724 0 0 0-1.187 1.016m-.126 3.666c-.516.522-1.348.733-2.123.261a1.724 1.724 0 0 0-2.572 1.065c-.426 1.756-2.924 1.756-3.35 0a1.724 1.724 0 0 0-2.573-1.066c-1.543.94-3.31-.826-2.37-2.37a1.724 1.724 0 0 0-1.065-2.572c-1.756-.426-1.756-2.924 0-3.35a1.724 1.724 0 0 0 1.066-2.573c-.468-.768-.266-1.59.246-2.108"})),l||(l=c.createElement("path",{d:"M9.879 9.878a3 3 0 1 0 4.256 4.23m.552-3.444a3.012 3.012 0 0 0-1.412-1.38M3 3l18 18"})))}},9539:(e,t,n)=>{n.d(t,{Z:()=>s});var r,a,l,c,i=n(7294);function o(){return o=Object.assign?Object.assign.bind():function(e){for(var t=1;t{let{title:t,titleId:n,...s}=e;return i.createElement("svg",o({xmlns:"http://www.w3.org/2000/svg",className:"icon icon-tabler icon-tabler-switch-3",width:24,height:24,viewBox:"0 0 24 24",strokeWidth:2,stroke:"currentColor",fill:"none",strokeLinecap:"round",strokeLinejoin:"round","aria-labelledby":n},s),t?i.createElement("title",{id:n},t):null,r||(r=i.createElement("path",{d:"M0 0h24v24H0z",stroke:"none"})),a||(a=i.createElement("path",{d:"M3 17h2.397a5 5 0 0 0 4.096-2.133l.177-.253m3.66-5.227.177-.254A5 5 0 0 1 17.603 7H21"})),l||(l=i.createElement("path",{d:"m18 4 3 3-3 3M3 7h2.397a5 5 0 0 1 4.096 2.133l4.014 5.734A5 5 0 0 0 17.603 17H21"})),c||(c=i.createElement("path",{d:"m18 20 3-3-3-3"})))}},8391:(e,t,n)=>{n.r(t),n.d(t,{default:()=>f});var r=n(7294),a=n(6010),l=n(9960),c=n(2263),i=n(3285),o=n(7462);const s="features_t9lD",m="featureSvg_GfXr",u="smallprint_z2jB",d=[{title:"Quick setup",Svg:n(5028).Z,description:r.createElement(r.Fragment,null,"Hook into public APIs of Valhalla, OSRM, GraphHopper* and OpenRouteService* with no setup.")},{title:"A unified API",Svg:n(9539).Z,description:r.createElement(r.Fragment,null,"With routing-js it has never been easier to switch between different routing engines.")},{title:"The Power of TypeScript",Svg:n(6535).Z,description:r.createElement(r.Fragment,null,"Full code completion in your IDE for all API's parameters, thanks to TypeScript, even if you use JavaScript.")}];function h(e){let{title:t,Svg:n,description:l}=e;return r.createElement("div",{className:(0,a.Z)("col col--4")},r.createElement("div",{className:"text--center"},r.createElement(n,{className:m,role:"img"})),r.createElement("div",{className:"text--center padding-horiz--md"},r.createElement("h3",null,t),r.createElement("p",null,l)))}function p(){return r.createElement(r.Fragment,null,r.createElement("section",{className:s},r.createElement("div",{className:"container"},r.createElement("div",{className:"row"},d.map(((e,t)=>r.createElement(h,(0,o.Z)({key:t},e))))))),r.createElement("div",{className:u},"* API keys required"))}const v="heroBanner_qdFl",g="buttons_AeoN";function E(){const{siteConfig:e}=(0,c.Z)();return r.createElement("header",{className:(0,a.Z)("hero hero--primary",v)},r.createElement("div",{className:"container"},r.createElement("h1",{className:"hero__title"},e.title),r.createElement("p",{className:"hero__subtitle"},e.tagline),r.createElement("div",{className:g},r.createElement(l.Z,{className:"button button--secondary button--lg",to:"/docs/quickstart"},"Quickstart"))))}function f(){const{siteConfig:e}=(0,c.Z)();return r.createElement(i.Z,{title:`${e.title}`,description:"Documentation for the RoutingJS npm package."},r.createElement(E,null),r.createElement("main",null,r.createElement(p,null)))}}}]); \ No newline at end of file diff --git a/assets/js/1f391b9e.c498ac94.js b/assets/js/1f391b9e.c498ac94.js new file mode 100644 index 0000000..1a43fd0 --- /dev/null +++ b/assets/js/1f391b9e.c498ac94.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3085],{4247:(e,t,a)=>{a.r(t),a.d(t,{default:()=>d});var l=a(7294),n=a(6010),c=a(1944),r=a(5281),m=a(3285),s=a(210),i=a(9407);const o="mdxPageWrapper_j9I6";function d(e){const{content:t}=e,{metadata:{title:a,description:d,frontMatter:p}}=t,{wrapperClassName:u,hide_table_of_contents:g}=p;return l.createElement(c.FG,{className:(0,n.Z)(u??r.k.wrapper.mdxPages,r.k.page.mdxPage)},l.createElement(c.d,{title:a,description:d}),l.createElement(m.Z,null,l.createElement("main",{className:"container container--fluid margin-vert--lg"},l.createElement("div",{className:(0,n.Z)("row",o)},l.createElement("div",{className:(0,n.Z)("col",!g&&"col--8")},l.createElement("article",null,l.createElement(s.Z,null,l.createElement(t,null)))),!g&&t.toc.length>0&&l.createElement("div",{className:"col col--2"},l.createElement(i.Z,{toc:t.toc,minHeadingLevel:p.toc_min_heading_level,maxHeadingLevel:p.toc_max_heading_level}))))))}}}]); \ No newline at end of file diff --git a/assets/js/23817249.2b67b94e.js b/assets/js/23817249.2b67b94e.js new file mode 100644 index 0000000..cba70c9 --- /dev/null +++ b/assets/js/23817249.2b67b94e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6030],{3905:(e,a,t)=>{t.d(a,{Zo:()=>d,kt:()=>c});var n=t(7294);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function i(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);a&&(n=n.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,n)}return t}function o(e){for(var a=1;a=0||(l[t]=e[t]);return l}(e,a);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(l[t]=e[t])}return l}var s=n.createContext({}),p=function(e){var a=n.useContext(s),t=a;return e&&(t="function"==typeof e?e(a):o(o({},a),e)),t},d=function(e){var a=p(e.components);return n.createElement(s.Provider,{value:a},e.children)},u={inlineCode:"code",wrapper:function(e){var a=e.children;return n.createElement(n.Fragment,{},a)}},h=n.forwardRef((function(e,a){var t=e.components,l=e.mdxType,i=e.originalType,s=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),h=p(t),c=l,m=h["".concat(s,".").concat(c)]||h[c]||u[c]||i;return t?n.createElement(m,o(o({ref:a},d),{},{components:t})):n.createElement(m,o({ref:a},d))}));function c(e,a){var t=arguments,l=a&&a.mdxType;if("string"==typeof e||l){var i=t.length,o=new Array(i);o[0]=h;var r={};for(var s in a)hasOwnProperty.call(a,s)&&(r[s]=a[s]);r.originalType=e,r.mdxType="string"==typeof e?e:l,o[1]=r;for(var p=2;p{t.r(a),t.d(a,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>p});var n=t(7462),l=(t(7294),t(3905));const i={id:"valhalla.ValhallaIsochroneParams",title:"Interface: ValhallaIsochroneParams",sidebar_label:"ValhallaIsochroneParams",custom_edit_url:null},o=void 0,r={unversionedId:"api/interfaces/valhalla.ValhallaIsochroneParams",id:"api/interfaces/valhalla.ValhallaIsochroneParams",title:"Interface: ValhallaIsochroneParams",description:"valhalla.ValhallaIsochroneParams",source:"@site/docs/api/interfaces/valhalla.ValhallaIsochroneParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaIsochroneParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaIsochroneParams",title:"Interface: ValhallaIsochroneParams",sidebar_label:"ValhallaIsochroneParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaIsochroneOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts"},next:{title:"ValhallaIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"contours",id:"contours",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costing",id:"costing",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"costing_options",id:"costing_options",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"date_time",id:"date_time",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"denoise",id:"denoise",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude_locations",id:"exclude_locations",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"exclude_polygons",id:"exclude_polygons",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"generalize",id:"generalize",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"locations",id:"locations",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"polygons",id:"polygons",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"show_locations",id:"show_locations",level:3},{value:"Defined in",id:"defined-in-11",level:4}],d={toc:p};function u(e){let{components:a,...t}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,t,{components:a,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaIsochroneParams"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaRequestParams")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaIsochroneParams"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"contours"},"contours"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"contours"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaContours"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaContours")),"[]"),(0,l.kt)("p",null,"A JSON array of contour objects with the time in minutes or distance in kilometers and\ncolor to use for each isochrone contour. You can specify up to four contours (by default)."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L122"},"packages/valhalla/parameters.ts:122")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costing"},"costing"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"costing"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("p",null,"Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route\nrequest must include the name of the costing model and can include optional parameters available\nfor the chosen costing model."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.costing"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L81"},"packages/valhalla/parameters.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costing_options"},"costing","_","options"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"costing","_","options"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptTypes")),(0,l.kt)("p",null,"Costing methods can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.costing","_","options"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L86"},"packages/valhalla/parameters.ts:86")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"date_time"},"date","_","time"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"date","_","time"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDateTime"))),(0,l.kt)("p",null,"The local date and time at the location. These parameters apply only for multimodal\nrequests and are not used with other costing methods."),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L117"},"packages/valhalla/parameters.ts:117")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"denoise"},"denoise"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"denoise"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A floating point value from 0 to 1 (default of 1) which can be used to remove smaller contours.\nA value of 1 will only return the largest contour for a given time value. A value of 0.5 drops\nany contours that are less than half the area of the largest contour in the set of contours for\nthat same time value."),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L137"},"packages/valhalla/parameters.ts:137")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exclude_locations"},"exclude","_","locations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"exclude","_","locations"),": ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,l.kt)("p",null,"A set of locations to exclude or avoid within a route can be specified using a JSON array\nof avoid_locations. The avoid_locations have the same format as the locations list. At a\nminimum each avoid location must include latitude and longitude. The avoid_locations are\nmapped to the closest road or roads and these roads are excluded from the route path computation."),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.exclude","_","locations"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L97"},"packages/valhalla/parameters.ts:97")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exclude_polygons"},"exclude","_","polygons"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"exclude","_","polygons"),": ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]","[] ","|"," ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]","[][]"),(0,l.kt)("p",null,"One or multiple exterior rings of polygons in the form of nested JSON arrays, e.g.\n[[","[lon1, lat1]",", ","[lon2,lat2]","],[","[lon1,lat1]",",","[lon2,lat2]","]]. Roads intersecting these rings\nwill be avoided during path finding. If you only need to avoid a few specific roads,\nit's much more efficient to use exclude_locations. Valhalla will close open rings (i.e.\ncopy the first coordingate to the last position)."),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.exclude","_","polygons"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L105"},"packages/valhalla/parameters.ts:105")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"generalize"},"generalize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"generalize"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A floating point value in meters used as the tolerance for Douglas-Peucker generalization."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note: Generalization of contours can lead to self-intersections, as well as intersections of\nadjacent contours."),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L145"},"packages/valhalla/parameters.ts:145")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"Name your route request. If id is specified, the naming will be sent thru to the response."),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.id"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L90"},"packages/valhalla/parameters.ts:90")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"locations"},"locations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"locations"),": [",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"]"),(0,l.kt)("p",null,"Only single location can be specified."),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L112"},"packages/valhalla/parameters.ts:112")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"polygons"},"polygons"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"polygons"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A Boolean value to determine whether to return geojson polygons or linestrings as the contours.\nThe default is false, which returns lines; when true, polygons are returned."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"When polygons is true, any contour that forms a ring is returned as a polygon."),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L130"},"packages/valhalla/parameters.ts:130")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"show_locations"},"show","_","locations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"show","_","locations"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean indicating whether the input locations should be returned as MultiPoint features:\none feature for the exact input coordinates and one feature for the coordinates of the network\nnode it snapped to."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default false."),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L154"},"packages/valhalla/parameters.ts:154")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2666.ce488b35.js b/assets/js/2666.ce488b35.js new file mode 100644 index 0000000..d506472 --- /dev/null +++ b/assets/js/2666.ce488b35.js @@ -0,0 +1 @@ +(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2666],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>u,kt:()=>p});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var i=o.createContext({}),s=function(e){var t=o.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=s(e.components);return o.createElement(i.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,i=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),d=s(n),p=r,f=d["".concat(i,".").concat(p)]||d[p]||m[p]||a;return n?o.createElement(f,l(l({ref:t},u),{},{components:n})):o.createElement(f,l({ref:t},u))}));function p(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=d;var c={};for(var i in t)hasOwnProperty.call(t,i)&&(c[i]=t[i]);c.originalType=e,c.mdxType="string"==typeof e?e:r,l[1]=c;for(var s=2;s{"use strict";n.d(t,{Z:()=>u});var o=n(7462),r=n(7294),a=n(6010),l=n(5999),c=n(6668);const i="anchorWithStickyNavbar_LWe7",s="anchorWithHideOnScrollNavbar_WYt5";function u(e){let{as:t,id:n,...u}=e;const{navbar:{hideOnScroll:m}}=(0,c.L)();return"h1"!==t&&n?r.createElement(t,(0,o.Z)({},u,{className:(0,a.Z)("anchor",m?s:i),id:n}),u.children,r.createElement("a",{className:"hash-link",href:`#${n}`,title:(0,l.I)({id:"theme.common.headingLinkTitle",message:"Direct link to heading",description:"Title for link to heading"})},"\u200b")):r.createElement(t,(0,o.Z)({},u,{id:void 0}))}},210:(e,t,n)=>{"use strict";n.d(t,{Z:()=>ve});var o=n(7294),r=n(3905),a=n(7462),l=n(5742);var c=n(2389),i=n(6010),s=n(2949),u=n(6668);function m(){const{prism:e}=(0,u.L)(),{colorMode:t}=(0,s.I)(),n=e.theme,o=e.darkTheme||n;return"dark"===t?o:n}var d=n(5281),p=n(7594),f=n.n(p);const h=/title=(?["'])(?.*?)\1/,g=/\{(?<range>[\d,-]+)\}/,v={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}};function y(e,t){const n=e.map((e=>{const{start:n,end:o}=v[e];return`(?:${n}\\s*(${t.flatMap((e=>{var t,n;return[e.line,null==(t=e.block)?void 0:t.start,null==(n=e.block)?void 0:n.end].filter(Boolean)})).join("|")})\\s*${o})`})).join("|");return new RegExp(`^\\s*(?:${n})\\s*$`)}function b(e,t){let n=e.replace(/\n$/,"");const{language:o,magicComments:r,metastring:a}=t;if(a&&g.test(a)){const e=a.match(g).groups.range;if(0===r.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${a}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const t=r[0].className,o=f()(e).filter((e=>e>0)).map((e=>[e-1,[t]]));return{lineClassNames:Object.fromEntries(o),code:n}}if(void 0===o)return{lineClassNames:{},code:n};const l=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return y(["js","jsBlock"],t);case"jsx":case"tsx":return y(["js","jsBlock","jsx"],t);case"html":return y(["js","jsBlock","html"],t);case"python":case"py":case"bash":return y(["bash"],t);case"markdown":case"md":return y(["html","jsx","bash"],t);default:return y(Object.keys(v),t)}}(o,r),c=n.split("\n"),i=Object.fromEntries(r.map((e=>[e.className,{start:0,range:""}]))),s=Object.fromEntries(r.filter((e=>e.line)).map((e=>{let{className:t,line:n}=e;return[n,t]}))),u=Object.fromEntries(r.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.start,t]}))),m=Object.fromEntries(r.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.end,t]})));for(let p=0;p<c.length;){const e=c[p].match(l);if(!e){p+=1;continue}const t=e.slice(1).find((e=>void 0!==e));s[t]?i[s[t]].range+=`${p},`:u[t]?i[u[t]].start=p:m[t]&&(i[m[t]].range+=`${i[m[t]].start}-${p-1},`),c.splice(p,1)}n=c.join("\n");const d={};return Object.entries(i).forEach((e=>{let[t,{range:n}]=e;f()(n).forEach((e=>{d[e]??=[],d[e].push(t)}))})),{lineClassNames:d,code:n}}const E="codeBlockContainer_Ckt0";function k(e){let{as:t,...n}=e;const r=function(e){const t={color:"--prism-color",backgroundColor:"--prism-background-color"},n={};return Object.entries(e.plain).forEach((e=>{let[o,r]=e;const a=t[o];a&&"string"==typeof r&&(n[a]=r)})),n}(m());return o.createElement(t,(0,a.Z)({},n,{style:r,className:(0,i.Z)(n.className,E,d.k.common.codeBlock)}))}const N={codeBlockContent:"codeBlockContent_biex",codeBlockTitle:"codeBlockTitle_Ktv7",codeBlock:"codeBlock_bY9V",codeBlockStandalone:"codeBlockStandalone_MEMb",codeBlockLines:"codeBlockLines_e6Vv",codeBlockLinesWithNumbering:"codeBlockLinesWithNumbering_o6Pm",buttonGroup:"buttonGroup__atx"};function C(e){let{children:t,className:n}=e;return o.createElement(k,{as:"pre",tabIndex:0,className:(0,i.Z)(N.codeBlockStandalone,"thin-scrollbar",n)},o.createElement("code",{className:N.codeBlockLines},t))}var L=n(902);const w={attributes:!0,characterData:!0,childList:!0,subtree:!0};function B(e,t){const[n,r]=(0,o.useState)(),a=(0,o.useCallback)((()=>{var t;r(null==(t=e.current)?void 0:t.closest("[role=tabpanel][hidden]"))}),[e,r]);(0,o.useEffect)((()=>{a()}),[a]),function(e,t,n){void 0===n&&(n=w);const r=(0,L.zX)(t),a=(0,L.Ql)(n);(0,o.useEffect)((()=>{const t=new MutationObserver(r);return e&&t.observe(e,a),()=>t.disconnect()}),[e,r,a])}(n,(e=>{e.forEach((e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(t(),a())}))}),{attributes:!0,characterData:!1,childList:!1,subtree:!1})}const x={plain:{backgroundColor:"#2a2734",color:"#9a86fd"},styles:[{types:["comment","prolog","doctype","cdata","punctuation"],style:{color:"#6c6783"}},{types:["namespace"],style:{opacity:.7}},{types:["tag","operator","number"],style:{color:"#e09142"}},{types:["property","function"],style:{color:"#9a86fd"}},{types:["tag-id","selector","atrule-id"],style:{color:"#eeebff"}},{types:["attr-name"],style:{color:"#c4b9fe"}},{types:["boolean","string","entity","url","attr-value","keyword","control","directive","unit","statement","regex","atrule","placeholder","variable"],style:{color:"#ffcc99"}},{types:["deleted"],style:{textDecorationLine:"line-through"}},{types:["inserted"],style:{textDecorationLine:"underline"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["important","bold"],style:{fontWeight:"bold"}},{types:["important"],style:{color:"#c4b9fe"}}]};var T={Prism:n(7410).Z,theme:x};function O(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function Z(){return Z=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},Z.apply(this,arguments)}var j=/\r\n|\r|\n/,_=function(e){0===e.length?e.push({types:["plain"],content:"\n",empty:!0}):1===e.length&&""===e[0].content&&(e[0].content="\n",e[0].empty=!0)},H=function(e,t){var n=e.length;return n>0&&e[n-1]===t?e:e.concat(t)},S=function(e,t){var n=e.plain,o=Object.create(null),r=e.styles.reduce((function(e,n){var o=n.languages,r=n.style;return o&&!o.includes(t)||n.types.forEach((function(t){var n=Z({},e[t],r);e[t]=n})),e}),o);return r.root=n,r.plain=Z({},n,{backgroundColor:null}),r};function A(e,t){var n={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&-1===t.indexOf(o)&&(n[o]=e[o]);return n}const P=function(e){function t(){for(var t=this,n=[],o=arguments.length;o--;)n[o]=arguments[o];e.apply(this,n),O(this,"getThemeDict",(function(e){if(void 0!==t.themeDict&&e.theme===t.prevTheme&&e.language===t.prevLanguage)return t.themeDict;t.prevTheme=e.theme,t.prevLanguage=e.language;var n=e.theme?S(e.theme,e.language):void 0;return t.themeDict=n})),O(this,"getLineProps",(function(e){var n=e.key,o=e.className,r=e.style,a=Z({},A(e,["key","className","style","line"]),{className:"token-line",style:void 0,key:void 0}),l=t.getThemeDict(t.props);return void 0!==l&&(a.style=l.plain),void 0!==r&&(a.style=void 0!==a.style?Z({},a.style,r):r),void 0!==n&&(a.key=n),o&&(a.className+=" "+o),a})),O(this,"getStyleForToken",(function(e){var n=e.types,o=e.empty,r=n.length,a=t.getThemeDict(t.props);if(void 0!==a){if(1===r&&"plain"===n[0])return o?{display:"inline-block"}:void 0;if(1===r&&!o)return a[n[0]];var l=o?{display:"inline-block"}:{},c=n.map((function(e){return a[e]}));return Object.assign.apply(Object,[l].concat(c))}})),O(this,"getTokenProps",(function(e){var n=e.key,o=e.className,r=e.style,a=e.token,l=Z({},A(e,["key","className","style","token"]),{className:"token "+a.types.join(" "),children:a.content,style:t.getStyleForToken(a),key:void 0});return void 0!==r&&(l.style=void 0!==l.style?Z({},l.style,r):r),void 0!==n&&(l.key=n),o&&(l.className+=" "+o),l})),O(this,"tokenize",(function(e,t,n,o){var r={code:t,grammar:n,language:o,tokens:[]};e.hooks.run("before-tokenize",r);var a=r.tokens=e.tokenize(r.code,r.grammar,r.language);return e.hooks.run("after-tokenize",r),a}))}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.render=function(){var e=this.props,t=e.Prism,n=e.language,o=e.code,r=e.children,a=this.getThemeDict(this.props),l=t.languages[n];return r({tokens:function(e){for(var t=[[]],n=[e],o=[0],r=[e.length],a=0,l=0,c=[],i=[c];l>-1;){for(;(a=o[l]++)<r[l];){var s=void 0,u=t[l],m=n[l][a];if("string"==typeof m?(u=l>0?u:["plain"],s=m):(u=H(u,m.type),m.alias&&(u=H(u,m.alias)),s=m.content),"string"==typeof s){var d=s.split(j),p=d.length;c.push({types:u,content:d[0]});for(var f=1;f<p;f++)_(c),i.push(c=[]),c.push({types:u,content:d[f]})}else l++,t.push(u),n.push(s),o.push(0),r.push(s.length)}l--,t.pop(),n.pop(),o.pop(),r.pop()}return _(c),i}(void 0!==l?this.tokenize(t,o,l,n):[o]),className:"prism-code language-"+n,style:void 0!==a?a.root:{},getLineProps:this.getLineProps,getTokenProps:this.getTokenProps})},t}(o.Component),z="codeLine_lJS_",I="codeLineNumber_Tfdd",M="codeLineContent_feaV";function D(e){let{line:t,classNames:n,showLineNumbers:r,getLineProps:l,getTokenProps:c}=e;1===t.length&&"\n"===t[0].content&&(t[0].content="");const s=l({line:t,className:(0,i.Z)(n,r&&z)}),u=t.map(((e,t)=>o.createElement("span",(0,a.Z)({key:t},c({token:e,key:t})))));return o.createElement("span",s,r?o.createElement(o.Fragment,null,o.createElement("span",{className:I}),o.createElement("span",{className:M},u)):u,o.createElement("br",null))}var R=n(5999);const V={copyButtonCopied:"copyButtonCopied_obH4",copyButtonIcons:"copyButtonIcons_eSgA",copyButtonIcon:"copyButtonIcon_y97N",copyButtonSuccessIcon:"copyButtonSuccessIcon_LjdS"};function $(e){let{code:t,className:n}=e;const[r,a]=(0,o.useState)(!1),l=(0,o.useRef)(void 0),c=(0,o.useCallback)((()=>{!function(e,t){let{target:n=document.body}=void 0===t?{}:t;const o=document.createElement("textarea"),r=document.activeElement;o.value=e,o.setAttribute("readonly",""),o.style.contain="strict",o.style.position="absolute",o.style.left="-9999px",o.style.fontSize="12pt";const a=document.getSelection();let l=!1;a.rangeCount>0&&(l=a.getRangeAt(0)),n.append(o),o.select(),o.selectionStart=0,o.selectionEnd=e.length;let c=!1;try{c=document.execCommand("copy")}catch{}o.remove(),l&&(a.removeAllRanges(),a.addRange(l)),r&&r.focus()}(t),a(!0),l.current=window.setTimeout((()=>{a(!1)}),1e3)}),[t]);return(0,o.useEffect)((()=>()=>window.clearTimeout(l.current)),[]),o.createElement("button",{type:"button","aria-label":r?(0,R.I)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,R.I)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,R.I)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,i.Z)("clean-btn",n,V.copyButton,r&&V.copyButtonCopied),onClick:c},o.createElement("span",{className:V.copyButtonIcons,"aria-hidden":"true"},o.createElement("svg",{className:V.copyButtonIcon,viewBox:"0 0 24 24"},o.createElement("path",{d:"M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"})),o.createElement("svg",{className:V.copyButtonSuccessIcon,viewBox:"0 0 24 24"},o.createElement("path",{d:"M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"}))))}const W="wordWrapButtonIcon_Bwma",q="wordWrapButtonEnabled_EoeP";function F(e){let{className:t,onClick:n,isEnabled:r}=e;const a=(0,R.I)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return o.createElement("button",{type:"button",onClick:n,className:(0,i.Z)("clean-btn",t,r&&q),"aria-label":a,title:a},o.createElement("svg",{className:W,viewBox:"0 0 24 24","aria-hidden":"true"},o.createElement("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"})))}function U(e){let{children:t,className:n="",metastring:r,title:l,showLineNumbers:c,language:s}=e;const{prism:{defaultLanguage:d,magicComments:p}}=(0,u.L)(),f=s??function(e){const t=e.split(" ").find((e=>e.startsWith("language-")));return null==t?void 0:t.replace(/language-/,"")}(n)??d,g=m(),v=function(){const[e,t]=(0,o.useState)(!1),[n,r]=(0,o.useState)(!1),a=(0,o.useRef)(null),l=(0,o.useCallback)((()=>{const n=a.current.querySelector("code");e?n.removeAttribute("style"):(n.style.whiteSpace="pre-wrap",n.style.overflowWrap="anywhere"),t((e=>!e))}),[a,e]),c=(0,o.useCallback)((()=>{const{scrollWidth:e,clientWidth:t}=a.current,n=e>t||a.current.querySelector("code").hasAttribute("style");r(n)}),[a]);return B(a,c),(0,o.useEffect)((()=>{c()}),[e,c]),(0,o.useEffect)((()=>(window.addEventListener("resize",c,{passive:!0}),()=>{window.removeEventListener("resize",c)})),[c]),{codeBlockRef:a,isEnabled:e,isCodeScrollable:n,toggle:l}}(),y=function(e){var t;return(null==e||null==(t=e.match(h))?void 0:t.groups.title)??""}(r)||l,{lineClassNames:E,code:C}=b(t,{metastring:r,language:f,magicComments:p}),L=c??function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(r);return o.createElement(k,{as:"div",className:(0,i.Z)(n,f&&!n.includes(`language-${f}`)&&`language-${f}`)},y&&o.createElement("div",{className:N.codeBlockTitle},y),o.createElement("div",{className:N.codeBlockContent},o.createElement(P,(0,a.Z)({},T,{theme:g,code:C,language:f??"text"}),(e=>{let{className:t,tokens:n,getLineProps:r,getTokenProps:a}=e;return o.createElement("pre",{tabIndex:0,ref:v.codeBlockRef,className:(0,i.Z)(t,N.codeBlock,"thin-scrollbar")},o.createElement("code",{className:(0,i.Z)(N.codeBlockLines,L&&N.codeBlockLinesWithNumbering)},n.map(((e,t)=>o.createElement(D,{key:t,line:e,getLineProps:r,getTokenProps:a,classNames:E[t],showLineNumbers:L})))))})),o.createElement("div",{className:N.buttonGroup},(v.isEnabled||v.isCodeScrollable)&&o.createElement(F,{className:N.codeButton,onClick:()=>v.toggle(),isEnabled:v.isEnabled}),o.createElement($,{className:N.codeButton,code:C}))))}function G(e){let{children:t,...n}=e;const r=(0,c.Z)(),l=function(e){return o.Children.toArray(e).some((e=>(0,o.isValidElement)(e)))?e:Array.isArray(e)?e.join(""):e}(t),i="string"==typeof l?U:C;return o.createElement(i,(0,a.Z)({key:String(r)},n),l)}var Y=n(9960);var Q=n(6043);const X="details_lb9f",J="isBrowser_bmU9",K="collapsibleContent_i85q";function ee(e){return!!e&&("SUMMARY"===e.tagName||ee(e.parentElement))}function te(e,t){return!!e&&(e===t||te(e.parentElement,t))}function ne(e){let{summary:t,children:n,...r}=e;const l=(0,c.Z)(),s=(0,o.useRef)(null),{collapsed:u,setCollapsed:m}=(0,Q.u)({initialState:!r.open}),[d,p]=(0,o.useState)(r.open);return o.createElement("details",(0,a.Z)({},r,{ref:s,open:d,"data-collapsed":u,className:(0,i.Z)(X,l&&J,r.className),onMouseDown:e=>{ee(e.target)&&e.detail>1&&e.preventDefault()},onClick:e=>{e.stopPropagation();const t=e.target;ee(t)&&te(t,s.current)&&(e.preventDefault(),u?(m(!1),p(!0)):m(!0))}}),t??o.createElement("summary",null,"Details"),o.createElement(Q.z,{lazy:!1,collapsed:u,disableSSRStyle:!0,onCollapseTransitionEnd:e=>{m(e),p(!e)}},o.createElement("div",{className:K},n)))}const oe="details_b_Ee";function re(e){let{...t}=e;return o.createElement(ne,(0,a.Z)({},t,{className:(0,i.Z)("alert alert--info",oe,t.className)}))}var ae=n(2503);function le(e){return o.createElement(ae.Z,e)}const ce="containsTaskList_mC6p";const ie="img_ev3q";const se="admonition_LlT9",ue="admonitionHeading_tbUL",me="admonitionIcon_kALy",de="admonitionContent_S0QG";const pe={note:{infimaClassName:"secondary",iconComponent:function(){return o.createElement("svg",{viewBox:"0 0 14 16"},o.createElement("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"}))},label:o.createElement(R.Z,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)"},"note")},tip:{infimaClassName:"success",iconComponent:function(){return o.createElement("svg",{viewBox:"0 0 12 16"},o.createElement("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"}))},label:o.createElement(R.Z,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)"},"tip")},danger:{infimaClassName:"danger",iconComponent:function(){return o.createElement("svg",{viewBox:"0 0 12 16"},o.createElement("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"}))},label:o.createElement(R.Z,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)"},"danger")},info:{infimaClassName:"info",iconComponent:function(){return o.createElement("svg",{viewBox:"0 0 14 16"},o.createElement("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))},label:o.createElement(R.Z,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)"},"info")},caution:{infimaClassName:"warning",iconComponent:function(){return o.createElement("svg",{viewBox:"0 0 16 16"},o.createElement("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"}))},label:o.createElement(R.Z,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)"},"caution")}},fe={secondary:"note",important:"info",success:"tip",warning:"danger"};function he(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=o.Children.toArray(e),n=t.find((e=>{var t;return o.isValidElement(e)&&"mdxAdmonitionTitle"===(null==(t=e.props)?void 0:t.mdxType)})),r=o.createElement(o.Fragment,null,t.filter((e=>e!==n)));return{mdxAdmonitionTitle:n,rest:r}}(e.children);return{...e,title:e.title??t,children:n}}const ge={head:function(e){const t=o.Children.map(e.children,(e=>o.isValidElement(e)?function(e){var t;if(null!=(t=e.props)&&t.mdxType&&e.props.originalType){const{mdxType:t,originalType:n,...r}=e.props;return o.createElement(e.props.originalType,r)}return e}(e):e));return o.createElement(l.Z,e,t)},code:function(e){const t=["a","abbr","b","br","button","cite","code","del","dfn","em","i","img","input","ins","kbd","label","object","output","q","ruby","s","small","span","strong","sub","sup","time","u","var","wbr"];return o.Children.toArray(e.children).every((e=>{var n;return"string"==typeof e&&!e.includes("\n")||(0,o.isValidElement)(e)&&t.includes(null==(n=e.props)?void 0:n.mdxType)}))?o.createElement("code",e):o.createElement(G,e)},a:function(e){return o.createElement(Y.Z,e)},pre:function(e){var t;return o.createElement(G,(0,o.isValidElement)(e.children)&&"code"===(null==(t=e.children.props)?void 0:t.originalType)?e.children.props:{...e})},details:function(e){const t=o.Children.toArray(e.children),n=t.find((e=>{var t;return o.isValidElement(e)&&"summary"===(null==(t=e.props)?void 0:t.mdxType)})),r=o.createElement(o.Fragment,null,t.filter((e=>e!==n)));return o.createElement(re,(0,a.Z)({},e,{summary:n}),r)},ul:function(e){return o.createElement("ul",(0,a.Z)({},e,{className:(t=e.className,(0,i.Z)(t,(null==t?void 0:t.includes("contains-task-list"))&&ce))}));var t},img:function(e){return o.createElement("img",(0,a.Z)({loading:"lazy"},e,{className:(t=e.className,(0,i.Z)(t,ie))}));var t},h1:e=>o.createElement(le,(0,a.Z)({as:"h1"},e)),h2:e=>o.createElement(le,(0,a.Z)({as:"h2"},e)),h3:e=>o.createElement(le,(0,a.Z)({as:"h3"},e)),h4:e=>o.createElement(le,(0,a.Z)({as:"h4"},e)),h5:e=>o.createElement(le,(0,a.Z)({as:"h5"},e)),h6:e=>o.createElement(le,(0,a.Z)({as:"h6"},e)),admonition:function(e){const{children:t,type:n,title:r,icon:a}=he(e),l=function(e){const t=fe[e]??e;return pe[t]||(console.warn(`No admonition config found for admonition type "${t}". Using Info as fallback.`),pe.info)}(n),c=r??l.label,{iconComponent:s}=l,u=a??o.createElement(s,null);return o.createElement("div",{className:(0,i.Z)(d.k.common.admonition,d.k.common.admonitionType(e.type),"alert",`alert--${l.infimaClassName}`,se)},o.createElement("div",{className:ue},o.createElement("span",{className:me},u),c),o.createElement("div",{className:de},t))},mermaid:n(1875).Z};function ve(e){let{children:t}=e;return o.createElement(r.Zo,{components:ge},t)}},9407:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var o=n(7462),r=n(7294),a=n(6010),l=n(3743);const c="tableOfContents_bqdL";function i(e){let{className:t,...n}=e;return r.createElement("div",{className:(0,a.Z)(c,"thin-scrollbar",t)},r.createElement(l.Z,(0,o.Z)({},n,{linkClassName:"table-of-contents__link toc-highlight",linkActiveClassName:"table-of-contents__link--active"})))}},3743:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var o=n(7462),r=n(7294),a=n(6668);function l(e){const t=e.map((e=>({...e,parentIndex:-1,children:[]}))),n=Array(7).fill(-1);t.forEach(((e,t)=>{const o=n.slice(2,e.level);e.parentIndex=Math.max(...o),n[e.level]=t}));const o=[];return t.forEach((e=>{const{parentIndex:n,...r}=e;n>=0?t[n].children.push(r):o.push(r)})),o}function c(e){let{toc:t,minHeadingLevel:n,maxHeadingLevel:o}=e;return t.flatMap((e=>{const t=c({toc:e.children,minHeadingLevel:n,maxHeadingLevel:o});return function(e){return e.level>=n&&e.level<=o}(e)?[{...e,children:t}]:t}))}function i(e){const t=e.getBoundingClientRect();return t.top===t.bottom?i(e.parentNode):t}function s(e,t){let{anchorTopOffset:n}=t;const o=e.find((e=>i(e).top>=n));if(o){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(i(o))?o:e[e.indexOf(o)-1]??null}return e[e.length-1]??null}function u(){const e=(0,r.useRef)(0),{navbar:{hideOnScroll:t}}=(0,a.L)();return(0,r.useEffect)((()=>{e.current=t?0:document.querySelector(".navbar").clientHeight}),[t]),e}function m(e){const t=(0,r.useRef)(void 0),n=u();(0,r.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:o,linkActiveClassName:r,minHeadingLevel:a,maxHeadingLevel:l}=e;function c(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(o),c=function(e){let{minHeadingLevel:t,maxHeadingLevel:n}=e;const o=[];for(let r=t;r<=n;r+=1)o.push(`h${r}.anchor`);return Array.from(document.querySelectorAll(o.join()))}({minHeadingLevel:a,maxHeadingLevel:l}),i=s(c,{anchorTopOffset:n.current}),u=e.find((e=>i&&i.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,n){n?(t.current&&t.current!==e&&t.current.classList.remove(r),e.classList.add(r),t.current=e):e.classList.remove(r)}(e,e===u)}))}return document.addEventListener("scroll",c),document.addEventListener("resize",c),c(),()=>{document.removeEventListener("scroll",c),document.removeEventListener("resize",c)}}),[e,n])}function d(e){let{toc:t,className:n,linkClassName:o,isChild:a}=e;return t.length?r.createElement("ul",{className:a?void 0:n},t.map((e=>r.createElement("li",{key:e.id},r.createElement("a",{href:`#${e.id}`,className:o??void 0,dangerouslySetInnerHTML:{__html:e.value}}),r.createElement(d,{isChild:!0,toc:e.children,className:n,linkClassName:o}))))):null}const p=r.memo(d);function f(e){let{toc:t,className:n="table-of-contents table-of-contents__left-border",linkClassName:i="table-of-contents__link",linkActiveClassName:s,minHeadingLevel:u,maxHeadingLevel:d,...f}=e;const h=(0,a.L)(),g=u??h.tableOfContents.minHeadingLevel,v=d??h.tableOfContents.maxHeadingLevel,y=function(e){let{toc:t,minHeadingLevel:n,maxHeadingLevel:o}=e;return(0,r.useMemo)((()=>c({toc:l(t),minHeadingLevel:n,maxHeadingLevel:o})),[t,n,o])}({toc:t,minHeadingLevel:g,maxHeadingLevel:v});return m((0,r.useMemo)((()=>{if(i&&s)return{linkClassName:i,linkActiveClassName:s,minHeadingLevel:g,maxHeadingLevel:v}}),[i,s,g,v])),r.createElement(p,(0,o.Z)({toc:y,className:n,linkClassName:i},f))}},7594:(e,t)=>{function n(e){let t,n=[];for(let o of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(o))n.push(parseInt(o,10));else if(t=o.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,o,r,a]=t;if(o&&a){o=parseInt(o),a=parseInt(a);const e=o<a?1:-1;"-"!==r&&".."!==r&&"\u2025"!==r||(a+=e);for(let t=o;t!==a;t+=e)n.push(t)}}return n}t.default=n,e.exports=n}}]); \ No newline at end of file diff --git a/assets/js/27302741.23bac3b0.js b/assets/js/27302741.23bac3b0.js new file mode 100644 index 0000000..e320fbb --- /dev/null +++ b/assets/js/27302741.23bac3b0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7873],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,f=c["".concat(l,".").concat(m)]||c[m]||u[m]||i;return r?n.createElement(f,s(s({ref:t},d),{},{components:r})):n.createElement(f,s({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=c;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var p=2;p<i;p++)s[p]=r[p];return n.createElement.apply(null,s)}return n.createElement.apply(null,r)}c.displayName="MDXCreateElement"},7100:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"ors.ORSMatrixResponse",title:"Interface: ORSMatrixResponse",sidebar_label:"ORSMatrixResponse",custom_edit_url:null},s=void 0,o={unversionedId:"api/interfaces/ors.ORSMatrixResponse",id:"api/interfaces/ors.ORSMatrixResponse",title:"Interface: ORSMatrixResponse",description:"ors.ORSMatrixResponse",source:"@site/docs/api/interfaces/ors.ORSMatrixResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSMatrixResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSMatrixResponse",title:"Interface: ORSMatrixResponse",sidebar_label:"ORSMatrixResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSMatrixParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams"},next:{title:"ORSRoute",permalink:"/routingjs/docs/api/interfaces/ors.ORSRoute"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"distances",id:"distances",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"durations",id:"durations",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"metadata",id:"metadata",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSMatrixResponse"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"ORSBaseResponse")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ORSMatrixResponse"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"destinations"},"destinations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"destinations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSMatrixResult"),"[]"),(0,a.kt)("p",null,"The individual destinations of the matrix calculations."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L249"},"packages/ors/parameters.ts:249")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"distances"},"distances"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"distances"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("p",null,"The distances of the matrix calculations."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L251"},"packages/ors/parameters.ts:251")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"durations"},"durations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"durations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("p",null,"The durations of the matrix calculations."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L253"},"packages/ors/parameters.ts:253")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSMetaData")),(0,a.kt)("p",null,"Information about the service and request"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"ORSBaseResponse.metadata"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L223"},"packages/ors/parameters.ts:223")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sources"},"sources"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"sources"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSMatrixResult"),"[]"),(0,a.kt)("p",null,"The individual sourcesof the matrix calculations."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L247"},"packages/ors/parameters.ts:247")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2fbe5889.a6fde2fd.js b/assets/js/2fbe5889.a6fde2fd.js new file mode 100644 index 0000000..8d61ab7 --- /dev/null +++ b/assets/js/2fbe5889.a6fde2fd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3800],{3905:(e,r,t)=>{t.d(r,{Zo:()=>c,kt:()=>f});var n=t(7294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function i(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function p(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=n.createContext({}),l=function(e){var r=n.useContext(s),t=r;return e&&(t="function"==typeof e?e(r):i(i({},r),e)),t},c=function(e){var r=l(e.components);return n.createElement(s.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},d=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=l(t),f=o,m=d["".concat(s,".").concat(f)]||d[f]||u[f]||a;return t?n.createElement(m,i(i({ref:r},c),{},{components:t})):n.createElement(m,i({ref:r},c))}));function f(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=d;var p={};for(var s in r)hasOwnProperty.call(r,s)&&(p[s]=r[s]);p.originalType=e,p.mdxType="string"==typeof e?e:o,i[1]=p;for(var l=2;l<a;l++)i[l]=t[l];return n.createElement.apply(null,i)}return n.createElement.apply(null,t)}d.displayName="MDXCreateElement"},1459:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>p,toc:()=>l});var n=t(7462),o=(t(7294),t(3905));const a={id:"core.ErrorProps",title:"Interface: ErrorProps",sidebar_label:"ErrorProps",custom_edit_url:null},i=void 0,p={unversionedId:"api/interfaces/core.ErrorProps",id:"api/interfaces/core.ErrorProps",title:"Interface: ErrorProps",description:"core.ErrorProps",source:"@site/docs/api/interfaces/core.ErrorProps.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/core.ErrorProps",permalink:"/routingjs/docs/api/interfaces/core.ErrorProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.ErrorProps",title:"Interface: ErrorProps",sidebar_label:"ErrorProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ClientConstructorArgs",permalink:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"},next:{title:"JSONObject",permalink:"/routingjs/docs/api/interfaces/core.JSONObject"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"errorMessage",id:"errormessage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"statusCode",id:"statuscode",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:l};function u(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},c,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".ErrorProps"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"ErrorProps")," is the type of the ",(0,o.kt)("inlineCode",{parentName:"p"},"properties")," field of the ",(0,o.kt)("inlineCode",{parentName:"p"},"RoutingJSAPIError")," class.\nIt is used to provide additional information about the error."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"ErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"ValhallaErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"OSRMErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"ORSErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"GraphHopperErrorProps"))))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"errormessage"},"errorMessage"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"errorMessage"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"errorMessage")," explains the error specific to that routing engine"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L11"},"packages/core/error.ts:11")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"status"},"status"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"status"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"status")," gives detailed info about that response"),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L9"},"packages/core/error.ts:9")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"statuscode"},"statusCode"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"statusCode"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"statusCode")," stands for the HTTP response status code"),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L7"},"packages/core/error.ts:7")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/31c5dceb.27072439.js b/assets/js/31c5dceb.27072439.js new file mode 100644 index 0000000..f58729b --- /dev/null +++ b/assets/js/31c5dceb.27072439.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3976],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var o=n.createContext({}),p=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),h=p(a),k=l,c=h["".concat(o,".").concat(k)]||h[k]||u[k]||i;return a?n.createElement(c,r(r({ref:t},d),{},{components:a})):n.createElement(c,r({ref:t},d))}));function k(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var i=a.length,r=new Array(i);r[0]=h;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:l,r[1]=s;for(var p=2;p<i;p++)r[p]=a[p];return n.createElement.apply(null,r)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"},9634:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var n=a(7462),l=(a(7294),a(3905));const i={id:"valhalla.ValhallaCostingOptsAuto",title:"Interface: ValhallaCostingOptsAuto",sidebar_label:"ValhallaCostingOptsAuto",custom_edit_url:null},r=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaCostingOptsAuto",id:"api/interfaces/valhalla.ValhallaCostingOptsAuto",title:"Interface: ValhallaCostingOptsAuto",description:"valhalla.ValhallaCostingOptsAuto",source:"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaCostingOptsAuto",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaCostingOptsAuto",title:"Interface: ValhallaCostingOptsAuto",sidebar_label:"ValhallaCostingOptsAuto",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaContours",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaContours"},next:{title:"ValhallaCostingOptsBicycle",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"closure_factor",id:"closure_factor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"country_crossing_cost",id:"country_crossing_cost",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"country_crossing_penalty",id:"country_crossing_penalty",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude_cash_only_tolls",id:"exclude_cash_only_tolls",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"exclude_unpaved",id:"exclude_unpaved",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ferry_cost",id:"ferry_cost",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"fixed_speed",id:"fixed_speed",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"gate_cost",id:"gate_cost",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"gate_penalty",id:"gate_penalty",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ignore_closures",id:"ignore_closures",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"include_hot",id:"include_hot",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"include_hov2",id:"include_hov2",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"include_hov3",id:"include_hov3",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"maneuver_penalty",id:"maneuver_penalty",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"private_access_penalty",id:"private_access_penalty",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"service_factor",id:"service_factor",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"service_penalty",id:"service_penalty",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"shortest",id:"shortest",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"toll_booth_cost",id:"toll_booth_cost",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"toll_booth_penalty",id:"toll_booth_penalty",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"top_speed",id:"top_speed",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"use_ferry",id:"use_ferry",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"use_highways",id:"use_highways",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"use_living_streets",id:"use_living_streets",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"use_tolls",id:"use_tolls",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"use_tracks",id:"use_tracks",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-27",level:4}],d={toc:p};function u(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaCostingOptsAuto"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptsWheels")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaCostingOptsAuto"))),(0,l.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsTruck"))),(0,l.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsMotorcycle"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"closure_factor"},"closure","_","factor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"closure","_","factor"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A factor that penalizes the cost when traversing a closed edge (eg: if\nsearch_filter.exclude_closures is false for origin and/or destination location and the\nroute starts/ends on closed edges). Its value can range from 1.0 - don't penalize closed\nedges, to 10.0 - apply high cost penalty to closed edges."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default value is 9.0."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle,\nmotor_scooter, bus, truck & taxi"),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L979"},"packages/valhalla/parameters.ts:979")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"country_crossing_cost"},"country","_","crossing","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"country","_","crossing","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A cost applied when encountering an international border. This cost is added to the\nestimated and elapsed times."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default cost is 600 seconds."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.country","_","crossing","_","cost"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L746"},"packages/valhalla/parameters.ts:746")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"country_crossing_penalty"},"country","_","crossing","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"country","_","crossing","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A penalty applied for a country crossing. This penalty can be used to create paths that\navoid spanning country boundaries."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default penalty is 0."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.country","_","crossing","_","penalty"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L754"},"packages/valhalla/parameters.ts:754")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exclude_cash_only_tolls"},"exclude","_","cash","_","only","_","tolls"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"exclude","_","cash","_","only","_","tolls"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean value which indicates the desire to avoid routes with cash-only tolls."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default false."),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1009"},"packages/valhalla/parameters.ts:1009")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exclude_unpaved"},"exclude","_","unpaved"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"exclude","_","unpaved"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"1")),(0,l.kt)("p",null,"This value indicates whether or not the path may include unpaved roads. If exclude_unpaved\nis set to 1 it is allowed to start and end with unpaved roads, but is not allowed to\nhave them in the middle of the route path, otherwise they are allowed."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default false."),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1002"},"packages/valhalla/parameters.ts:1002")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ferry_cost"},"ferry","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"ferry","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A cost applied when entering a ferry. This cost is added to the estimated and elapsed times."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default cost is 300 seconds (5 minutes)."),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L892"},"packages/valhalla/parameters.ts:892")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"fixed_speed"},"fixed","_","speed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"fixed","_","speed"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"Fixed speed the vehicle can go. Used to override the calculated speed. Can be useful if\nspeed of vehicle is known. fixed_speed must be between 1 and 252 KPH."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0 KPH which disables fixed speed and falls back to the standard\ncalculated speed based on the road attribution."),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L955"},"packages/valhalla/parameters.ts:955")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"gate_cost"},"gate","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"gate","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.gate","_","cost"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L737"},"packages/valhalla/parameters.ts:737")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"gate_penalty"},"gate","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"gate","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.gate","_","penalty"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L738"},"packages/valhalla/parameters.ts:738")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"height"},"height"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"height"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"The height of the vehicle (in meters)."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default 1.9 for car, bus, taxi and 4.11 for truck."),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L986"},"packages/valhalla/parameters.ts:986")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ignore_closures"},"ignore","_","closures"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"ignore","_","closures"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"If set to true, ignores all closures, marked due to live traffic closures,\nduring routing."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note: This option cannot be set if location.search_filter.exclude_closures is also\nspecified in the request and will return an error if it is."),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L965"},"packages/valhalla/parameters.ts:965")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"include_hot"},"include","_","hot"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"include","_","hot"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean value which indicates the desire to include tolled HOV roads which require the driver\nto pay a toll if the occupant requirement isn't met."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default false."),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1033"},"packages/valhalla/parameters.ts:1033")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"include_hov2"},"include","_","hov2"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"include","_","hov2"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean value which indicates the desire to include HOV roads with a 2-occupant requirement\nin the route when advantageous."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default false."),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1017"},"packages/valhalla/parameters.ts:1017")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"include_hov3"},"include","_","hov3"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"include","_","hov3"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean value which indicates the desire to include HOV roads with a 3-occupant requirement\nin the route when advantageous."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default false."),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1025"},"packages/valhalla/parameters.ts:1025")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"maneuver_penalty"},"maneuver","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"maneuver","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.maneuver","_","penalty"),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L736"},"packages/valhalla/parameters.ts:736")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"private_access_penalty"},"private","_","access","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"private","_","access","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A penalty applied when transitioning between roads that do not have consistent\nnaming\u2013in other words, no road names in common. This penalty can be used to create\nsimpler routes that tend to have fewer maneuvers or narrative guidance instructions."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default maneuver penalty is five seconds."),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L869"},"packages/valhalla/parameters.ts:869")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"service_factor"},"service","_","factor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"service","_","factor"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A factor that modifies (multiplies) the cost when generic service roads are encountered."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default service_factor is 1."),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L938"},"packages/valhalla/parameters.ts:938")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"service_penalty"},"service","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"service","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A penalty applied for transition to generic service road. The default penalty is 0 for\ntrucks and 15 for cars, buses, motor scooters and motorcycles."),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.service","_","penalty"),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L719"},"packages/valhalla/parameters.ts:719")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"shortest"},"shortest"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"shortest"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"Changes the metric to quasi-shortest, i.e. purely distance-based costing."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note, this will disable all other costings & penalties. Also note, shortest will not\ndisable hierarchy pruning, leading to potentially sub-optimal routes for some costing\nmodels."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default is false."),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.shortest"),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L732"},"packages/valhalla/parameters.ts:732")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"toll_booth_cost"},"toll","_","booth","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"toll","_","booth","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A cost applied when a toll booth is encountered. This cost is added to the estimated and\nelapsed times."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default cost is 15 seconds."),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L877"},"packages/valhalla/parameters.ts:877")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"toll_booth_penalty"},"toll","_","booth","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"toll","_","booth","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A penalty applied to the cost when a toll booth is encountered. This penalty can be used to\ncreate paths that avoid toll roads."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default toll booth penalty is 0."),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L885"},"packages/valhalla/parameters.ts:885")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"top_speed"},"top","_","speed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"top","_","speed"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"Top speed the vehicle can go. Also used to avoid roads with higher speeds than this\nvalue. top_speed must be between 10 and 252 KPH."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 140 KPH."),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L946"},"packages/valhalla/parameters.ts:946")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_ferry"},"use","_","ferry"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","ferry"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take ferries. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0.5."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely."),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.use","_","ferry"),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L700"},"packages/valhalla/parameters.ts:700")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_highways"},"use","_","highways"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","highways"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take highways. This is a range of values between 0\nand 1. Values near 0 attempt to avoid highways and values near 1 will favor highways."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 1.0."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes highways are required to complete a route so\nvalues of 0 are not guaranteed to avoid highways entirely."),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L904"},"packages/valhalla/parameters.ts:904")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_living_streets"},"use","_","living","_","streets"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","living","_","streets"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take living streets. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will\nfavor living streets."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0 for trucks, 0.1 for cars, buses, motor\nscooters and motorcycles."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes living streets are required to complete\na route so values of 0 are not guaranteed to avoid living streets entirely."),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.use","_","living","_","streets"),(0,l.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L714"},"packages/valhalla/parameters.ts:714")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_tolls"},"use","_","tolls"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","tolls"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take roads with tolls. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid tolls and values near 1 will not attempt\nto avoid them."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0.5."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes roads with tolls are\nrequired to complete a route so values of 0 are not guaranteed to avoid them entirely."),(0,l.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L917"},"packages/valhalla/parameters.ts:917")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_tracks"},"use","_","tracks"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","tracks"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take track roads. This is a range of values between\n0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a\nlittle bit."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0 for autos, 0.5 for motor scooters and motorcycles."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes tracks are required to complete a route so values of 0 are\nnot guaranteed to avoid tracks entirely."),(0,l.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L931"},"packages/valhalla/parameters.ts:931")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"width"},"width"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"width"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"The width of the vehicle (in meters)."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Default 1.6 for car, bus, taxi and 2.6 for truck."),(0,l.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L993"},"packages/valhalla/parameters.ts:993")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/35a07047.b08de4a7.js b/assets/js/35a07047.b08de4a7.js new file mode 100644 index 0000000..27c27f1 --- /dev/null +++ b/assets/js/35a07047.b08de4a7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7986],{3905:(e,t,r)=>{r.d(t,{Zo:()=>m,kt:()=>c});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},i=Object.keys(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),p=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},m=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),u=p(r),c=n,f=u["".concat(l,".").concat(c)]||u[c]||d[c]||i;return r?a.createElement(f,s(s({ref:t},m),{},{components:r})):a.createElement(f,s({ref:t},m))}));function c(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,s=new Array(i);s[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:n,s[1]=o;for(var p=2;p<i;p++)s[p]=r[p];return a.createElement.apply(null,s)}return a.createElement.apply(null,r)}u.displayName="MDXCreateElement"},8025:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"osrm",title:"Module: osrm",sidebar_label:"osrm",sidebar_position:0,custom_edit_url:null},s=void 0,o={unversionedId:"api/modules/osrm",id:"api/modules/osrm",title:"Module: osrm",description:"Classes",source:"@site/docs/api/modules/osrm.md",sourceDirName:"api/modules",slug:"/api/modules/osrm",permalink:"/routingjs/docs/api/modules/osrm",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"osrm",title:"Module: osrm",sidebar_label:"osrm",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ors",permalink:"/routingjs/docs/api/modules/ors"},next:{title:"valhalla",permalink:"/routingjs/docs/api/modules/valhalla"}},l={},p=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"OSRMAPIError",id:"osrmapierror",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"OSRMClient",id:"osrmclient",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"OSRMDirections",id:"osrmdirections",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"OSRMGeometryType",id:"osrmgeometrytype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"OSRMMatrix",id:"osrmmatrix",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"OSRMOverviewType",id:"osrmoverviewtype",level:3},{value:"Defined in",id:"defined-in-5",level:4}],m={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"classes"},"Classes"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/osrm.OSRM"},"OSRM"))),(0,n.kt)("h2",{id:"interfaces"},"Interfaces"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps"},"OSRMErrorProps")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"},"OSRMGeometryObject")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"},"OSRMMatrixOpts")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMRoute"},"OSRMRoute")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams"},"OSRMRouteParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse"},"OSRMRouteResponse")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams"},"OSRMTableParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse"},"OSRMTableResponse"))),(0,n.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,n.kt)("h3",{id:"osrmapierror"},"OSRMAPIError"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"OSRMAPIError"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.RoutingJSAPIError"},(0,n.kt)("inlineCode",{parentName:"a"},"RoutingJSAPIError")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMErrorProps")),">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L40"},"packages/osrm/index.ts:40")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"osrmclient"},"OSRMClient"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"OSRMClient"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Client"},(0,n.kt)("inlineCode",{parentName:"a"},"Client")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMRouteResponse"))," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMTableResponse")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMRouteParams")),">"," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMTableParams")),">",">"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L99"},"packages/osrm/index.ts:99")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"osrmdirections"},"OSRMDirections"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"OSRMDirections"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,n.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMRouteResponse")),", ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRoute"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMRoute")),">"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L95"},"packages/osrm/index.ts:95")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"osrmgeometrytype"},"OSRMGeometryType"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"OSRMGeometryType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"polyline"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"polyline6"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"geojson"')),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L51"},"packages/osrm/parameters.ts:51")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"osrmmatrix"},"OSRMMatrix"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"OSRMMatrix"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,n.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"OSRMTableResponse")),">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L97"},"packages/osrm/index.ts:97")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"osrmoverviewtype"},"OSRMOverviewType"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"OSRMOverviewType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"simplified"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"full"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"false"')),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L52"},"packages/osrm/parameters.ts:52")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/360d8d70.3410e1f1.js b/assets/js/360d8d70.3410e1f1.js new file mode 100644 index 0000000..e251bda --- /dev/null +++ b/assets/js/360d8d70.3410e1f1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9342],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function i(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},l=Object.keys(e);for(r=0;r<l.length;r++)n=l[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r<l.length;r++)n=l[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),h=p(n),u=a,f=h["".concat(s,".").concat(u)]||h[u]||c[u]||l;return n?r.createElement(f,o(o({ref:t},d),{},{components:n})):r.createElement(f,o({ref:t},d))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=h;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:a,o[1]=i;for(var p=2;p<l;p++)o[p]=n[p];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}h.displayName="MDXCreateElement"},6551:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const l={id:"valhalla.ValhallaIsochroneResponse",title:"Interface: ValhallaIsochroneResponse",sidebar_label:"ValhallaIsochroneResponse",custom_edit_url:null},o=void 0,i={unversionedId:"api/interfaces/valhalla.ValhallaIsochroneResponse",id:"api/interfaces/valhalla.ValhallaIsochroneResponse",title:"Interface: ValhallaIsochroneResponse",description:"valhalla.ValhallaIsochroneResponse",source:"@site/docs/api/interfaces/valhalla.ValhallaIsochroneResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaIsochroneResponse",title:"Interface: ValhallaIsochroneResponse",sidebar_label:"ValhallaIsochroneResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaIsochroneParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams"},next:{title:"ValhallaLeg",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"bbox",id:"bbox",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"features",id:"features",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:p};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaIsochroneResponse"),(0,a.kt)("p",null,"In the service response, the isochrone contours are returned as GeoJSON, which can be integrated\ninto mapping applications."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"FeatureCollection")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ValhallaIsochroneResponse"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"bbox"},"bbox"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"bbox"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"BBox")),(0,a.kt)("p",null,"Bounding box of the coordinate range of the object's Geometries, Features, or Feature Collections.\nThe value of the bbox member is an array of length 2*n where n is the number of dimensions\nrepresented in the contained geometries, with all axes of the most southwesterly point\nfollowed by all axes of the more northeasterly point.\nThe axes order of a bbox follows the axes order of geometries.\n",(0,a.kt)("a",{parentName:"p",href:"https://tools.ietf.org/html/rfc7946#section-5"},"https://tools.ietf.org/html/rfc7946#section-5")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"FeatureCollection.bbox"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/geojson/index.d.ts:67"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"features"},"features"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"features"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Geometry"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">","[]"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"FeatureCollection.features"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/geojson/index.d.ts:174"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L364"},"packages/valhalla/parameters.ts:364")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"FeatureCollection"')),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"FeatureCollection.type"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/geojson/index.d.ts:173"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/393be207.9fbb9d65.js b/assets/js/393be207.9fbb9d65.js new file mode 100644 index 0000000..4bf68e5 --- /dev/null +++ b/assets/js/393be207.9fbb9d65.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7414],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function p(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function c(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),i=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},u=function(e){var t=i(e.components);return n.createElement(l.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),f=i(r),m=o,d=f["".concat(l,".").concat(m)]||f[m]||s[m]||a;return r?n.createElement(d,p(p({ref:t},u),{},{components:r})):n.createElement(d,p({ref:t},u))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,p=new Array(a);p[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:o,p[1]=c;for(var i=2;i<a;i++)p[i]=r[i];return n.createElement.apply(null,p)}return n.createElement.apply(null,r)}f.displayName="MDXCreateElement"},9286:(e,t,r)=>{r.r(t),r.d(t,{contentTitle:()=>p,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const a={title:"Markdown page example"},p="Markdown page example",c={type:"mdx",permalink:"/routingjs/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"}},l=[],i={toc:l};function u(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"markdown-page-example"},"Markdown page example"),(0,o.kt)("p",null,"You don't need React to write simple standalone pages."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3ebc895b.1f1b94eb.js b/assets/js/3ebc895b.1f1b94eb.js new file mode 100644 index 0000000..13c30ea --- /dev/null +++ b/assets/js/3ebc895b.1f1b94eb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9818],{3905:(e,r,t)=>{t.d(r,{Zo:()=>s,kt:()=>d});var n=t(7294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function c(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var p=n.createContext({}),l=function(e){var r=n.useContext(p),t=r;return e&&(t="function"==typeof e?e(r):c(c({},r),e)),t},s=function(e){var r=l(e.components);return n.createElement(p.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},f=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),f=l(t),d=o,O=f["".concat(p,".").concat(d)]||f[d]||u[d]||a;return t?n.createElement(O,c(c({ref:r},s),{},{components:t})):n.createElement(O,c({ref:r},s))}));function d(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,c=new Array(a);c[0]=f;var i={};for(var p in r)hasOwnProperty.call(r,p)&&(i[p]=r[p]);i.originalType=e,i.mdxType="string"==typeof e?e:o,c[1]=i;for(var l=2;l<a;l++)c[l]=t[l];return n.createElement.apply(null,c)}return n.createElement.apply(null,t)}f.displayName="MDXCreateElement"},1883:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=t(7462),o=(t(7294),t(3905));const a={id:"core.JSONObject",title:"Interface: JSONObject",sidebar_label:"JSONObject",custom_edit_url:null},c=void 0,i={unversionedId:"api/interfaces/core.JSONObject",id:"api/interfaces/core.JSONObject",title:"Interface: JSONObject",description:"core.JSONObject",source:"@site/docs/api/interfaces/core.JSONObject.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/core.JSONObject",permalink:"/routingjs/docs/api/interfaces/core.JSONObject",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.JSONObject",title:"Interface: JSONObject",sidebar_label:"JSONObject",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ErrorProps",permalink:"/routingjs/docs/api/interfaces/core.ErrorProps"},next:{title:"GraphHopperErrorProps",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps"}},p={},l=[{value:"Indexable",id:"indexable",level:2}],s={toc:l};function u(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},s,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".JSONObject"),(0,o.kt)("h2",{id:"indexable"},"Indexable"),(0,o.kt)("p",null,"\u25aa ","[k: ",(0,o.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,o.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core#jsonvalue"},(0,o.kt)("inlineCode",{parentName:"a"},"JSONValue"))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4105c75d.a91d4a6a.js b/assets/js/4105c75d.a91d4a6a.js new file mode 100644 index 0000000..93a42db --- /dev/null +++ b/assets/js/4105c75d.a91d4a6a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5686],{3905:(e,a,t)=>{t.d(a,{Zo:()=>d,kt:()=>h});var l=t(7294);function n(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function i(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);a&&(l=l.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,l)}return t}function r(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?i(Object(t),!0).forEach((function(a){n(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function o(e,a){if(null==e)return{};var t,l,n=function(e,a){if(null==e)return{};var t,l,n={},i=Object.keys(e);for(l=0;l<i.length;l++)t=i[l],a.indexOf(t)>=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(l=0;l<i.length;l++)t=i[l],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var s=l.createContext({}),p=function(e){var a=l.useContext(s),t=a;return e&&(t="function"==typeof e?e(a):r(r({},a),e)),t},d=function(e){var a=p(e.components);return l.createElement(s.Provider,{value:a},e.children)},u={inlineCode:"code",wrapper:function(e){var a=e.children;return l.createElement(l.Fragment,{},a)}},c=l.forwardRef((function(e,a){var t=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=p(t),h=n,m=c["".concat(s,".").concat(h)]||c[h]||u[h]||i;return t?l.createElement(m,r(r({ref:a},d),{},{components:t})):l.createElement(m,r({ref:a},d))}));function h(e,a){var t=arguments,n=a&&a.mdxType;if("string"==typeof e||n){var i=t.length,r=new Array(i);r[0]=c;var o={};for(var s in a)hasOwnProperty.call(a,s)&&(o[s]=a[s]);o.originalType=e,o.mdxType="string"==typeof e?e:n,r[1]=o;for(var p=2;p<i;p++)r[p]=t[p];return l.createElement.apply(null,r)}return l.createElement.apply(null,t)}c.displayName="MDXCreateElement"},4079:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var l=t(7462),n=(t(7294),t(3905));const i={id:"valhalla.ValhallaMatrixParams",title:"Interface: ValhallaMatrixParams",sidebar_label:"ValhallaMatrixParams",custom_edit_url:null},r=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaMatrixParams",id:"api/interfaces/valhalla.ValhallaMatrixParams",title:"Interface: ValhallaMatrixParams",description:"valhalla.ValhallaMatrixParams",source:"@site/docs/api/interfaces/valhalla.ValhallaMatrixParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaMatrixParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaMatrixParams",title:"Interface: ValhallaMatrixParams",sidebar_label:"ValhallaMatrixParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaMatrixOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts"},next:{title:"ValhallaMatrixResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"costing",id:"costing",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"costing_options",id:"costing_options",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude_locations",id:"exclude_locations",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude_polygons",id:"exclude_polygons",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"targets",id:"targets",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:p};function u(e){let{components:a,...t}=e;return(0,n.kt)("wrapper",(0,l.Z)({},d,t,{components:a,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaMatrixParams"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaRequestParams")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ValhallaMatrixParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"costing"},"costing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"costing"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,n.kt)("p",null,"Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route\nrequest must include the name of the costing model and can include optional parameters available\nfor the chosen costing model."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"ValhallaRequestParams.costing"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L81"},"packages/valhalla/parameters.ts:81")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"costing_options"},"costing","_","options"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"costing","_","options"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptTypes")),(0,n.kt)("p",null,"Costing methods can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"ValhallaRequestParams.costing","_","options"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L86"},"packages/valhalla/parameters.ts:86")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude_locations"},"exclude","_","locations"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude","_","locations"),": ","[",(0,n.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,n.kt)("p",null,"A set of locations to exclude or avoid within a route can be specified using a JSON array\nof avoid_locations. The avoid_locations have the same format as the locations list. At a\nminimum each avoid location must include latitude and longitude. The avoid_locations are\nmapped to the closest road or roads and these roads are excluded from the route path computation."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"ValhallaRequestParams.exclude","_","locations"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L97"},"packages/valhalla/parameters.ts:97")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude_polygons"},"exclude","_","polygons"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude","_","polygons"),": ","[",(0,n.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"][]","[] ","|"," ","[",(0,n.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"][]","[][]"),(0,n.kt)("p",null,"One or multiple exterior rings of polygons in the form of nested JSON arrays, e.g.\n[[","[lon1, lat1]",", ","[lon2,lat2]","],[","[lon1,lat1]",",","[lon2,lat2]","]]. Roads intersecting these rings\nwill be avoided during path finding. If you only need to avoid a few specific roads,\nit's much more efficient to use exclude_locations. Valhalla will close open rings (i.e.\ncopy the first coordingate to the last position)."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"ValhallaRequestParams.exclude","_","polygons"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L105"},"packages/valhalla/parameters.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Name your route request. If id is specified, the naming will be sent thru to the response."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"ValhallaRequestParams.id"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L90"},"packages/valhalla/parameters.ts:90")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sources"},"sources"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"sources"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"[]"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L158"},"packages/valhalla/parameters.ts:158")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"targets"},"targets"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"targets"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"[]"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L159"},"packages/valhalla/parameters.ts:159")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/43063e81.8d1a3974.js b/assets/js/43063e81.8d1a3974.js new file mode 100644 index 0000000..5d0998a --- /dev/null +++ b/assets/js/43063e81.8d1a3974.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2241],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>c});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function p(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),u=s(a),c=l,m=u["".concat(o,".").concat(c)]||u[c]||h[c]||i;return a?n.createElement(m,r(r({ref:t},d),{},{components:a})):n.createElement(m,r({ref:t},d))}));function c(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var i=a.length,r=new Array(i);r[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:l,r[1]=p;for(var s=2;s<i;s++)r[s]=a[s];return n.createElement.apply(null,r)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"},625:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var n=a(7462),l=(a(7294),a(3905));const i={id:"valhalla.ValhallaTraceRouteOpts",title:"Interface: ValhallaTraceRouteOpts",sidebar_label:"ValhallaTraceRouteOpts",custom_edit_url:null},r=void 0,p={unversionedId:"api/interfaces/valhalla.ValhallaTraceRouteOpts",id:"api/interfaces/valhalla.ValhallaTraceRouteOpts",title:"Interface: ValhallaTraceRouteOpts",description:"valhalla.ValhallaTraceRouteOpts",source:"@site/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaTraceRouteOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaTraceRouteOpts",title:"Interface: ValhallaTraceRouteOpts",sidebar_label:"ValhallaTraceRouteOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaRouteResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},next:{title:"ValhallaTraceRouteParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"beginTime",id:"begintime",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costingOpts",id:"costingopts",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"dateTime",id:"datetime",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"directionsOptions",id:"directionsoptions",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"durations",id:"durations",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"preference",id:"preference",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"shapeMatch",id:"shapematch",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"traceOptions",id:"traceoptions",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"useTimestamps",id:"usetimestamps",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:s};function h(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaTraceRouteOpts"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaBaseOpts"),", ",(0,l.kt)("inlineCode",{parentName:"p"},'"avoidLocations"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"avoidPolygons"'),">"),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaTraceRouteOpts"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"begintime"},"beginTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"beginTime"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"Begin timestamp for the trace."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"This is used along with the durations so that timestamps can be specified for a\ntrace that is specified using an encoded polyline."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L231"},"packages/valhalla/index.ts:231")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costingopts"},"costingOpts"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"costingOpts"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsAuto"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsTruck"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsBicycle"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsMotorcycle"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsPedestrian"))),(0,l.kt)("p",null,"Profiles can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path. Only specify the actual options dict, the profile\nwill be filled automatically. For more information, visit:\n",(0,l.kt)("a",{parentName:"p",href:"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options"},"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options")),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"Omit.costingOpts"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L83"},"packages/valhalla/index.ts:83")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"datetime"},"dateTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"dateTime"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDateTime"))),(0,l.kt)("p",null,"This is the local date and time at the location. Field ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),": 0: Current departure time,\n1: Specified departure time. Field ",(0,l.kt)("inlineCode",{parentName:"p"},"value"),": the date and time is specified\nin ISO 8601 format (YYYY-MM-DDThh:mm), local time."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-js"}," date_time = {type: 0, value: 2021-03-03T08:06:23}\n")),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"Omit.dateTime"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L110"},"packages/valhalla/index.ts:110")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"directionsoptions"},"directionsOptions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"directionsOptions"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirectionOpts"))),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L254"},"packages/valhalla/index.ts:254")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"durations"},"durations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"durations"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,l.kt)("p",null,"List of durations (seconds) between each successive pair of input trace points."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,'This allows trace points to be supplied as an encoded polyline and timestamps to be\ncreated by using this list of "delta" times along with the begin_time of the trace.'),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L239"},"packages/valhalla/index.ts:239")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"A request ID that will be returned in the response"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"Omit.id"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L70"},"packages/valhalla/index.ts:70")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"preference"},"preference"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"preference"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"shortest"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"fastest"')),(0,l.kt)("p",null,"Convenience argument to set the cost metric, one of ","['shortest', 'fastest']",". Note,\nthat shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called ",(0,l.kt)("inlineCode",{parentName:"p"},"preference"),"\nto be in line with the already existing parameter in the ORS adapter."),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"Omit.preference"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L76"},"packages/valhalla/index.ts:76")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"shapematch"},"shapeMatch"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"shapeMatch"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallashapematch"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaShapeMatch"))),(0,l.kt)("p",null,"shape_match is an optional string input parameter. It allows some control\nof the matching algorithm based on the type of input."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"edge_walk"),": Indicates an edge walking algorithm can be used. This algorithm\nrequires nearly exact shape matching, so it should only be used\nwhen the shape is from a prior Valhalla route."),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"map_snap"),": \t Indicates that a map-matching algorithm should be used because\nthe input shape might not closely match Valhalla edges. This\nalgorithm is more expensive."),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"walk_or_snap"),": Also the default option. This will try edge walking and if this\ndoes not succeed, it will fall back and use map matching."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"walk_or_snap")),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L223"},"packages/valhalla/index.ts:223")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"traceoptions"},"traceOptions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"traceOptions"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaAdditionalTraceOpts")),(0,l.kt)("p",null,"Additional Options"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L253"},"packages/valhalla/index.ts:253")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usetimestamps"},"useTimestamps"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"useTimestamps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean value indicating whether the input timestamps or durations should be used\nwhen computing elapsed time at each edge along the matched path."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"If true, timestamps are used. If false (default), internal costing is applied to\ncompute elapsed times."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"false")),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L251"},"packages/valhalla/index.ts:251")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/45d0475c.30a21dfa.js b/assets/js/45d0475c.30a21dfa.js new file mode 100644 index 0000000..41e00b4 --- /dev/null +++ b/assets/js/45d0475c.30a21dfa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7987],{3905:(e,a,t)=>{t.d(a,{Zo:()=>d,kt:()=>m});var n=t(7294);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function i(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);a&&(n=n.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,n)}return t}function r(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?i(Object(t),!0).forEach((function(a){l(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function s(e,a){if(null==e)return{};var t,n,l=function(e,a){if(null==e)return{};var t,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)t=i[n],a.indexOf(t)>=0||(l[t]=e[t]);return l}(e,a);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)t=i[n],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(l[t]=e[t])}return l}var p=n.createContext({}),o=function(e){var a=n.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):r(r({},a),e)),t},d=function(e){var a=o(e.components);return n.createElement(p.Provider,{value:a},e.children)},u={inlineCode:"code",wrapper:function(e){var a=e.children;return n.createElement(n.Fragment,{},a)}},h=n.forwardRef((function(e,a){var t=e.components,l=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),h=o(t),m=l,c=h["".concat(p,".").concat(m)]||h[m]||u[m]||i;return t?n.createElement(c,r(r({ref:a},d),{},{components:t})):n.createElement(c,r({ref:a},d))}));function m(e,a){var t=arguments,l=a&&a.mdxType;if("string"==typeof e||l){var i=t.length,r=new Array(i);r[0]=h;var s={};for(var p in a)hasOwnProperty.call(a,p)&&(s[p]=a[p]);s.originalType=e,s.mdxType="string"==typeof e?e:l,r[1]=s;for(var o=2;o<i;o++)r[o]=t[o];return n.createElement.apply(null,r)}return n.createElement.apply(null,t)}h.displayName="MDXCreateElement"},151:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>p,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var n=t(7462),l=(t(7294),t(3905));const i={id:"valhalla.ValhallaTraceRouteParams",title:"Interface: ValhallaTraceRouteParams",sidebar_label:"ValhallaTraceRouteParams",custom_edit_url:null},r=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaTraceRouteParams",id:"api/interfaces/valhalla.ValhallaTraceRouteParams",title:"Interface: ValhallaTraceRouteParams",description:"valhalla.ValhallaTraceRouteParams",source:"@site/docs/api/interfaces/valhalla.ValhallaTraceRouteParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaTraceRouteParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaTraceRouteParams",title:"Interface: ValhallaTraceRouteParams",sidebar_label:"ValhallaTraceRouteParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaTraceRouteOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts"},next:{title:"ValhallaTrip",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"begin_time",id:"begin_time",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costing",id:"costing",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"costing_options",id:"costing_options",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"directions_options",id:"directions_options",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"directions_type",id:"directions_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"durations",id:"durations",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"language",id:"language",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"shape",id:"shape",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"shape_match",id:"shape_match",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"trace_options",id:"trace_options",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"units",id:"units",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"use_timestamps",id:"use_timestamps",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:o};function u(e){let{components:a,...t}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,t,{components:a,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaTraceRouteParams"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaRequestParams"),", ",(0,l.kt)("inlineCode",{parentName:"p"},'"exclude_locations"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"exclude_polygons"'),">")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaDirectionsOptions")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaTraceRouteParams"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"begin_time"},"begin","_","time"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"begin","_","time"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"Begin timestamp for the trace."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"This is used along with the durations so that timestamps can be specified for a\ntrace that is specified using an encoded polyline."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1366"},"packages/valhalla/parameters.ts:1366")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costing"},"costing"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"costing"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("p",null,"Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route\nrequest must include the name of the costing model and can include optional parameters available\nfor the chosen costing model."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"Omit.costing"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L81"},"packages/valhalla/parameters.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costing_options"},"costing","_","options"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"costing","_","options"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptTypes")),(0,l.kt)("p",null,"Costing methods can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"Omit.costing","_","options"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L86"},"packages/valhalla/parameters.ts:86")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"directions_options"},"directions","_","options"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"directions","_","options"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaDirectionsOptions")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1389"},"packages/valhalla/parameters.ts:1389")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"directions_type"},"directions","_","type"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"directions","_","type"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirectionstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirectionsType"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"none")," indicates no maneuvers or instructions should be returned,\n",(0,l.kt)("inlineCode",{parentName:"p"},"maneuvers")," indicates that only maneuvers be returned.\n",(0,l.kt)("inlineCode",{parentName:"p"},"instructions")," indeicates that maneuvers with instructions should be returned"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Defaults to ",(0,l.kt)("inlineCode",{parentName:"p"},"instructions"),"."),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaDirectionsOptions.directions","_","type"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L64"},"packages/valhalla/parameters.ts:64")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"durations"},"durations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"durations"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,l.kt)("p",null,"List of durations (seconds) between each successive pair of input trace points."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,'This allows trace points to be supplied as an encoded polyline and timestamps to be\ncreated by using this list of "delta" times along with the begin_time of the trace.'),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1374"},"packages/valhalla/parameters.ts:1374")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"Name your route request. If id is specified, the naming will be sent thru to the response."),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"Omit.id"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L90"},"packages/valhalla/parameters.ts:90")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"language"},"language"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"language"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"The language of the narration instructions based on the IETF BCP 47 language tag string.\nIf no language is specified or the specified language is unsupported, United States-based\nEnglish (en-US) is used."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"See"))),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#supported-language-tags"},"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#supported-language-tags")," for full list of supported languages."),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaDirectionsOptions.language"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L72"},"packages/valhalla/parameters.ts:72")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"shape"},"shape"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"shape"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"[]"),(0,l.kt)("p",null,"The array of input locations"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1338"},"packages/valhalla/parameters.ts:1338")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"shape_match"},"shape","_","match"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"shape","_","match"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallashapematch"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaShapeMatch"))),(0,l.kt)("p",null,"shape_match is an optional string input parameter. It allows some control\nof the matching algorithm based on the type of input."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"edge_walk"),": Indicates an edge walking algorithm can be used. This algorithm\nrequires nearly exact shape matching, so it should only be used\nwhen the shape is from a prior Valhalla route."),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"map_snap"),": \t Indicates that a map-matching algorithm should be used because\nthe input shape might not closely match Valhalla edges. This\nalgorithm is more expensive."),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"walk_or_snap"),": Also the default option. This will try edge walking and if this\ndoes not succeed, it will fall back and use map matching."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"walk_or_snap")),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1358"},"packages/valhalla/parameters.ts:1358")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"trace_options"},"trace","_","options"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"trace","_","options"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaTraceOptions")),(0,l.kt)("p",null,"Additional Options"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1388"},"packages/valhalla/parameters.ts:1388")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"units"},"units"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"units"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallarequestunit"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRequestUnit"))),(0,l.kt)("p",null,"Distance units for output. Allowable unit types are miles (or mi) and kilometers (or km).\nIf no unit type is specified, the units default to kilometers."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,'Defaults to "kilometers".'),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"ValhallaDirectionsOptions.units"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L55"},"packages/valhalla/parameters.ts:55")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_timestamps"},"use","_","timestamps"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","timestamps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean value indicating whether the input timestamps or durations should be used\nwhen computing elapsed time at each edge along the matched path."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"If true, timestamps are used. If false (default), internal costing is applied to\ncompute elapsed times."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"false")),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1386"},"packages/valhalla/parameters.ts:1386")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/481e471a.726e49b0.js b/assets/js/481e471a.726e49b0.js new file mode 100644 index 0000000..ddcfed9 --- /dev/null +++ b/assets/js/481e471a.726e49b0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1281],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?p(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):p(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function l(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},p=Object.keys(e);for(n=0;n<p.length;n++)a=p[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n<p.length;n++)a=p[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),h=s(a),k=r,m=h["".concat(o,".").concat(k)]||h[k]||u[k]||p;return a?n.createElement(m,i(i({ref:t},d),{},{components:a})):n.createElement(m,i({ref:t},d))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=a.length,i=new Array(p);i[0]=h;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,i[1]=l;for(var s=2;s<p;s++)i[s]=a[s];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"},293:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>u,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const p={id:"graphhopper.GraphHopperRouteParams",title:"Interface: GraphHopperRouteParams",sidebar_label:"GraphHopperRouteParams",custom_edit_url:null},i=void 0,l={unversionedId:"api/interfaces/graphhopper.GraphHopperRouteParams",id:"api/interfaces/graphhopper.GraphHopperRouteParams",title:"Interface: GraphHopperRouteParams",description:"graphhopper.GraphHopperRouteParams",source:"@site/docs/api/interfaces/graphhopper.GraphHopperRouteParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperRouteParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperRouteParams",title:"Interface: GraphHopperRouteParams",sidebar_label:"GraphHopperRouteParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperMatrixResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse"},next:{title:"GraphHopperRoutePath",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"algorithm",id:"algorithm",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"alternative_route.max_paths",id:"alternative_routemax_paths",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"alternative_route.max_share_factor",id:"alternative_routemax_share_factor",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"alternative_route.max_weight_factor",id:"alternative_routemax_weight_factor",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"calc_points",id:"calc_points",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ch.disable",id:"chdisable",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"curbsides",id:"curbsides",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"custom_model",id:"custom_model",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"debug",id:"debug",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"details",id:"details",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"elevation",id:"elevation",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"heading_penalty",id:"heading_penalty",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"headings",id:"headings",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"instructions",id:"instructions",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"optimize",id:"optimize",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"pass_through",id:"pass_through",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"point_hints",id:"point_hints",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"points",id:"points",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"points_encoded",id:"points_encoded",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"profile",id:"profile",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"round_trip.distance",id:"round_tripdistance",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"round_trip.seed",id:"round_tripseed",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"snap_preventions",id:"snap_preventions",level:3},{value:"Defined in",id:"defined-in-23",level:4}],d={toc:s};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperRouteParams"),(0,r.kt)("p",null,"All parameters accepted by the ",(0,r.kt)("inlineCode",{parentName:"p"},"/route")," endpoint"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"GraphHopperBaseParams")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"GraphHopperRouteParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"algorithm"},"algorithm"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"algorithm"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"GraphHopperAlgorithm")),(0,r.kt)("p",null,"Rather than looking for the shortest or fastest path, this parameter lets you solve two\ndifferent problems related to routing: With alternative_route, we give you not one but several\nroutes that are close to optimal, but not too similar to each other. With round_trip, the\nroute will get you back to where you started. This is meant for fun (think of a bike trip),\nso we will add some randomness."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),"."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L150"},"packages/graphhopper/parameters.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"alternative_routemax_paths"},"alternative","_","route.max","_","paths"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alternative","_","route.max","_","paths"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"This parameter sets the number of maximum\npaths which should be calculated. Increasing can lead to worse alternatives."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),".\nRequires ",(0,r.kt)("inlineCode",{parentName:"p"},"algorithm=alternative_route"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to 2."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L186"},"packages/graphhopper/parameters.ts:186")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"alternative_routemax_share_factor"},"alternative","_","route.max","_","share","_","factor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alternative","_","route.max","_","share","_","factor"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"This parameter specifies how similar an alternative route can be to the optimal route.\nIncreasing can lead to worse alternatives."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),".\nRequires ",(0,r.kt)("inlineCode",{parentName:"p"},"algorithm=alternative_route"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to 0.6."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L214"},"packages/graphhopper/parameters.ts:214")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"alternative_routemax_weight_factor"},"alternative","_","route.max","_","weight","_","factor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alternative","_","route.max","_","weight","_","factor"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"This parameter sets the factor by which the alternatives routes can be longer\nthan the optimal route. Increasing can lead to worse alternatives."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),".\nRequires ",(0,r.kt)("inlineCode",{parentName:"p"},"algorithm=alternative_route"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to 1.4."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L200"},"packages/graphhopper/parameters.ts:200")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calc_points"},"calc","_","points"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"calc","_","points"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether the points for the route should be calculated at all. If true, only returns\ntime and distance."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L72"},"packages/graphhopper/parameters.ts:72")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chdisable"},"ch.disable"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"ch.disable"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If certain optional parameters are set, contraction hierarchies need to be disabled using this flag.\nIs detected automatically in the ",(0,r.kt)("inlineCode",{parentName:"p"},".directions()")," method, so no need to pass explicitly."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L93"},"packages/graphhopper/parameters.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"curbsides"},"curbsides"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"curbsides"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"GraphHopperCurbside"),"[]"),(0,r.kt)("p",null,"Specifies on which side a point should be relative to the driver when she\nleaves/arrives at a start/target/via point. You need to specify this parameter\nfor either none or all points. Only supported for motor vehicle profiles and OpenStreetMap."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L34"},"packages/graphhopper/parameters.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"custom_model"},"custom","_","model"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"custom","_","model"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject"))),(0,r.kt)("p",null,"The custom_model modifies the routing behaviour of the specified profile."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://docs.graphhopper.com/#section/Custom-Model"},"https://docs.graphhopper.com/#section/Custom-Model")," for full documentation."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L99"},"packages/graphhopper/parameters.ts:99")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"debug"},"debug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If true, output will be formatted."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L78"},"packages/graphhopper/parameters.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"details"},"details"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"details"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"GraphHopperDetail"),"[]"),(0,r.kt)("p",null,"Enables additional attributes to be added to the returned path(s)."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L48"},"packages/graphhopper/parameters.ts:48")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"elevation"},"elevation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"elevation"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If true, a third coordinate, the altitude, is included with all positions in the response.\nThis changes the format of the points and snapped_waypoints fields of the response, in both\ntheir encodings. Unless you switch off the points_encoded parameter, you need special code on\nthe client side that can handle three-dimensional coordinates."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L46"},"packages/graphhopper/parameters.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"heading_penalty"},"heading","_","penalty"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"heading","_","penalty"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Time penalty in seconds for not obeying a specified heading."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to 120."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L124"},"packages/graphhopper/parameters.ts:124")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headings"},"headings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"headings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Favour a heading direction for a certain point. Specify either one heading for the start\npoint or as many as there are points. In this case headings are associated by their order\nto the specific points. Headings are given as north based clockwise angle between 0 and 360\ndegree. This parameter also influences the tour generated with algorithm=round_trip and forces\nthe initial direction."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),"."),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L112"},"packages/graphhopper/parameters.ts:112")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"instructions"},"instructions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"instructions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If true, detailed instructions are returned."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L64"},"packages/graphhopper/parameters.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"locale"},"locale"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"locale"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,'The locale of the resulting turn instructions. Defaults to "en".'),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L36"},"packages/graphhopper/parameters.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"optimize"},"optimize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"optimize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,'Normally, the calculated route will visit the points in the order you specified them.\nIf you have more than two points, you can set this parameter to "true" and the points may\nbe re-ordered to minimize the total travel time. Keep in mind that the limits on the number\nof locations of the Route Optimization API applies, and the request costs more credits.'),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L58"},"packages/graphhopper/parameters.ts:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pass_through"},"pass","_","through"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"pass","_","through"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If true, u-turns are avoided at via-points with regard to the heading_penalty."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to false."),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L136"},"packages/graphhopper/parameters.ts:136")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"point_hints"},"point","_","hints"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"point","_","hints"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Specifies a hint for each point in the points array to prefer a\ncertain street for the closest location lookup. E.g. if there is an\naddress or house with two or more neighboring streets you can control for\nwhich street the closest location is looked up. Make sure you do not\ninclude the house number of city name and only the street name to improve the\nquality of the matching."),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L26"},"packages/graphhopper/parameters.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"points"},"points"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"points"),": ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,r.kt)("p",null,"The points for the route in an array of ","[longitude,latitude]","."),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L17"},"packages/graphhopper/parameters.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"points_encoded"},"points","_","encoded"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"points","_","encoded"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"False")," the coordinates in point and snapped_waypoints are returned as array using the order\n","[lon,lat,elevation]"," for every point. If true the coordinates will be encoded as string leading to less bandwith usage."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to true."),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L85"},"packages/graphhopper/parameters.ts:85")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"profile"},"profile"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"profile"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,r.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile"))),(0,r.kt)("p",null,"The vehicle for which the route should be calculated."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"GraphHopperBaseParams.profile"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L9"},"packages/graphhopper/parameters.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"round_tripdistance"},"round","_","trip.distance"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"round","_","trip.distance"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"This parameter configures approximative length of the\nresulting round trip."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),".\nRequires ",(0,r.kt)("inlineCode",{parentName:"p"},"algorithm=round_trip"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Defaults to 10000."),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L163"},"packages/graphhopper/parameters.ts:163")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"round_tripseed"},"round","_","trip.seed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"round","_","trip.seed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"This sets the random seed. Change this to get a different tour for each value."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Requires ",(0,r.kt)("inlineCode",{parentName:"p"},"ch.disabled = true"),".\nRequires ",(0,r.kt)("inlineCode",{parentName:"p"},"algorithm=round_trip"),"."),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L172"},"packages/graphhopper/parameters.ts:172")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"snap_preventions"},"snap","_","preventions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"snap","_","preventions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"GraphHopperSnapPrevention"),"[]"),(0,r.kt)("p",null,"Parameter to avoid snapping to a certain road class or road environment"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L28"},"packages/graphhopper/parameters.ts:28")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/484329c4.102fb0cd.js b/assets/js/484329c4.102fb0cd.js new file mode 100644 index 0000000..1bf2d62 --- /dev/null +++ b/assets/js/484329c4.102fb0cd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3599],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=s(r),u=a,k=m["".concat(p,".").concat(u)]||m[u]||d[u]||i;return r?n.createElement(k,o(o({ref:t},c),{},{components:r})):n.createElement(k,o({ref:t},c))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var s=2;s<i;s++)o[s]=r[s];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},3513:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const i={id:"core.Directions",title:"Class: Directions<T, U>",sidebar_label:"Directions",custom_edit_url:null},o=void 0,l={unversionedId:"api/classes/core.Directions",id:"api/classes/core.Directions",title:"Class: Directions<T, U>",description:"core.Directions",source:"@site/docs/api/classes/core.Directions.md",sourceDirName:"api/classes",slug:"/api/classes/core.Directions",permalink:"/routingjs/docs/api/classes/core.Directions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.Directions",title:"Class: Directions<T, U>",sidebar_label:"Directions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Direction",permalink:"/routingjs/docs/api/classes/core.Direction"},next:{title:"Isochrone",permalink:"/routingjs/docs/api/classes/core.Isochrone"}},p={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"directions",id:"directions",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"raw",id:"raw",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".Directions"),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"U"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Directions"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,a.kt)("inlineCode",{parentName:"p"},"directions"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"raw"),")"),(0,a.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"U"))))),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"directions")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/routingjs/docs/api/classes/core.Direction"},(0,a.kt)("inlineCode",{parentName:"a"},"Direction")),"<",(0,a.kt)("inlineCode",{parentName:"td"},"U"),">","[]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"raw")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L4"},"packages/core/Direction.ts:4")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"directions"},"directions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"directions"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Direction"},(0,a.kt)("inlineCode",{parentName:"a"},"Direction")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"U"),">","[]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L5"},"packages/core/Direction.ts:5")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"raw"},"raw"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"raw"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"T")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L6"},"packages/core/Direction.ts:6")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4972.9fc7005b.js b/assets/js/4972.9fc7005b.js new file mode 100644 index 0000000..32080c7 --- /dev/null +++ b/assets/js/4972.9fc7005b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4972],{4972:(e,t,n)=>{n.r(t),n.d(t,{default:()=>c});var a=n(7294),l=n(5999),o=n(1944),r=n(3285);function c(){return a.createElement(a.Fragment,null,a.createElement(o.d,{title:(0,l.I)({id:"theme.NotFound.title",message:"Page Not Found"})}),a.createElement(r.Z,null,a.createElement("main",{className:"container margin-vert--xl"},a.createElement("div",{className:"row"},a.createElement("div",{className:"col col--6 col--offset-3"},a.createElement("h1",{className:"hero__title"},a.createElement(l.Z,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),a.createElement("p",null,a.createElement(l.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page"},"We could not find what you were looking for.")),a.createElement("p",null,a.createElement(l.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page"},"Please contact the owner of the site that linked you to the original URL and let them know their link is broken.")))))))}}}]); \ No newline at end of file diff --git a/assets/js/4aa12286.b5f66a60.js b/assets/js/4aa12286.b5f66a60.js new file mode 100644 index 0000000..b9de0a0 --- /dev/null +++ b/assets/js/4aa12286.b5f66a60.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3416],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var l=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);t&&(l=l.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,l)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,l,n=function(e,t){if(null==e)return{};var a,l,n={},i=Object.keys(e);for(l=0;l<i.length;l++)a=i[l],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(l=0;l<i.length;l++)a=i[l],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=l.createContext({}),p=function(e){var t=l.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=p(e.components);return l.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return l.createElement(l.Fragment,{},t)}},h=l.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),h=p(a),k=n,c=h["".concat(o,".").concat(k)]||h[k]||u[k]||i;return a?l.createElement(c,r(r({ref:t},d),{},{components:a})):l.createElement(c,r({ref:t},d))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,r=new Array(i);r[0]=h;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:n,r[1]=s;for(var p=2;p<i;p++)r[p]=a[p];return l.createElement.apply(null,r)}return l.createElement.apply(null,a)}h.displayName="MDXCreateElement"},4124:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var l=a(7462),n=(a(7294),a(3905));const i={id:"valhalla.ValhallaCostingOptsTruck",title:"Interface: ValhallaCostingOptsTruck",sidebar_label:"ValhallaCostingOptsTruck",custom_edit_url:null},r=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaCostingOptsTruck",id:"api/interfaces/valhalla.ValhallaCostingOptsTruck",title:"Interface: ValhallaCostingOptsTruck",description:"valhalla.ValhallaCostingOptsTruck",source:"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaCostingOptsTruck",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaCostingOptsTruck",title:"Interface: ValhallaCostingOptsTruck",sidebar_label:"ValhallaCostingOptsTruck",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaCostingOptsPedestrian",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},next:{title:"ValhallaDateTime",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"axle_count",id:"axle_count",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"axle_load",id:"axle_load",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"closure_factor",id:"closure_factor",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"country_crossing_cost",id:"country_crossing_cost",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"country_crossing_penalty",id:"country_crossing_penalty",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude_cash_only_tolls",id:"exclude_cash_only_tolls",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"exclude_unpaved",id:"exclude_unpaved",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"ferry_cost",id:"ferry_cost",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fixed_speed",id:"fixed_speed",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"gate_cost",id:"gate_cost",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"gate_penalty",id:"gate_penalty",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hazmat",id:"hazmat",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"height",id:"height",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"ignore_closures",id:"ignore_closures",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"include_hot",id:"include_hot",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"include_hov2",id:"include_hov2",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"include_hov3",id:"include_hov3",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"length",id:"length",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"maneuver_penalty",id:"maneuver_penalty",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"private_access_penalty",id:"private_access_penalty",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"service_factor",id:"service_factor",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"service_penalty",id:"service_penalty",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"shortest",id:"shortest",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"toll_booth_cost",id:"toll_booth_cost",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"toll_booth_penalty",id:"toll_booth_penalty",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"top_speed",id:"top_speed",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"use_ferry",id:"use_ferry",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"use_highways",id:"use_highways",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"use_living_streets",id:"use_living_streets",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"use_tolls",id:"use_tolls",level:3},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"use_tracks",id:"use_tracks",level:3},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"width",id:"width",level:3},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-32",level:4}],d={toc:p};function u(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,l.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaCostingOptsTruck"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsAuto"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ValhallaCostingOptsTruck"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"axle_count"},"axle","_","count"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"axle","_","count"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The axle count of the truck."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 5."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1064"},"packages/valhalla/parameters.ts:1064")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"axle_load"},"axle","_","load"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"axle","_","load"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The axle load of the truck (in metric tons)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 9.07."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1057"},"packages/valhalla/parameters.ts:1057")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"closure_factor"},"closure","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"closure","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that penalizes the cost when traversing a closed edge (eg: if\nsearch_filter.exclude_closures is false for origin and/or destination location and the\nroute starts/ends on closed edges). Its value can range from 1.0 - don't penalize closed\nedges, to 10.0 - apply high cost penalty to closed edges."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default value is 9.0."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle,\nmotor_scooter, bus, truck & taxi"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#closure_factor"},"closure_factor")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L979"},"packages/valhalla/parameters.ts:979")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"country_crossing_cost"},"country","_","crossing","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"country","_","crossing","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A cost applied when encountering an international border. This cost is added to the\nestimated and elapsed times."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default cost is 600 seconds."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#country_crossing_cost"},"country_crossing_cost")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L746"},"packages/valhalla/parameters.ts:746")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"country_crossing_penalty"},"country","_","crossing","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"country","_","crossing","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied for a country crossing. This penalty can be used to create paths that\navoid spanning country boundaries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default penalty is 0."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#country_crossing_penalty"},"country_crossing_penalty")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L754"},"packages/valhalla/parameters.ts:754")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude_cash_only_tolls"},"exclude","_","cash","_","only","_","tolls"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude","_","cash","_","only","_","tolls"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to avoid routes with cash-only tolls."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#exclude_cash_only_tolls"},"exclude_cash_only_tolls")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1009"},"packages/valhalla/parameters.ts:1009")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude_unpaved"},"exclude","_","unpaved"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude","_","unpaved"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"1")),(0,n.kt)("p",null,"This value indicates whether or not the path may include unpaved roads. If exclude_unpaved\nis set to 1 it is allowed to start and end with unpaved roads, but is not allowed to\nhave them in the middle of the route path, otherwise they are allowed."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#exclude_unpaved"},"exclude_unpaved")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1002"},"packages/valhalla/parameters.ts:1002")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ferry_cost"},"ferry","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ferry","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A cost applied when entering a ferry. This cost is added to the estimated and elapsed times."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default cost is 300 seconds (5 minutes)."),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#ferry_cost"},"ferry_cost")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L892"},"packages/valhalla/parameters.ts:892")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fixed_speed"},"fixed","_","speed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fixed","_","speed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Fixed speed the vehicle can go. Used to override the calculated speed. Can be useful if\nspeed of vehicle is known. fixed_speed must be between 1 and 252 KPH."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 KPH which disables fixed speed and falls back to the standard\ncalculated speed based on the road attribution."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#fixed_speed"},"fixed_speed")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L955"},"packages/valhalla/parameters.ts:955")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gate_cost"},"gate","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"gate","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#gate_cost"},"gate_cost")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L737"},"packages/valhalla/parameters.ts:737")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gate_penalty"},"gate","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"gate","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#gate_penalty"},"gate_penalty")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L738"},"packages/valhalla/parameters.ts:738")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hazmat"},"hazmat"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"hazmat"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A value indicating if the truck is carrying hazardous materials."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1071"},"packages/valhalla/parameters.ts:1071")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The height of the vehicle (in meters)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 1.9 for car, bus, taxi and 4.11 for truck."),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#height"},"height")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L986"},"packages/valhalla/parameters.ts:986")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ignore_closures"},"ignore","_","closures"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ignore","_","closures"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"If set to true, ignores all closures, marked due to live traffic closures,\nduring routing."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note: This option cannot be set if location.search_filter.exclude_closures is also\nspecified in the request and will return an error if it is."),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#ignore_closures"},"ignore_closures")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L965"},"packages/valhalla/parameters.ts:965")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include_hot"},"include","_","hot"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include","_","hot"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to include tolled HOV roads which require the driver\nto pay a toll if the occupant requirement isn't met."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#include_hot"},"include_hot")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1033"},"packages/valhalla/parameters.ts:1033")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include_hov2"},"include","_","hov2"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include","_","hov2"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to include HOV roads with a 2-occupant requirement\nin the route when advantageous."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#include_hov2"},"include_hov2")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1017"},"packages/valhalla/parameters.ts:1017")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include_hov3"},"include","_","hov3"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include","_","hov3"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to include HOV roads with a 3-occupant requirement\nin the route when advantageous."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#include_hov3"},"include_hov3")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1025"},"packages/valhalla/parameters.ts:1025")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"length"},"length"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"length"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The length of the truck (in meters)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 21.64."),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1043"},"packages/valhalla/parameters.ts:1043")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"maneuver_penalty"},"maneuver","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"maneuver","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#maneuver_penalty"},"maneuver_penalty")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L736"},"packages/valhalla/parameters.ts:736")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"private_access_penalty"},"private","_","access","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"private","_","access","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied when transitioning between roads that do not have consistent\nnaming\u2013in other words, no road names in common. This penalty can be used to create\nsimpler routes that tend to have fewer maneuvers or narrative guidance instructions."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default maneuver penalty is five seconds."),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#private_access_penalty"},"private_access_penalty")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L869"},"packages/valhalla/parameters.ts:869")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"service_factor"},"service","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"service","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies (multiplies) the cost when generic service roads are encountered."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default service_factor is 1."),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#service_factor"},"service_factor")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L938"},"packages/valhalla/parameters.ts:938")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"service_penalty"},"service","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"service","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied for transition to generic service road. The default penalty is 0 for\ntrucks and 15 for cars, buses, motor scooters and motorcycles."),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#service_penalty"},"service_penalty")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L719"},"packages/valhalla/parameters.ts:719")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shortest"},"shortest"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shortest"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Changes the metric to quasi-shortest, i.e. purely distance-based costing."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note, this will disable all other costings & penalties. Also note, shortest will not\ndisable hierarchy pruning, leading to potentially sub-optimal routes for some costing\nmodels."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default is false."),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#shortest"},"shortest")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L732"},"packages/valhalla/parameters.ts:732")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"toll_booth_cost"},"toll","_","booth","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"toll","_","booth","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A cost applied when a toll booth is encountered. This cost is added to the estimated and\nelapsed times."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default cost is 15 seconds."),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#toll_booth_cost"},"toll_booth_cost")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L877"},"packages/valhalla/parameters.ts:877")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"toll_booth_penalty"},"toll","_","booth","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"toll","_","booth","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied to the cost when a toll booth is encountered. This penalty can be used to\ncreate paths that avoid toll roads."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default toll booth penalty is 0."),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#toll_booth_penalty"},"toll_booth_penalty")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L885"},"packages/valhalla/parameters.ts:885")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"top_speed"},"top","_","speed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"top","_","speed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Top speed the vehicle can go. Also used to avoid roads with higher speeds than this\nvalue. top_speed must be between 10 and 252 KPH."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 140 KPH."),(0,n.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#top_speed"},"top_speed")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L946"},"packages/valhalla/parameters.ts:946")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_ferry"},"use","_","ferry"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","ferry"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take ferries. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.5."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely."),(0,n.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_ferry"},"use_ferry")),(0,n.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L700"},"packages/valhalla/parameters.ts:700")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_highways"},"use","_","highways"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","highways"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take highways. This is a range of values between 0\nand 1. Values near 0 attempt to avoid highways and values near 1 will favor highways."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 1.0."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes highways are required to complete a route so\nvalues of 0 are not guaranteed to avoid highways entirely."),(0,n.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_highways"},"use_highways")),(0,n.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L904"},"packages/valhalla/parameters.ts:904")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_living_streets"},"use","_","living","_","streets"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","living","_","streets"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take living streets. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will\nfavor living streets."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 for trucks, 0.1 for cars, buses, motor\nscooters and motorcycles."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes living streets are required to complete\na route so values of 0 are not guaranteed to avoid living streets entirely."),(0,n.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_living_streets"},"use_living_streets")),(0,n.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L714"},"packages/valhalla/parameters.ts:714")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_tolls"},"use","_","tolls"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","tolls"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take roads with tolls. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid tolls and values near 1 will not attempt\nto avoid them."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.5."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes roads with tolls are\nrequired to complete a route so values of 0 are not guaranteed to avoid them entirely."),(0,n.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_tolls"},"use_tolls")),(0,n.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L917"},"packages/valhalla/parameters.ts:917")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_tracks"},"use","_","tracks"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","tracks"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take track roads. This is a range of values between\n0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a\nlittle bit."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 for autos, 0.5 for motor scooters and motorcycles."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes tracks are required to complete a route so values of 0 are\nnot guaranteed to avoid tracks entirely."),(0,n.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_tracks"},"use_tracks")),(0,n.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L931"},"packages/valhalla/parameters.ts:931")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"weight"},"weight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"weight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The weight of the truck (in metric tons)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 21.77."),(0,n.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1050"},"packages/valhalla/parameters.ts:1050")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The width of the vehicle (in meters)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 1.6 for car, bus, taxi and 2.6 for truck."),(0,n.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#width"},"width")),(0,n.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L993"},"packages/valhalla/parameters.ts:993")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4ae4fd96.ec60fc41.js b/assets/js/4ae4fd96.ec60fc41.js new file mode 100644 index 0000000..fffb61c --- /dev/null +++ b/assets/js/4ae4fd96.ec60fc41.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2716],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},u=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),m=l(n),c=a,k=m["".concat(p,".").concat(c)]||m[c]||d[c]||i;return n?r.createElement(k,o(o({ref:t},u),{},{components:n})):r.createElement(k,o({ref:t},u))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var l=2;l<i;l++)o[l]=n[l];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"},8995:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(7462),a=(n(7294),n(3905));const i={id:"ors.ORSRoute",title:"Interface: ORSRoute",sidebar_label:"ORSRoute",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/ors.ORSRoute",id:"api/interfaces/ors.ORSRoute",title:"Interface: ORSRoute",description:"ors.ORSRoute",source:"@site/docs/api/interfaces/ors.ORSRoute.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSRoute",permalink:"/routingjs/docs/api/interfaces/ors.ORSRoute",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSRoute",title:"Interface: ORSRoute",sidebar_label:"ORSRoute",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSMatrixResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse"},next:{title:"ORSRouteParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSRouteParams"}},p={},l=[{value:"Properties",id:"properties",level:2},{value:"arrival",id:"arrival",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"bbox",id:"bbox",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"departure",id:"departure",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"extras",id:"extras",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"geometry",id:"geometry",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"segments",id:"segments",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"summary",id:"summary",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"way_points",id:"way_points",level:3},{value:"Defined in",id:"defined-in-8",level:4}],u={toc:l};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSRoute"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"arrival"},"arrival"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"arrival"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Arrival date and time"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L300"},"packages/ors/parameters.ts:300")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"bbox"},"bbox"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"bbox"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSBbox")),(0,a.kt)("p",null,"A bounding box which contains the entire route"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L302"},"packages/ors/parameters.ts:302")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"departure"},"departure"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"departure"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Departure date and time"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L304"},"packages/ors/parameters.ts:304")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"extras"},"extras"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"extras"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"object"),"[]"),(0,a.kt)("p",null,"List of extra info objects representing the extra info items that were requested for the route."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L308"},"packages/ors/parameters.ts:308")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"geometry"},"geometry"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"geometry"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The route geometry as a decoded polyline"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L318"},"packages/ors/parameters.ts:318")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"segments"},"segments"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"segments"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSSegment"),"[]"),(0,a.kt)("p",null,"List containing the segments and its corresponding steps which make up the route."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L310"},"packages/ors/parameters.ts:310")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"summary"},"summary"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"summary"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSSummary")),(0,a.kt)("p",null,"Summary information about the route"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L312"},"packages/ors/parameters.ts:312")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warnings"},"warnings"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"warnings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSWarning"),"[]"),(0,a.kt)("p",null,"List of warnings that have been generated for the route"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L314"},"packages/ors/parameters.ts:314")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"way_points"},"way","_","points"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"way","_","points"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"List containing the indices of way points corresponding to the geometry."),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L316"},"packages/ors/parameters.ts:316")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5b8d0eef.bf78469c.js b/assets/js/5b8d0eef.bf78469c.js new file mode 100644 index 0000000..466e0cf --- /dev/null +++ b/assets/js/5b8d0eef.bf78469c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3769],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=p(n),m=a,f=c["".concat(l,".").concat(m)]||c[m]||u[m]||i;return n?r.createElement(f,s(s({ref:t},d),{},{components:n})):r.createElement(f,s({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=c;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var p=2;p<i;p++)s[p]=n[p];return r.createElement.apply(null,s)}return r.createElement.apply(null,n)}c.displayName="MDXCreateElement"},5739:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={id:"osrm.OSRMTableResponse",title:"Interface: OSRMTableResponse",sidebar_label:"OSRMTableResponse",custom_edit_url:null},s=void 0,o={unversionedId:"api/interfaces/osrm.OSRMTableResponse",id:"api/interfaces/osrm.OSRMTableResponse",title:"Interface: OSRMTableResponse",description:"osrm.OSRMTableResponse",source:"@site/docs/api/interfaces/osrm.OSRMTableResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMTableResponse",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMTableResponse",title:"Interface: OSRMTableResponse",sidebar_label:"OSRMTableResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMTableParams",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams"},next:{title:"MapboxAuthParams",permalink:"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"code",id:"code",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"distances",id:"distances",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"durations",id:"durations",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMTableResponse"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"OSRMBaseResponse")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"OSRMTableResponse"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"code"},"code"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"code"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OSRMResponseCode")),(0,a.kt)("p",null,"Every response object has a code field containing one of the strings below or a\nservice dependent code:"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseResponse.code"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L59"},"packages/osrm/parameters.ts:59")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"destinations"},"destinations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"destinations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OSRMWayPoint"),"[]"),(0,a.kt)("p",null,"array of Waypoint objects describing all destinations in order"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L238"},"packages/osrm/parameters.ts:238")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"distances"},"distances"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"distances"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L234"},"packages/osrm/parameters.ts:234")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"durations"},"durations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"durations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("p",null,"array of arrays that stores the matrix in row-major order. durations","[i][j]"," gives the travel\ntime from the i-th waypoint to the j-th waypoint. Values are given in seconds."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L233"},"packages/osrm/parameters.ts:233")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Optional human-readable error message. All other status types are service dependent."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseResponse.message"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L61"},"packages/osrm/parameters.ts:61")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sources"},"sources"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"sources"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OSRMWayPoint"),"[]"),(0,a.kt)("p",null,"array of Waypoint objects describing all sources in order"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L236"},"packages/osrm/parameters.ts:236")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5ceb730d.364ede46.js b/assets/js/5ceb730d.364ede46.js new file mode 100644 index 0000000..ced1df6 --- /dev/null +++ b/assets/js/5ceb730d.364ede46.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2347],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(r),f=a,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},c),{},{components:r})):n.createElement(m,i({ref:t},c))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var l=2;l<o;l++)i[l]=r[l];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},2388:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={id:"ors.ORSIsochroneResponse",title:"Interface: ORSIsochroneResponse",sidebar_label:"ORSIsochroneResponse",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/ors.ORSIsochroneResponse",id:"api/interfaces/ors.ORSIsochroneResponse",title:"Interface: ORSIsochroneResponse",description:"ors.ORSIsochroneResponse",source:"@site/docs/api/interfaces/ors.ORSIsochroneResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSIsochroneResponse",title:"Interface: ORSIsochroneResponse",sidebar_label:"ORSIsochroneResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSIsochroneParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams"},next:{title:"ORSMatrixParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"bbox",id:"bbox",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"features",id:"features",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"metadata",id:"metadata",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:l};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSIsochroneResponse"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"ORSBaseResponse")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ORSIsochroneResponse"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"bbox"},"bbox"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"bbox"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSBbox")),(0,a.kt)("p",null,"Bounding box that covers all returned isochrones"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L238"},"packages/ors/parameters.ts:238")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"features"},"features"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"features"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Geometry"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"any"),">","[]"),(0,a.kt)("p",null,"The features containing the isochrone/isodistance geometries"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L240"},"packages/ors/parameters.ts:240")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSMetaData")),(0,a.kt)("p",null,"Information about the service and request"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"ORSBaseResponse.metadata"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L223"},"packages/ors/parameters.ts:223")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"FeatureCollection"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L242"},"packages/ors/parameters.ts:242")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5e5ac311.a22b72ee.js b/assets/js/5e5ac311.a22b72ee.js new file mode 100644 index 0000000..ab69627 --- /dev/null +++ b/assets/js/5e5ac311.a22b72ee.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1425],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function i(e,t){if(null==e)return{};var a,r,n=function(e,t){if(null==e)return{};var a,r,n={},l=Object.keys(e);for(r=0;r<l.length;r++)a=l[r],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r<l.length;r++)a=l[r],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),p=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),f=p(a),m=n,d=f["".concat(s,".").concat(m)]||f[m]||u[m]||l;return a?r.createElement(d,o(o({ref:t},c),{},{components:a})):r.createElement(d,o({ref:t},c))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,o=new Array(l);o[0]=f;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:n,o[1]=i;for(var p=2;p<l;p++)o[p]=a[p];return r.createElement.apply(null,o)}return r.createElement.apply(null,a)}f.displayName="MDXCreateElement"},6531:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>p});var r=a(7462),n=(a(7294),a(3905));const l={id:"valhalla.MapboxAuthParams",title:"Interface: MapboxAuthParams",sidebar_label:"MapboxAuthParams",custom_edit_url:null},o=void 0,i={unversionedId:"api/interfaces/valhalla.MapboxAuthParams",id:"api/interfaces/valhalla.MapboxAuthParams",title:"Interface: MapboxAuthParams",description:"valhalla.MapboxAuthParams",source:"@site/docs/api/interfaces/valhalla.MapboxAuthParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.MapboxAuthParams",permalink:"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.MapboxAuthParams",title:"Interface: MapboxAuthParams",sidebar_label:"MapboxAuthParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMTableResponse",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse"},next:{title:"ValhallaContours",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaContours"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"access_token",id:"access_token",level:3},{value:"Defined in",id:"defined-in",level:4}],c={toc:p};function u(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".MapboxAuthParams"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"access_token"},"access","_","token"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"access","_","token"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1328"},"packages/valhalla/parameters.ts:1328")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5e8c322a.55775b71.js b/assets/js/5e8c322a.55775b71.js new file mode 100644 index 0000000..4ab54a6 --- /dev/null +++ b/assets/js/5e8c322a.55775b71.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7597],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},a=Object.keys(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),d=p(n),m=o,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||a;return n?r.createElement(f,i(i({ref:t},u),{},{components:n})):r.createElement(f,i({ref:t},u))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,i[1]=l;for(var p=2;p<a;p++)i[p]=n[p];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"},7926:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>c,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var r=n(7462),o=(n(7294),n(3905));const a={id:"index",title:"routingjs",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},i="RoutingJS",l={unversionedId:"api/index",id:"api/index",title:"routingjs",description:"example workflow",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/routingjs/docs/api/",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"index",title:"routingjs",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Quickstart",permalink:"/routingjs/docs/quickstart"},next:{title:"Table of Contents",permalink:"/routingjs/docs/api/modules"}},s={},p=[{value:"Installation",id:"installation",level:2},{value:"Examples",id:"examples",level:2},{value:"Documentation",id:"documentation",level:2},{value:"Contributing",id:"contributing",level:2}],u={toc:p};function c(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"routingjs"},"RoutingJS"),(0,o.kt)("p",null,(0,o.kt)("img",{parentName:"p",src:"https://github.com/gis-ops/routingjs/actions/workflows/ci-tests.yml/badge.svg",alt:"example workflow"})),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"One lib to route them all")," : ",(0,o.kt)("em",{parentName:"p"},"RoutingJS")," is a promise-based web client for accessing different\nrouting web services, analogous to our Python client ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routing-py"},"routingpy"),". Get unified access to several routing services with the power of modern asynchronous JavaScript fully typed thanks to the power of TypeScript!"),(0,o.kt)("p",null,"We currently support the following routers:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/valhalla/valhalla"},"Valhalla")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"http://project-osrm.org"},"OSRM")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://openrouteservice.org"},"OpenRouteService")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://graphhopper.com"},"GraphHopper"))),(0,o.kt)("p",null,"Future support for other service (like the ones ",(0,o.kt)("em",{parentName:"p"},"routingpy")," is supporting) might come at a later stage."),(0,o.kt)("h2",{id:"installation"},"Installation"),(0,o.kt)("p",null,"Router clients are installable individually:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"npm install @routingjs/valhalla\n")),(0,o.kt)("h2",{id:"examples"},"Examples"),(0,o.kt)("p",null,"RoutingJS offers ",(0,o.kt)("inlineCode",{parentName:"p"},"directions"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"matrix")," and ",(0,o.kt)("inlineCode",{parentName:"p"},"reachability")," methods where available (e.g. OSRM does not support reachability/isochrones)."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { Valhalla } from "@routingjs/valhalla"\n\nconst v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de\nv.directions(\n [\n [47.380742, 8.512516], // pass as [lat, lon]\n [47.359467, 8.557835],\n ],\n "auto"\n).then((d) => {\n // do stuff with the directions response\n d.directions.forEach((direction) => {\n console.log(direction.feature) // get the route as GeoJSON feature\n console.log(direction.feature.properties.distance) // get the route distance\n console.log(direction.feature.properties.duration) // get the route duration\n })\n})\n\nv.reachability([47.380742, 8.512516], "pedestrian", [30, 90]).then((i) => {\n i.isochrones.forEach((isochrone) => {\n console.log(i.interval) // 30/90\n console.log(i.intervalType) // "time"\n console.log(i.feature) // GeoJSON feature\n })\n})\n\nv.matrix(\n [\n [47.380742, 8.512516], // pass as [lat, lon]\n [47.359467, 8.557835],\n ],\n "auto"\n).then((m) => {\n console.log(m.durations) // get the durations array for each location\n console.log(m.distances) // get the distances array for each location\n})\n')),(0,o.kt)("h2",{id:"documentation"},"Documentation"),(0,o.kt)("p",null,"See ",(0,o.kt)("a",{parentName:"p",href:"https://gis-ops.github.io/routingjs/"},"here")," for the full documentation."),(0,o.kt)("h2",{id:"contributing"},"Contributing"),(0,o.kt)("p",null,"Contributions are welcome! We are open to improvements of existing clients, as well as additions of\nnew ones :-)"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5ffeac76.c3005cc5.js b/assets/js/5ffeac76.c3005cc5.js new file mode 100644 index 0000000..a310642 --- /dev/null +++ b/assets/js/5ffeac76.c3005cc5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5874],{3769:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-docs","id":"default"}')}}]); \ No newline at end of file diff --git a/assets/js/60784167.b1cb172b.js b/assets/js/60784167.b1cb172b.js new file mode 100644 index 0000000..99ecda9 --- /dev/null +++ b/assets/js/60784167.b1cb172b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1022],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?r(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):r(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function p(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},r=Object.keys(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var o=n.createContext({}),d=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(o.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,r=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),k=d(a),N=l,h=k["".concat(o,".").concat(N)]||k[N]||m[N]||r;return a?n.createElement(h,i(i({ref:t},s),{},{components:a})):n.createElement(h,i({ref:t},s))}));function N(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var r=a.length,i=new Array(r);i[0]=k;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:l,i[1]=p;for(var d=2;d<r;d++)i[d]=a[d];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}k.displayName="MDXCreateElement"},297:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var n=a(7462),l=(a(7294),a(3905));const r={id:"valhalla.Valhalla",title:"Class: Valhalla",sidebar_label:"Valhalla",custom_edit_url:null},i=void 0,p={unversionedId:"api/classes/valhalla.Valhalla",id:"api/classes/valhalla.Valhalla",title:"Class: Valhalla",description:"valhalla.Valhalla",source:"@site/docs/api/classes/valhalla.Valhalla.md",sourceDirName:"api/classes",slug:"/api/classes/valhalla.Valhalla",permalink:"/routingjs/docs/api/classes/valhalla.Valhalla",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.Valhalla",title:"Class: Valhalla",sidebar_label:"Valhalla",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRM",permalink:"/routingjs/docs/api/classes/osrm.OSRM"},next:{title:"BaseRouter",permalink:"/routingjs/docs/api/interfaces/core.BaseRouter"}},o={},d=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"client",id:"client",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"directions",id:"directions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"mapMatch",id:"mapmatch",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"matrix",id:"matrix",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"parseDirectionsResponse",id:"parsedirectionsresponse",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"reachability",id:"reachability",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_buildLocations",id:"_buildlocations",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDirectionParams",id:"getdirectionparams",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getIsochroneParams",id:"getisochroneparams",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getMatrixParams",id:"getmatrixparams",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getTraceRouteParams",id:"gettracerouteparams",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"parseIsochroneResponse",id:"parseisochroneresponse",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"parseMatrixResponse",id:"parsematrixresponse",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],s={toc:d};function m(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".Valhalla"),(0,l.kt)("h2",{id:"implements"},"Implements"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},(0,l.kt)("inlineCode",{parentName:"a"},"BaseRouter")))),(0,l.kt)("h2",{id:"constructors"},"Constructors"),(0,l.kt)("h3",{id:"constructor"},"constructor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"new Valhalla"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"clientArgs?"),")"),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"clientArgs?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"},(0,l.kt)("inlineCode",{parentName:"a"},"ClientConstructorArgs")))))),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L283"},"packages/valhalla/index.ts:283")),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"apikey"},"apiKey"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"apiKey"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L282"},"packages/valhalla/index.ts:282")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"client"},"client"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"client"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallaclient"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaClient"))),(0,l.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},"BaseRouter"),".",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter#client"},"client")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L281"},"packages/valhalla/index.ts:281")),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"directions"},"directions"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"directions"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirections"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirections")),">"),(0,l.kt)("p",null,"Makes a request to Valhalla's ",(0,l.kt)("inlineCode",{parentName:"p"},"/route")," endpoint."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"See"))),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},"ValhallaCostingType")," for available profiles"),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]"),(0,l.kt)("td",{parentName:"tr",align:"left"},"The coordinates tuple the route should be calculated from in order of visit. Format: ","[lat, lon]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"directionsOpts?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirectionOpts"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Additional parameters, such as costing options.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirections"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirections")),">"),(0,l.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.directions"),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L319"},"packages/valhalla/index.ts:319")),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"directions"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"directionsOpts"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"directionsOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirectionOpts")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"true"))))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.directions"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L325"},"packages/valhalla/index.ts:325")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"mapmatch"},"mapMatch"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"mapMatch"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"mapMatchOpts?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirections"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirections")),">"),(0,l.kt)("p",null,"Makes a request to Valhalla's ",(0,l.kt)("inlineCode",{parentName:"p"},"/trace_route")," endpoint."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"See"))),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},"ValhallaCostingType")," for available profiles"),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]"),(0,l.kt)("td",{parentName:"tr",align:"left"},"Format: ","[lat, lon]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"mapMatchOpts?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaTraceRouteOpts"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Additional parameters, such as costing options.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirections"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirections")),">"),(0,l.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.mapMatch"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L898"},"packages/valhalla/index.ts:898")),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"mapMatch"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"mapMatchOpts"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"mapMatchOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaTraceRouteOpts")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"true"))))),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.mapMatch"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L904"},"packages/valhalla/index.ts:904")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"matrix"},"matrix"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"matrix"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallamatrix"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrix")),">"),(0,l.kt)("p",null,"Makes a request to Valhalla's ",(0,l.kt)("inlineCode",{parentName:"p"},"/matrix")," endpoint."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"See"))),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},"ValhallaCostingType")," for available profiles"),(0,l.kt)("h4",{id:"parameters-5"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]"),(0,l.kt)("td",{parentName:"tr",align:"left"},"Format: ","[lat, lon]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"matrixOpts?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixOpts"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Additional parameters, such as costing options.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallamatrix"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrix")),">"),(0,l.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.matrix"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L734"},"packages/valhalla/index.ts:734")),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"matrix"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"matrixOpts"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"parameters-6"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"matrixOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixOpts")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"true"))))),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.matrix"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L740"},"packages/valhalla/index.ts:740")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"parsedirectionsresponse"},"parseDirectionsResponse"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"parseDirectionsResponse"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirections"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirections"))),(0,l.kt)("h4",{id:"parameters-7"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"response")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"type")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"main"'))))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirections"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirections"))),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L461"},"packages/valhalla/index.ts:461")),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"parseDirectionsResponse"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Direction"},(0,l.kt)("inlineCode",{parentName:"a"},"Direction")),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),">"),(0,l.kt)("h4",{id:"parameters-8"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"response")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"type")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"alternative"'))))),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Direction"},(0,l.kt)("inlineCode",{parentName:"a"},"Direction")),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),">"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L465"},"packages/valhalla/index.ts:465")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"reachability"},"reachability"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"reachability"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"isochronesOpts?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallaisochrones"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochrones")),">"),(0,l.kt)("p",null,"Makes a request to Valhalla's ",(0,l.kt)("inlineCode",{parentName:"p"},"/isochrone")," endpoint."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"See"))),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},"ValhallaCostingType")," for available profiles"),(0,l.kt)("h4",{id:"parameters-9"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"location")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"]"),(0,l.kt)("td",{parentName:"tr",align:"left"},"The coordinates tuple that represents the starting location. Format: ","[lat, lon]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"intervals")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"),"[]"),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"isochronesOpts?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneOpts"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Additional parameters, such as costing options.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallaisochrones"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochrones")),">"),(0,l.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.reachability"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L539"},"packages/valhalla/index.ts:539")),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"reachability"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"isochronesOpts"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"parameters-10"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"location")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"intervals")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"isochronesOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneOpts")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"true"))))),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,l.kt)("p",null,"BaseRouter.reachability"),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L546"},"packages/valhalla/index.ts:546")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_buildlocations"},"_","buildLocations"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"_buildLocations"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"coordinates"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"[]"),(0,l.kt)("h4",{id:"parameters-11"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"coordinates")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")))),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"[]"),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L992"},"packages/valhalla/index.ts:992")),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"_buildLocations"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"coordinates"),"): [",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"]"),(0,l.kt)("h4",{id:"parameters-12"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"coordinates")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"]")))),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,"[",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"]"),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L995"},"packages/valhalla/index.ts:995")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getdirectionparams"},"getDirectionParams"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"getDirectionParams"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRouteParams"))),(0,l.kt)("h4",{id:"parameters-13"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"directionsOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDirectionOpts")))))),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRouteParams"))),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L367"},"packages/valhalla/index.ts:367")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getisochroneparams"},"getIsochroneParams"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"getIsochroneParams"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"isochroneOpts?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneParams"))),(0,l.kt)("h4",{id:"parameters-14"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"location")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"intervals")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"isochroneOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneOpts")))))),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneParams"))),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L594"},"packages/valhalla/index.ts:594")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getmatrixparams"},"getMatrixParams"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"getMatrixParams"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixParams"))),(0,l.kt)("h4",{id:"parameters-15"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"matrixOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixOpts")))))),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixParams"))),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L777"},"packages/valhalla/index.ts:777")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"gettracerouteparams"},"getTraceRouteParams"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"getTraceRouteParams"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"traceRouteOpts?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaTraceRouteParams"))),(0,l.kt)("h4",{id:"parameters-16"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"locations")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"profile")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"traceRouteOpts")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaTraceRouteOpts")))))),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaTraceRouteParams"))),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L945"},"packages/valhalla/index.ts:945")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"parseisochroneresponse"},"parseIsochroneResponse"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"parseIsochroneResponse"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"intervalType"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallaisochrones"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochrones"))),(0,l.kt)("h4",{id:"parameters-17"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"response")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneResponse")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"location")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"intervals")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"intervalType")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"time"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"distance"'))))),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallaisochrones"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaIsochrones"))),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L701"},"packages/valhalla/index.ts:701")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"parsematrixresponse"},"parseMatrixResponse"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,l.kt)("strong",{parentName:"p"},"parseMatrixResponse"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"units"),"): ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallamatrix"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrix"))),(0,l.kt)("h4",{id:"parameters-18"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"response")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixResponse")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"units")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/valhalla#valhallarequestunit"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRequestUnit")))))),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallamatrix"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaMatrix"))),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L869"},"packages/valhalla/index.ts:869")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/629bdd40.7e90bfdd.js b/assets/js/629bdd40.7e90bfdd.js new file mode 100644 index 0000000..6a455a4 --- /dev/null +++ b/assets/js/629bdd40.7e90bfdd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7173],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),m=p(r),u=a,k=m["".concat(l,".").concat(u)]||m[u]||d[u]||o;return r?n.createElement(k,s(s({ref:t},c),{},{components:r})):n.createElement(k,s({ref:t},c))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:a,s[1]=i;for(var p=2;p<o;p++)s[p]=r[p];return n.createElement.apply(null,s)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},6931:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"core.Isochrones",title:"Class: Isochrones<T, U>",sidebar_label:"Isochrones",custom_edit_url:null},s=void 0,i={unversionedId:"api/classes/core.Isochrones",id:"api/classes/core.Isochrones",title:"Class: Isochrones<T, U>",description:"core.Isochrones",source:"@site/docs/api/classes/core.Isochrones.md",sourceDirName:"api/classes",slug:"/api/classes/core.Isochrones",permalink:"/routingjs/docs/api/classes/core.Isochrones",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.Isochrones",title:"Class: Isochrones<T, U>",sidebar_label:"Isochrones",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Isochrone",permalink:"/routingjs/docs/api/classes/core.Isochrone"},next:{title:"Matrix",permalink:"/routingjs/docs/api/classes/core.Matrix"}},l={},p=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"isochrones",id:"isochrones",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"raw",id:"raw",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".Isochrones"),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"U"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Isochrones"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,a.kt)("inlineCode",{parentName:"p"},"isochrones"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"raw"),")"),(0,a.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"U"))))),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"isochrones")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/routingjs/docs/api/classes/core.Isochrone"},(0,a.kt)("inlineCode",{parentName:"a"},"Isochrone")),"<",(0,a.kt)("inlineCode",{parentName:"td"},"U"),">","[]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"raw")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L4"},"packages/core/Isochrone.ts:4")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"isochrones"},"isochrones"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"isochrones"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrone"},(0,a.kt)("inlineCode",{parentName:"a"},"Isochrone")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"U"),">","[]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L5"},"packages/core/Isochrone.ts:5")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"raw"},"raw"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"raw"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"T")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L6"},"packages/core/Isochrone.ts:6")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6b9ea5a6.b5a80d15.js b/assets/js/6b9ea5a6.b5a80d15.js new file mode 100644 index 0000000..6d4c1aa --- /dev/null +++ b/assets/js/6b9ea5a6.b5a80d15.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5079],{3905:(a,e,l)=>{l.d(e,{Zo:()=>h,kt:()=>d});var t=l(7294);function n(a,e,l){return e in a?Object.defineProperty(a,e,{value:l,enumerable:!0,configurable:!0,writable:!0}):a[e]=l,a}function i(a,e){var l=Object.keys(a);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(a);e&&(t=t.filter((function(e){return Object.getOwnPropertyDescriptor(a,e).enumerable}))),l.push.apply(l,t)}return l}function r(a){for(var e=1;e<arguments.length;e++){var l=null!=arguments[e]?arguments[e]:{};e%2?i(Object(l),!0).forEach((function(e){n(a,e,l[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(a,Object.getOwnPropertyDescriptors(l)):i(Object(l)).forEach((function(e){Object.defineProperty(a,e,Object.getOwnPropertyDescriptor(l,e))}))}return a}function s(a,e){if(null==a)return{};var l,t,n=function(a,e){if(null==a)return{};var l,t,n={},i=Object.keys(a);for(t=0;t<i.length;t++)l=i[t],e.indexOf(l)>=0||(n[l]=a[l]);return n}(a,e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(a);for(t=0;t<i.length;t++)l=i[t],e.indexOf(l)>=0||Object.prototype.propertyIsEnumerable.call(a,l)&&(n[l]=a[l])}return n}var o=t.createContext({}),p=function(a){var e=t.useContext(o),l=e;return a&&(l="function"==typeof a?a(e):r(r({},e),a)),l},h=function(a){var e=p(a.components);return t.createElement(o.Provider,{value:e},a.children)},c={inlineCode:"code",wrapper:function(a){var e=a.children;return t.createElement(t.Fragment,{},e)}},u=t.forwardRef((function(a,e){var l=a.components,n=a.mdxType,i=a.originalType,o=a.parentName,h=s(a,["components","mdxType","originalType","parentName"]),u=p(l),d=n,m=u["".concat(o,".").concat(d)]||u[d]||c[d]||i;return l?t.createElement(m,r(r({ref:e},h),{},{components:l})):t.createElement(m,r({ref:e},h))}));function d(a,e){var l=arguments,n=e&&e.mdxType;if("string"==typeof a||n){var i=l.length,r=new Array(i);r[0]=u;var s={};for(var o in e)hasOwnProperty.call(e,o)&&(s[o]=e[o]);s.originalType=a,s.mdxType="string"==typeof a?a:n,r[1]=s;for(var p=2;p<i;p++)r[p]=l[p];return t.createElement.apply(null,r)}return t.createElement.apply(null,l)}u.displayName="MDXCreateElement"},6585:(a,e,l)=>{l.r(e),l.d(e,{assets:()=>o,contentTitle:()=>r,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var t=l(7462),n=(l(7294),l(3905));const i={id:"valhalla",title:"Module: valhalla",sidebar_label:"valhalla",sidebar_position:0,custom_edit_url:null},r=void 0,s={unversionedId:"api/modules/valhalla",id:"api/modules/valhalla",title:"Module: valhalla",description:"Classes",source:"@site/docs/api/modules/valhalla.md",sourceDirName:"api/modules",slug:"/api/modules/valhalla",permalink:"/routingjs/docs/api/modules/valhalla",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"valhalla",title:"Module: valhalla",sidebar_label:"valhalla",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"osrm",permalink:"/routingjs/docs/api/modules/osrm"},next:{title:"Client",permalink:"/routingjs/docs/api/classes/core.Client"}},o={},p=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"ValhallaAPIError",id:"valhallaapierror",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ValhallaClient",id:"valhallaclient",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ValhallaCostingType",id:"valhallacostingtype",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ValhallaDirections",id:"valhalladirections",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ValhallaDirectionsType",id:"valhalladirectionstype",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ValhallaIsochrones",id:"valhallaisochrones",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"ValhallaMatrix",id:"valhallamatrix",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"ValhallaRequestUnit",id:"valhallarequestunit",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"ValhallaShapeMatch",id:"valhallashapematch",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"ValhallaTraceRoute",id:"valhallatraceroute",level:3},{value:"Defined in",id:"defined-in-9",level:4}],h={toc:p};function c(a){let{components:e,...l}=a;return(0,n.kt)("wrapper",(0,t.Z)({},h,l,{components:e,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"classes"},"Classes"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/valhalla.Valhalla"},"Valhalla"))),(0,n.kt)("h2",{id:"interfaces"},"Interfaces"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams"},"MapboxAuthParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaContours"},"ValhallaContours")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"},"ValhallaCostingOptsBicycle")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},"ValhallaCostingOptsMotorcycle")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},"ValhallaCostingOptsPedestrian")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},"ValhallaCostingOptsTruck")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},"ValhallaDateTime")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"},"ValhallaDirectionOpts")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps"},"ValhallaErrorProps")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts"},"ValhallaIsochroneOpts")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams"},"ValhallaIsochroneParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse"},"ValhallaIsochroneResponse")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg"},"ValhallaLeg")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},"ValhallaLocation")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers"},"ValhallaManeuvers")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts"},"ValhallaMatrixOpts")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams"},"ValhallaMatrixParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse"},"ValhallaMatrixResponse")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams"},"ValhallaRouteParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},"ValhallaRouteResponse")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts"},"ValhallaTraceRouteOpts")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams"},"ValhallaTraceRouteParams")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip"},"ValhallaTrip"))),(0,n.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,n.kt)("h3",{id:"valhallaapierror"},"ValhallaAPIError"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaAPIError"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.RoutingJSAPIError"},(0,n.kt)("inlineCode",{parentName:"a"},"RoutingJSAPIError")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaErrorProps")),">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L56"},"packages/valhalla/index.ts:56")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallaclient"},"ValhallaClient"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaClient"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Client"},(0,n.kt)("inlineCode",{parentName:"a"},"Client")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse"))," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixResponse"))," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"FeatureCollection"),", ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams"},(0,n.kt)("inlineCode",{parentName:"a"},"MapboxAuthParams")),", ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneParams"))," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteParams"))," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixParams"))," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaTraceRouteParams")),">"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L271"},"packages/valhalla/index.ts:271")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallacostingtype"},"ValhallaCostingType"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaCostingType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"auto"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"bicycle"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"motorcycle"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"truck"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"pedestrian"')),(0,n.kt)("p",null,"Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route\nrequest must include the name of the costing model and can include optional parameters available\nfor the chosen costing model."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1276"},"packages/valhalla/parameters.ts:1276")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhalladirections"},"ValhallaDirections"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaDirections"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,n.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),", ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),">"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L257"},"packages/valhalla/index.ts:257")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhalladirectionstype"},"ValhallaDirectionsType"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaDirectionsType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"maneuvers"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"instructions"')),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L422"},"packages/valhalla/parameters.ts:422")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallaisochrones"},"ValhallaIsochrones"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaIsochrones"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrones"},(0,n.kt)("inlineCode",{parentName:"a"},"Isochrones")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaIsochroneResponse")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Feature"),">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L262"},"packages/valhalla/index.ts:262")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallamatrix"},"ValhallaMatrix"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaMatrix"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,n.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaMatrixResponse")),">"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L264"},"packages/valhalla/index.ts:264")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallarequestunit"},"ValhallaRequestUnit"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaRequestUnit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"mi"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"km"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"miles"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"kilometers"')),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L108"},"packages/valhalla/parameters.ts:108")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallashapematch"},"ValhallaShapeMatch"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaShapeMatch"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"edge_walk"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"map_snap"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"walk_or_snap"')),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1308"},"packages/valhalla/parameters.ts:1308")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"valhallatraceroute"},"ValhallaTraceRoute"),(0,n.kt)("p",null,"\u01ac ",(0,n.kt)("strong",{parentName:"p"},"ValhallaTraceRoute"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,n.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),", ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),">"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L266"},"packages/valhalla/index.ts:266")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6ef32316.a297b114.js b/assets/js/6ef32316.a297b114.js new file mode 100644 index 0000000..49ea5ba --- /dev/null +++ b/assets/js/6ef32316.a297b114.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9012],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,f=d["".concat(l,".").concat(m)]||d[m]||c[m]||o;return r?n.createElement(f,i(i({ref:t},u),{},{components:r})):n.createElement(f,i({ref:t},u))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var p=2;p<o;p++)i[p]=r[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},5047:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"osrm.OSRMRoute",title:"Interface: OSRMRoute",sidebar_label:"OSRMRoute",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/osrm.OSRMRoute",id:"api/interfaces/osrm.OSRMRoute",title:"Interface: OSRMRoute",description:"osrm.OSRMRoute",source:"@site/docs/api/interfaces/osrm.OSRMRoute.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMRoute",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRoute",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMRoute",title:"Interface: OSRMRoute",sidebar_label:"OSRMRoute",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMMatrixOpts",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"},next:{title:"OSRMRouteParams",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams"}},l={},p=[{value:"Properties",id:"properties",level:2},{value:"distance",id:"distance",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"duration",id:"duration",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"geometry",id:"geometry",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"legs",id:"legs",level:3},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMRoute"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"distance"},"distance"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"distance"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The distance traveled by the route, in float meters."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L82"},"packages/osrm/parameters.ts:82")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"duration"},"duration"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"duration"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The estimated travel time, in float number of seconds."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L84"},"packages/osrm/parameters.ts:84")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"geometry"},"geometry"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"geometry"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"},(0,a.kt)("inlineCode",{parentName:"a"},"OSRMGeometryObject"))),(0,a.kt)("p",null,"The whole geometry of the route value depending on overview parameter, format depending\non the geometries parameter. See RouteStep's geometry field for a parameter documentation."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L78"},"packages/osrm/parameters.ts:78")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"legs"},"legs"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"legs"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OSRMLeg"),"[]"),(0,a.kt)("p",null,"The legs between the given waypoints, an array of RouteLeg objects."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L80"},"packages/osrm/parameters.ts:80")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6ffa1466.8c205006.js b/assets/js/6ffa1466.8c205006.js new file mode 100644 index 0000000..b0bb609 --- /dev/null +++ b/assets/js/6ffa1466.8c205006.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6596],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},i=Object.keys(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=c(r),m=n,k=u["".concat(p,".").concat(m)]||u[m]||d[m]||i;return r?a.createElement(k,o(o({ref:t},s),{},{components:r})):a.createElement(k,o({ref:t},s))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:n,o[1]=l;for(var c=2;c<i;c++)o[c]=r[c];return a.createElement.apply(null,o)}return a.createElement.apply(null,r)}u.displayName="MDXCreateElement"},2854:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"core.Direction",title:"Class: Direction<T>",sidebar_label:"Direction",custom_edit_url:null},o=void 0,l={unversionedId:"api/classes/core.Direction",id:"api/classes/core.Direction",title:"Class: Direction<T>",description:"core.Direction",source:"@site/docs/api/classes/core.Direction.md",sourceDirName:"api/classes",slug:"/api/classes/core.Direction",permalink:"/routingjs/docs/api/classes/core.Direction",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.Direction",title:"Class: Direction<T>",sidebar_label:"Direction",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Client",permalink:"/routingjs/docs/api/classes/core.Client"},next:{title:"Directions",permalink:"/routingjs/docs/api/classes/core.Directions"}},p={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"feature",id:"feature",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"raw",id:"raw",level:3},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".Direction"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new Direction"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"feature"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"raw?"),")"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"feature")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/core#directionfeat"},(0,n.kt)("inlineCode",{parentName:"a"},"DirectionFeat")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"raw?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L18"},"packages/core/Direction.ts:18")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"feature"},"feature"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,n.kt)("strong",{parentName:"p"},"feature"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core#directionfeat"},(0,n.kt)("inlineCode",{parentName:"a"},"DirectionFeat"))),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L19"},"packages/core/Direction.ts:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"raw"},"raw"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,n.kt)("strong",{parentName:"p"},"raw"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L20"},"packages/core/Direction.ts:20")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/705151d0.0b912d8e.js b/assets/js/705151d0.0b912d8e.js new file mode 100644 index 0000000..3194936 --- /dev/null +++ b/assets/js/705151d0.0b912d8e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[313],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=p(n),m=a,f=c["".concat(l,".").concat(m)]||c[m]||u[m]||i;return n?r.createElement(f,o(o({ref:t},d),{},{components:n})):r.createElement(f,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=c;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p<i;p++)o[p]=n[p];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}c.displayName="MDXCreateElement"},160:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={id:"ors.ORSMatrixParams",title:"Interface: ORSMatrixParams",sidebar_label:"ORSMatrixParams",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/ors.ORSMatrixParams",id:"api/interfaces/ors.ORSMatrixParams",title:"Interface: ORSMatrixParams",description:"ors.ORSMatrixParams",source:"@site/docs/api/interfaces/ors.ORSMatrixParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSMatrixParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSMatrixParams",title:"Interface: ORSMatrixParams",sidebar_label:"ORSMatrixParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse"},next:{title:"ORSMatrixResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"locations",id:"locations",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"metrics",id:"metrics",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"resolve_locations",id:"resolve_locations",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"units",id:"units",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSMatrixParams"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"ORSBaseParams")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ORSMatrixParams"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"destinations"},"destinations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"destinations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"A list of indices that refers to the list of locations (starting with 0).\n",(0,a.kt)("inlineCode",{parentName:"p"},"{index_1},{index_2}[,{index_N} ...]")," or all (default). ",(0,a.kt)("inlineCode",{parentName:"p"},"[0,3]")," for the first and\nfourth locations"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"all"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L173"},"packages/ors/parameters.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Arbitrary identification string of the request reflected in the meta information."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"ORSBaseParams.id"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L16"},"packages/ors/parameters.ts:16")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"locations"},"locations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"locations"),": ","[",(0,a.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,a.kt)("p",null,"List of comma separated lists of longitude,latitude coordinates."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L164"},"packages/ors/parameters.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metrics"},"metrics"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"metrics"),": (",(0,a.kt)("inlineCode",{parentName:"p"},'"distance"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"duration"'),")[]"),(0,a.kt)("p",null,"Arbitrary identification string of the request reflected in the meta information."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L177"},"packages/ors/parameters.ts:177")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resolve_locations"},"resolve","_","locations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"resolve","_","locations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Specifies whether given locations are resolved or not. If the parameter value set to true,\nevery element in destinations and sources will contain a name element that identifies the name\nof the closest street."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"Default is false."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L186"},"packages/ors/parameters.ts:186")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sources"},"sources"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sources"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"A list of indices that refers to the list of locations (starting with 0).\n",(0,a.kt)("inlineCode",{parentName:"p"},"{index_1},{index_2}[,{index_N} ...]")," or all (default). ",(0,a.kt)("inlineCode",{parentName:"p"},"[0,3]")," for the first and\nfourth locations"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"all"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L195"},"packages/ors/parameters.ts:195")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"units"},"units"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"units"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsunit"},(0,a.kt)("inlineCode",{parentName:"a"},"ORSUnit"))),(0,a.kt)("p",null,"Specifies the distance units only if range_type is set to distance."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"Default: m."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"ORSBaseParams.units"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L23"},"packages/ors/parameters.ts:23")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7a832ccb.67f95331.js b/assets/js/7a832ccb.67f95331.js new file mode 100644 index 0000000..151bc7e --- /dev/null +++ b/assets/js/7a832ccb.67f95331.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7384],{3905:(e,a,t)=>{t.d(a,{Zo:()=>u,kt:()=>h});var l=t(7294);function r(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function n(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);a&&(l=l.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,l)}return t}function i(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?n(Object(t),!0).forEach((function(a){r(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):n(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function o(e,a){if(null==e)return{};var t,l,r=function(e,a){if(null==e)return{};var t,l,r={},n=Object.keys(e);for(l=0;l<n.length;l++)t=n[l],a.indexOf(t)>=0||(r[t]=e[t]);return r}(e,a);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(l=0;l<n.length;l++)t=n[l],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var p=l.createContext({}),s=function(e){var a=l.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):i(i({},a),e)),t},u=function(e){var a=s(e.components);return l.createElement(p.Provider,{value:a},e.children)},c={inlineCode:"code",wrapper:function(e){var a=e.children;return l.createElement(l.Fragment,{},a)}},d=l.forwardRef((function(e,a){var t=e.components,r=e.mdxType,n=e.originalType,p=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=s(t),h=r,m=d["".concat(p,".").concat(h)]||d[h]||c[h]||n;return t?l.createElement(m,i(i({ref:a},u),{},{components:t})):l.createElement(m,i({ref:a},u))}));function h(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var n=t.length,i=new Array(n);i[0]=d;var o={};for(var p in a)hasOwnProperty.call(a,p)&&(o[p]=a[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,i[1]=o;for(var s=2;s<n;s++)i[s]=t[s];return l.createElement.apply(null,i)}return l.createElement.apply(null,t)}d.displayName="MDXCreateElement"},9519:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>n,metadata:()=>o,toc:()=>s});var l=t(7462),r=(t(7294),t(3905));const n={id:"valhalla.ValhallaLeg",title:"Interface: ValhallaLeg",sidebar_label:"ValhallaLeg",custom_edit_url:null},i=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaLeg",id:"api/interfaces/valhalla.ValhallaLeg",title:"Interface: ValhallaLeg",description:"valhalla.ValhallaLeg",source:"@site/docs/api/interfaces/valhalla.ValhallaLeg.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaLeg",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaLeg",title:"Interface: ValhallaLeg",sidebar_label:"ValhallaLeg",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse"},next:{title:"ValhallaLocation",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"maneuvers",id:"maneuvers",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"shape",id:"shape",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"summary",id:"summary",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:s};function c(e){let{components:a,...t}=e;return(0,r.kt)("wrapper",(0,l.Z)({},u,t,{components:a,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaLeg"),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"maneuvers"},"maneuvers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"maneuvers"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers"},(0,r.kt)("inlineCode",{parentName:"a"},"ValhallaManeuvers")),"[]"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L235"},"packages/valhalla/parameters.ts:235")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"shape"},"shape"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"shape"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The shape is an encoded polyline of the route path (with 6 digits decimal precision)."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L234"},"packages/valhalla/parameters.ts:234")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"summary"},"summary"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"summary"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ValhallaRouteSummary")),(0,r.kt)("p",null,"A leg summary is comprised of the same information as a trip summary but applied to the single leg of the trip."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L230"},"packages/valhalla/parameters.ts:230")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/84af600f.1020d227.js b/assets/js/84af600f.1020d227.js new file mode 100644 index 0000000..e0c67ac --- /dev/null +++ b/assets/js/84af600f.1020d227.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[885],{3905:(e,r,t)=>{t.d(r,{Zo:()=>c,kt:()=>d});var n=t(7294);function p(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function o(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){p(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,n,p=function(e,r){if(null==e)return{};var t,n,p={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(p[t]=e[t]);return p}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(p[t]=e[t])}return p}var l=n.createContext({}),s=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):o(o({},r),e)),t},c=function(e){var r=s(e.components);return n.createElement(l.Provider,{value:r},e.children)},h={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},u=n.forwardRef((function(e,r){var t=e.components,p=e.mdxType,a=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=s(t),d=p,m=u["".concat(l,".").concat(d)]||u[d]||h[d]||a;return t?n.createElement(m,o(o({ref:r},c),{},{components:t})):n.createElement(m,o({ref:r},c))}));function d(e,r){var t=arguments,p=r&&r.mdxType;if("string"==typeof e||p){var a=t.length,o=new Array(a);o[0]=u;var i={};for(var l in r)hasOwnProperty.call(r,l)&&(i[l]=r[l]);i.originalType=e,i.mdxType="string"==typeof e?e:p,o[1]=i;for(var s=2;s<a;s++)o[s]=t[s];return n.createElement.apply(null,o)}return n.createElement.apply(null,t)}u.displayName="MDXCreateElement"},294:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var n=t(7462),p=(t(7294),t(3905));const a={id:"graphhopper.GraphHopperIsochroneOpts",title:"Interface: GraphHopperIsochroneOpts",sidebar_label:"GraphHopperIsochroneOpts",custom_edit_url:null},o=void 0,i={unversionedId:"api/interfaces/graphhopper.GraphHopperIsochroneOpts",id:"api/interfaces/graphhopper.GraphHopperIsochroneOpts",title:"Interface: GraphHopperIsochroneOpts",description:"graphhopper.GraphHopperIsochroneOpts",source:"@site/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperIsochroneOpts",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperIsochroneOpts",title:"Interface: GraphHopperIsochroneOpts",sidebar_label:"GraphHopperIsochroneOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperErrorProps",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps"},next:{title:"GraphHopperIsochroneParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams"}},l={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"buckets",id:"buckets",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"interval_type",id:"interval_type",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"reverse_flow",id:"reverse_flow",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function h(e){let{components:r,...t}=e;return(0,p.kt)("wrapper",(0,n.Z)({},c,t,{components:r,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperIsochroneOpts"),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,p.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams"},(0,p.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneParams")),", ",(0,p.kt)("inlineCode",{parentName:"p"},'"point"')," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},'"profile"')," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},'"time_limit"')," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},'"distance_limit"'),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"GraphHopperIsochroneOpts"))))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"buckets"},"buckets"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"buckets"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("p",null,"Number by which to divide the given ",(0,p.kt)("inlineCode",{parentName:"p"},"time_limit")," / ",(0,p.kt)("inlineCode",{parentName:"p"},"distance_limit")," to create buckets nested\nisochrones of time intervals ",(0,p.kt)("inlineCode",{parentName:"p"},"limit-n * limit / buckets"),"."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,p.kt)("p",null,"Defaults to 1."),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,"Omit.buckets"),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L239"},"packages/graphhopper/parameters.ts:239")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"interval_type"},"interval","_","type"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"interval","_","type"),": ",(0,p.kt)("inlineCode",{parentName:"p"},'"time"')," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},'"distance"')),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L90"},"packages/graphhopper/index.ts:90")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"reverse_flow"},"reverse","_","flow"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"reverse","_","flow"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,'If false the flow goes from point to the polygon, if true the flow goes from the\npolygon "inside" to the point.'),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,p.kt)("p",null,"Defaults to false."),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,"Omit.reverse","_","flow"),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L247"},"packages/graphhopper/parameters.ts:247")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/855fb381.8c218cb5.js b/assets/js/855fb381.8c218cb5.js new file mode 100644 index 0000000..782603e --- /dev/null +++ b/assets/js/855fb381.8c218cb5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5997],{3905:(t,e,a)=>{a.d(e,{Zo:()=>m,kt:()=>g});var n=a(7294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function p(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function i(t){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?p(Object(a),!0).forEach((function(e){r(t,e,a[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):p(Object(a)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))}))}return t}function l(t,e){if(null==t)return{};var a,n,r=function(t,e){if(null==t)return{};var a,n,r={},p=Object.keys(t);for(n=0;n<p.length;n++)a=p[n],e.indexOf(a)>=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(t);for(n=0;n<p.length;n++)a=p[n],e.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),o=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):i(i({},e),t)),a},m=function(t){var e=o(t.components);return n.createElement(d.Provider,{value:e},t.children)},k={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},s=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,p=t.originalType,d=t.parentName,m=l(t,["components","mdxType","originalType","parentName"]),s=o(a),g=r,N=s["".concat(d,".").concat(g)]||s[g]||k[g]||p;return a?n.createElement(N,i(i({ref:e},m),{},{components:a})):n.createElement(N,i({ref:e},m))}));function g(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var p=a.length,i=new Array(p);i[0]=s;var l={};for(var d in e)hasOwnProperty.call(e,d)&&(l[d]=e[d]);l.originalType=t,l.mdxType="string"==typeof t?t:r,i[1]=l;for(var o=2;o<p;o++)i[o]=a[o];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}s.displayName="MDXCreateElement"},4111:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>i,default:()=>k,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const p={id:"graphhopper.GraphHopperRoutePath",title:"Interface: GraphHopperRoutePath",sidebar_label:"GraphHopperRoutePath",custom_edit_url:null},i=void 0,l={unversionedId:"api/interfaces/graphhopper.GraphHopperRoutePath",id:"api/interfaces/graphhopper.GraphHopperRoutePath",title:"Interface: GraphHopperRoutePath",description:"graphhopper.GraphHopperRoutePath",source:"@site/docs/api/interfaces/graphhopper.GraphHopperRoutePath.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperRoutePath",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperRoutePath",title:"Interface: GraphHopperRoutePath",sidebar_label:"GraphHopperRoutePath",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperRouteParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams"},next:{title:"GraphHopperRouteResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"ascend",id:"ascend",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"bbox",id:"bbox",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"descend",id:"descend",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"details",id:"details",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"distance",id:"distance",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"instructions",id:"instructions",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"points",id:"points",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"points_encoded",id:"points_encoded",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"points_order",id:"points_order",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"snapped_waypoints",id:"snapped_waypoints",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"time",id:"time",level:3},{value:"Defined in",id:"defined-in-10",level:4}],m={toc:o};function k(t){let{components:e,...a}=t;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperRoutePath"),(0,r.kt)("p",null,"A route path object that includes the points along the route as well as additional route attributes."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"ascend"},"ascend"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ascend"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The total ascent, in meters."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L470"},"packages/graphhopper/parameters.ts:470")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"bbox"},"bbox"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"bbox"),": ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"]"),(0,r.kt)("p",null,"The bounding box of the route geometry."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L483"},"packages/graphhopper/parameters.ts:483")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"descend"},"descend"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"descend"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The total descent, in meters."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L472"},"packages/graphhopper/parameters.ts:472")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"details"},"details"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"details"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Details, as requested with the details parameter.\nConsider the value ",(0,r.kt)("inlineCode",{parentName:"p"},'{"street_name": [[0,2,"Frankfurter Stra\xdfe"],[2,6,"Zollweg"]]}'),".\nIn this example, the route uses two streets: The first, Frankfurter Stra\xdfe, is used\nbetween points","[0]"," and points","[2]",", and the second, Zollweg, between points","[2]"," and points","[6]","."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"length")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/core#jsonvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONValue"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Returns the length of a String object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"[iterator]")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anchor")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"at")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"big")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blink")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bold")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"charAt")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"charCodeAt")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"codePointAt")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"concat")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endsWith")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fixed")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontcolor")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontsize")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includes")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"indexOf")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"italics")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastIndexOf")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"localeCompare")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"match")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchAll")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"normalize")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padEnd")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padStart")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"repeat")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"replace")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slice")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"small")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"split")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"startsWith")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strike")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sub")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"substr")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"substring")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sup")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toLocaleLowerCase")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toLocaleUpperCase")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toLowerCase")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toString")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toUpperCase")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"trim")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"trimEnd")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"trimLeft")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"trimRight")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"trimStart")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"valueOf")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L495"},"packages/graphhopper/parameters.ts:495")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"distance"},"distance"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"distance"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The total distance, in meters."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://www.graphhopper.com/blog/2019/11/28/routing-api-using-path-details/"},"https://www.graphhopper.com/blog/2019/11/28/routing-api-using-path-details/")," for more details."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L462"},"packages/graphhopper/parameters.ts:462")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"instructions"},"instructions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"instructions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"GraphHopperInstruction"),"[]"),(0,r.kt)("p",null,"The instructions for this route. This feature is under active development, and our\ninstructions can sometimes be misleading, so be mindful when using them for navigation."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L488"},"packages/graphhopper/parameters.ts:488")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"points"},"points"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"points"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"LineString")),(0,r.kt)("p",null,"The geometry of the route. The format depends on the value of points_encoded."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L474"},"packages/graphhopper/parameters.ts:474")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"points_encoded"},"points","_","encoded"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"points","_","encoded"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether the points and snapped_waypoints fields are polyline-encoded strings rather than\nJSON arrays of coordinates. See the field description for more information on the two formats."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L481"},"packages/graphhopper/parameters.ts:481")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"points_order"},"points","_","order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"points","_","order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"An array of indices (zero-based), specifiying the order in which the input points are visited.\nOnly present if the optimize parameter was used."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L500"},"packages/graphhopper/parameters.ts:500")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"snapped_waypoints"},"snapped","_","waypoints"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"snapped","_","waypoints"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"LineString")),(0,r.kt)("p",null,"The snapped input points. The format depends on the value of points_encoded."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L476"},"packages/graphhopper/parameters.ts:476")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"time"},"time"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"time"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The total travel time, in milliseconds."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://www.graphhopper.com/blog/2019/11/28/routing-api-using-path-details/"},"https://www.graphhopper.com/blog/2019/11/28/routing-api-using-path-details/")," for more details."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L468"},"packages/graphhopper/parameters.ts:468")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/88cbaf7a.5df204b2.js b/assets/js/88cbaf7a.5df204b2.js new file mode 100644 index 0000000..c9ff6f1 --- /dev/null +++ b/assets/js/88cbaf7a.5df204b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1673],{3905:(e,r,t)=>{t.d(r,{Zo:()=>d,kt:()=>f});var n=t(7294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function i(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function a(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?i(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function s(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},i=Object.keys(e);for(n=0;n<i.length;n++)t=i[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)t=i[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var p=n.createContext({}),l=function(e){var r=n.useContext(p),t=r;return e&&(t="function"==typeof e?e(r):a(a({},r),e)),t},d=function(e){var r=l(e.components);return n.createElement(p.Provider,{value:r},e.children)},c={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},u=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(t),f=o,m=u["".concat(p,".").concat(f)]||u[f]||c[f]||i;return t?n.createElement(m,a(a({ref:r},d),{},{components:t})):n.createElement(m,a({ref:r},d))}));function f(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=u;var s={};for(var p in r)hasOwnProperty.call(r,p)&&(s[p]=r[p]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var l=2;l<i;l++)a[l]=t[l];return n.createElement.apply(null,a)}return n.createElement.apply(null,t)}u.displayName="MDXCreateElement"},5946:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>a,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=t(7462),o=(t(7294),t(3905));const i={id:"osrm.OSRMErrorProps",title:"Interface: OSRMErrorProps",sidebar_label:"OSRMErrorProps",custom_edit_url:null},a=void 0,s={unversionedId:"api/interfaces/osrm.OSRMErrorProps",id:"api/interfaces/osrm.OSRMErrorProps",title:"Interface: OSRMErrorProps",description:"osrm.OSRMErrorProps",source:"@site/docs/api/interfaces/osrm.OSRMErrorProps.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMErrorProps",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMErrorProps",title:"Interface: OSRMErrorProps",sidebar_label:"OSRMErrorProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMDirectionsOpts",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},next:{title:"OSRMGeometryObject",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"errorCode",id:"errorcode",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"errorMessage",id:"errormessage",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"statusCode",id:"statuscode",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},d,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMErrorProps"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"OSRMErrorProps")," returns additional information about the error thrown by the\nOSRM routing engine. It sends a JSON response with the following fields: code and message,\nwhere the specific code defines the kind of error that occurred."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"ErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"OSRMErrorProps"))))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"errorcode"},"errorCode"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"errorCode"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L37"},"packages/osrm/index.ts:37")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"errormessage"},"errorMessage"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"errorMessage"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"errorMessage")," explains the error specific to that routing engine"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#errormessage"},"errorMessage")),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L11"},"packages/core/error.ts:11")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"status"},"status"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"status"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"status")," gives detailed info about that response"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#status"},"status")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L9"},"packages/core/error.ts:9")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"statuscode"},"statusCode"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"statusCode"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"statusCode")," stands for the HTTP response status code"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#statuscode"},"statusCode")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L7"},"packages/core/error.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8f93cbcd.615cc490.js b/assets/js/8f93cbcd.615cc490.js new file mode 100644 index 0000000..4953462 --- /dev/null +++ b/assets/js/8f93cbcd.615cc490.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7199],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?p(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):p(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,r,n=function(e,t){if(null==e)return{};var a,r,n={},p=Object.keys(e);for(r=0;r<p.length;r++)a=p[r],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(r=0;r<p.length;r++)a=p[r],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,p=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),k=d(a),h=n,u=k["".concat(l,".").concat(h)]||k[h]||m[h]||p;return a?r.createElement(u,i(i({ref:t},s),{},{components:a})):r.createElement(u,i({ref:t},s))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=a.length,i=new Array(p);i[0]=k;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:n,i[1]=o;for(var d=2;d<p;d++)i[d]=a[d];return r.createElement.apply(null,i)}return r.createElement.apply(null,a)}k.displayName="MDXCreateElement"},5291:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>p,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const p={id:"graphhopper.GraphHopper",title:"Class: GraphHopper",sidebar_label:"GraphHopper",custom_edit_url:null},i=void 0,o={unversionedId:"api/classes/graphhopper.GraphHopper",id:"api/classes/graphhopper.GraphHopper",title:"Class: GraphHopper",description:"graphhopper.GraphHopper",source:"@site/docs/api/classes/graphhopper.GraphHopper.md",sourceDirName:"api/classes",slug:"/api/classes/graphhopper.GraphHopper",permalink:"/routingjs/docs/api/classes/graphhopper.GraphHopper",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopper",title:"Class: GraphHopper",sidebar_label:"GraphHopper",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"RoutingJSAPIError",permalink:"/routingjs/docs/api/classes/core.RoutingJSAPIError"},next:{title:"ORS",permalink:"/routingjs/docs/api/classes/ors.ORS"}},l={},d=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"client",id:"client",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"directions",id:"directions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"matrix",id:"matrix",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"reachability",id:"reachability",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"parseDirectionsResponse",id:"parsedirectionsresponse",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"parseIsochroneResponse",id:"parseisochroneresponse",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"parseMatrixResponse",id:"parsematrixresponse",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4}],s={toc:d};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopper"),(0,n.kt)("p",null,"Performs requests to the GraphHopper API. Default public URL is\n",(0,n.kt)("a",{parentName:"p",href:"https://graphhopper.com/api/1"},"https://graphhopper.com/api/1"),"."),(0,n.kt)("p",null,"For the full documentation, see ",(0,n.kt)("a",{parentName:"p",href:"https://docs.graphhopper.com"},"https://docs.graphhopper.com"),"."),(0,n.kt)("h2",{id:"implements"},"Implements"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},(0,n.kt)("inlineCode",{parentName:"a"},"BaseRouter")))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new GraphHopper"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"clientArgs?"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"clientArgs?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"},(0,n.kt)("inlineCode",{parentName:"a"},"ClientConstructorArgs")))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L126"},"packages/graphhopper/index.ts:126")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"apikey"},"apiKey"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"apiKey"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L124"},"packages/graphhopper/index.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"client"},"client"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"client"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperclient"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperClient"))),(0,n.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},"BaseRouter"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter#client"},"client")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L123"},"packages/graphhopper/index.ts:123")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"directions"},"directions"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"directions"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirections"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperDirections")),">"),(0,n.kt)("p",null,"Get directions between two or more points. For the complete documentation, please see ",(0,n.kt)("a",{parentName:"p",href:"https://docs.graphhopper.com/#operation/postRoute"},"https://docs.graphhopper.com/#operation/postRoute"),"."),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"locations")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"][]"),(0,n.kt)("td",{parentName:"tr",align:"left"},"coordinate tuples in lat/lon format")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"profile")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"one of ",(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},"GraphHopperProfile"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"directionsOpts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirectionsopts"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperDirectionsOpts"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"optional parameters that are passed to the route endpoint. See ",(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirectionsopts"},"GraphHopperDirectionsOpts"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"false")),(0,n.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirections"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperDirections")),">"),(0,n.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,n.kt)("p",null,"BaseRouter.directions"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L163"},"packages/graphhopper/index.ts:163")),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"directions"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"directionsOpts"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"locations")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"profile")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"directionsOpts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirectionsopts"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperDirectionsOpts")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"true"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,n.kt)("p",null,"BaseRouter.directions"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L169"},"packages/graphhopper/index.ts:169")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"matrix"},"matrix"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"matrix"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhoppermatrix"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrix")),">"),(0,n.kt)("p",null,"Makes a request to the ",(0,n.kt)("inlineCode",{parentName:"p"},"/matrix")," endpoint."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Currently not available on the open source version."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://docs.graphhopper.com/#tag/Matrix-API"},"https://docs.graphhopper.com/#tag/Matrix-API")," for the full documentation."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"locations")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"][]"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Specify multiple points for which the weight-, route-, time- or distance-matrix should be calculated. In this case the starts are identical to the destinations. If there are N points, then NxN entries will be calculated. Format: ","[lat, lon]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"profile")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport.")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"matrixOpts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrixOpts"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"additional options specific to the matrix endpoint")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"false")),(0,n.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhoppermatrix"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrix")),">"),(0,n.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,n.kt)("p",null,"BaseRouter.matrix"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L369"},"packages/graphhopper/index.ts:369")),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"matrix"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"matrixOpts"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"locations")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"profile")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"matrixOpts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrixOpts")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"true"))))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,n.kt)("p",null,"BaseRouter.matrix"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L375"},"packages/graphhopper/index.ts:375")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"reachability"},"reachability"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"reachability"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"isochronesOpts?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperisochrones"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochrones")),">"),(0,n.kt)("p",null,"Gets isochrones or equidistants for a range of time/distance values around a given set of coordinates."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://docs.graphhopper.com/#tag/Isochrone-API"},"https://docs.graphhopper.com/#tag/Isochrone-API")," for the full documentation."),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"location")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"]"),(0,n.kt)("td",{parentName:"tr",align:"left"},"One coordinate pair denoting the location. Format: ","[lat, lon]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"profile")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport.")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"intervals")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"]"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Maximum range to calculate distances/durations for. You can also specify the ",(0,n.kt)("inlineCode",{parentName:"td"},"buckets")," variable to break the single value into more isochrones. For compatibility reasons, this parameter is expressed as list. In meters or seconds depending on ",(0,n.kt)("inlineCode",{parentName:"td"},"interval_type"),".")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"isochronesOpts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneOpts"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"additional options specific to the isochrone endpoint.")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"false")),(0,n.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperisochrones"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochrones")),">"),(0,n.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,n.kt)("p",null,"BaseRouter.reachability"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L265"},"packages/graphhopper/index.ts:265")),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"reachability"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"isochronesOpts"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"location")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"profile")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"intervals")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"isochronesOpts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneOpts")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"true"))))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,n.kt)("p",null,"BaseRouter.reachability"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L272"},"packages/graphhopper/index.ts:272")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"parsedirectionsresponse"},"parseDirectionsResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"parseDirectionsResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),"): ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirections"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperDirections"))),(0,n.kt)("p",null,"Parse a response object returned from the ",(0,n.kt)("inlineCode",{parentName:"p"},"/route")," endpoint and returns an Isochrone object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperRouteResponse"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"the response from the server")))),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperdirections"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperDirections"))),(0,n.kt)("p",null,"a new Directions object"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L222"},"packages/graphhopper/index.ts:222")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"parseisochroneresponse"},"parseIsochroneResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"parseIsochroneResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"center"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"intervalType"),"): ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperisochrones"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochrones"))),(0,n.kt)("p",null,"Parses a response returned from the ",(0,n.kt)("inlineCode",{parentName:"p"},"/isochrone")," endpoint and returns an Isochrones object."),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneResponse"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"a graphhopper isochrone response")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"center")),(0,n.kt)("td",{parentName:"tr",align:"left"},"[",(0,n.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),"]"),(0,n.kt)("td",{parentName:"tr",align:"left"},"the originally requested location")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"intervalType")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},'"time"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"distance"')),(0,n.kt)("td",{parentName:"tr",align:"left"},"whether isodistances or isochrones were requested")))),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperisochrones"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochrones"))),(0,n.kt)("p",null,"a new Isochrones instance"),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L334"},"packages/graphhopper/index.ts:334")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"parsematrixresponse"},"parseMatrixResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"parseMatrixResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),"): ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhoppermatrix"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrix"))),(0,n.kt)("p",null,"Parse a response returned from the ",(0,n.kt)("inlineCode",{parentName:"p"},"/matrix")," endpoint."),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrixResponse"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"a GraphHopper Matrix response")))),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhoppermatrix"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrix"))),(0,n.kt)("p",null,"a new Matrix instance"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L431"},"packages/graphhopper/index.ts:431")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8fc6b66b.31d71cf9.js b/assets/js/8fc6b66b.31d71cf9.js new file mode 100644 index 0000000..18db575 --- /dev/null +++ b/assets/js/8fc6b66b.31d71cf9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5823],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>d});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=c(r),d=o,f=u["".concat(p,".").concat(d)]||u[d]||m[d]||a;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=u;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:o,i[1]=s;for(var c=2;c<a;c++)i[c]=r[c];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}u.displayName="MDXCreateElement"},2231:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var n=r(7462),o=(r(7294),r(3905));const a={id:"osrm.OSRMGeometryObject",title:"Interface: OSRMGeometryObject",sidebar_label:"OSRMGeometryObject",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/osrm.OSRMGeometryObject",id:"api/interfaces/osrm.OSRMGeometryObject",title:"Interface: OSRMGeometryObject",description:"osrm.OSRMGeometryObject",source:"@site/docs/api/interfaces/osrm.OSRMGeometryObject.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMGeometryObject",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMGeometryObject",title:"Interface: OSRMGeometryObject",sidebar_label:"OSRMGeometryObject",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMErrorProps",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps"},next:{title:"OSRMMatrixOpts",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"}},p={},c=[{value:"Properties",id:"properties",level:2},{value:"coordinates",id:"coordinates",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function m(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMGeometryObject"),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"coordinates"},"coordinates"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"coordinates"),": ","[",(0,o.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L88"},"packages/osrm/parameters.ts:88")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"type"},"type"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"type"),": ",(0,o.kt)("inlineCode",{parentName:"p"},'"LineString"')),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L89"},"packages/osrm/parameters.ts:89")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.6170d225.js b/assets/js/935f2afb.6170d225.js new file mode 100644 index 0000000..75116ee --- /dev/null +++ b/assets/js/935f2afb.6170d225.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53],{1109:a=>{a.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Quickstart","href":"/routingjs/docs/quickstart","docId":"quickstart"},{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Table of Contents","href":"/routingjs/docs/api/modules","docId":"api/modules"},{"type":"category","label":"Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"core","href":"/routingjs/docs/api/modules/core","docId":"api/modules/core"},{"type":"link","label":"graphhopper","href":"/routingjs/docs/api/modules/graphhopper","docId":"api/modules/graphhopper"},{"type":"link","label":"ors","href":"/routingjs/docs/api/modules/ors","docId":"api/modules/ors"},{"type":"link","label":"osrm","href":"/routingjs/docs/api/modules/osrm","docId":"api/modules/osrm"},{"type":"link","label":"valhalla","href":"/routingjs/docs/api/modules/valhalla","docId":"api/modules/valhalla"}]},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Client","href":"/routingjs/docs/api/classes/core.Client","docId":"api/classes/core.Client"},{"type":"link","label":"Direction","href":"/routingjs/docs/api/classes/core.Direction","docId":"api/classes/core.Direction"},{"type":"link","label":"Directions","href":"/routingjs/docs/api/classes/core.Directions","docId":"api/classes/core.Directions"},{"type":"link","label":"Isochrone","href":"/routingjs/docs/api/classes/core.Isochrone","docId":"api/classes/core.Isochrone"},{"type":"link","label":"Isochrones","href":"/routingjs/docs/api/classes/core.Isochrones","docId":"api/classes/core.Isochrones"},{"type":"link","label":"Matrix","href":"/routingjs/docs/api/classes/core.Matrix","docId":"api/classes/core.Matrix"},{"type":"link","label":"RoutingJSAPIError","href":"/routingjs/docs/api/classes/core.RoutingJSAPIError","docId":"api/classes/core.RoutingJSAPIError"},{"type":"link","label":"GraphHopper","href":"/routingjs/docs/api/classes/graphhopper.GraphHopper","docId":"api/classes/graphhopper.GraphHopper"},{"type":"link","label":"ORS","href":"/routingjs/docs/api/classes/ors.ORS","docId":"api/classes/ors.ORS"},{"type":"link","label":"OSRM","href":"/routingjs/docs/api/classes/osrm.OSRM","docId":"api/classes/osrm.OSRM"},{"type":"link","label":"Valhalla","href":"/routingjs/docs/api/classes/valhalla.Valhalla","docId":"api/classes/valhalla.Valhalla"}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BaseRouter","href":"/routingjs/docs/api/interfaces/core.BaseRouter","docId":"api/interfaces/core.BaseRouter"},{"type":"link","label":"ClientConstructorArgs","href":"/routingjs/docs/api/interfaces/core.ClientConstructorArgs","docId":"api/interfaces/core.ClientConstructorArgs"},{"type":"link","label":"ErrorProps","href":"/routingjs/docs/api/interfaces/core.ErrorProps","docId":"api/interfaces/core.ErrorProps"},{"type":"link","label":"JSONObject","href":"/routingjs/docs/api/interfaces/core.JSONObject","docId":"api/interfaces/core.JSONObject"},{"type":"link","label":"GraphHopperErrorProps","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps","docId":"api/interfaces/graphhopper.GraphHopperErrorProps"},{"type":"link","label":"GraphHopperIsochroneOpts","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts","docId":"api/interfaces/graphhopper.GraphHopperIsochroneOpts"},{"type":"link","label":"GraphHopperIsochroneParams","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams","docId":"api/interfaces/graphhopper.GraphHopperIsochroneParams"},{"type":"link","label":"GraphHopperIsochroneResponse","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse","docId":"api/interfaces/graphhopper.GraphHopperIsochroneResponse"},{"type":"link","label":"GraphHopperMatrixOpts","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts","docId":"api/interfaces/graphhopper.GraphHopperMatrixOpts"},{"type":"link","label":"GraphHopperMatrixParams","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams","docId":"api/interfaces/graphhopper.GraphHopperMatrixParams"},{"type":"link","label":"GraphHopperMatrixResponse","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse","docId":"api/interfaces/graphhopper.GraphHopperMatrixResponse"},{"type":"link","label":"GraphHopperRouteParams","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams","docId":"api/interfaces/graphhopper.GraphHopperRouteParams"},{"type":"link","label":"GraphHopperRoutePath","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath","docId":"api/interfaces/graphhopper.GraphHopperRoutePath"},{"type":"link","label":"GraphHopperRouteResponse","href":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse","docId":"api/interfaces/graphhopper.GraphHopperRouteResponse"},{"type":"link","label":"ORSAlternateRouteParam","href":"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam","docId":"api/interfaces/ors.ORSAlternateRouteParam"},{"type":"link","label":"ORSErrorProps","href":"/routingjs/docs/api/interfaces/ors.ORSErrorProps","docId":"api/interfaces/ors.ORSErrorProps"},{"type":"link","label":"ORSIsochroneParams","href":"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams","docId":"api/interfaces/ors.ORSIsochroneParams"},{"type":"link","label":"ORSIsochroneResponse","href":"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse","docId":"api/interfaces/ors.ORSIsochroneResponse"},{"type":"link","label":"ORSMatrixParams","href":"/routingjs/docs/api/interfaces/ors.ORSMatrixParams","docId":"api/interfaces/ors.ORSMatrixParams"},{"type":"link","label":"ORSMatrixResponse","href":"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse","docId":"api/interfaces/ors.ORSMatrixResponse"},{"type":"link","label":"ORSRoute","href":"/routingjs/docs/api/interfaces/ors.ORSRoute","docId":"api/interfaces/ors.ORSRoute"},{"type":"link","label":"ORSRouteParams","href":"/routingjs/docs/api/interfaces/ors.ORSRouteParams","docId":"api/interfaces/ors.ORSRouteParams"},{"type":"link","label":"ORSRouteResponse","href":"/routingjs/docs/api/interfaces/ors.ORSRouteResponse","docId":"api/interfaces/ors.ORSRouteResponse"},{"type":"link","label":"OSRMDirectionsOpts","href":"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts","docId":"api/interfaces/osrm.OSRMDirectionsOpts"},{"type":"link","label":"OSRMErrorProps","href":"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps","docId":"api/interfaces/osrm.OSRMErrorProps"},{"type":"link","label":"OSRMGeometryObject","href":"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject","docId":"api/interfaces/osrm.OSRMGeometryObject"},{"type":"link","label":"OSRMMatrixOpts","href":"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts","docId":"api/interfaces/osrm.OSRMMatrixOpts"},{"type":"link","label":"OSRMRoute","href":"/routingjs/docs/api/interfaces/osrm.OSRMRoute","docId":"api/interfaces/osrm.OSRMRoute"},{"type":"link","label":"OSRMRouteParams","href":"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams","docId":"api/interfaces/osrm.OSRMRouteParams"},{"type":"link","label":"OSRMRouteResponse","href":"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse","docId":"api/interfaces/osrm.OSRMRouteResponse"},{"type":"link","label":"OSRMTableParams","href":"/routingjs/docs/api/interfaces/osrm.OSRMTableParams","docId":"api/interfaces/osrm.OSRMTableParams"},{"type":"link","label":"OSRMTableResponse","href":"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse","docId":"api/interfaces/osrm.OSRMTableResponse"},{"type":"link","label":"MapboxAuthParams","href":"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams","docId":"api/interfaces/valhalla.MapboxAuthParams"},{"type":"link","label":"ValhallaContours","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaContours","docId":"api/interfaces/valhalla.ValhallaContours"},{"type":"link","label":"ValhallaCostingOptsAuto","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto","docId":"api/interfaces/valhalla.ValhallaCostingOptsAuto"},{"type":"link","label":"ValhallaCostingOptsBicycle","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle","docId":"api/interfaces/valhalla.ValhallaCostingOptsBicycle"},{"type":"link","label":"ValhallaCostingOptsMotorcycle","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle","docId":"api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},{"type":"link","label":"ValhallaCostingOptsPedestrian","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian","docId":"api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},{"type":"link","label":"ValhallaCostingOptsTruck","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck","docId":"api/interfaces/valhalla.ValhallaCostingOptsTruck"},{"type":"link","label":"ValhallaDateTime","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime","docId":"api/interfaces/valhalla.ValhallaDateTime"},{"type":"link","label":"ValhallaDirectionOpts","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts","docId":"api/interfaces/valhalla.ValhallaDirectionOpts"},{"type":"link","label":"ValhallaErrorProps","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps","docId":"api/interfaces/valhalla.ValhallaErrorProps"},{"type":"link","label":"ValhallaIsochroneOpts","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts","docId":"api/interfaces/valhalla.ValhallaIsochroneOpts"},{"type":"link","label":"ValhallaIsochroneParams","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams","docId":"api/interfaces/valhalla.ValhallaIsochroneParams"},{"type":"link","label":"ValhallaIsochroneResponse","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse","docId":"api/interfaces/valhalla.ValhallaIsochroneResponse"},{"type":"link","label":"ValhallaLeg","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg","docId":"api/interfaces/valhalla.ValhallaLeg"},{"type":"link","label":"ValhallaLocation","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation","docId":"api/interfaces/valhalla.ValhallaLocation"},{"type":"link","label":"ValhallaManeuvers","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers","docId":"api/interfaces/valhalla.ValhallaManeuvers"},{"type":"link","label":"ValhallaMatrixOpts","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts","docId":"api/interfaces/valhalla.ValhallaMatrixOpts"},{"type":"link","label":"ValhallaMatrixParams","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams","docId":"api/interfaces/valhalla.ValhallaMatrixParams"},{"type":"link","label":"ValhallaMatrixResponse","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse","docId":"api/interfaces/valhalla.ValhallaMatrixResponse"},{"type":"link","label":"ValhallaRouteParams","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams","docId":"api/interfaces/valhalla.ValhallaRouteParams"},{"type":"link","label":"ValhallaRouteResponse","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse","docId":"api/interfaces/valhalla.ValhallaRouteResponse"},{"type":"link","label":"ValhallaTraceRouteOpts","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts","docId":"api/interfaces/valhalla.ValhallaTraceRouteOpts"},{"type":"link","label":"ValhallaTraceRouteParams","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams","docId":"api/interfaces/valhalla.ValhallaTraceRouteParams"},{"type":"link","label":"ValhallaTrip","href":"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip","docId":"api/interfaces/valhalla.ValhallaTrip"}]}],"href":"/routingjs/docs/api/"}]},"docs":{"api/classes/core.Client":{"id":"api/classes/core.Client","title":"Class: Client<ResponseType, GetParams, PostParams>","description":"core.Client","sidebar":"tutorialSidebar"},"api/classes/core.Direction":{"id":"api/classes/core.Direction","title":"Class: Direction<T>","description":"core.Direction","sidebar":"tutorialSidebar"},"api/classes/core.Directions":{"id":"api/classes/core.Directions","title":"Class: Directions<T, U>","description":"core.Directions","sidebar":"tutorialSidebar"},"api/classes/core.Isochrone":{"id":"api/classes/core.Isochrone","title":"Class: Isochrone<T>","description":"core.Isochrone","sidebar":"tutorialSidebar"},"api/classes/core.Isochrones":{"id":"api/classes/core.Isochrones","title":"Class: Isochrones<T, U>","description":"core.Isochrones","sidebar":"tutorialSidebar"},"api/classes/core.Matrix":{"id":"api/classes/core.Matrix","title":"Class: Matrix<T>","description":"core.Matrix","sidebar":"tutorialSidebar"},"api/classes/core.RoutingJSAPIError":{"id":"api/classes/core.RoutingJSAPIError","title":"Class: RoutingJSAPIError<T>","description":"core.RoutingJSAPIError","sidebar":"tutorialSidebar"},"api/classes/graphhopper.GraphHopper":{"id":"api/classes/graphhopper.GraphHopper","title":"Class: GraphHopper","description":"graphhopper.GraphHopper","sidebar":"tutorialSidebar"},"api/classes/ors.ORS":{"id":"api/classes/ors.ORS","title":"Class: ORS","description":"ors.ORS","sidebar":"tutorialSidebar"},"api/classes/osrm.OSRM":{"id":"api/classes/osrm.OSRM","title":"Class: OSRM","description":"osrm.OSRM","sidebar":"tutorialSidebar"},"api/classes/valhalla.Valhalla":{"id":"api/classes/valhalla.Valhalla","title":"Class: Valhalla","description":"valhalla.Valhalla","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"routingjs","description":"example workflow","sidebar":"tutorialSidebar"},"api/interfaces/core.BaseRouter":{"id":"api/interfaces/core.BaseRouter","title":"Interface: BaseRouter","description":"core.BaseRouter","sidebar":"tutorialSidebar"},"api/interfaces/core.ClientConstructorArgs":{"id":"api/interfaces/core.ClientConstructorArgs","title":"Interface: ClientConstructorArgs","description":"core.ClientConstructorArgs","sidebar":"tutorialSidebar"},"api/interfaces/core.ErrorProps":{"id":"api/interfaces/core.ErrorProps","title":"Interface: ErrorProps","description":"core.ErrorProps","sidebar":"tutorialSidebar"},"api/interfaces/core.JSONObject":{"id":"api/interfaces/core.JSONObject","title":"Interface: JSONObject","description":"core.JSONObject","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperErrorProps":{"id":"api/interfaces/graphhopper.GraphHopperErrorProps","title":"Interface: GraphHopperErrorProps","description":"graphhopper.GraphHopperErrorProps","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperIsochroneOpts":{"id":"api/interfaces/graphhopper.GraphHopperIsochroneOpts","title":"Interface: GraphHopperIsochroneOpts","description":"graphhopper.GraphHopperIsochroneOpts","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperIsochroneParams":{"id":"api/interfaces/graphhopper.GraphHopperIsochroneParams","title":"Interface: GraphHopperIsochroneParams","description":"graphhopper.GraphHopperIsochroneParams","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperIsochroneResponse":{"id":"api/interfaces/graphhopper.GraphHopperIsochroneResponse","title":"Interface: GraphHopperIsochroneResponse","description":"graphhopper.GraphHopperIsochroneResponse","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperMatrixOpts":{"id":"api/interfaces/graphhopper.GraphHopperMatrixOpts","title":"Interface: GraphHopperMatrixOpts","description":"graphhopper.GraphHopperMatrixOpts","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperMatrixParams":{"id":"api/interfaces/graphhopper.GraphHopperMatrixParams","title":"Interface: GraphHopperMatrixParams","description":"graphhopper.GraphHopperMatrixParams","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperMatrixResponse":{"id":"api/interfaces/graphhopper.GraphHopperMatrixResponse","title":"Interface: GraphHopperMatrixResponse","description":"graphhopper.GraphHopperMatrixResponse","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperRouteParams":{"id":"api/interfaces/graphhopper.GraphHopperRouteParams","title":"Interface: GraphHopperRouteParams","description":"graphhopper.GraphHopperRouteParams","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperRoutePath":{"id":"api/interfaces/graphhopper.GraphHopperRoutePath","title":"Interface: GraphHopperRoutePath","description":"graphhopper.GraphHopperRoutePath","sidebar":"tutorialSidebar"},"api/interfaces/graphhopper.GraphHopperRouteResponse":{"id":"api/interfaces/graphhopper.GraphHopperRouteResponse","title":"Interface: GraphHopperRouteResponse","description":"graphhopper.GraphHopperRouteResponse","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSAlternateRouteParam":{"id":"api/interfaces/ors.ORSAlternateRouteParam","title":"Interface: ORSAlternateRouteParam","description":"ors.ORSAlternateRouteParam","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSErrorProps":{"id":"api/interfaces/ors.ORSErrorProps","title":"Interface: ORSErrorProps","description":"ors.ORSErrorProps","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSIsochroneParams":{"id":"api/interfaces/ors.ORSIsochroneParams","title":"Interface: ORSIsochroneParams","description":"ors.ORSIsochroneParams","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSIsochroneResponse":{"id":"api/interfaces/ors.ORSIsochroneResponse","title":"Interface: ORSIsochroneResponse","description":"ors.ORSIsochroneResponse","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSMatrixParams":{"id":"api/interfaces/ors.ORSMatrixParams","title":"Interface: ORSMatrixParams","description":"ors.ORSMatrixParams","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSMatrixResponse":{"id":"api/interfaces/ors.ORSMatrixResponse","title":"Interface: ORSMatrixResponse","description":"ors.ORSMatrixResponse","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSRoute":{"id":"api/interfaces/ors.ORSRoute","title":"Interface: ORSRoute","description":"ors.ORSRoute","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSRouteParams":{"id":"api/interfaces/ors.ORSRouteParams","title":"Interface: ORSRouteParams","description":"ors.ORSRouteParams","sidebar":"tutorialSidebar"},"api/interfaces/ors.ORSRouteResponse":{"id":"api/interfaces/ors.ORSRouteResponse","title":"Interface: ORSRouteResponse","description":"ors.ORSRouteResponse","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMDirectionsOpts":{"id":"api/interfaces/osrm.OSRMDirectionsOpts","title":"Interface: OSRMDirectionsOpts","description":"osrm.OSRMDirectionsOpts","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMErrorProps":{"id":"api/interfaces/osrm.OSRMErrorProps","title":"Interface: OSRMErrorProps","description":"osrm.OSRMErrorProps","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMGeometryObject":{"id":"api/interfaces/osrm.OSRMGeometryObject","title":"Interface: OSRMGeometryObject","description":"osrm.OSRMGeometryObject","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMMatrixOpts":{"id":"api/interfaces/osrm.OSRMMatrixOpts","title":"Interface: OSRMMatrixOpts","description":"osrm.OSRMMatrixOpts","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMRoute":{"id":"api/interfaces/osrm.OSRMRoute","title":"Interface: OSRMRoute","description":"osrm.OSRMRoute","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMRouteParams":{"id":"api/interfaces/osrm.OSRMRouteParams","title":"Interface: OSRMRouteParams","description":"osrm.OSRMRouteParams","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMRouteResponse":{"id":"api/interfaces/osrm.OSRMRouteResponse","title":"Interface: OSRMRouteResponse","description":"osrm.OSRMRouteResponse","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMTableParams":{"id":"api/interfaces/osrm.OSRMTableParams","title":"Interface: OSRMTableParams","description":"osrm.OSRMTableParams","sidebar":"tutorialSidebar"},"api/interfaces/osrm.OSRMTableResponse":{"id":"api/interfaces/osrm.OSRMTableResponse","title":"Interface: OSRMTableResponse","description":"osrm.OSRMTableResponse","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.MapboxAuthParams":{"id":"api/interfaces/valhalla.MapboxAuthParams","title":"Interface: MapboxAuthParams","description":"valhalla.MapboxAuthParams","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaContours":{"id":"api/interfaces/valhalla.ValhallaContours","title":"Interface: ValhallaContours","description":"valhalla.ValhallaContours","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaCostingOptsAuto":{"id":"api/interfaces/valhalla.ValhallaCostingOptsAuto","title":"Interface: ValhallaCostingOptsAuto","description":"valhalla.ValhallaCostingOptsAuto","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaCostingOptsBicycle":{"id":"api/interfaces/valhalla.ValhallaCostingOptsBicycle","title":"Interface: ValhallaCostingOptsBicycle","description":"valhalla.ValhallaCostingOptsBicycle","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaCostingOptsMotorcycle":{"id":"api/interfaces/valhalla.ValhallaCostingOptsMotorcycle","title":"Interface: ValhallaCostingOptsMotorcycle","description":"valhalla.ValhallaCostingOptsMotorcycle","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaCostingOptsPedestrian":{"id":"api/interfaces/valhalla.ValhallaCostingOptsPedestrian","title":"Interface: ValhallaCostingOptsPedestrian","description":"valhalla.ValhallaCostingOptsPedestrian","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaCostingOptsTruck":{"id":"api/interfaces/valhalla.ValhallaCostingOptsTruck","title":"Interface: ValhallaCostingOptsTruck","description":"valhalla.ValhallaCostingOptsTruck","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaDateTime":{"id":"api/interfaces/valhalla.ValhallaDateTime","title":"Interface: ValhallaDateTime","description":"valhalla.ValhallaDateTime","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaDirectionOpts":{"id":"api/interfaces/valhalla.ValhallaDirectionOpts","title":"Interface: ValhallaDirectionOpts","description":"valhalla.ValhallaDirectionOpts","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaErrorProps":{"id":"api/interfaces/valhalla.ValhallaErrorProps","title":"Interface: ValhallaErrorProps","description":"valhalla.ValhallaErrorProps","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaIsochroneOpts":{"id":"api/interfaces/valhalla.ValhallaIsochroneOpts","title":"Interface: ValhallaIsochroneOpts","description":"valhalla.ValhallaIsochroneOpts","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaIsochroneParams":{"id":"api/interfaces/valhalla.ValhallaIsochroneParams","title":"Interface: ValhallaIsochroneParams","description":"valhalla.ValhallaIsochroneParams","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaIsochroneResponse":{"id":"api/interfaces/valhalla.ValhallaIsochroneResponse","title":"Interface: ValhallaIsochroneResponse","description":"valhalla.ValhallaIsochroneResponse","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaLeg":{"id":"api/interfaces/valhalla.ValhallaLeg","title":"Interface: ValhallaLeg","description":"valhalla.ValhallaLeg","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaLocation":{"id":"api/interfaces/valhalla.ValhallaLocation","title":"Interface: ValhallaLocation","description":"valhalla.ValhallaLocation","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaManeuvers":{"id":"api/interfaces/valhalla.ValhallaManeuvers","title":"Interface: ValhallaManeuvers","description":"valhalla.ValhallaManeuvers","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaMatrixOpts":{"id":"api/interfaces/valhalla.ValhallaMatrixOpts","title":"Interface: ValhallaMatrixOpts","description":"valhalla.ValhallaMatrixOpts","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaMatrixParams":{"id":"api/interfaces/valhalla.ValhallaMatrixParams","title":"Interface: ValhallaMatrixParams","description":"valhalla.ValhallaMatrixParams","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaMatrixResponse":{"id":"api/interfaces/valhalla.ValhallaMatrixResponse","title":"Interface: ValhallaMatrixResponse","description":"valhalla.ValhallaMatrixResponse","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaRouteParams":{"id":"api/interfaces/valhalla.ValhallaRouteParams","title":"Interface: ValhallaRouteParams","description":"valhalla.ValhallaRouteParams","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaRouteResponse":{"id":"api/interfaces/valhalla.ValhallaRouteResponse","title":"Interface: ValhallaRouteResponse","description":"valhalla.ValhallaRouteResponse","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaTraceRouteOpts":{"id":"api/interfaces/valhalla.ValhallaTraceRouteOpts","title":"Interface: ValhallaTraceRouteOpts","description":"valhalla.ValhallaTraceRouteOpts","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaTraceRouteParams":{"id":"api/interfaces/valhalla.ValhallaTraceRouteParams","title":"Interface: ValhallaTraceRouteParams","description":"valhalla.ValhallaTraceRouteParams","sidebar":"tutorialSidebar"},"api/interfaces/valhalla.ValhallaTrip":{"id":"api/interfaces/valhalla.ValhallaTrip","title":"Interface: ValhallaTrip","description":"valhalla.ValhallaTrip","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"routingjs","description":"Modules","sidebar":"tutorialSidebar"},"api/modules/core":{"id":"api/modules/core","title":"Module: core","description":"Classes","sidebar":"tutorialSidebar"},"api/modules/graphhopper":{"id":"api/modules/graphhopper","title":"Module: graphhopper","description":"Classes","sidebar":"tutorialSidebar"},"api/modules/ors":{"id":"api/modules/ors","title":"Module: ors","description":"Classes","sidebar":"tutorialSidebar"},"api/modules/osrm":{"id":"api/modules/osrm","title":"Module: osrm","description":"Classes","sidebar":"tutorialSidebar"},"api/modules/valhalla":{"id":"api/modules/valhalla","title":"Module: valhalla","description":"Classes","sidebar":"tutorialSidebar"},"quickstart":{"id":"quickstart","title":"Quickstart","description":"Installation","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/94bca0b8.da649158.js b/assets/js/94bca0b8.da649158.js new file mode 100644 index 0000000..b196bc2 --- /dev/null +++ b/assets/js/94bca0b8.da649158.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9796],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>c});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){i(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,i=function(e,t){if(null==e)return{};var a,n,i={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var p=n.createContext({}),s=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),h=s(a),c=i,m=h["".concat(p,".").concat(c)]||h[c]||u[c]||l;return a?n.createElement(m,r(r({ref:t},d),{},{components:a})):n.createElement(m,r({ref:t},d))}));function c(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=a.length,r=new Array(l);r[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,r[1]=o;for(var s=2;s<l;s++)r[s]=a[s];return n.createElement.apply(null,r)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"},2366:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>s});var n=a(7462),i=(a(7294),a(3905));const l={id:"valhalla.ValhallaDirectionOpts",title:"Interface: ValhallaDirectionOpts",sidebar_label:"ValhallaDirectionOpts",custom_edit_url:null},r=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaDirectionOpts",id:"api/interfaces/valhalla.ValhallaDirectionOpts",title:"Interface: ValhallaDirectionOpts",description:"valhalla.ValhallaDirectionOpts",source:"@site/docs/api/interfaces/valhalla.ValhallaDirectionOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaDirectionOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaDirectionOpts",title:"Interface: ValhallaDirectionOpts",sidebar_label:"ValhallaDirectionOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaDateTime",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},next:{title:"ValhallaErrorProps",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alternatives",id:"alternatives",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"avoidLocations",id:"avoidlocations",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"avoidPolygons",id:"avoidpolygons",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"costingOpts",id:"costingopts",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dateTime",id:"datetime",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"directionsType",id:"directionstype",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"instructions",id:"instructions",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"language",id:"language",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"preference",id:"preference",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"units",id:"units",level:3},{value:"Defined in",id:"defined-in-10",level:4}],d={toc:s};function u(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaDirectionOpts"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaBaseOpts")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ValhallaDirectionOpts"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"alternatives"},"alternatives"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"alternatives"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"A number denoting how many alternate routes should be provided.\nThere may be no alternates or less alternates than the user specifies.\nAlternates are not yet supported on multipoint routes (that is, routes with\nmore than 2 locations). They are also not supported on time dependent routes."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L142"},"packages/valhalla/index.ts:142")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"avoidlocations"},"avoidLocations"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"avoidLocations"),": (","[",(0,i.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"]"," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Point")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Point"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">",")[]"),(0,i.kt)("p",null,"A set of locations to exclude or avoid within a route."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"ValhallaBaseOpts.avoidLocations"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L92"},"packages/valhalla/index.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"avoidpolygons"},"avoidPolygons"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"avoidPolygons"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"Polygon")," ","|"," ","[",(0,i.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"][]","[] ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Polygon"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">",")[]"),(0,i.kt)("p",null,"Roads intersecting these polygons\nwill be avoided during path finding. If you only need to avoid a few specific roads, it's much more\nefficient to use avoid_locations. Valhalla will close open rings (i.e. copy the first coordingate to the\nlast position)."),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"ValhallaBaseOpts.avoidPolygons"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L99"},"packages/valhalla/index.ts:99")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"costingopts"},"costingOpts"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"costingOpts"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsAuto"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsTruck"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsBicycle"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsMotorcycle"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsPedestrian"))),(0,i.kt)("p",null,"Profiles can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path. Only specify the actual options dict, the profile\nwill be filled automatically. For more information, visit:\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options"},"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"ValhallaBaseOpts.costingOpts"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L83"},"packages/valhalla/index.ts:83")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"datetime"},"dateTime"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"dateTime"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaDateTime"))),(0,i.kt)("p",null,"This is the local date and time at the location. Field ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": 0: Current departure time,\n1: Specified departure time. Field ",(0,i.kt)("inlineCode",{parentName:"p"},"value"),": the date and time is specified\nin ISO 8601 format (YYYY-MM-DDThh:mm), local time."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"}," date_time = {type: 0, value: 2021-03-03T08:06:23}\n")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"ValhallaBaseOpts.dateTime"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L110"},"packages/valhalla/index.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"directionstype"},"directionsType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"directionsType"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhalladirectionstype"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaDirectionsType"))),(0,i.kt)("p",null,"'none': no instructions are returned. 'maneuvers': only maneuvers are returned.\n'instructions': maneuvers with instructions are returned. Default 'instructions'"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L160"},"packages/valhalla/index.ts:160")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"A request ID that will be returned in the response"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"ValhallaBaseOpts.id"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L70"},"packages/valhalla/index.ts:70")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"instructions"},"instructions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"instructions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether to return turn-by-turn instructions. Named for compatibility with other\nproviders. Valhalla's parameter here is 'narrative'."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L136"},"packages/valhalla/index.ts:136")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"language"},"language"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"language"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The language of the narration instructions based on the IETF BCP 47 language tag string.\nIf no language is specified or the specified language is unsupported, United States-based\nEnglish (en-US) is used."),(0,i.kt)("p",null,"See here for a list of supported languages: ",(0,i.kt)("a",{parentName:"p",href:"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#supported-language-tags"},"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#supported-language-tags")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L155"},"packages/valhalla/index.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"preference"},"preference"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"preference"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"shortest"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"fastest"')),(0,i.kt)("p",null,"Convenience argument to set the cost metric, one of ","['shortest', 'fastest']",". Note,\nthat shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called ",(0,i.kt)("inlineCode",{parentName:"p"},"preference"),"\nto be in line with the already existing parameter in the ORS adapter."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"ValhallaBaseOpts.preference"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L76"},"packages/valhalla/index.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"units"},"units"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"units"),": ",(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallarequestunit"},(0,i.kt)("inlineCode",{parentName:"a"},"ValhallaRequestUnit"))),(0,i.kt)("p",null,"Distance units for output. Allowable unit types are miles (or mi) and kilometers (or km).\nIf no unit type is specified, the units default to kilometers."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L147"},"packages/valhalla/index.ts:147")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9ae98e8e.84b27e6a.js b/assets/js/9ae98e8e.84b27e6a.js new file mode 100644 index 0000000..9587d56 --- /dev/null +++ b/assets/js/9ae98e8e.84b27e6a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6566],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});var i=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,i,r=function(e,t){if(null==e)return{};var n,i,r={},a=Object.keys(e);for(i=0;i<a.length;i++)n=a[i],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i<a.length;i++)n=a[i],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=i.createContext({}),p=function(e){var t=i.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return i.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},m=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=p(n),c=r,k=m["".concat(l,".").concat(c)]||m[c]||u[c]||a;return n?i.createElement(k,o(o({ref:t},d),{},{components:n})):i.createElement(k,o({ref:t},d))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,o=new Array(a);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:r,o[1]=s;for(var p=2;p<a;p++)o[p]=n[p];return i.createElement.apply(null,o)}return i.createElement.apply(null,n)}m.displayName="MDXCreateElement"},9014:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var i=n(7462),r=(n(7294),n(3905));const a={id:"osrm.OSRMDirectionsOpts",title:"Interface: OSRMDirectionsOpts",sidebar_label:"OSRMDirectionsOpts",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/osrm.OSRMDirectionsOpts",id:"api/interfaces/osrm.OSRMDirectionsOpts",title:"Interface: OSRMDirectionsOpts",description:"osrm.OSRMDirectionsOpts",source:"@site/docs/api/interfaces/osrm.OSRMDirectionsOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMDirectionsOpts",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMDirectionsOpts",title:"Interface: OSRMDirectionsOpts",sidebar_label:"OSRMDirectionsOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSRouteResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse"},next:{title:"OSRMErrorProps",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alternatives",id:"alternatives",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"annotations",id:"annotations",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"bearings",id:"bearings",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"continueStraight",id:"continuestraight",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"geometries",id:"geometries",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"overview",id:"overview",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"radiuses",id:"radiuses",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"steps",id:"steps",level:3},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMDirectionsOpts"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"OSRMBaseOpts")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"OSRMDirectionsOpts"))),(0,r.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrixOpts"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"alternatives"},"alternatives"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alternatives"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("p",null,"Search for alternative routes and return as well."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Please note that even if an alternative route is requested, a result cannot be guaranteed."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L69"},"packages/osrm/index.ts:69")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"annotations"},"annotations"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"annotations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Returns additional metadata for each coordinate along the route geometry."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L78"},"packages/osrm/index.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"bearings"},"bearings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"bearings"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"]",")[]"),(0,r.kt)("p",null,"Limits the search to segments with given bearing in degrees towards true north in\nclockwise direction."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"OSRMBaseOpts.bearings"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L59"},"packages/osrm/index.ts:59")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"continuestraight"},"continueStraight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"continueStraight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"default"')),(0,r.kt)("p",null,"Forces the route to keep going straight at waypoints constraining uturns there even if\nit would be faster. Default value depends on the profile."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L76"},"packages/osrm/index.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"geometries"},"geometries"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"geometries"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmgeometrytype"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryType"))),(0,r.kt)("p",null,"Returned route geometry format (influences overview and per step)"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L80"},"packages/osrm/index.ts:80")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"overview"},"overview"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"overview"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmoverviewtype"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMOverviewType"))),(0,r.kt)("p",null,"Add overview geometry either full, simplified according to highest zoom level it\ncould be display on, or not at all."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L85"},"packages/osrm/index.ts:85")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"radiuses"},"radiuses"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"radiuses"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),")[]"),(0,r.kt)("p",null,"Limits the search to given radius in meters."),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"OSRMBaseOpts.radiuses"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L54"},"packages/osrm/index.ts:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"steps"},"steps"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"steps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Return route steps for each route leg"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L71"},"packages/osrm/index.ts:71")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9e00c705.62314703.js b/assets/js/9e00c705.62314703.js new file mode 100644 index 0000000..a6a01ae --- /dev/null +++ b/assets/js/9e00c705.62314703.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[130],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(n),u=a,k=m["".concat(p,".").concat(u)]||m[u]||c[u]||i;return n?r.createElement(k,o(o({ref:t},d),{},{components:n})):r.createElement(k,o({ref:t},d))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var s=2;s<i;s++)o[s]=n[s];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"},6957:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const i={id:"core.Isochrone",title:"Class: Isochrone<T>",sidebar_label:"Isochrone",custom_edit_url:null},o=void 0,l={unversionedId:"api/classes/core.Isochrone",id:"api/classes/core.Isochrone",title:"Class: Isochrone<T>",description:"core.Isochrone",source:"@site/docs/api/classes/core.Isochrone.md",sourceDirName:"api/classes",slug:"/api/classes/core.Isochrone",permalink:"/routingjs/docs/api/classes/core.Isochrone",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.Isochrone",title:"Class: Isochrone<T>",sidebar_label:"Isochrone",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Directions",permalink:"/routingjs/docs/api/classes/core.Directions"},next:{title:"Isochrones",permalink:"/routingjs/docs/api/classes/core.Isochrones"}},p={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"center",id:"center",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"feature",id:"feature",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"interval",id:"interval",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"intervalType",id:"intervaltype",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:s};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".Isochrone"),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Isochrone"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,a.kt)("inlineCode",{parentName:"p"},"center"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"interval"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"intervalType"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"feature"),")"),(0,a.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))))),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"center")),(0,a.kt)("td",{parentName:"tr",align:"left"},"[",(0,a.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"interval")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"intervalType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"feature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Feature"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Geometry"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L11"},"packages/core/Isochrone.ts:11")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"center"},"center"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"center"),": ","[",(0,a.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L12"},"packages/core/Isochrone.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"feature"},"feature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"feature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Geometry"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L15"},"packages/core/Isochrone.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"interval"},"interval"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"interval"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L13"},"packages/core/Isochrone.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"intervaltype"},"intervalType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"intervalType"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Isochrone.ts#L14"},"packages/core/Isochrone.ts:14")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9e3cb6c3.49ec0a48.js b/assets/js/9e3cb6c3.49ec0a48.js new file mode 100644 index 0000000..2dc7781 --- /dev/null +++ b/assets/js/9e3cb6c3.49ec0a48.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8769],{3905:(e,a,t)=>{t.d(a,{Zo:()=>d,kt:()=>h});var n=t(7294);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function i(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);a&&(n=n.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,n)}return t}function r(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?i(Object(t),!0).forEach((function(a){l(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function o(e,a){if(null==e)return{};var t,n,l=function(e,a){if(null==e)return{};var t,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)t=i[n],a.indexOf(t)>=0||(l[t]=e[t]);return l}(e,a);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)t=i[n],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(l[t]=e[t])}return l}var s=n.createContext({}),p=function(e){var a=n.useContext(s),t=a;return e&&(t="function"==typeof e?e(a):r(r({},a),e)),t},d=function(e){var a=p(e.components);return n.createElement(s.Provider,{value:a},e.children)},u={inlineCode:"code",wrapper:function(e){var a=e.children;return n.createElement(n.Fragment,{},a)}},c=n.forwardRef((function(e,a){var t=e.components,l=e.mdxType,i=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=p(t),h=l,m=c["".concat(s,".").concat(h)]||c[h]||u[h]||i;return t?n.createElement(m,r(r({ref:a},d),{},{components:t})):n.createElement(m,r({ref:a},d))}));function h(e,a){var t=arguments,l=a&&a.mdxType;if("string"==typeof e||l){var i=t.length,r=new Array(i);r[0]=c;var o={};for(var s in a)hasOwnProperty.call(a,s)&&(o[s]=a[s]);o.originalType=e,o.mdxType="string"==typeof e?e:l,r[1]=o;for(var p=2;p<i;p++)r[p]=t[p];return n.createElement.apply(null,r)}return n.createElement.apply(null,t)}c.displayName="MDXCreateElement"},3138:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=t(7462),l=(t(7294),t(3905));const i={id:"valhalla.ValhallaRouteParams",title:"Interface: ValhallaRouteParams",sidebar_label:"ValhallaRouteParams",custom_edit_url:null},r=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaRouteParams",id:"api/interfaces/valhalla.ValhallaRouteParams",title:"Interface: ValhallaRouteParams",description:"valhalla.ValhallaRouteParams",source:"@site/docs/api/interfaces/valhalla.ValhallaRouteParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaRouteParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaRouteParams",title:"Interface: ValhallaRouteParams",sidebar_label:"ValhallaRouteParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaMatrixResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse"},next:{title:"ValhallaRouteResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alternates",id:"alternates",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costing",id:"costing",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"costing_options",id:"costing_options",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"date_time",id:"date_time",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"directions_options",id:"directions_options",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude_locations",id:"exclude_locations",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"exclude_polygons",id:"exclude_polygons",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"linear_references",id:"linear_references",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"locations",id:"locations",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"narrative",id:"narrative",level:3},{value:"Defined in",id:"defined-in-10",level:4}],d={toc:p};function u(e){let{components:a,...t}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,t,{components:a,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaRouteParams"),(0,l.kt)("p",null,"You specify locations as an ordered list of two or more locations within a JSON array.\nLocations are visited in the order specified."),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaRequestParams")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaRouteParams"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"alternates"},"alternates"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"alternates"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A number denoting how many alternate routes should be provided. There may be no alternates or\nless alternates than the user specifies. Alternates are not yet supported on multipoint\nroutes (that is, routes with more than 2 locations). They are also not supported on time\ndependent routes."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L33"},"packages/valhalla/parameters.ts:33")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costing"},"costing"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"costing"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallacostingtype"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingType"))),(0,l.kt)("p",null,"Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route\nrequest must include the name of the costing model and can include optional parameters available\nfor the chosen costing model."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.costing"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L81"},"packages/valhalla/parameters.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costing_options"},"costing","_","options"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"costing","_","options"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptTypes")),(0,l.kt)("p",null,"Costing methods can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.costing","_","options"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L86"},"packages/valhalla/parameters.ts:86")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"date_time"},"date","_","time"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"date","_","time"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDateTime"))),(0,l.kt)("p",null,"This is the local date and time at the location."),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L37"},"packages/valhalla/parameters.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"directions_options"},"directions","_","options"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"directions","_","options"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaDirectionsOptions")),(0,l.kt)("p",null,"Additional options specific to the ",(0,l.kt)("inlineCode",{parentName:"p"},"/route")," endpoint"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L26"},"packages/valhalla/parameters.ts:26")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exclude_locations"},"exclude","_","locations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"exclude","_","locations"),": ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,l.kt)("p",null,"A set of locations to exclude or avoid within a route can be specified using a JSON array\nof avoid_locations. The avoid_locations have the same format as the locations list. At a\nminimum each avoid location must include latitude and longitude. The avoid_locations are\nmapped to the closest road or roads and these roads are excluded from the route path computation."),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.exclude","_","locations"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L97"},"packages/valhalla/parameters.ts:97")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exclude_polygons"},"exclude","_","polygons"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"exclude","_","polygons"),": ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]","[] ","|"," ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]","[][]"),(0,l.kt)("p",null,"One or multiple exterior rings of polygons in the form of nested JSON arrays, e.g.\n[[","[lon1, lat1]",", ","[lon2,lat2]","],[","[lon1,lat1]",",","[lon2,lat2]","]]. Roads intersecting these rings\nwill be avoided during path finding. If you only need to avoid a few specific roads,\nit's much more efficient to use exclude_locations. Valhalla will close open rings (i.e.\ncopy the first coordingate to the last position)."),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.exclude","_","polygons"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L105"},"packages/valhalla/parameters.ts:105")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"Name your route request. If id is specified, the naming will be sent thru to the response."),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaRequestParams.id"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L90"},"packages/valhalla/parameters.ts:90")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"linear_references"},"linear","_","references"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"linear","_","references"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"When present and true, the successful route response will include a key linear_references.\nIts value is an array of base64-encoded OpenLR location references, one for each graph edge\nof the road network matched by the input trace."),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L43"},"packages/valhalla/parameters.ts:43")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"locations"},"locations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"locations"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaLocation")),"[]"),(0,l.kt)("p",null,"A location must include a latitude and longitude in decimal degrees. The coordinates can\ncome from many input sources, such as a GPS location, a point or a click on a map,\na geocoding service, and so on."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that the Valhalla cannot search for names or addresses or perform geocoding or\nreverse geocoding."),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L17"},"packages/valhalla/parameters.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"narrative"},"narrative"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"narrative"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"Whether or not narrative instructions should be returned for the route"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"Defaults to false."),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L24"},"packages/valhalla/parameters.ts:24")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a063e0e3.4c88e1cc.js b/assets/js/a063e0e3.4c88e1cc.js new file mode 100644 index 0000000..dcb4ff4 --- /dev/null +++ b/assets/js/a063e0e3.4c88e1cc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4884],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>d});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},o=Object.keys(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),p=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),f=p(r),d=n,m=f["".concat(s,".").concat(d)]||f[d]||c[d]||o;return r?a.createElement(m,i(i({ref:t},u),{},{components:r})):a.createElement(m,i({ref:t},u))}));function d(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:n,i[1]=l;for(var p=2;p<o;p++)i[p]=r[p];return a.createElement.apply(null,i)}return a.createElement.apply(null,r)}f.displayName="MDXCreateElement"},3603:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"ors.ORSAlternateRouteParam",title:"Interface: ORSAlternateRouteParam",sidebar_label:"ORSAlternateRouteParam",custom_edit_url:null},i=void 0,l={unversionedId:"api/interfaces/ors.ORSAlternateRouteParam",id:"api/interfaces/ors.ORSAlternateRouteParam",title:"Interface: ORSAlternateRouteParam",description:"ors.ORSAlternateRouteParam",source:"@site/docs/api/interfaces/ors.ORSAlternateRouteParam.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSAlternateRouteParam",permalink:"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSAlternateRouteParam",title:"Interface: ORSAlternateRouteParam",sidebar_label:"ORSAlternateRouteParam",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperRouteResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse"},next:{title:"ORSErrorProps",permalink:"/routingjs/docs/api/interfaces/ors.ORSErrorProps"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"share_factor",id:"share_factor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"target_count",id:"target_count",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"weight_factor",id:"weight_factor",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSAlternateRouteParam"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"share_factor"},"share","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"share","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L199"},"packages/ors/parameters.ts:199")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"target_count"},"target","_","count"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"target","_","count"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Number of alternative routes (up to 3)"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L201"},"packages/ors/parameters.ts:201")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"weight_factor"},"weight","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"weight","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L202"},"packages/ors/parameters.ts:202")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a557ae41.12866256.js b/assets/js/a557ae41.12866256.js new file mode 100644 index 0000000..8b9b22f --- /dev/null +++ b/assets/js/a557ae41.12866256.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1358],{3905:(e,r,t)=>{t.d(r,{Zo:()=>d,kt:()=>f});var n=t(7294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function i(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function s(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var p=n.createContext({}),l=function(e){var r=n.useContext(p),t=r;return e&&(t="function"==typeof e?e(r):i(i({},r),e)),t},d=function(e){var r=l(e.components);return n.createElement(p.Provider,{value:r},e.children)},c={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},u=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(t),f=o,m=u["".concat(p,".").concat(f)]||u[f]||c[f]||a;return t?n.createElement(m,i(i({ref:r},d),{},{components:t})):n.createElement(m,i({ref:r},d))}));function f(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=u;var s={};for(var p in r)hasOwnProperty.call(r,p)&&(s[p]=r[p]);s.originalType=e,s.mdxType="string"==typeof e?e:o,i[1]=s;for(var l=2;l<a;l++)i[l]=t[l];return n.createElement.apply(null,i)}return n.createElement.apply(null,t)}u.displayName="MDXCreateElement"},7014:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var n=t(7462),o=(t(7294),t(3905));const a={id:"ors.ORSErrorProps",title:"Interface: ORSErrorProps",sidebar_label:"ORSErrorProps",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/ors.ORSErrorProps",id:"api/interfaces/ors.ORSErrorProps",title:"Interface: ORSErrorProps",description:"ors.ORSErrorProps",source:"@site/docs/api/interfaces/ors.ORSErrorProps.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSErrorProps",permalink:"/routingjs/docs/api/interfaces/ors.ORSErrorProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSErrorProps",title:"Interface: ORSErrorProps",sidebar_label:"ORSErrorProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSAlternateRouteParam",permalink:"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam"},next:{title:"ORSIsochroneParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"errorCode",id:"errorcode",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"errorMessage",id:"errormessage",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"statusCode",id:"statuscode",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},d,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSErrorProps"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"ORSErrorProps")," returns additional information about the error thrown by the\nORS routing engine. It sends a JSON response with two props: error and info where the error\nprop contains the error code and message. The info prop contains the engine version and\nbuild date."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"ErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"ORSErrorProps"))))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"errorcode"},"errorCode"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"errorCode"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L48"},"packages/ors/index.ts:48")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"errormessage"},"errorMessage"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"errorMessage"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"errorMessage")," explains the error specific to that routing engine"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#errormessage"},"errorMessage")),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L11"},"packages/core/error.ts:11")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"status"},"status"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"status"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"status")," gives detailed info about that response"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#status"},"status")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L9"},"packages/core/error.ts:9")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"statuscode"},"statusCode"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"statusCode"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"statusCode")," stands for the HTTP response status code"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#statuscode"},"statusCode")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L7"},"packages/core/error.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/aa082b57.519bb473.js b/assets/js/aa082b57.519bb473.js new file mode 100644 index 0000000..01d4df4 --- /dev/null +++ b/assets/js/aa082b57.519bb473.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6161],{3905:(e,t,a)=>{a.d(t,{Zo:()=>m,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function p(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},m=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),k=s(a),u=r,N=k["".concat(o,".").concat(u)]||k[u]||d[u]||i;return a?n.createElement(N,l(l({ref:t},m),{},{components:a})):n.createElement(N,l({ref:t},m))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var s=2;s<i;s++)l[s]=a[s];return n.createElement.apply(null,l)}return n.createElement.apply(null,a)}k.displayName="MDXCreateElement"},1600:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const i={id:"osrm.OSRM",title:"Class: OSRM",sidebar_label:"OSRM",custom_edit_url:null},l=void 0,p={unversionedId:"api/classes/osrm.OSRM",id:"api/classes/osrm.OSRM",title:"Class: OSRM",description:"osrm.OSRM",source:"@site/docs/api/classes/osrm.OSRM.md",sourceDirName:"api/classes",slug:"/api/classes/osrm.OSRM",permalink:"/routingjs/docs/api/classes/osrm.OSRM",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRM",title:"Class: OSRM",sidebar_label:"OSRM",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORS",permalink:"/routingjs/docs/api/classes/ors.ORS"},next:{title:"Valhalla",permalink:"/routingjs/docs/api/classes/valhalla.Valhalla"}},o={},s=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"client",id:"client",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"directions",id:"directions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"matrix",id:"matrix",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"getDirectionParams",id:"getdirectionparams",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getMatrixParams",id:"getmatrixparams",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"parseDirectionsResponse",id:"parsedirectionsresponse",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"parseGeometry",id:"parsegeometry",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"parseMatrixResponse",id:"parsematrixresponse",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4}],m={toc:s};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRM"),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRouter")))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new OSRM"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"clientArgs?"),")"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"clientArgs?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"},(0,r.kt)("inlineCode",{parentName:"a"},"ClientConstructorArgs")))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L107"},"packages/osrm/index.ts:107")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"apikey"},"apiKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"apiKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L106"},"packages/osrm/index.ts:106")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"client"},"client"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"client"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmclient"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMClient"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},"BaseRouter"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter#client"},"client")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L105"},"packages/osrm/index.ts:105")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"directions"},"directions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"directions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirections")),">"),(0,r.kt)("p",null,"Makes a request to OSRM's ",(0,r.kt)("inlineCode",{parentName:"p"},"/route")," endpoint."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The coordinates tuple the route should be calculated from in order of visit. Format: ","[lat, lon]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Specifies the mode of transport (superfluous for OSRM)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"directionsOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirectionsOpts"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Additional parameters")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"if true, will not make the request and instead return an info string containing the URL and request parameters; for debugging")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirections")),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.directions"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L143"},"packages/osrm/index.ts:143")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"directions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"directionsOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirectionsOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.directions"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L149"},"packages/osrm/index.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matrix"},"matrix"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"matrix"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrix")),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matrixOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrixOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrix")),">"),(0,r.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.matrix"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L280"},"packages/osrm/index.ts:280")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"matrix"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matrixOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrixOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.matrix"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L286"},"packages/osrm/index.ts:286")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getdirectionparams"},"getDirectionParams"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"getDirectionParams"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMRouteParams")),">"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"directionsOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirectionsOpts")))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMRouteParams")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L179"},"packages/osrm/index.ts:179")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmatrixparams"},"getMatrixParams"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"getMatrixParams"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMTableParams")),">"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matrixOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrixOpts")))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMTableParams")),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L316"},"packages/osrm/index.ts:316")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsedirectionsresponse"},"parseDirectionsResponse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"parseDirectionsResponse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"geometryFormat?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirections"))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"response")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMRouteResponse")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"geometryFormat?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/osrm#osrmgeometrytype"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryType")))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirections"))),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L230"},"packages/osrm/index.ts:230")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsegeometry"},"parseGeometry"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"parseGeometry"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"routeGeometry?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"geometryFormat?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryObject"))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"routeGeometry?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryObject")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"geometryFormat?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/osrm#osrmgeometrytype"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryType")))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryObject"))),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L254"},"packages/osrm/index.ts:254")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsematrixresponse"},"parseMatrixResponse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"parseMatrixResponse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"response"),"): ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrix"))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"response")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMTableResponse")))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMMatrix"))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L349"},"packages/osrm/index.ts:349")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/acc2462d.9d970edb.js b/assets/js/acc2462d.9d970edb.js new file mode 100644 index 0000000..d374e33 --- /dev/null +++ b/assets/js/acc2462d.9d970edb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1973],{3905:(e,a,t)=>{t.d(a,{Zo:()=>u,kt:()=>h});var l=t(7294);function n(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function r(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);a&&(l=l.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,l)}return t}function i(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?r(Object(t),!0).forEach((function(a){n(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function s(e,a){if(null==e)return{};var t,l,n=function(e,a){if(null==e)return{};var t,l,n={},r=Object.keys(e);for(l=0;l<r.length;l++)t=r[l],a.indexOf(t)>=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(l=0;l<r.length;l++)t=r[l],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var o=l.createContext({}),p=function(e){var a=l.useContext(o),t=a;return e&&(t="function"==typeof e?e(a):i(i({},a),e)),t},u=function(e){var a=p(e.components);return l.createElement(o.Provider,{value:a},e.children)},c={inlineCode:"code",wrapper:function(e){var a=e.children;return l.createElement(l.Fragment,{},a)}},d=l.forwardRef((function(e,a){var t=e.components,n=e.mdxType,r=e.originalType,o=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),d=p(t),h=n,f=d["".concat(o,".").concat(h)]||d[h]||c[h]||r;return t?l.createElement(f,i(i({ref:a},u),{},{components:t})):l.createElement(f,i({ref:a},u))}));function h(e,a){var t=arguments,n=a&&a.mdxType;if("string"==typeof e||n){var r=t.length,i=new Array(r);i[0]=d;var s={};for(var o in a)hasOwnProperty.call(a,o)&&(s[o]=a[o]);s.originalType=e,s.mdxType="string"==typeof e?e:n,i[1]=s;for(var p=2;p<r;p++)i[p]=t[p];return l.createElement.apply(null,i)}return l.createElement.apply(null,t)}d.displayName="MDXCreateElement"},4960:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>p});var l=t(7462),n=(t(7294),t(3905));const r={id:"valhalla.ValhallaMatrixResponse",title:"Interface: ValhallaMatrixResponse",sidebar_label:"ValhallaMatrixResponse",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaMatrixResponse",id:"api/interfaces/valhalla.ValhallaMatrixResponse",title:"Interface: ValhallaMatrixResponse",description:"valhalla.ValhallaMatrixResponse",source:"@site/docs/api/interfaces/valhalla.ValhallaMatrixResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaMatrixResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaMatrixResponse",title:"Interface: ValhallaMatrixResponse",sidebar_label:"ValhallaMatrixResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaMatrixParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams"},next:{title:"ValhallaRouteParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams"}},o={},p=[{value:"Properties",id:"properties",level:2},{value:"locations",id:"locations",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"sources_to_targets",id:"sources_to_targets",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"targets",id:"targets",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"units",id:"units",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-5",level:4}],u={toc:p};function c(e){let{components:a,...t}=e;return(0,n.kt)("wrapper",(0,l.Z)({},u,t,{components:a,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaMatrixResponse"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"locations"},"locations"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"locations"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaReturnLocation"),"[]"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L371"},"packages/valhalla/parameters.ts:371")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sources"},"sources"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"sources"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaReturnLocation"),"[][]"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L369"},"packages/valhalla/parameters.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sources_to_targets"},"sources","_","to","_","targets"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"sources","_","to","_","targets"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaMatrixItem"),"[][]"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L368"},"packages/valhalla/parameters.ts:368")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"targets"},"targets"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"targets"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaReturnLocation"),"[][]"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L370"},"packages/valhalla/parameters.ts:370")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"units"},"units"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"units"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L372"},"packages/valhalla/parameters.ts:372")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"warnings"},"warnings"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"warnings"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),"; }[]"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L373"},"packages/valhalla/parameters.ts:373")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b009f941.3423c09d.js b/assets/js/b009f941.3423c09d.js new file mode 100644 index 0000000..3ec2286 --- /dev/null +++ b/assets/js/b009f941.3423c09d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2758],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>c});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){i(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,i=function(e,t){if(null==e)return{};var r,n,i={},a=Object.keys(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=p(r),c=i,f=u["".concat(l,".").concat(c)]||u[c]||m[c]||a;return r?n.createElement(f,s(s({ref:t},d),{},{components:r})):n.createElement(f,s({ref:t},d))}));function c(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=r.length,s=new Array(a);s[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var p=2;p<a;p++)s[p]=r[p];return n.createElement.apply(null,s)}return n.createElement.apply(null,r)}u.displayName="MDXCreateElement"},1234:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var n=r(7462),i=(r(7294),r(3905));const a={id:"osrm.OSRMTableParams",title:"Interface: OSRMTableParams",sidebar_label:"OSRMTableParams",custom_edit_url:null},s=void 0,o={unversionedId:"api/interfaces/osrm.OSRMTableParams",id:"api/interfaces/osrm.OSRMTableParams",title:"Interface: OSRMTableParams",description:"osrm.OSRMTableParams",source:"@site/docs/api/interfaces/osrm.OSRMTableParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMTableParams",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMTableParams",title:"Interface: OSRMTableParams",sidebar_label:"OSRMTableParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMRouteResponse",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse"},next:{title:"OSRMTableResponse",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"bearings",id:"bearings",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"coordinates",id:"coordinates",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"hint",id:"hint",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"profile",id:"profile",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"radiuses",id:"radiuses",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:p};function m(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMTableParams"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"OSRMBaseParams")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"OSRMTableParams"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"bearings"},"bearings"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"bearings"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Limits the search to segments with given bearing in degrees towards true north in\nclockwise direction."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"OSRMBaseParams.bearings"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L18"},"packages/osrm/parameters.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"coordinates"},"coordinates"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"coordinates"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"String of format ",(0,i.kt)("inlineCode",{parentName:"p"},"{longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...]"),"\nor ",(0,i.kt)("inlineCode",{parentName:"p"},"polyline({polyline})"),"."),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"OSRMBaseParams.coordinates"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L8"},"packages/osrm/parameters.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"destinations"},"destinations"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"destinations"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Use location with given index as destination."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L225"},"packages/osrm/parameters.ts:225")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"hint"},"hint"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"hint"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Hint from previous request to derive position in street network."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"OSRMBaseParams.hint"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L22"},"packages/osrm/parameters.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"profile"},"profile"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"profile"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Mode of transportation, is determined statically by the Lua profile that is used to prepare\nthe data using osrm-extract. Typically car, bike or foot if using one of the supplied profiles."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"OSRMBaseParams.profile"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L13"},"packages/osrm/parameters.ts:13")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"radiuses"},"radiuses"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"radiuses"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Limits the search to given radius in meters."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"OSRMBaseParams.radiuses"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L20"},"packages/osrm/parameters.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sources"},"sources"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"sources"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Use location with given index as source."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L223"},"packages/osrm/parameters.ts:223")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b45c6e46.e5ecd680.js b/assets/js/b45c6e46.e5ecd680.js new file mode 100644 index 0000000..4495006 --- /dev/null +++ b/assets/js/b45c6e46.e5ecd680.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7494],{3905:(e,r,t)=>{t.d(r,{Zo:()=>h,kt:()=>d});var n=t(7294);function a(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function p(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function i(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?p(Object(t),!0).forEach((function(r){a(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):p(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function o(e,r){if(null==e)return{};var t,n,a=function(e,r){if(null==e)return{};var t,n,a={},p=Object.keys(e);for(n=0;n<p.length;n++)t=p[n],r.indexOf(t)>=0||(a[t]=e[t]);return a}(e,r);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n<p.length;n++)t=p[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=n.createContext({}),s=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):i(i({},r),e)),t},h=function(e){var r=s(e.components);return n.createElement(l.Provider,{value:r},e.children)},c={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},u=n.forwardRef((function(e,r){var t=e.components,a=e.mdxType,p=e.originalType,l=e.parentName,h=o(e,["components","mdxType","originalType","parentName"]),u=s(t),d=a,m=u["".concat(l,".").concat(d)]||u[d]||c[d]||p;return t?n.createElement(m,i(i({ref:r},h),{},{components:t})):n.createElement(m,i({ref:r},h))}));function d(e,r){var t=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var p=t.length,i=new Array(p);i[0]=u;var o={};for(var l in r)hasOwnProperty.call(r,l)&&(o[l]=r[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var s=2;s<p;s++)i[s]=t[s];return n.createElement.apply(null,i)}return n.createElement.apply(null,t)}u.displayName="MDXCreateElement"},8116:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>p,metadata:()=>o,toc:()=>s});var n=t(7462),a=(t(7294),t(3905));const p={id:"graphhopper.GraphHopperIsochroneParams",title:"Interface: GraphHopperIsochroneParams",sidebar_label:"GraphHopperIsochroneParams",custom_edit_url:null},i=void 0,o={unversionedId:"api/interfaces/graphhopper.GraphHopperIsochroneParams",id:"api/interfaces/graphhopper.GraphHopperIsochroneParams",title:"Interface: GraphHopperIsochroneParams",description:"graphhopper.GraphHopperIsochroneParams",source:"@site/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperIsochroneParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperIsochroneParams",title:"Interface: GraphHopperIsochroneParams",sidebar_label:"GraphHopperIsochroneParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperIsochroneOpts",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts"},next:{title:"GraphHopperIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse"}},l={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"buckets",id:"buckets",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"distance_limit",id:"distance_limit",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"point",id:"point",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"profile",id:"profile",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"reverse_flow",id:"reverse_flow",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"time_limit",id:"time_limit",level:3},{value:"Defined in",id:"defined-in-5",level:4}],h={toc:s};function c(e){let{components:r,...t}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,t,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperIsochroneParams"),(0,a.kt)("p",null,"All parameters accepted by the ",(0,a.kt)("inlineCode",{parentName:"p"},"/isocrhone")," endpoint"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperBaseParams")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"GraphHopperIsochroneParams"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"buckets"},"buckets"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"buckets"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Number by which to divide the given ",(0,a.kt)("inlineCode",{parentName:"p"},"time_limit")," / ",(0,a.kt)("inlineCode",{parentName:"p"},"distance_limit")," to create buckets nested\nisochrones of time intervals ",(0,a.kt)("inlineCode",{parentName:"p"},"limit-n * limit / buckets"),"."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"Defaults to 1."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L239"},"packages/graphhopper/parameters.ts:239")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"distance_limit"},"distance","_","limit"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"distance","_","limit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Specify which distance the vehicle should travel. In meters."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L231"},"packages/graphhopper/parameters.ts:231")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"point"},"point"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"point"),": ","[",(0,a.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"]"),(0,a.kt)("p",null,"A single Lon/Lat tuple."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L222"},"packages/graphhopper/parameters.ts:222")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"profile"},"profile"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"profile"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperprofile"},(0,a.kt)("inlineCode",{parentName:"a"},"GraphHopperProfile"))),(0,a.kt)("p",null,"The vehicle for which the route should be calculated."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperBaseParams.profile"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L9"},"packages/graphhopper/parameters.ts:9")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"reverse_flow"},"reverse","_","flow"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"reverse","_","flow"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,'If false the flow goes from point to the polygon, if true the flow goes from the\npolygon "inside" to the point.'),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"Defaults to false."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L247"},"packages/graphhopper/parameters.ts:247")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"time_limit"},"time","_","limit"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"time","_","limit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Specify which time the vehicle should travel. In seconds."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"Defaults to 600."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L229"},"packages/graphhopper/parameters.ts:229")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b4f090cd.61d7a88c.js b/assets/js/b4f090cd.61d7a88c.js new file mode 100644 index 0000000..b166c9f --- /dev/null +++ b/assets/js/b4f090cd.61d7a88c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2378],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>N});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),k=d(n),N=r,c=k["".concat(o,".").concat(N)]||k[N]||s[N]||i;return n?a.createElement(c,p(p({ref:t},m),{},{components:n})):a.createElement(c,p({ref:t},m))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=k;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,p[1]=l;for(var d=2;d<i;d++)p[d]=n[d];return a.createElement.apply(null,p)}return a.createElement.apply(null,n)}k.displayName="MDXCreateElement"},4186:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"core.BaseRouter",title:"Interface: BaseRouter",sidebar_label:"BaseRouter",custom_edit_url:null},p=void 0,l={unversionedId:"api/interfaces/core.BaseRouter",id:"api/interfaces/core.BaseRouter",title:"Interface: BaseRouter",description:"core.BaseRouter",source:"@site/docs/api/interfaces/core.BaseRouter.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/core.BaseRouter",permalink:"/routingjs/docs/api/interfaces/core.BaseRouter",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.BaseRouter",title:"Interface: BaseRouter",sidebar_label:"BaseRouter",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Valhalla",permalink:"/routingjs/docs/api/classes/valhalla.Valhalla"},next:{title:"ClientConstructorArgs",permalink:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"}},o={},d=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"client",id:"client",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"directions",id:"directions",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"mapMatch",id:"mapmatch",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-2",level:4},{value:"matrix",id:"matrix",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"reachability",id:"reachability",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-4",level:4}],m={toc:d};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".BaseRouter"),(0,r.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/graphhopper.GraphHopper"},(0,r.kt)("inlineCode",{parentName:"a"},"GraphHopper"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/ors.ORS"},(0,r.kt)("inlineCode",{parentName:"a"},"ORS"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/osrm.OSRM"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRM"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/valhalla.Valhalla"},(0,r.kt)("inlineCode",{parentName:"a"},"Valhalla")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"client"},"client"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"client"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Client"},(0,r.kt)("inlineCode",{parentName:"a"},"Client")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L52"},"packages/core/BaseRouter.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"directions"},"directions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"directions"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[][]",", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"symbol"),", ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core#jsonvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONValue")),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"),"[][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"directionsOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"),", ",(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/core#jsonvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONValue")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L58"},"packages/core/BaseRouter.ts:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mapmatch"},"mapMatch"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"mapMatch"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),": ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"][]",", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"mapMatchOpts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"mapMatchOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mapMatchOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L80"},"packages/core/BaseRouter.ts:80")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matrix"},"matrix"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"matrix"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),": ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"][]",", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,r.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,r.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matrixOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h5",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,r.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L65"},"packages/core/BaseRouter.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reachability"},"reachability"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"reachability"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"location"),": ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"]",", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"intervals"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"isochronesOpts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"Isochrones")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isochronesOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"Isochrones")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"intervals")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isochronesOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,r.kt)("inlineCode",{parentName:"a"},"JSONObject")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h5",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"Isochrones")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/BaseRouter.ts#L72"},"packages/core/BaseRouter.ts:72")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b567fbc2.889188ad.js b/assets/js/b567fbc2.889188ad.js new file mode 100644 index 0000000..c650e7e --- /dev/null +++ b/assets/js/b567fbc2.889188ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8318],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(n),k=r,m=c["".concat(p,".").concat(k)]||c[k]||u[k]||i;return n?a.createElement(m,s(s({ref:t},d),{},{components:n})):a.createElement(m,s({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,s[1]=o;for(var l=2;l<i;l++)s[l]=n[l];return a.createElement.apply(null,s)}return a.createElement.apply(null,n)}c.displayName="MDXCreateElement"},2890:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const i={id:"ors",title:"Module: ors",sidebar_label:"ors",sidebar_position:0,custom_edit_url:null},s=void 0,o={unversionedId:"api/modules/ors",id:"api/modules/ors",title:"Module: ors",description:"Classes",source:"@site/docs/api/modules/ors.md",sourceDirName:"api/modules",slug:"/api/modules/ors",permalink:"/routingjs/docs/api/modules/ors",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ors",title:"Module: ors",sidebar_label:"ors",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"graphhopper",permalink:"/routingjs/docs/api/modules/graphhopper"},next:{title:"osrm",permalink:"/routingjs/docs/api/modules/osrm"}},p={},l=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"ORSAPIError",id:"orsapierror",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ORSAttribute",id:"orsattribute",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ORSClient",id:"orsclient",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ORSDirections",id:"orsdirections",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ORSDirectionsOpts",id:"orsdirectionsopts",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ORSExtraInfo",id:"orsextrainfo",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"ORSFormat",id:"orsformat",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"ORSInstructionFormat",id:"orsinstructionformat",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"ORSIsoAttribute",id:"orsisoattribute",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"ORSIsochroneOpts",id:"orsisochroneopts",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ORSIsochrones",id:"orsisochrones",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"ORSMatrix",id:"orsmatrix",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"ORSMatrixOpts",id:"orsmatrixopts",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ORSPreference",id:"orspreference",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"ORSProfile",id:"orsprofile",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"ORSUnit",id:"orsunit",level:3},{value:"Defined in",id:"defined-in-15",level:4}],d={toc:l};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/ors.ORS"},"ORS"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam"},"ORSAlternateRouteParam")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSErrorProps"},"ORSErrorProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams"},"ORSIsochroneParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse"},"ORSIsochroneResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams"},"ORSMatrixParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse"},"ORSMatrixResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSRoute"},"ORSRoute")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSRouteParams"},"ORSRouteParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse"},"ORSRouteResponse"))),(0,r.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,r.kt)("h3",{id:"orsapierror"},"ORSAPIError"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSAPIError"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.RoutingJSAPIError"},(0,r.kt)("inlineCode",{parentName:"a"},"RoutingJSAPIError")),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSErrorProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSErrorProps")),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L51"},"packages/ors/index.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsattribute"},"ORSAttribute"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSAttribute"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"avgspeed"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"detourfactor"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"percentage"')),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L207"},"packages/ors/parameters.ts:207")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsclient"},"ORSClient"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSClient"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Client"},(0,r.kt)("inlineCode",{parentName:"a"},"Client")),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSRouteResponse"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneResponse"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixResponse")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined"),", ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSRouteParams"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSRouteParams"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixParams"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneParams")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L82"},"packages/ors/index.ts:82")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsdirections"},"ORSDirections"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSDirections"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,r.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSRouteResponse")),", ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSRoute"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSRoute")),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L76"},"packages/ors/index.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsdirectionsopts"},"ORSDirectionsOpts"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSDirectionsOpts"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSRouteParams"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSRouteParams")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"coordinates"'),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L64"},"packages/ors/index.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsextrainfo"},"ORSExtraInfo"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSExtraInfo"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"steepness"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"suitability"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"surface"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"waycategory"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"waytype"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"tollways"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"traildifficulty"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"roadaccessrestrictions"')),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L208"},"packages/ors/parameters.ts:208")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsformat"},"ORSFormat"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSFormat"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"geojson"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"json"')),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L218"},"packages/ors/parameters.ts:218")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsinstructionformat"},"ORSInstructionFormat"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSInstructionFormat"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"html"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"text"')),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L217"},"packages/ors/parameters.ts:217")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsisoattribute"},"ORSIsoAttribute"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSIsoAttribute"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"area"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"reachfactor"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"total_pop"')),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L219"},"packages/ors/parameters.ts:219")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsisochroneopts"},"ORSIsochroneOpts"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSIsochroneOpts"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneParams")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"locations"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"range"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"interval"'),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L71"},"packages/ors/index.ts:71")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsisochrones"},"ORSIsochrones"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSIsochrones"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"Isochrones")),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneResponse")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L78"},"packages/ors/index.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsmatrix"},"ORSMatrix"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSMatrix"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,r.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixResponse")),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L80"},"packages/ors/index.ts:80")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsmatrixopts"},"ORSMatrixOpts"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSMatrixOpts"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixParams")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"metrics"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"resolve_locations"'),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L66"},"packages/ors/index.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orspreference"},"ORSPreference"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSPreference"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"fastest"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"shortest"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"recommended"')),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L205"},"packages/ors/parameters.ts:205")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsprofile"},"ORSProfile"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSProfile"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"driving-car"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"driving-hgv"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"foot-walking"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"foot-hiking"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"cycling-regular"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"cycling-road"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"cycling-mountain"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"cycling-electric"')),(0,r.kt)("p",null,"Specifies the mode of transport."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L4"},"packages/ors/parameters.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orsunit"},"ORSUnit"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ORSUnit"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"m"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"km"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"mi"')),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L206"},"packages/ors/parameters.ts:206")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b5c59fa7.efc789c1.js b/assets/js/b5c59fa7.efc789c1.js new file mode 100644 index 0000000..171428a --- /dev/null +++ b/assets/js/b5c59fa7.efc789c1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39],{3905:(e,t,a)=>{a.d(t,{Zo:()=>u,kt:()=>f});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?r(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):r(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function i(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},r=Object.keys(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var s=n.createContext({}),p=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},u=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,r=e.originalType,s=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=p(a),f=l,h=d["".concat(s,".").concat(f)]||d[f]||c[f]||r;return a?n.createElement(h,o(o({ref:t},u),{},{components:a})):n.createElement(h,o({ref:t},u))}));function f(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var r=a.length,o=new Array(r);o[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:l,o[1]=i;for(var p=2;p<r;p++)o[p]=a[p];return n.createElement.apply(null,o)}return n.createElement.apply(null,a)}d.displayName="MDXCreateElement"},8774:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>i,toc:()=>p});var n=a(7462),l=(a(7294),a(3905));const r={id:"valhalla.ValhallaContours",title:"Interface: ValhallaContours",sidebar_label:"ValhallaContours",custom_edit_url:null},o=void 0,i={unversionedId:"api/interfaces/valhalla.ValhallaContours",id:"api/interfaces/valhalla.ValhallaContours",title:"Interface: ValhallaContours",description:"valhalla.ValhallaContours",source:"@site/docs/api/interfaces/valhalla.ValhallaContours.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaContours",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaContours",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaContours",title:"Interface: ValhallaContours",sidebar_label:"ValhallaContours",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"MapboxAuthParams",permalink:"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams"},next:{title:"ValhallaCostingOptsAuto",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"color",id:"color",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"distance",id:"distance",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"time",id:"time",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:p};function c(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},u,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaContours"),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"color"},"color"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"color"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,'The color for the output of the contour. Specify it as a Hex value, but without the #,\nsuch as "color":"ff0000" for red. If no color is specified, the isochrone service will\nassign a default color to the output.'),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L172"},"packages/valhalla/parameters.ts:172")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"distance"},"distance"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"distance"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A floating point value specifying the distance in kilometers for the contour."),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L166"},"packages/valhalla/parameters.ts:166")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"time"},"time"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"time"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A floating point value specifying the time in minutes for the contour."),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L164"},"packages/valhalla/parameters.ts:164")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bc512349.1db77f72.js b/assets/js/bc512349.1db77f72.js new file mode 100644 index 0000000..4dc6d3e --- /dev/null +++ b/assets/js/bc512349.1db77f72.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5133],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=p(n),k=r,c=m["".concat(l,".").concat(k)]||m[k]||u[k]||i;return n?a.createElement(c,o(o({ref:t},d),{},{components:n})):a.createElement(c,o({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:r,o[1]=s;for(var p=2;p<i;p++)o[p]=n[p];return a.createElement.apply(null,o)}return a.createElement.apply(null,n)}m.displayName="MDXCreateElement"},1533:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const i={id:"ors.ORSIsochroneParams",title:"Interface: ORSIsochroneParams",sidebar_label:"ORSIsochroneParams",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/ors.ORSIsochroneParams",id:"api/interfaces/ors.ORSIsochroneParams",title:"Interface: ORSIsochroneParams",description:"ors.ORSIsochroneParams",source:"@site/docs/api/interfaces/ors.ORSIsochroneParams.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSIsochroneParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSIsochroneParams",title:"Interface: ORSIsochroneParams",sidebar_label:"ORSIsochroneParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSErrorProps",permalink:"/routingjs/docs/api/interfaces/ors.ORSErrorProps"},next:{title:"ORSIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"area_units",id:"area_units",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"intersections",id:"intersections",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"interval",id:"interval",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"location_type",id:"location_type",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"locations",id:"locations",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"range",id:"range",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"range_type",id:"range_type",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"smoothing",id:"smoothing",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"time",id:"time",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"units",id:"units",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSIsochroneParams"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"ORSBaseParams")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ORSIsochroneParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"area_units"},"area","_","units"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"area","_","units"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsunit"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSUnit"))),(0,r.kt)("p",null,"Specifies the area unit."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"m"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L157"},"packages/ors/parameters.ts:157")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"attributes"},"attributes"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"attributes"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsisoattribute"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsoAttribute")),"[]"),(0,r.kt)("p",null,"List of isochrones attributes"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L120"},"packages/ors/parameters.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Arbitrary identification string of the request reflected in the meta information."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"ORSBaseParams.id"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L16"},"packages/ors/parameters.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"intersections"},"intersections"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"intersections"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Specifies whether to return intersecting polygons."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"false"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L127"},"packages/ors/parameters.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"interval"},"interval"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"interval"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Interval of isochrones or equidistants. This is only used if a single range value is given.\nValue in seconds for time and meters for distance."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"false"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L135"},"packages/ors/parameters.ts:135")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"location_type"},"location","_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"location","_","type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"start"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"destination"')),(0,r.kt)("p",null,"start treats the location(s) as starting point, destination as goal."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"start"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L142"},"packages/ors/parameters.ts:142")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"locations"},"locations"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"locations"),": ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"][]"),(0,r.kt)("p",null,"The locations to use for the route as an array of longitude/latitude pairs"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L113"},"packages/ors/parameters.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"options"},"options"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"options"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"object")),(0,r.kt)("p",null,"Additional options for the isochrones request"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L151"},"packages/ors/parameters.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"range"},"range"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"range"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Maximum range value of the analysis in seconds for time and metres for distance. Alternatively\na comma separated list of specific range values. Ranges will be the same for all locations."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L118"},"packages/ors/parameters.ts:118")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"range_type"},"range","_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"range","_","type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"time"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"distance"')),(0,r.kt)("p",null,"Specifies the isochrones reachability type."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L144"},"packages/ors/parameters.ts:144")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"smoothing"},"smoothing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"smoothing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Applies a level of generalisation to the isochrone polygons generated as a ",(0,r.kt)("inlineCode",{parentName:"p"},"smoothing_factor"),"\nbetween 0 and 100.0."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L149"},"packages/ors/parameters.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"time"},"time"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"time"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Departure date and time provided in local time zone"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L159"},"packages/ors/parameters.ts:159")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"units"},"units"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"units"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsunit"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSUnit"))),(0,r.kt)("p",null,"Specifies the distance units only if range_type is set to distance."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,r.kt)("p",null,"Default: m."),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"ORSBaseParams.units"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L23"},"packages/ors/parameters.ts:23")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c1888b50.bd558eb1.js b/assets/js/c1888b50.bd558eb1.js new file mode 100644 index 0000000..3935bac --- /dev/null +++ b/assets/js/c1888b50.bd558eb1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3308],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var l=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);t&&(l=l.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,l)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,l,n=function(e,t){if(null==e)return{};var a,l,n={},i=Object.keys(e);for(l=0;l<i.length;l++)a=i[l],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(l=0;l<i.length;l++)a=i[l],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=l.createContext({}),p=function(e){var t=l.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=p(e.components);return l.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return l.createElement(l.Fragment,{},t)}},h=l.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),h=p(a),k=n,c=h["".concat(o,".").concat(k)]||h[k]||u[k]||i;return a?l.createElement(c,r(r({ref:t},d),{},{components:a})):l.createElement(c,r({ref:t},d))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,r=new Array(i);r[0]=h;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:n,r[1]=s;for(var p=2;p<i;p++)r[p]=a[p];return l.createElement.apply(null,r)}return l.createElement.apply(null,a)}h.displayName="MDXCreateElement"},9627:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var l=a(7462),n=(a(7294),a(3905));const i={id:"valhalla.ValhallaCostingOptsMotorcycle",title:"Interface: ValhallaCostingOptsMotorcycle",sidebar_label:"ValhallaCostingOptsMotorcycle",custom_edit_url:null},r=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaCostingOptsMotorcycle",id:"api/interfaces/valhalla.ValhallaCostingOptsMotorcycle",title:"Interface: ValhallaCostingOptsMotorcycle",description:"valhalla.ValhallaCostingOptsMotorcycle",source:"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaCostingOptsMotorcycle",title:"Interface: ValhallaCostingOptsMotorcycle",sidebar_label:"ValhallaCostingOptsMotorcycle",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaCostingOptsBicycle",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"},next:{title:"ValhallaCostingOptsPedestrian",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"closure_factor",id:"closure_factor",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"country_crossing_cost",id:"country_crossing_cost",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"country_crossing_penalty",id:"country_crossing_penalty",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude_cash_only_tolls",id:"exclude_cash_only_tolls",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"exclude_unpaved",id:"exclude_unpaved",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"ferry_cost",id:"ferry_cost",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fixed_speed",id:"fixed_speed",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"gate_cost",id:"gate_cost",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"gate_penalty",id:"gate_penalty",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"height",id:"height",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"ignore_closures",id:"ignore_closures",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"include_hot",id:"include_hot",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"include_hov2",id:"include_hov2",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"include_hov3",id:"include_hov3",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"maneuver_penalty",id:"maneuver_penalty",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"private_access_penalty",id:"private_access_penalty",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"service_factor",id:"service_factor",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"service_penalty",id:"service_penalty",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"shortest",id:"shortest",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"toll_booth_cost",id:"toll_booth_cost",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"toll_booth_penalty",id:"toll_booth_penalty",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"top_speed",id:"top_speed",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"use_ferry",id:"use_ferry",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"use_highways",id:"use_highways",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"use_living_streets",id:"use_living_streets",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"use_tolls",id:"use_tolls",level:3},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"use_tracks",id:"use_tracks",level:3},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"use_trails",id:"use_trails",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"width",id:"width",level:3},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-28",level:4}],d={toc:p};function u(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,l.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaCostingOptsMotorcycle"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsAuto"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ValhallaCostingOptsMotorcycle"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"closure_factor"},"closure","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"closure","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that penalizes the cost when traversing a closed edge (eg: if\nsearch_filter.exclude_closures is false for origin and/or destination location and the\nroute starts/ends on closed edges). Its value can range from 1.0 - don't penalize closed\nedges, to 10.0 - apply high cost penalty to closed edges."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default value is 9.0."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle,\nmotor_scooter, bus, truck & taxi"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#closure_factor"},"closure_factor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L979"},"packages/valhalla/parameters.ts:979")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"country_crossing_cost"},"country","_","crossing","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"country","_","crossing","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A cost applied when encountering an international border. This cost is added to the\nestimated and elapsed times."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default cost is 600 seconds."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#country_crossing_cost"},"country_crossing_cost")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L746"},"packages/valhalla/parameters.ts:746")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"country_crossing_penalty"},"country","_","crossing","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"country","_","crossing","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied for a country crossing. This penalty can be used to create paths that\navoid spanning country boundaries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default penalty is 0."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#country_crossing_penalty"},"country_crossing_penalty")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L754"},"packages/valhalla/parameters.ts:754")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude_cash_only_tolls"},"exclude","_","cash","_","only","_","tolls"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude","_","cash","_","only","_","tolls"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to avoid routes with cash-only tolls."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#exclude_cash_only_tolls"},"exclude_cash_only_tolls")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1009"},"packages/valhalla/parameters.ts:1009")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude_unpaved"},"exclude","_","unpaved"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude","_","unpaved"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"1")),(0,n.kt)("p",null,"This value indicates whether or not the path may include unpaved roads. If exclude_unpaved\nis set to 1 it is allowed to start and end with unpaved roads, but is not allowed to\nhave them in the middle of the route path, otherwise they are allowed."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#exclude_unpaved"},"exclude_unpaved")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1002"},"packages/valhalla/parameters.ts:1002")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ferry_cost"},"ferry","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ferry","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A cost applied when entering a ferry. This cost is added to the estimated and elapsed times."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default cost is 300 seconds (5 minutes)."),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#ferry_cost"},"ferry_cost")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L892"},"packages/valhalla/parameters.ts:892")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fixed_speed"},"fixed","_","speed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fixed","_","speed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Fixed speed the vehicle can go. Used to override the calculated speed. Can be useful if\nspeed of vehicle is known. fixed_speed must be between 1 and 252 KPH."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 KPH which disables fixed speed and falls back to the standard\ncalculated speed based on the road attribution."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#fixed_speed"},"fixed_speed")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L955"},"packages/valhalla/parameters.ts:955")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gate_cost"},"gate","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"gate","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#gate_cost"},"gate_cost")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L737"},"packages/valhalla/parameters.ts:737")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gate_penalty"},"gate","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"gate","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#gate_penalty"},"gate_penalty")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L738"},"packages/valhalla/parameters.ts:738")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The height of the vehicle (in meters)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 1.9 for car, bus, taxi and 4.11 for truck."),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#height"},"height")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L986"},"packages/valhalla/parameters.ts:986")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ignore_closures"},"ignore","_","closures"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ignore","_","closures"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"If set to true, ignores all closures, marked due to live traffic closures,\nduring routing."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note: This option cannot be set if location.search_filter.exclude_closures is also\nspecified in the request and will return an error if it is."),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#ignore_closures"},"ignore_closures")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L965"},"packages/valhalla/parameters.ts:965")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include_hot"},"include","_","hot"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include","_","hot"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to include tolled HOV roads which require the driver\nto pay a toll if the occupant requirement isn't met."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#include_hot"},"include_hot")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1033"},"packages/valhalla/parameters.ts:1033")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include_hov2"},"include","_","hov2"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include","_","hov2"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to include HOV roads with a 2-occupant requirement\nin the route when advantageous."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#include_hov2"},"include_hov2")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1017"},"packages/valhalla/parameters.ts:1017")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include_hov3"},"include","_","hov3"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include","_","hov3"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A boolean value which indicates the desire to include HOV roads with a 3-occupant requirement\nin the route when advantageous."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default false."),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#include_hov3"},"include_hov3")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1025"},"packages/valhalla/parameters.ts:1025")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"maneuver_penalty"},"maneuver","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"maneuver","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#maneuver_penalty"},"maneuver_penalty")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L736"},"packages/valhalla/parameters.ts:736")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"private_access_penalty"},"private","_","access","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"private","_","access","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied when transitioning between roads that do not have consistent\nnaming\u2013in other words, no road names in common. This penalty can be used to create\nsimpler routes that tend to have fewer maneuvers or narrative guidance instructions."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default maneuver penalty is five seconds."),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#private_access_penalty"},"private_access_penalty")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L869"},"packages/valhalla/parameters.ts:869")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"service_factor"},"service","_","factor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"service","_","factor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A factor that modifies (multiplies) the cost when generic service roads are encountered."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default service_factor is 1."),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#service_factor"},"service_factor")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L938"},"packages/valhalla/parameters.ts:938")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"service_penalty"},"service","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"service","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied for transition to generic service road. The default penalty is 0 for\ntrucks and 15 for cars, buses, motor scooters and motorcycles."),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#service_penalty"},"service_penalty")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L719"},"packages/valhalla/parameters.ts:719")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shortest"},"shortest"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shortest"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Changes the metric to quasi-shortest, i.e. purely distance-based costing."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note, this will disable all other costings & penalties. Also note, shortest will not\ndisable hierarchy pruning, leading to potentially sub-optimal routes for some costing\nmodels."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default is false."),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#shortest"},"shortest")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L732"},"packages/valhalla/parameters.ts:732")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"toll_booth_cost"},"toll","_","booth","_","cost"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"toll","_","booth","_","cost"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A cost applied when a toll booth is encountered. This cost is added to the estimated and\nelapsed times."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default cost is 15 seconds."),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#toll_booth_cost"},"toll_booth_cost")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L877"},"packages/valhalla/parameters.ts:877")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"toll_booth_penalty"},"toll","_","booth","_","penalty"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"toll","_","booth","_","penalty"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"A penalty applied to the cost when a toll booth is encountered. This penalty can be used to\ncreate paths that avoid toll roads."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default toll booth penalty is 0."),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#toll_booth_penalty"},"toll_booth_penalty")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L885"},"packages/valhalla/parameters.ts:885")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"top_speed"},"top","_","speed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"top","_","speed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Top speed the vehicle can go. Also used to avoid roads with higher speeds than this\nvalue. top_speed must be between 10 and 252 KPH."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 140 KPH."),(0,n.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#top_speed"},"top_speed")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L946"},"packages/valhalla/parameters.ts:946")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_ferry"},"use","_","ferry"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","ferry"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take ferries. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.5."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely."),(0,n.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_ferry"},"use_ferry")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L700"},"packages/valhalla/parameters.ts:700")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_highways"},"use","_","highways"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","highways"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take highways. This is a range of values between 0\nand 1. Values near 0 attempt to avoid highways and values near 1 will favor highways."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 1.0."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes highways are required to complete a route so\nvalues of 0 are not guaranteed to avoid highways entirely."),(0,n.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_highways"},"use_highways")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L904"},"packages/valhalla/parameters.ts:904")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_living_streets"},"use","_","living","_","streets"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","living","_","streets"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take living streets. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will\nfavor living streets."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 for trucks, 0.1 for cars, buses, motor\nscooters and motorcycles."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes living streets are required to complete\na route so values of 0 are not guaranteed to avoid living streets entirely."),(0,n.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_living_streets"},"use_living_streets")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L714"},"packages/valhalla/parameters.ts:714")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_tolls"},"use","_","tolls"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","tolls"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take roads with tolls. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid tolls and values near 1 will not attempt\nto avoid them."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.5."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes roads with tolls are\nrequired to complete a route so values of 0 are not guaranteed to avoid them entirely."),(0,n.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_tolls"},"use_tolls")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L917"},"packages/valhalla/parameters.ts:917")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_tracks"},"use","_","tracks"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","tracks"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"This value indicates the willingness to take track roads. This is a range of values between\n0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a\nlittle bit."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0 for autos, 0.5 for motor scooters and motorcycles."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,n.kt)("p",null,"Note that sometimes tracks are required to complete a route so values of 0 are\nnot guaranteed to avoid tracks entirely."),(0,n.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#use_tracks"},"use_tracks")),(0,n.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L931"},"packages/valhalla/parameters.ts:931")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"use_trails"},"use","_","trails"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"use","_","trails"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"A riders's desire for adventure in their routes. This is a range of values from 0 to 1,\nwhere 0 will avoid trails, tracks, unclassified or bad surfaces and values towards 1 will\ntend to avoid major roads and route on secondary roads."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"The default value is 0.0."),(0,n.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1160"},"packages/valhalla/parameters.ts:1160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"The width of the vehicle (in meters)."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,n.kt)("p",null,"Default 1.6 for car, bus, taxi and 2.6 for truck."),(0,n.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},"ValhallaCostingOptsAuto"),".",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto#width"},"width")),(0,n.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L993"},"packages/valhalla/parameters.ts:993")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c7a53f27.453117d5.js b/assets/js/c7a53f27.453117d5.js new file mode 100644 index 0000000..0f7f79a --- /dev/null +++ b/assets/js/c7a53f27.453117d5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5648],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},u=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=l(n),f=a,m=c["".concat(p,".").concat(f)]||c[f]||d[f]||i;return n?r.createElement(m,o(o({ref:t},u),{},{components:n})):r.createElement(m,o({ref:t},u))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=c;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var l=2;l<i;l++)o[l]=n[l];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}c.displayName="MDXCreateElement"},5101:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(7462),a=(n(7294),n(3905));const i={id:"ors.ORSRouteResponse",title:"Interface: ORSRouteResponse",sidebar_label:"ORSRouteResponse",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/ors.ORSRouteResponse",id:"api/interfaces/ors.ORSRouteResponse",title:"Interface: ORSRouteResponse",description:"ors.ORSRouteResponse",source:"@site/docs/api/interfaces/ors.ORSRouteResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ors.ORSRouteResponse",permalink:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORSRouteResponse",title:"Interface: ORSRouteResponse",sidebar_label:"ORSRouteResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ORSRouteParams",permalink:"/routingjs/docs/api/interfaces/ors.ORSRouteParams"},next:{title:"OSRMDirectionsOpts",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"bbox",id:"bbox",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"features",id:"features",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"metadata",id:"metadata",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"routes",id:"routes",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-4",level:4}],u={toc:l};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORSRouteResponse"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"ORSBaseResponse")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ORSRouteResponse"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"bbox"},"bbox"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"bbox"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSBbox")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L227"},"packages/ors/parameters.ts:227")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"features"},"features"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"features"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"LineString"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"any"),">","[]"),(0,a.kt)("p",null,"If the ",(0,a.kt)("inlineCode",{parentName:"p"},"/geojson")," endpoint was requested"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L233"},"packages/ors/parameters.ts:233")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ORSMetaData")),(0,a.kt)("p",null,"Information about the service and request"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"ORSBaseResponse.metadata"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L223"},"packages/ors/parameters.ts:223")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"routes"},"routes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"routes"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/ors.ORSRoute"},(0,a.kt)("inlineCode",{parentName:"a"},"ORSRoute")),"[]"),(0,a.kt)("p",null,"A list of routes returned from the request"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L229"},"packages/ors/parameters.ts:229")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"FeatureCollection"')),(0,a.kt)("p",null,"If the ",(0,a.kt)("inlineCode",{parentName:"p"},"/geojson")," endpoint was requested"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/parameters.ts#L231"},"packages/ors/parameters.ts:231")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cb9481a5.d3c8ed64.js b/assets/js/cb9481a5.d3c8ed64.js new file mode 100644 index 0000000..5f38086 --- /dev/null +++ b/assets/js/cb9481a5.d3c8ed64.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2673],{3905:(e,a,t)=>{t.d(a,{Zo:()=>c,kt:()=>m});var l=t(7294);function r(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function n(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);a&&(l=l.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,l)}return t}function i(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?n(Object(t),!0).forEach((function(a){r(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):n(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function o(e,a){if(null==e)return{};var t,l,r=function(e,a){if(null==e)return{};var t,l,r={},n=Object.keys(e);for(l=0;l<n.length;l++)t=n[l],a.indexOf(t)>=0||(r[t]=e[t]);return r}(e,a);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(l=0;l<n.length;l++)t=n[l],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var p=l.createContext({}),s=function(e){var a=l.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):i(i({},a),e)),t},c=function(e){var a=s(e.components);return l.createElement(p.Provider,{value:a},e.children)},u={inlineCode:"code",wrapper:function(e){var a=e.children;return l.createElement(l.Fragment,{},a)}},d=l.forwardRef((function(e,a){var t=e.components,r=e.mdxType,n=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=s(t),m=r,f=d["".concat(p,".").concat(m)]||d[m]||u[m]||n;return t?l.createElement(f,i(i({ref:a},c),{},{components:t})):l.createElement(f,i({ref:a},c))}));function m(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var n=t.length,i=new Array(n);i[0]=d;var o={};for(var p in a)hasOwnProperty.call(a,p)&&(o[p]=a[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,i[1]=o;for(var s=2;s<n;s++)i[s]=t[s];return l.createElement.apply(null,i)}return l.createElement.apply(null,t)}d.displayName="MDXCreateElement"},8938:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>n,metadata:()=>o,toc:()=>s});var l=t(7462),r=(t(7294),t(3905));const n={id:"valhalla.ValhallaDateTime",title:"Interface: ValhallaDateTime",sidebar_label:"ValhallaDateTime",custom_edit_url:null},i=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaDateTime",id:"api/interfaces/valhalla.ValhallaDateTime",title:"Interface: ValhallaDateTime",description:"valhalla.ValhallaDateTime",source:"@site/docs/api/interfaces/valhalla.ValhallaDateTime.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaDateTime",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaDateTime",title:"Interface: ValhallaDateTime",sidebar_label:"ValhallaDateTime",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaCostingOptsTruck",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},next:{title:"ValhallaDirectionOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:s};function u(e){let{components:a,...t}=e;return(0,r.kt)("wrapper",(0,l.Z)({},c,t,{components:a,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaDateTime"),(0,r.kt)("p",null,"This is the local date and time at the location."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"0")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"2")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"1")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"3")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L434"},"packages/valhalla/parameters.ts:434")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"value"},"value"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L445"},"packages/valhalla/parameters.ts:445")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d08d5db0.9bc72761.js b/assets/js/d08d5db0.9bc72761.js new file mode 100644 index 0000000..7ff895b --- /dev/null +++ b/assets/js/d08d5db0.9bc72761.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7719],{3905:(e,r,t)=>{t.d(r,{Zo:()=>c,kt:()=>h});var n=t(7294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function p(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=n.createContext({}),l=function(e){var r=n.useContext(s),t=r;return e&&(t="function"==typeof e?e(r):p(p({},r),e)),t},c=function(e){var r=l(e.components);return n.createElement(s.Provider,{value:r},e.children)},d={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},u=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=l(t),h=o,f=u["".concat(s,".").concat(h)]||u[h]||d[h]||a;return t?n.createElement(f,p(p({ref:r},c),{},{components:t})):n.createElement(f,p({ref:r},c))}));function h(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,p=new Array(a);p[0]=u;var i={};for(var s in r)hasOwnProperty.call(r,s)&&(i[s]=r[s]);i.originalType=e,i.mdxType="string"==typeof e?e:o,p[1]=i;for(var l=2;l<a;l++)p[l]=t[l];return n.createElement.apply(null,p)}return n.createElement.apply(null,t)}u.displayName="MDXCreateElement"},1402:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=t(7462),o=(t(7294),t(3905));const a={id:"graphhopper.GraphHopperErrorProps",title:"Interface: GraphHopperErrorProps",sidebar_label:"GraphHopperErrorProps",custom_edit_url:null},p=void 0,i={unversionedId:"api/interfaces/graphhopper.GraphHopperErrorProps",id:"api/interfaces/graphhopper.GraphHopperErrorProps",title:"Interface: GraphHopperErrorProps",description:"graphhopper.GraphHopperErrorProps",source:"@site/docs/api/interfaces/graphhopper.GraphHopperErrorProps.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperErrorProps",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperErrorProps",title:"Interface: GraphHopperErrorProps",sidebar_label:"GraphHopperErrorProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"JSONObject",permalink:"/routingjs/docs/api/interfaces/core.JSONObject"},next:{title:"GraphHopperIsochroneOpts",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"errorMessage",id:"errormessage",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"hints",id:"hints",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"statusCode",id:"statuscode",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:l};function d(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},c,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperErrorProps"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"GraphHopperErrorProps")," returns additional information about the error thrown by the\nGraphHopper routing engine. It sends a JSON response including an error message along with\na hints array."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},(0,o.kt)("inlineCode",{parentName:"a"},"ErrorProps"))),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"GraphHopperErrorProps"))))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"errormessage"},"errorMessage"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"errorMessage"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"errorMessage")," explains the error specific to that routing engine"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#errormessage"},"errorMessage")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L11"},"packages/core/error.ts:11")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"hints"},"hints"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"hints"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"GraphHopperHint"),"[]"),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L46"},"packages/graphhopper/index.ts:46")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"status"},"status"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"status"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"status")," gives detailed info about that response"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#status"},"status")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L9"},"packages/core/error.ts:9")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"statuscode"},"statusCode"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"statusCode"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"statusCode")," stands for the HTTP response status code"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps"),".",(0,o.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.ErrorProps#statuscode"},"statusCode")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L7"},"packages/core/error.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d17d046f.6cd65e6a.js b/assets/js/d17d046f.6cd65e6a.js new file mode 100644 index 0000000..ed16939 --- /dev/null +++ b/assets/js/d17d046f.6cd65e6a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5825],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>c});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function p(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},i=Object.keys(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),d=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=d(r),c=n,u=m["".concat(o,".").concat(c)]||m[c]||k[c]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function c(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:n,l[1]=p;for(var d=2;d<i;d++)l[d]=r[d];return a.createElement.apply(null,l)}return a.createElement.apply(null,r)}m.displayName="MDXCreateElement"},7800:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var a=r(7462),n=(r(7294),r(3905));const i={id:"core.RoutingJSAPIError",title:"Class: RoutingJSAPIError<T>",sidebar_label:"RoutingJSAPIError",custom_edit_url:null},l=void 0,p={unversionedId:"api/classes/core.RoutingJSAPIError",id:"api/classes/core.RoutingJSAPIError",title:"Class: RoutingJSAPIError<T>",description:"core.RoutingJSAPIError",source:"@site/docs/api/classes/core.RoutingJSAPIError.md",sourceDirName:"api/classes",slug:"/api/classes/core.RoutingJSAPIError",permalink:"/routingjs/docs/api/classes/core.RoutingJSAPIError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.RoutingJSAPIError",title:"Class: RoutingJSAPIError<T>",sidebar_label:"RoutingJSAPIError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Matrix",permalink:"/routingjs/docs/api/classes/core.Matrix"},next:{title:"GraphHopper",permalink:"/routingjs/docs/api/classes/graphhopper.GraphHopper"}},o={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"properties",id:"properties-1",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"toJSON",id:"tojson",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4}],s={toc:d};function k(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".RoutingJSAPIError"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"RoutingJSAPIError")," is the error class used to handle errors thrown by different routing\nengines."),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ErrorProps")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"RoutingJSAPIError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new RoutingJSAPIError"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"properties"),")"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ErrorProps")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"properties")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L21"},"packages/core/error.ts:21")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"node_modules/typescript/lib/lib.es5.d.ts:1041"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"node_modules/typescript/lib/lib.es5.d.ts:1040"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"properties-1"},"properties"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,n.kt)("strong",{parentName:"p"},"properties"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L19"},"packages/core/error.ts:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"node_modules/typescript/lib/lib.es5.d.ts:1042"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"},"https://v8.dev/docs/stack-trace-api#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/ts4.8/globals.d.ts:11"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/ts4.8/globals.d.ts:13"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"tojson"},"toJSON"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"toJSON"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"properties")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/error.ts#L26"},"packages/core/error.ts:26")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/ts4.8/globals.d.ts:4"))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d1df3a82.d57692bb.js b/assets/js/d1df3a82.d57692bb.js new file mode 100644 index 0000000..1d5e132 --- /dev/null +++ b/assets/js/d1df3a82.d57692bb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3987],{5745:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-pages","id":"default"}')}}]); \ No newline at end of file diff --git a/assets/js/d829a3a8.f55ffe4f.js b/assets/js/d829a3a8.f55ffe4f.js new file mode 100644 index 0000000..7912cc4 --- /dev/null +++ b/assets/js/d829a3a8.f55ffe4f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3482],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){i(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,i=function(e,t){if(null==e)return{};var a,n,i={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),p=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,l=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=p(a),k=i,m=u["".concat(s,".").concat(k)]||u[k]||h[k]||l;return a?n.createElement(m,r(r({ref:t},d),{},{components:a})):n.createElement(m,r({ref:t},d))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=a.length,r=new Array(l);r[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,r[1]=o;for(var p=2;p<l;p++)r[p]=a[p];return n.createElement.apply(null,r)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"},4742:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>p});var n=a(7462),i=(a(7294),a(3905));const l={id:"valhalla.ValhallaLocation",title:"Interface: ValhallaLocation",sidebar_label:"ValhallaLocation",custom_edit_url:null},r=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaLocation",id:"api/interfaces/valhalla.ValhallaLocation",title:"Interface: ValhallaLocation",description:"valhalla.ValhallaLocation",source:"@site/docs/api/interfaces/valhalla.ValhallaLocation.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaLocation",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaLocation",title:"Interface: ValhallaLocation",sidebar_label:"ValhallaLocation",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaLeg",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg"},next:{title:"ValhallaManeuvers",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"city",id:"city",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"country",id:"country",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"date_time",id:"date_time",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"display_lat",id:"display_lat",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"display_lon",id:"display_lon",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"heading",id:"heading",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"heading_tolerance",id:"heading_tolerance",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"lat",id:"lat",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"lon",id:"lon",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"minimum_reachability",id:"minimum_reachability",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"node_snap_tolerance",id:"node_snap_tolerance",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"phone",id:"phone",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"postal_code",id:"postal_code",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"preferred_side",id:"preferred_side",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"radius",id:"radius",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"rank_candidates",id:"rank_candidates",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"search_cutoff",id:"search_cutoff",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"search_filter",id:"search_filter",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"side_of_street",id:"side_of_street",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"state",id:"state",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"street",id:"street",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"street_side_max_distance",id:"street_side_max_distance",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"street_side_tolerance",id:"street_side_tolerance",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"way_id",id:"way_id",level:3},{value:"Defined in",id:"defined-in-26",level:4}],d={toc:p};function h(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaLocation"),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"city"},"city"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"city"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L626"},"packages/valhalla/parameters.ts:626")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"country"},"country"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"country"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L644"},"packages/valhalla/parameters.ts:644")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_time"},"date","_","time"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"date","_","time"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience.\nResponse only."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L670"},"packages/valhalla/parameters.ts:670")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"display_lat"},"display","_","lat"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"display","_","lat"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Latitude of the map location in degrees."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"If provided the lat and lon parameters will be treated as the routing location and the\ndisplay_lat and display_lon will be used to determine the side of street. Both display_lat\nand display_lon must be provided and valid to achieve the desired effect."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L575"},"packages/valhalla/parameters.ts:575")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"display_lon"},"display","_","lon"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"display","_","lon"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Longitude of the map location in degrees."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"If provided the lat and lon parameters will be treated as the routing location and the\ndisplay_lat and display_lon will be used to determine the side of street. Both display_lat\nand display_lon must be provided and valid to achieve the desired effect."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L586"},"packages/valhalla/parameters.ts:586")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"heading"},"heading"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"heading"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Preferred direction of travel for the start from the location."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This can be useful for mobile\nrouting where a vehicle is traveling in a specific direction along a road, and the route should\nstart in that direction. The heading is indicated in degrees from north in a clockwise direction,\nwhere north is 0\xb0, east is 90\xb0, south is 180\xb0, and west is 270\xb0."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L484"},"packages/valhalla/parameters.ts:484")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"heading_tolerance"},"heading","_","tolerance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"heading","_","tolerance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"How close in degrees a given street's angle must be in order for it to be considered as in the\nsame direction of the heading parameter."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"The default value is 60 degrees."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L492"},"packages/valhalla/parameters.ts:492")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"lat"},"lat"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"lat"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Latitude of the location in degrees. This is assumed to be both the routing location and\nthe display location if no display_lat and display_lon are provided."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L453"},"packages/valhalla/parameters.ts:453")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"lon"},"lon"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"lon"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Longitude of the location in degrees. This is assumed to be both the routing location and the\ndisplay location if no display_lat and display_lon are provided."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L458"},"packages/valhalla/parameters.ts:458")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"minimum_reachability"},"minimum","_","reachability"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"minimum","_","reachability"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Minimum number of nodes (intersections) reachable for a given edge (road between intersections) to\nconsider that edge as belonging to a connected region."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"When correlating this location to the route network, try to find candidates who are reachable\nfrom this many or more nodes (intersections). If a given candidate edge reaches less than\nthis number of nodes its considered to be a disconnected island and we'll search for more\ncandidates until we find at least one that isn't considered a disconnected island. If this\nvalue is larger than the configured service limit it will be clamped to that limit."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"The default is a minimum of 50 reachable nodes."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L524"},"packages/valhalla/parameters.ts:524")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L620"},"packages/valhalla/parameters.ts:620")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"node_snap_tolerance"},"node","_","snap","_","tolerance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"node","_","snap","_","tolerance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"During edge correlation this is the tolerance used to determine whether or not to snap\nto the intersection rather than along the street, if the snap location is within this\ndistance from the intersection the intersection is used instead."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"The default is 5 meters."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L600"},"packages/valhalla/parameters.ts:600")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"phone"},"phone"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"phone"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L650"},"packages/valhalla/parameters.ts:650")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"postal_code"},"postal","_","code"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"postal","_","code"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L638"},"packages/valhalla/parameters.ts:638")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"preferred_side"},"preferred","_","side"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"preferred","_","side"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaPreferredSiteType")),(0,i.kt)("p",null,"If the location is not offset from the road centerline or is closest to an intersection this\noption has no effect. Otherwise the determined side of street is used to determine whether\nor not the location should be visited from the same, opposite or either side of the road with\nrespect to the side of the road the given locale drives on."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"In Germany (driving on the right\nside of the road), passing a value of same will only allow you to leave from or arrive at a\nlocation such that the location will be on your right. In Australia (driving on the left side\nof the road), passing a value of same will force the location to be on your left. A value of\nopposite will enforce arriving/departing from a location on the opposite side of the road from\nthat which you would be driving on while a value of either will make no attempt limit the side\nof street that is available for the route."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L564"},"packages/valhalla/parameters.ts:564")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"radius"},"radius"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"radius"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The number of meters about this input location within which edges (roads between intersections)\nwill be considered as candidates for said location. When correlating this location to the\nroute network, try to only return results within this distance (meters) from this location.\nIf there are no candidates within this distance it will return the closest candidate within\nreason. If this value is larger than the configured service limit it will be clamped to that\nlimit."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"The default is 0 meters."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L536"},"packages/valhalla/parameters.ts:536")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"rank_candidates"},"rank","_","candidates"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"rank","_","candidates"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether or not to rank the edge candidates for this location."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"The ranking is used as a penalty\nwithin the routing algorithm so that some edges will be penalized more heavily than others.\nIf true candidates will be ranked according to their distance from the input and various other\nattributes. If false the candidates will all be treated as equal which should lead to routes\nthat are just the most optimal path with emphasis about which edges were selected."),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L547"},"packages/valhalla/parameters.ts:547")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"search_cutoff"},"search","_","cutoff"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"search","_","cutoff"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The cutoff at which we will assume the input is too far away from civilisation to be worth\ncorrelating to the nearest graph elements"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L591"},"packages/valhalla/parameters.ts:591")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"search_filter"},"search","_","filter"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"search","_","filter"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaSearchFilter")),(0,i.kt)("p",null,"A set of optional filters to exclude candidate edges based on their attribution."),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L614"},"packages/valhalla/parameters.ts:614")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"side_of_street"},"side","_","of","_","street"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"side","_","of","_","street"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaSideOfStreet")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience.\nResponse only."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L663"},"packages/valhalla/parameters.ts:663")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"state"},"state"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"state"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L632"},"packages/valhalla/parameters.ts:632")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"street"},"street"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"street"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Street name. The street name may be used to assist finding the correct routing location at\nthe specified latitude, longitude."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This is not currently implemented."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L500"},"packages/valhalla/parameters.ts:500")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"street_side_max_distance"},"street","_","side","_","max","_","distance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"street","_","side","_","max","_","distance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The max distance in meters that the input coordinates or display ll can be from the edge\ncenterline for them to be used for determining the side of street. Beyond this distance\nthe side of street is set to none."),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L612"},"packages/valhalla/parameters.ts:612")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"street_side_tolerance"},"street","_","side","_","tolerance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"street","_","side","_","tolerance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"If your input coordinate is less than this tolerance away from the edge centerline then we set\nyour side of street to none otherwise your side of street will be left or right depending on\ndirection of travel."),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L606"},"packages/valhalla/parameters.ts:606")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ValhallaLocationType")),(0,i.kt)("p",null,"Type of location, either break, through, via or break_through."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"Each type controls two characteristics: whether or not to allow a u-turn at the location and\nwhether or not to generate guidance/legs at the location. The types of the first and last locations are ignored and\nare treated as breaks."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,i.kt)("p",null,"If no type is provided,\nthe type is assumed to be a break."),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L473"},"packages/valhalla/parameters.ts:473")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"url"},"url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This information is carried through the request and returned as a convenience."),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L656"},"packages/valhalla/parameters.ts:656")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"way_id"},"way","_","id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"way","_","id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"OpenStreetMap identification number for a polyline way. The way ID may be used to assist\nfinding the correct routing location at the specified latitude, longitude."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,i.kt)("p",null,"This is not currently implemented."),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L509"},"packages/valhalla/parameters.ts:509")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/da631d65.afcd01b7.js b/assets/js/da631d65.afcd01b7.js new file mode 100644 index 0000000..de9057d --- /dev/null +++ b/assets/js/da631d65.afcd01b7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7332],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,o(o({ref:t},c),{},{components:r})):n.createElement(f,o({ref:t},c))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var p=2;p<i;p++)o[p]=r[p];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},4876:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"core",title:"Module: core",sidebar_label:"core",sidebar_position:0,custom_edit_url:null},o=void 0,l={unversionedId:"api/modules/core",id:"api/modules/core",title:"Module: core",description:"Classes",source:"@site/docs/api/modules/core.md",sourceDirName:"api/modules",slug:"/api/modules/core",permalink:"/routingjs/docs/api/modules/core",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"core",title:"Module: core",sidebar_label:"core",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Table of Contents",permalink:"/routingjs/docs/api/modules"},next:{title:"graphhopper",permalink:"/routingjs/docs/api/modules/graphhopper"}},s={},p=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"DirectionFeat",id:"directionfeat",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"JSONArray",id:"jsonarray",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"JSONValue",id:"jsonvalue",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Variables",id:"variables",level:2},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"classes"},"Classes"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.Client"},"Client")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.Direction"},"Direction")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.Directions"},"Directions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.Isochrone"},"Isochrone")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.Isochrones"},"Isochrones")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.Matrix"},"Matrix")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/core.RoutingJSAPIError"},"RoutingJSAPIError"))),(0,a.kt)("h2",{id:"interfaces"},"Interfaces"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},"BaseRouter")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"},"ClientConstructorArgs")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.ErrorProps"},"ErrorProps")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.JSONObject"},"JSONObject"))),(0,a.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,a.kt)("h3",{id:"directionfeat"},"DirectionFeat"),(0,a.kt)("p",null,"\u01ac ",(0,a.kt)("strong",{parentName:"p"},"DirectionFeat"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"LineString")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"null"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"DirectionProps"),">"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Direction.ts#L15"},"packages/core/Direction.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"jsonarray"},"JSONArray"),(0,a.kt)("p",null,"\u01ac ",(0,a.kt)("strong",{parentName:"p"},"JSONArray"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core#jsonvalue"},(0,a.kt)("inlineCode",{parentName:"a"},"JSONValue")),"[]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/json.ts#L2"},"packages/core/json.ts:2")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"jsonvalue"},"JSONValue"),(0,a.kt)("p",null,"\u01ac ",(0,a.kt)("strong",{parentName:"p"},"JSONValue"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core#jsonarray"},(0,a.kt)("inlineCode",{parentName:"a"},"JSONArray"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,a.kt)("inlineCode",{parentName:"a"},"JSONObject"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/json.ts#L1"},"packages/core/json.ts:1")),(0,a.kt)("h2",{id:"variables"},"Variables"),(0,a.kt)("h3",{id:"options"},"options"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,a.kt)("strong",{parentName:"p"},"options"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"optionsInterface")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/options.ts#L11"},"packages/core/options.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dd4f9bad.62095289.js b/assets/js/dd4f9bad.62095289.js new file mode 100644 index 0000000..0189f7a --- /dev/null +++ b/assets/js/dd4f9bad.62095289.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4985],{3905:(e,r,t)=>{t.d(r,{Zo:()=>u,kt:()=>d});var p=t(7294);function n(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);r&&(p=p.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,p)}return t}function o(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){n(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,p,n=function(e,r){if(null==e)return{};var t,p,n={},a=Object.keys(e);for(p=0;p<a.length;p++)t=a[p],r.indexOf(t)>=0||(n[t]=e[t]);return n}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(p=0;p<a.length;p++)t=a[p],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var s=p.createContext({}),l=function(e){var r=p.useContext(s),t=r;return e&&(t="function"==typeof e?e(r):o(o({},r),e)),t},u=function(e){var r=l(e.components);return p.createElement(s.Provider,{value:r},e.children)},c={inlineCode:"code",wrapper:function(e){var r=e.children;return p.createElement(p.Fragment,{},r)}},h=p.forwardRef((function(e,r){var t=e.components,n=e.mdxType,a=e.originalType,s=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),h=l(t),d=n,f=h["".concat(s,".").concat(d)]||h[d]||c[d]||a;return t?p.createElement(f,o(o({ref:r},u),{},{components:t})):p.createElement(f,o({ref:r},u))}));function d(e,r){var t=arguments,n=r&&r.mdxType;if("string"==typeof e||n){var a=t.length,o=new Array(a);o[0]=h;var i={};for(var s in r)hasOwnProperty.call(r,s)&&(i[s]=r[s]);i.originalType=e,i.mdxType="string"==typeof e?e:n,o[1]=i;for(var l=2;l<a;l++)o[l]=t[l];return p.createElement.apply(null,o)}return p.createElement.apply(null,t)}h.displayName="MDXCreateElement"},2988:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var p=t(7462),n=(t(7294),t(3905));const a={id:"graphhopper.GraphHopperRouteResponse",title:"Interface: GraphHopperRouteResponse",sidebar_label:"GraphHopperRouteResponse",custom_edit_url:null},o=void 0,i={unversionedId:"api/interfaces/graphhopper.GraphHopperRouteResponse",id:"api/interfaces/graphhopper.GraphHopperRouteResponse",title:"Interface: GraphHopperRouteResponse",description:"graphhopper.GraphHopperRouteResponse",source:"@site/docs/api/interfaces/graphhopper.GraphHopperRouteResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperRouteResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperRouteResponse",title:"Interface: GraphHopperRouteResponse",sidebar_label:"GraphHopperRouteResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperRoutePath",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath"},next:{title:"ORSAlternateRouteParam",permalink:"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"hints",id:"hints",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"info",id:"info",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"paths",id:"paths",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:l};function c(e){let{components:r,...t}=e;return(0,n.kt)("wrapper",(0,p.Z)({},u,t,{components:r,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperRouteResponse"),(0,n.kt)("p",null,"The response object returned by the ",(0,n.kt)("inlineCode",{parentName:"p"},"/route")," endpoint."),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"hints"},"hints"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"hints"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.JSONObject"},(0,n.kt)("inlineCode",{parentName:"a"},"JSONObject"))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L341"},"packages/graphhopper/parameters.ts:341")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"info"},"info"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"info"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"GraphHopperResponseInfo")),(0,n.kt)("p",null,"Additional information for your request"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L344"},"packages/graphhopper/parameters.ts:344")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"paths"},"paths"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"paths"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperRoutePath")),"[]"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L342"},"packages/graphhopper/parameters.ts:342")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dd6706b8.2ce48e5c.js b/assets/js/dd6706b8.2ce48e5c.js new file mode 100644 index 0000000..a73128e --- /dev/null +++ b/assets/js/dd6706b8.2ce48e5c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1994],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},i=Object.keys(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),s=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=s(r),m=n,k=u["".concat(p,".").concat(m)]||u[m]||c[m]||i;return r?a.createElement(k,l(l({ref:t},d),{},{components:r})):a.createElement(k,l({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:n,l[1]=o;for(var s=2;s<i;s++)l[s]=r[s];return a.createElement.apply(null,l)}return a.createElement.apply(null,r)}u.displayName="MDXCreateElement"},8155:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const i={id:"core.Matrix",title:"Class: Matrix<T>",sidebar_label:"Matrix",custom_edit_url:null},l=void 0,o={unversionedId:"api/classes/core.Matrix",id:"api/classes/core.Matrix",title:"Class: Matrix<T>",description:"core.Matrix",source:"@site/docs/api/classes/core.Matrix.md",sourceDirName:"api/classes",slug:"/api/classes/core.Matrix",permalink:"/routingjs/docs/api/classes/core.Matrix",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.Matrix",title:"Class: Matrix<T>",sidebar_label:"Matrix",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Isochrones",permalink:"/routingjs/docs/api/classes/core.Isochrones"},next:{title:"RoutingJSAPIError",permalink:"/routingjs/docs/api/classes/core.RoutingJSAPIError"}},p={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"distances",id:"distances",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"durations",id:"durations",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"raw",id:"raw",level:3},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:s};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".Matrix"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new Matrix"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"durations"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"distances"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"raw"),")"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"durations")),(0,n.kt)("td",{parentName:"tr",align:"left"},"(",(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),")","[][]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"distances")),(0,n.kt)("td",{parentName:"tr",align:"left"},"(",(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"),")","[][]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"raw")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Matrix.ts#L2"},"packages/core/Matrix.ts:2")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"distances"},"distances"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,n.kt)("strong",{parentName:"p"},"distances"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),")","[][]"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Matrix.ts#L4"},"packages/core/Matrix.ts:4")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"durations"},"durations"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,n.kt)("strong",{parentName:"p"},"durations"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),")","[][]"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Matrix.ts#L3"},"packages/core/Matrix.ts:3")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"raw"},"raw"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,n.kt)("strong",{parentName:"p"},"raw"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Matrix.ts#L5"},"packages/core/Matrix.ts:5")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e33a542e.a0c64b08.js b/assets/js/e33a542e.a0c64b08.js new file mode 100644 index 0000000..eb79b97 --- /dev/null +++ b/assets/js/e33a542e.a0c64b08.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6309],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(n),m=a,h=d["".concat(s,".").concat(m)]||d[m]||u[m]||o;return n?r.createElement(h,i(i({ref:t},p),{},{components:n})):r.createElement(h,i({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var c=2;c<o;c++)i[c]=n[c];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"},118:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(7462),a=(n(7294),n(3905));const o={},i="Quickstart",l={unversionedId:"quickstart",id:"quickstart",title:"Quickstart",description:"Installation",source:"@site/docs/00_quickstart.md",sourceDirName:".",slug:"/quickstart",permalink:"/routingjs/docs/quickstart",draft:!1,editUrl:"https://github.com/gis-ops/routingjs/docs/00_quickstart.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{},sidebar:"tutorialSidebar",next:{title:"Readme",permalink:"/routingjs/docs/api/"}},s={},c=[{value:"Installation",id:"installation",level:2},{value:"Directions",id:"directions",level:2},{value:"Matrix",id:"matrix",level:2},{value:"Reachability",id:"reachability",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quickstart"},"Quickstart"),(0,a.kt)("h2",{id:"installation"},"Installation"),(0,a.kt)("p",null,"Install single client classes:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"npm i @routingjs/valhalla @routingjs/osrm @routingjs/ors @routingjs/graphhopper\n")),(0,a.kt)("h2",{id:"directions"},"Directions"),(0,a.kt)("p",null,"All clients support the ",(0,a.kt)("inlineCode",{parentName:"p"},".directions()")," method:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'import { Valhalla } from "@routingjs/valhalla"\n\nconst v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de\nv.directions(\n [\n [8.512516, 47.380742],\n [8.557835, 47.359467],\n ],\n "auto"\n).then((d) => {\n // do stuff with the directions response\n d.directions.forEach((direction) => {\n console.log(direction.feature)\n })\n})\n')),(0,a.kt)("p",null,"The result's ",(0,a.kt)("inlineCode",{parentName:"p"},"directions")," property is an array of at least one route as GeoJSON LineString feature, and more if alternatives have been requested."),(0,a.kt)("p",null,"If you want to access the response as sent by the routing server, you can always access it using the ",(0,a.kt)("inlineCode",{parentName:"p"},"raw")," property."),(0,a.kt)("h2",{id:"matrix"},"Matrix"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"Hint: GraphHopper only supports the ",(0,a.kt)("inlineCode",{parentName:"p"},"/matrix")," endpoint in their own hosted version.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'import { Valhalla } from "@routingjs/valhalla"\n\nconst v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de\n\nv.matrix(\n [\n [1.51886, 42.5063],\n [1.53789, 42.51007],\n ],\n "auto"\n).then((m) => {\n console.log(m.durations)\n})\n')),(0,a.kt)("p",null,"The returned ",(0,a.kt)("inlineCode",{parentName:"p"},"Matrix")," has ",(0,a.kt)("inlineCode",{parentName:"p"},"durations")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"distances")," properties, and you can access the response via its ",(0,a.kt)("inlineCode",{parentName:"p"},"raw")," property."),(0,a.kt)("h2",{id:"reachability"},"Reachability"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},".reachability()")," method is analogous to isochrone/isodistance analyses."),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"Note: OSRM does not support this method.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'import { Valhalla } from "@routingjs/valhalla"\n\nconst v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de\n\nv.reachability([[1.51886, 42.5063]], "auto").then((i) => {\n i.isochrones.forEach((isochrone) => console.log(isochrone.feature))\n})\n')))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e356c530.7fc81d28.js b/assets/js/e356c530.7fc81d28.js new file mode 100644 index 0000000..b0e3240 --- /dev/null +++ b/assets/js/e356c530.7fc81d28.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2846],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=l(r),m=a,f=c["".concat(p,".").concat(m)]||c[m]||d[m]||o;return r?n.createElement(f,i(i({ref:t},u),{},{components:r})):n.createElement(f,i({ref:t},u))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=c;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var l=2;l<o;l++)i[l]=r[l];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}c.displayName="MDXCreateElement"},8494:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={id:"osrm.OSRMRouteResponse",title:"Interface: OSRMRouteResponse",sidebar_label:"OSRMRouteResponse",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/osrm.OSRMRouteResponse",id:"api/interfaces/osrm.OSRMRouteResponse",title:"Interface: OSRMRouteResponse",description:"osrm.OSRMRouteResponse",source:"@site/docs/api/interfaces/osrm.OSRMRouteResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMRouteResponse",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMRouteResponse",title:"Interface: OSRMRouteResponse",sidebar_label:"OSRMRouteResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMRouteParams",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams"},next:{title:"OSRMTableParams",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"code",id:"code",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"routes",id:"routes",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"waypoints",id:"waypoints",level:3},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMRouteResponse"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"OSRMBaseResponse")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"OSRMRouteResponse"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"code"},"code"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"code"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OSRMResponseCode")),(0,a.kt)("p",null,"Every response object has a code field containing one of the strings below or a\nservice dependent code:"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseResponse.code"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L59"},"packages/osrm/parameters.ts:59")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Optional human-readable error message. All other status types are service dependent."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"OSRMBaseResponse.message"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L61"},"packages/osrm/parameters.ts:61")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"routes"},"routes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"routes"),": ",(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMRoute"},(0,a.kt)("inlineCode",{parentName:"a"},"OSRMRoute")),"[]"),(0,a.kt)("p",null,"An array of Route objects, ordered by descending recommendation rank."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L70"},"packages/osrm/parameters.ts:70")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"waypoints"},"waypoints"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"waypoints"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OSRMWayPoint"),"[]"),(0,a.kt)("p",null,"Array of Waypoint objects representing all waypoints in order"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/parameters.ts#L66"},"packages/osrm/parameters.ts:66")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e4e8843d.9a39db58.js b/assets/js/e4e8843d.9a39db58.js new file mode 100644 index 0000000..9ccf44a --- /dev/null +++ b/assets/js/e4e8843d.9a39db58.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6856],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>c});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var o=n.createContext({}),p=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},d=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),h=p(a),c=l,k=h["".concat(o,".").concat(c)]||h[c]||u[c]||i;return a?n.createElement(k,r(r({ref:t},d),{},{components:a})):n.createElement(k,r({ref:t},d))}));function c(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var i=a.length,r=new Array(i);r[0]=h;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:l,r[1]=s;for(var p=2;p<i;p++)r[p]=a[p];return n.createElement.apply(null,r)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"},1006:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var n=a(7462),l=(a(7294),a(3905));const i={id:"valhalla.ValhallaCostingOptsBicycle",title:"Interface: ValhallaCostingOptsBicycle",sidebar_label:"ValhallaCostingOptsBicycle",custom_edit_url:null},r=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaCostingOptsBicycle",id:"api/interfaces/valhalla.ValhallaCostingOptsBicycle",title:"Interface: ValhallaCostingOptsBicycle",description:"valhalla.ValhallaCostingOptsBicycle",source:"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaCostingOptsBicycle",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaCostingOptsBicycle",title:"Interface: ValhallaCostingOptsBicycle",sidebar_label:"ValhallaCostingOptsBicycle",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaCostingOptsAuto",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},next:{title:"ValhallaCostingOptsMotorcycle",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avoid_bad_surfaces",id:"avoid_bad_surfaces",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"bicycle_type",id:"bicycle_type",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"bss_return_cost",id:"bss_return_cost",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"bss_return_penalty",id:"bss_return_penalty",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"country_crossing_cost",id:"country_crossing_cost",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"country_crossing_penalty",id:"country_crossing_penalty",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"cycling_speed",id:"cycling_speed",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"gate_cost",id:"gate_cost",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"gate_penalty",id:"gate_penalty",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"maneuver_penalty",id:"maneuver_penalty",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"service_penalty",id:"service_penalty",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"shortest",id:"shortest",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"use_ferry",id:"use_ferry",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"use_hills",id:"use_hills",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"use_living_streets",id:"use_living_streets",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"use_roads",id:"use_roads",level:3},{value:"Defined in",id:"defined-in-15",level:4}],d={toc:p};function u(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaCostingOptsBicycle"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaCostingOptsWheels")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaCostingOptsBicycle"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"avoid_bad_surfaces"},"avoid","_","bad","_","surfaces"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"avoid","_","bad","_","surfaces"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value is meant to represent how much a cyclist wants to avoid roads with poor surfaces\nrelative to the bicycle type being used. This is a range of values between 0 and 1. When the\nvalue is 0, there is no penalization of roads with different surface types; only bicycle speed\non each surface is taken into account. As the value approaches 1, roads with poor surfaces for\nthe bike are penalized heavier so that they are only taken if they significantly\nimprove travel time. When the value is equal to 1, all bad surfaces are completely disallowed\nfrom routing, including start and end points."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0.25."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1133"},"packages/valhalla/parameters.ts:1133")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"bicycle_type"},"bicycle","_","type"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"bicycle","_","type"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaBicycleType")),(0,l.kt)("p",null,"The type of bicycle."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default type is Hybrid."),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1081"},"packages/valhalla/parameters.ts:1081")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"bss_return_cost"},"bss","_","return","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"bss","_","return","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value is useful when bikeshare is chosen as travel mode. It is meant to give the time\nwill be used to return a rental bike. This value will be displayed in the final directions\nand used to calculate the whole duation."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 120 seconds."),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1142"},"packages/valhalla/parameters.ts:1142")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"bss_return_penalty"},"bss","_","return","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"bss","_","return","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value is useful when bikeshare is chosen as travel mode. It is meant to describe the\npotential effort to return a rental bike. This value won't be displayed and used only\ninside of the algorithm."),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1148"},"packages/valhalla/parameters.ts:1148")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"country_crossing_cost"},"country","_","crossing","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"country","_","crossing","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A cost applied when encountering an international border. This cost is added to the\nestimated and elapsed times."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default cost is 600 seconds."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.country","_","crossing","_","cost"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L746"},"packages/valhalla/parameters.ts:746")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"country_crossing_penalty"},"country","_","crossing","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"country","_","crossing","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A penalty applied for a country crossing. This penalty can be used to create paths that\navoid spanning country boundaries."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default penalty is 0."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.country","_","crossing","_","penalty"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L754"},"packages/valhalla/parameters.ts:754")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"cycling_speed"},"cycling","_","speed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"cycling","_","speed"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"Cycling speed is the average travel speed along smooth, flat roads. This is meant to be the\nspeed a rider can comfortably maintain over the desired distance of the route."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"It can be modified (in the costing method) by surface type in conjunction with bicycle type\nand (coming soon) by hilliness of the road section. When no speed is specifically provided,\nthe default speed is determined by the bicycle type and are as follows:\nRoad = 25 KPH (15.5 MPH), Cross = 20 KPH (13 MPH), Hybrid/City = 18 KPH (11.5 MPH), and\nMountain = 16 KPH (10 MPH)."),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1093"},"packages/valhalla/parameters.ts:1093")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"gate_cost"},"gate","_","cost"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"gate","_","cost"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.gate","_","cost"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L737"},"packages/valhalla/parameters.ts:737")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"gate_penalty"},"gate","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"gate","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.gate","_","penalty"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L738"},"packages/valhalla/parameters.ts:738")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"maneuver_penalty"},"maneuver","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"maneuver","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.maneuver","_","penalty"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L736"},"packages/valhalla/parameters.ts:736")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"service_penalty"},"service","_","penalty"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"service","_","penalty"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A penalty applied for transition to generic service road. The default penalty is 0 for\ntrucks and 15 for cars, buses, motor scooters and motorcycles."),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.service","_","penalty"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L719"},"packages/valhalla/parameters.ts:719")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"shortest"},"shortest"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"shortest"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"Changes the metric to quasi-shortest, i.e. purely distance-based costing."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note, this will disable all other costings & penalties. Also note, shortest will not\ndisable hierarchy pruning, leading to potentially sub-optimal routes for some costing\nmodels."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default is false."),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.shortest"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L732"},"packages/valhalla/parameters.ts:732")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_ferry"},"use","_","ferry"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","ferry"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take ferries. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0.5."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely."),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.use","_","ferry"),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L700"},"packages/valhalla/parameters.ts:700")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_hills"},"use","_","hills"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","hills"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A cyclist's desire to tackle hills in their routes. This is a range of values from 0 to 1,\nwhere 0 attempts to avoid hills and steep grades even if it means a longer (time and distance)\npath, while 1 indicates the rider does not fear hills and steeper grades. Based on the\nuse_hills factor, penalties are applied to roads based on elevation change and grade. These\npenalties help the path avoid hilly roads in favor of flatter roads or less steep grades where\navailable. Note that it is not always possible to find alternate paths to avoid\nhills (for example when route locations are in mountainous areas)."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0.5."),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1120"},"packages/valhalla/parameters.ts:1120")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_living_streets"},"use","_","living","_","streets"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","living","_","streets"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"This value indicates the willingness to take living streets. This is a range of values\nbetween 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will\nfavor living streets."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0 for trucks, 0.1 for cars, buses, motor\nscooters and motorcycles."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Note that sometimes living streets are required to complete\na route so values of 0 are not guaranteed to avoid living streets entirely."),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,"ValhallaCostingOptsWheels.use","_","living","_","streets"),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L714"},"packages/valhalla/parameters.ts:714")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"use_roads"},"use","_","roads"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"use","_","roads"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A cyclist's propensity to use roads alongside other vehicles. This is a range of values\nfrom 0 to 1, where 0 attempts to avoid roads and stay on cycleways and paths, and 1 indicates\nthe rider is more comfortable riding on roads."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,l.kt)("p",null,"Based on the use_roads factor, roads with\ncertain classifications and higher speeds are penalized in an attempt to avoid them when\nfinding the best path."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,l.kt)("p",null,"The default value is 0.5."),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L1107"},"packages/valhalla/parameters.ts:1107")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e69ab7fa.3303323d.js b/assets/js/e69ab7fa.3303323d.js new file mode 100644 index 0000000..74a55c4 --- /dev/null +++ b/assets/js/e69ab7fa.3303323d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6401],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function p(e,t){if(null==e)return{};var n,a,i=function(e,t){if(null==e)return{};var n,a,i={},r=Object.keys(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),k=d(n),u=i,f=k["".concat(o,".").concat(u)]||k[u]||m[u]||r;return n?a.createElement(f,l(l({ref:t},s),{},{components:n})):a.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=k;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:i,l[1]=p;for(var d=2;d<r;d++)l[d]=n[d];return a.createElement.apply(null,l)}return a.createElement.apply(null,n)}k.displayName="MDXCreateElement"},497:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={id:"core.Client",title:"Class: Client<ResponseType, GetParams, PostParams>",sidebar_label:"Client",custom_edit_url:null},l=void 0,p={unversionedId:"api/classes/core.Client",id:"api/classes/core.Client",title:"Class: Client<ResponseType, GetParams, PostParams>",description:"core.Client",source:"@site/docs/api/classes/core.Client.md",sourceDirName:"api/classes",slug:"/api/classes/core.Client",permalink:"/routingjs/docs/api/classes/core.Client",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"core.Client",title:"Class: Client<ResponseType, GetParams, PostParams>",sidebar_label:"Client",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"valhalla",permalink:"/routingjs/docs/api/modules/valhalla"},next:{title:"Direction",permalink:"/routingjs/docs/api/classes/core.Direction"}},o={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"additionalAxiosOpts",id:"additionalaxiosopts",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"axiosInstance",id:"axiosinstance",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"axiosOptions",id:"axiosoptions",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"baseURL",id:"baseurl",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"headers",id:"headers",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxRetries",id:"maxretries",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"proxy",id:"proxy",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"retryOverQueryLimit",id:"retryoverquerylimit",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"timeout",id:"timeout",level:3},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"userAgent",id:"useragent",level:3},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Methods",id:"methods",level:2},{value:"request",id:"request",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-11",level:4}],s={toc:d};function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/core"},"core"),".Client"),(0,i.kt)("p",null,"The client class from which all underlying requests to the routing eninges' servers are made."),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ResponseType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ResponseType"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"GetParams")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined")," = ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PostParams")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined")," = ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))))),(0,i.kt)("h2",{id:"implements"},"Implements"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"ClientInterface"))),(0,i.kt)("h2",{id:"constructors"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new Client"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"ResponseType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"GetParams"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"PostParams"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"baseURL"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"userAgent?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"timeout?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"retryOverQueryLimit?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"headers?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"maxRetries?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"additionalAxiosOpts?"),")"),(0,i.kt)("p",null,"Create a new client instance"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ResponseType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ResponseType"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"GetParams")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"," = ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PostParams")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"," = ",(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))))),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"baseURL")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the base URL that requests will be made to")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"userAgent")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.defaultUserAgent")),(0,i.kt)("td",{parentName:"tr",align:"left"},"define a custom user agent to be passed in each request header")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"timeout")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.defaultTimeout")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the time to await a response")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"retryOverQueryLimit")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether or not requests should be retried when receiving a status 429 response")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"headers?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"additional headers to be passed with each request")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"maxRetries")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.defaultMaxRetries")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the maximum number of retries made by axios-retry")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"additionalAxiosOpts?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"any additional options that are passed to the axios instance")))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L77"},"packages/core/Client.ts:77")),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"additionalaxiosopts"},"additionalAxiosOpts"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"additionalAxiosOpts"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"AxiosRequestConfig"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"any additional options that are passed to the axios instance"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L84"},"packages/core/Client.ts:84")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"axiosinstance"},"axiosInstance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"axiosInstance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Axios")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L61"},"packages/core/Client.ts:61")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"axiosoptions"},"axiosOptions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"axiosOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"AxiosRequestConfig"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L62"},"packages/core/Client.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"baseurl"},"baseURL"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"the base URL that requests will be made to"),(0,i.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,i.kt)("p",null,"ClientInterface.baseURL"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L78"},"packages/core/Client.ts:78")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"headers"},"headers"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"headers"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"additional headers to be passed with each request"),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[k: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L82"},"packages/core/Client.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxretries"},"maxRetries"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"maxRetries"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"options.defaultMaxRetries")),(0,i.kt)("p",null,"the maximum number of retries made by axios-retry"),(0,i.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,i.kt)("p",null,"ClientInterface.maxRetries"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L83"},"packages/core/Client.ts:83")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proxy"},"proxy"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"proxy"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"AxiosProxyConfig")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,"ClientInterface.proxy"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L63"},"packages/core/Client.ts:63")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"retryoverquerylimit"},"retryOverQueryLimit"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"retryOverQueryLimit"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"false")),(0,i.kt)("p",null,"whether or not requests should be retried when\nreceiving a status 429 response"),(0,i.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,i.kt)("p",null,"ClientInterface.retryOverQueryLimit"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L81"},"packages/core/Client.ts:81")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"timeout"},"timeout"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"timeout"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"options.defaultTimeout")),(0,i.kt)("p",null,"the time to await a response"),(0,i.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,i.kt)("p",null,"ClientInterface.timeout"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L80"},"packages/core/Client.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"useragent"},"userAgent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"userAgent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"options.defaultUserAgent")),(0,i.kt)("p",null,"define a custom user agent to be passed in each request header"),(0,i.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,i.kt)("p",null,"ClientInterface.userAgent"),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L79"},"packages/core/Client.ts:79")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"request"},"request"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"request"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"requestArgs"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ResponseType"),">"),(0,i.kt)("p",null,"The main request method. Decides whether a GET or POST request is to be made depending on\nthe passed arguments."),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"requestArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"requestArgs"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"GetParams"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"PostParams"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the parameters passed as an object")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ResponseType"),">"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/core/Client.ts#L121"},"packages/core/Client.ts:121")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e6bf94c2.f8f565f8.js b/assets/js/e6bf94c2.f8f565f8.js new file mode 100644 index 0000000..6534096 --- /dev/null +++ b/assets/js/e6bf94c2.f8f565f8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6588],{3905:(e,r,p)=>{p.d(r,{Zo:()=>h,kt:()=>u});var a=p(7294);function t(e,r,p){return r in e?Object.defineProperty(e,r,{value:p,enumerable:!0,configurable:!0,writable:!0}):e[r]=p,e}function n(e,r){var p=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);r&&(a=a.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),p.push.apply(p,a)}return p}function o(e){for(var r=1;r<arguments.length;r++){var p=null!=arguments[r]?arguments[r]:{};r%2?n(Object(p),!0).forEach((function(r){t(e,r,p[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(p)):n(Object(p)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(p,r))}))}return e}function i(e,r){if(null==e)return{};var p,a,t=function(e,r){if(null==e)return{};var p,a,t={},n=Object.keys(e);for(a=0;a<n.length;a++)p=n[a],r.indexOf(p)>=0||(t[p]=e[p]);return t}(e,r);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a<n.length;a++)p=n[a],r.indexOf(p)>=0||Object.prototype.propertyIsEnumerable.call(e,p)&&(t[p]=e[p])}return t}var s=a.createContext({}),l=function(e){var r=a.useContext(s),p=r;return e&&(p="function"==typeof e?e(r):o(o({},r),e)),p},h=function(e){var r=l(e.components);return a.createElement(s.Provider,{value:r},e.children)},d={inlineCode:"code",wrapper:function(e){var r=e.children;return a.createElement(a.Fragment,{},r)}},c=a.forwardRef((function(e,r){var p=e.components,t=e.mdxType,n=e.originalType,s=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),c=l(p),u=t,k=c["".concat(s,".").concat(u)]||c[u]||d[u]||n;return p?a.createElement(k,o(o({ref:r},h),{},{components:p})):a.createElement(k,o({ref:r},h))}));function u(e,r){var p=arguments,t=r&&r.mdxType;if("string"==typeof e||t){var n=p.length,o=new Array(n);o[0]=c;var i={};for(var s in r)hasOwnProperty.call(r,s)&&(i[s]=r[s]);i.originalType=e,i.mdxType="string"==typeof e?e:t,o[1]=i;for(var l=2;l<n;l++)o[l]=p[l];return a.createElement.apply(null,o)}return a.createElement.apply(null,p)}c.displayName="MDXCreateElement"},4518:(e,r,p)=>{p.r(r),p.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>n,metadata:()=>i,toc:()=>l});var a=p(7462),t=(p(7294),p(3905));const n={id:"graphhopper",title:"Module: graphhopper",sidebar_label:"graphhopper",sidebar_position:0,custom_edit_url:null},o=void 0,i={unversionedId:"api/modules/graphhopper",id:"api/modules/graphhopper",title:"Module: graphhopper",description:"Classes",source:"@site/docs/api/modules/graphhopper.md",sourceDirName:"api/modules",slug:"/api/modules/graphhopper",permalink:"/routingjs/docs/api/modules/graphhopper",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"graphhopper",title:"Module: graphhopper",sidebar_label:"graphhopper",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"core",permalink:"/routingjs/docs/api/modules/core"},next:{title:"ors",permalink:"/routingjs/docs/api/modules/ors"}},s={},l=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"GraphHopperAPIError",id:"graphhopperapierror",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"GraphHopperClient",id:"graphhopperclient",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"GraphHopperDirections",id:"graphhopperdirections",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GraphHopperDirectionsOpts",id:"graphhopperdirectionsopts",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GraphHopperIsochroneGetParams",id:"graphhopperisochronegetparams",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GraphHopperIsochroneProps",id:"graphhopperisochroneprops",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"GraphHopperIsochrones",id:"graphhopperisochrones",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"GraphHopperMatrix",id:"graphhoppermatrix",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"GraphHopperProfile",id:"graphhopperprofile",level:3},{value:"Defined in",id:"defined-in-8",level:4}],h={toc:l};function d(e){let{components:r,...p}=e;return(0,t.kt)("wrapper",(0,a.Z)({},h,p,{components:r,mdxType:"MDXLayout"}),(0,t.kt)("h2",{id:"classes"},"Classes"),(0,t.kt)("ul",null,(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/classes/graphhopper.GraphHopper"},"GraphHopper"))),(0,t.kt)("h2",{id:"interfaces"},"Interfaces"),(0,t.kt)("ul",null,(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps"},"GraphHopperErrorProps")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts"},"GraphHopperIsochroneOpts")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams"},"GraphHopperIsochroneParams")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse"},"GraphHopperIsochroneResponse")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts"},"GraphHopperMatrixOpts")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams"},"GraphHopperMatrixParams")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse"},"GraphHopperMatrixResponse")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams"},"GraphHopperRouteParams")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath"},"GraphHopperRoutePath")),(0,t.kt)("li",{parentName:"ul"},(0,t.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse"},"GraphHopperRouteResponse"))),(0,t.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,t.kt)("h3",{id:"graphhopperapierror"},"GraphHopperAPIError"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperAPIError"),": ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.RoutingJSAPIError"},(0,t.kt)("inlineCode",{parentName:"a"},"RoutingJSAPIError")),"<",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperErrorProps")),">"),(0,t.kt)("h4",{id:"defined-in"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L49"},"packages/graphhopper/index.ts:49")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperclient"},"GraphHopperClient"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperClient"),": ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Client"},(0,t.kt)("inlineCode",{parentName:"a"},"Client")),"<",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperRouteResponse"))," ","|"," ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneResponse"))," ","|"," ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrixResponse")),", { ","[k in keyof GraphHopperIsochroneGetParams]",": GraphHopperIsochroneGetParams","[k]"," } ","|"," { ",(0,t.kt)("inlineCode",{parentName:"p"},"key?"),": ",(0,t.kt)("inlineCode",{parentName:"p"},"string")," }, ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperRouteParams"))," ","|"," ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrixParams")),">"),(0,t.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L105"},"packages/graphhopper/index.ts:105")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperdirections"},"GraphHopperDirections"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperDirections"),": ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Directions"},(0,t.kt)("inlineCode",{parentName:"a"},"Directions")),"<",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperRouteResponse")),", ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperRoutePath")),">"),(0,t.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L93"},"packages/graphhopper/index.ts:93")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperdirectionsopts"},"GraphHopperDirectionsOpts"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperDirectionsOpts"),": ",(0,t.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperRouteParams")),", ",(0,t.kt)("inlineCode",{parentName:"p"},'"points"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"profile"'),">"),(0,t.kt)("p",null,(0,t.kt)("inlineCode",{parentName:"p"},"points")," and ",(0,t.kt)("inlineCode",{parentName:"p"},"profile")," properties are passed using the ",(0,t.kt)("inlineCode",{parentName:"p"},"directions()")," method's top level args for\nconsistency."),(0,t.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L68"},"packages/graphhopper/index.ts:68")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperisochronegetparams"},"GraphHopperIsochroneGetParams"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperIsochroneGetParams"),": { ","[K in keyof GraphHopperIsochroneParams]",": string }"),(0,t.kt)("p",null,"Since the ",(0,t.kt)("inlineCode",{parentName:"p"},"/isochrone")," endpoint only accepts GET requests,\nall parameters need to be stringified."),(0,t.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L254"},"packages/graphhopper/parameters.ts:254")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperisochroneprops"},"GraphHopperIsochroneProps"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperIsochroneProps"),": ",(0,t.kt)("inlineCode",{parentName:"p"},"Object")),(0,t.kt)("p",null,"Properties of the returned Features."),(0,t.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,t.kt)("table",null,(0,t.kt)("thead",{parentName:"table"},(0,t.kt)("tr",{parentName:"thead"},(0,t.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,t.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,t.kt)("tbody",{parentName:"table"},(0,t.kt)("tr",{parentName:"tbody"},(0,t.kt)("td",{parentName:"tr",align:"left"},(0,t.kt)("inlineCode",{parentName:"td"},"bucket")),(0,t.kt)("td",{parentName:"tr",align:"left"},(0,t.kt)("inlineCode",{parentName:"td"},"number"))))),(0,t.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L543"},"packages/graphhopper/parameters.ts:543")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperisochrones"},"GraphHopperIsochrones"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperIsochrones"),": ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Isochrones"},(0,t.kt)("inlineCode",{parentName:"a"},"Isochrones")),"<",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneResponse")),", ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperisochroneprops"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneProps")),">"),(0,t.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L98"},"packages/graphhopper/index.ts:98")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhoppermatrix"},"GraphHopperMatrix"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperMatrix"),": ",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/classes/core.Matrix"},(0,t.kt)("inlineCode",{parentName:"a"},"Matrix")),"<",(0,t.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse"},(0,t.kt)("inlineCode",{parentName:"a"},"GraphHopperMatrixResponse")),">"),(0,t.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L103"},"packages/graphhopper/index.ts:103")),(0,t.kt)("hr",null),(0,t.kt)("h3",{id:"graphhopperprofile"},"GraphHopperProfile"),(0,t.kt)("p",null,"\u01ac ",(0,t.kt)("strong",{parentName:"p"},"GraphHopperProfile"),": ",(0,t.kt)("inlineCode",{parentName:"p"},'"car"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"car_delivery"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"car_avoid_ferry"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"car_avoid_motorway"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"car_avoid_toll"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"small_truck"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"small_truck_delivery"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"truck"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"scooter"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"scooter_delivery"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"foot"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"hike"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"bike"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"mtb"')," ","|"," ",(0,t.kt)("inlineCode",{parentName:"p"},'"racingbike"')),(0,t.kt)("p",null,"The profile is used to determine the network, speed and other physical attributes to use\nfor routing the vehicle or pedestrian."),(0,t.kt)("p",null,(0,t.kt)("strong",{parentName:"p"},(0,t.kt)("inlineCode",{parentName:"strong"},"See"))),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://docs.graphhopper.com/#section/Map-Data-and-Routing-Profiles"},"https://docs.graphhopper.com/#section/Map-Data-and-Routing-Profiles")," for full documentation."),(0,t.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,t.kt)("p",null,(0,t.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L385"},"packages/graphhopper/parameters.ts:385")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ea776caf.0adea3b3.js b/assets/js/ea776caf.0adea3b3.js new file mode 100644 index 0000000..fe0166c --- /dev/null +++ b/assets/js/ea776caf.0adea3b3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7340],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});var i=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function s(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,i,r=function(e,t){if(null==e)return{};var n,i,r={},a=Object.keys(e);for(i=0;i<a.length;i++)n=a[i],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i<a.length;i++)n=a[i],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=i.createContext({}),l=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=l(e.components);return i.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},m=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=l(n),c=r,f=m["".concat(p,".").concat(c)]||m[c]||u[c]||a;return n?i.createElement(f,s(s({ref:t},d),{},{components:n})):i.createElement(f,s({ref:t},d))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,s[1]=o;for(var l=2;l<a;l++)s[l]=n[l];return i.createElement.apply(null,s)}return i.createElement.apply(null,n)}m.displayName="MDXCreateElement"},1898:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=n(7462),r=(n(7294),n(3905));const a={id:"osrm.OSRMMatrixOpts",title:"Interface: OSRMMatrixOpts",sidebar_label:"OSRMMatrixOpts",custom_edit_url:null},s=void 0,o={unversionedId:"api/interfaces/osrm.OSRMMatrixOpts",id:"api/interfaces/osrm.OSRMMatrixOpts",title:"Interface: OSRMMatrixOpts",description:"osrm.OSRMMatrixOpts",source:"@site/docs/api/interfaces/osrm.OSRMMatrixOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/osrm.OSRMMatrixOpts",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"osrm.OSRMMatrixOpts",title:"Interface: OSRMMatrixOpts",sidebar_label:"OSRMMatrixOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OSRMGeometryObject",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject"},next:{title:"OSRMRoute",permalink:"/routingjs/docs/api/interfaces/osrm.OSRMRoute"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alternatives",id:"alternatives",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"annotations",id:"annotations",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"bearings",id:"bearings",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"continueStraight",id:"continuestraight",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"geometries",id:"geometries",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"overview",id:"overview",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"radiuses",id:"radiuses",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"steps",id:"steps",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:l};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm"},"osrm"),".OSRMMatrixOpts"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMDirectionsOpts"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"OSRMMatrixOpts"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"alternatives"},"alternatives"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alternatives"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("p",null,"Search for alternative routes and return as well."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,r.kt)("p",null,"Please note that even if an alternative route is requested, a result cannot be guaranteed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#alternatives"},"alternatives")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L69"},"packages/osrm/index.ts:69")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"annotations"},"annotations"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"annotations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Returns additional metadata for each coordinate along the route geometry."),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#annotations"},"annotations")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L78"},"packages/osrm/index.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"bearings"},"bearings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"bearings"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ","[",(0,r.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"]",")[]"),(0,r.kt)("p",null,"Limits the search to segments with given bearing in degrees towards true north in\nclockwise direction."),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#bearings"},"bearings")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L59"},"packages/osrm/index.ts:59")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"continuestraight"},"continueStraight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"continueStraight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"default"')),(0,r.kt)("p",null,"Forces the route to keep going straight at waypoints constraining uturns there even if\nit would be faster. Default value depends on the profile."),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#continuestraight"},"continueStraight")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L76"},"packages/osrm/index.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"destinations"},"destinations"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"destinations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Use location with given index as destination."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L92"},"packages/osrm/index.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"geometries"},"geometries"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"geometries"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmgeometrytype"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMGeometryType"))),(0,r.kt)("p",null,"Returned route geometry format (influences overview and per step)"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#geometries"},"geometries")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L80"},"packages/osrm/index.ts:80")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"overview"},"overview"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"overview"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/osrm#osrmoverviewtype"},(0,r.kt)("inlineCode",{parentName:"a"},"OSRMOverviewType"))),(0,r.kt)("p",null,"Add overview geometry either full, simplified according to highest zoom level it\ncould be display on, or not at all."),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#overview"},"overview")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L85"},"packages/osrm/index.ts:85")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"radiuses"},"radiuses"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"radiuses"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),")[]"),(0,r.kt)("p",null,"Limits the search to given radius in meters."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#radiuses"},"radiuses")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L54"},"packages/osrm/index.ts:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sources"},"sources"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"sources"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Use location with given index as source."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L90"},"packages/osrm/index.ts:90")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"steps"},"steps"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"steps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Return route steps for each route leg"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts"},"OSRMDirectionsOpts"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts#steps"},"steps")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/osrm/index.ts#L71"},"packages/osrm/index.ts:71")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ebfbfacf.f056dca4.js b/assets/js/ebfbfacf.f056dca4.js new file mode 100644 index 0000000..fc10140 --- /dev/null +++ b/assets/js/ebfbfacf.f056dca4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1751],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),s=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),k=s(a),N=r,u=k["".concat(p,".").concat(N)]||k[N]||m[N]||i;return a?n.createElement(u,l(l({ref:t},d),{},{components:a})):n.createElement(u,l({ref:t},d))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var s=2;s<i;s++)l[s]=a[s];return n.createElement.apply(null,l)}return n.createElement.apply(null,a)}k.displayName="MDXCreateElement"},9049:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const i={id:"ors.ORS",title:"Class: ORS",sidebar_label:"ORS",custom_edit_url:null},l=void 0,o={unversionedId:"api/classes/ors.ORS",id:"api/classes/ors.ORS",title:"Class: ORS",description:"ors.ORS",source:"@site/docs/api/classes/ors.ORS.md",sourceDirName:"api/classes",slug:"/api/classes/ors.ORS",permalink:"/routingjs/docs/api/classes/ors.ORS",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"ors.ORS",title:"Class: ORS",sidebar_label:"ORS",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopper",permalink:"/routingjs/docs/api/classes/graphhopper.GraphHopper"},next:{title:"OSRM",permalink:"/routingjs/docs/api/classes/osrm.OSRM"}},p={},s=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"client",id:"client",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"directions",id:"directions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"matrix",id:"matrix",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"reachability",id:"reachability",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"parseDirectionsResponse",id:"parsedirectionsresponse",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"parseIsochroneResponse",id:"parseisochroneresponse",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"parseMatrixResponse",id:"parsematrixresponse",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4}],d={toc:s};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors"},"ors"),".ORS"),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRouter")))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ORS"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"clientArgs?"),")"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"clientArgs?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs"},(0,r.kt)("inlineCode",{parentName:"a"},"ClientConstructorArgs")))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L91"},"packages/ors/index.ts:91")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"apikey"},"apiKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"apiKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L90"},"packages/ors/index.ts:90")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"client"},"client"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"client"),": ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsclient"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSClient"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter"},"BaseRouter"),".",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/core.BaseRouter#client"},"client")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L89"},"packages/ors/index.ts:89")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"directions"},"directions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"directions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"format?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSDirections")),">"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsprofile"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSProfile")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"directionsOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsdirectionsopts"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSDirectionsOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsformat"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSFormat")))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSDirections")),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.directions"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L120"},"packages/ors/index.ts:120")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"directions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"directionsOpts"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"format?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsprofile"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSProfile")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"directionsOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsdirectionsopts"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSDirectionsOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsformat"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSFormat")))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.directions"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L127"},"packages/ors/index.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matrix"},"matrix"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"matrix"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrix")),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsprofile"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSProfile")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matrixOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsmatrixopts"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrix")),">"),(0,r.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.matrix"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L315"},"packages/ors/index.ts:315")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"matrix"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"locations"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"matrixOpts"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locations")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsprofile"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSProfile")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matrixOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsmatrixopts"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.matrix"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L321"},"packages/ors/index.ts:321")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reachability"},"reachability"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reachability"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isochronesOpts?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsisochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochrones")),">"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"intervals")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isochronesOpts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsisochroneopts"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsisochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochrones")),">"),(0,r.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.reachability"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L247"},"packages/ors/index.ts:247")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reachability"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"location"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"profile"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"intervals"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isochronesOpts"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dryRun"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),"]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"profile")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"intervals")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isochronesOpts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsisochroneopts"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneOpts")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dryRun")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,r.kt)("p",null,"BaseRouter.reachability"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L254"},"packages/ors/index.ts:254")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsedirectionsresponse"},"parseDirectionsResponse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"parseDirectionsResponse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSDirections"))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"response")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSRouteResponse")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsformat"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSFormat")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"units?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/modules/ors#orsunit"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSUnit")))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsdirections"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSDirections"))),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L183"},"packages/ors/index.ts:183")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parseisochroneresponse"},"parseIsochroneResponse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"parseIsochroneResponse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"intervalType?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsisochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochrones"))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"response")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochroneResponse")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"intervalType?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"time"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"distance"'))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsisochrones"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSIsochrones"))),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L295"},"packages/ors/index.ts:295")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsematrixresponse"},"parseMatrixResponse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"parseMatrixResponse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"response"),"): ",(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrix"))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"response")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrixResponse")))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/ors#orsmatrix"},(0,r.kt)("inlineCode",{parentName:"a"},"ORSMatrix"))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/ors/index.ts#L356"},"packages/ors/index.ts:356")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eca7e322.e29f95f5.js b/assets/js/eca7e322.e29f95f5.js new file mode 100644 index 0000000..a663705 --- /dev/null +++ b/assets/js/eca7e322.e29f95f5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7181],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function p(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},h=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,h=o(e,["components","mdxType","originalType","parentName"]),u=l(r),f=a,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(m,p(p({ref:t},h),{},{components:r})):n.createElement(m,p({ref:t},h))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,p=new Array(i);p[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,p[1]=o;for(var l=2;l<i;l++)p[l]=r[l];return n.createElement.apply(null,p)}return n.createElement.apply(null,r)}u.displayName="MDXCreateElement"},2211:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const i={id:"graphhopper.GraphHopperMatrixOpts",title:"Interface: GraphHopperMatrixOpts",sidebar_label:"GraphHopperMatrixOpts",custom_edit_url:null},p=void 0,o={unversionedId:"api/interfaces/graphhopper.GraphHopperMatrixOpts",id:"api/interfaces/graphhopper.GraphHopperMatrixOpts",title:"Interface: GraphHopperMatrixOpts",description:"graphhopper.GraphHopperMatrixOpts",source:"@site/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperMatrixOpts",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperMatrixOpts",title:"Interface: GraphHopperMatrixOpts",sidebar_label:"GraphHopperMatrixOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse"},next:{title:"GraphHopperMatrixParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fail_fast",id:"fail_fast",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"from_curbsides",id:"from_curbsides",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"from_point_hints",id:"from_point_hints",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"out_arrays",id:"out_arrays",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"snap_preventions",id:"snap_preventions",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"to_curbsides",id:"to_curbsides",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"to_point_hints",id:"to_point_hints",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4}],h={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperMatrixOpts"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperMatrixBaseOpts")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"GraphHopperMatrixOpts"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"destinations"},"destinations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"destinations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L82"},"packages/graphhopper/index.ts:82")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"fail_fast"},"fail","_","fast"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"fail","_","fast"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Specifies whether or not the matrix calculation should return with an error as soon as\npossible in case some points cannot be found or some points are not connected. If set\nto false the time/weight/distance matrix will be calculated for all valid points and contain\nthe null value for all entries that could not be calculated. The hint field of the response\nwill also contain additional information about what went wrong."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Default Value"))),(0,a.kt)("p",null,"Defaults to true."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.fail","_","fast"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L336"},"packages/graphhopper/parameters.ts:336")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from_curbsides"},"from","_","curbsides"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"from","_","curbsides"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperCurbside"),"[]"),(0,a.kt)("p",null,"Specifies on which side a point should be relative to the driver when she leaves/arrives\nat a start/target/via point. You need to specify this parameter for either none or all points.\nOnly supported for motor vehicles and OpenStreetMap."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,a.kt)("p",null,"Array length needs to match ",(0,a.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.from","_","curbsides"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L308"},"packages/graphhopper/parameters.ts:308")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from_point_hints"},"from","_","point","_","hints"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"from","_","point","_","hints"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"Specifies a hint for each ",(0,a.kt)("inlineCode",{parentName:"p"},"from_point")," parameter to prefer a certain street for the closest\nlocation lookup. E.g. if there is an address or house with two or more neighboring streets\nyou can control for which street the closest location is looked up."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,a.kt)("p",null,"Array length needs to match ",(0,a.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.from","_","point","_","hints"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L280"},"packages/graphhopper/parameters.ts:280")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"out_arrays"},"out","_","arrays"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"out","_","arrays"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperMatrixOut"),"[]"),(0,a.kt)("p",null,"Specifies which arrays should be included in the response. Specify one or more of\nthe following options 'weights', 'times', 'distances'. To specify more than one array\nuse e.g. out_array=times&out_array=distances. The units of the entries of distances\nare meters, of times are seconds and of weights is arbitrary and it can differ for different\nvehicles or versions of this API."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.out","_","arrays"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L325"},"packages/graphhopper/parameters.ts:325")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"snap_preventions"},"snap","_","preventions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"snap","_","preventions"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"Optional parameter to avoid snapping to a certain road class or road environment.\nMultiple values are specified like ",(0,a.kt)("inlineCode",{parentName:"p"},"snap_prevention=ferry&snap_prevention=motorway"),'.\nPlease note that this feature does not e.g. avoid motorways for the route - it\nonly avoids it for the "location snap".'),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,a.kt)("p",null,"Array length needs to match ",(0,a.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.snap","_","preventions"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L299"},"packages/graphhopper/parameters.ts:299")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sources"},"sources"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sources"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/index.ts#L81"},"packages/graphhopper/index.ts:81")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"to_curbsides"},"to","_","curbsides"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"to","_","curbsides"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperCurbside"),"[]"),(0,a.kt)("p",null,"Specifies on which side a point should be relative to the driver when she leaves/arrives\nat a start/target/via point. You need to specify this parameter for either none or all points.\nOnly supported for motor vehicles and OpenStreetMap."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,a.kt)("p",null,"Array length needs to match ",(0,a.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.to","_","curbsides"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L317"},"packages/graphhopper/parameters.ts:317")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"to_point_hints"},"to","_","point","_","hints"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"to","_","point","_","hints"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"Specifies a hint for each ",(0,a.kt)("inlineCode",{parentName:"p"},"from_point")," parameter to prefer a certain street for the closest\nlocation lookup. E.g. if there is an address or house with two or more neighboring streets\nyou can control for which street the closest location is looked up."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Remarks"))),(0,a.kt)("p",null,"Array length needs to match ",(0,a.kt)("inlineCode",{parentName:"p"},"from_points")," array length."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"GraphHopperMatrixBaseOpts.to","_","point","_","hints"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L289"},"packages/graphhopper/parameters.ts:289")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eff1c6c7.1faf84b4.js b/assets/js/eff1c6c7.1faf84b4.js new file mode 100644 index 0000000..e1bbb6b --- /dev/null +++ b/assets/js/eff1c6c7.1faf84b4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1917],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?p(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):p(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},p=Object.keys(e);for(n=0;n<p.length;n++)r=p[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n<p.length;n++)r=p[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,p=e.originalType,s=e.parentName,h=o(e,["components","mdxType","originalType","parentName"]),c=l(r),u=a,f=c["".concat(s,".").concat(u)]||c[u]||d[u]||p;return r?n.createElement(f,i(i({ref:t},h),{},{components:r})):n.createElement(f,i({ref:t},h))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=r.length,i=new Array(p);i[0]=c;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var l=2;l<p;l++)i[l]=r[l];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}c.displayName="MDXCreateElement"},3972:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const p={id:"graphhopper.GraphHopperMatrixResponse",title:"Interface: GraphHopperMatrixResponse",sidebar_label:"GraphHopperMatrixResponse",custom_edit_url:null},i=void 0,o={unversionedId:"api/interfaces/graphhopper.GraphHopperMatrixResponse",id:"api/interfaces/graphhopper.GraphHopperMatrixResponse",title:"Interface: GraphHopperMatrixResponse",description:"graphhopper.GraphHopperMatrixResponse",source:"@site/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperMatrixResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperMatrixResponse",title:"Interface: GraphHopperMatrixResponse",sidebar_label:"GraphHopperMatrixResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperMatrixParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams"},next:{title:"GraphHopperRouteParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"distances",id:"distances",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hints",id:"hints",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"info",id:"info",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"times",id:"times",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"weights",id:"weights",level:3},{value:"Defined in",id:"defined-in-4",level:4}],h={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperMatrixResponse"),(0,a.kt)("p",null,"The response object returned by the ",(0,a.kt)("inlineCode",{parentName:"p"},"/matrix")," endpoint."),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"distances"},"distances"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"distances"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("p",null,"The distance matrix for the specified points in the same order as the time matrix.\nThe distances are in meters. If fail_fast=false the matrix will contain null for connections\nthat could not be found."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L359"},"packages/graphhopper/parameters.ts:359")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hints"},"hints"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"hints"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperMatrixHint"),"[]"),(0,a.kt)("p",null,"Optional. Additional response data."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L376"},"packages/graphhopper/parameters.ts:376")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"info"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GraphHopperResponseInfo")),(0,a.kt)("p",null,"Additional information for your request"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L374"},"packages/graphhopper/parameters.ts:374")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"times"},"times"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"times"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("p",null,"The time matrix for the specified points in the order ",(0,a.kt)("inlineCode",{parentName:"p"},"[[from1->to1, from1->to2, ...], [from2->to1, from2->to2, ...], ...]"),".\nThe times are in seconds. If ",(0,a.kt)("inlineCode",{parentName:"p"},"fail_fast=false")," the matrix will contain null for connections that could not be found."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L365"},"packages/graphhopper/parameters.ts:365")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"weights"},"weights"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"weights"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[][]"),(0,a.kt)("p",null,"The weight matrix for the specified points in the same order as the time matrix.\nThe weights for different vehicle profiles can have a different unit but the weights array\nis perfectly suited as input for Vehicle Routing Problems as it is currently faster to calculate.\nIf fail_fast=false the matrix will contain null for connections that could not be found."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L372"},"packages/graphhopper/parameters.ts:372")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f6aebfbf.9650982f.js b/assets/js/f6aebfbf.9650982f.js new file mode 100644 index 0000000..b506aeb --- /dev/null +++ b/assets/js/f6aebfbf.9650982f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7306],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),u=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=u(e.components);return n.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=u(r),m=o,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||a;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,i[1]=l;for(var u=2;u<a;u++)i[u]=r[u];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},4440:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>c,frontMatter:()=>a,metadata:()=>l,toc:()=>u});var n=r(7462),o=(r(7294),r(3905));const a={id:"modules",title:"routingjs",sidebar_label:"Table of Contents",sidebar_position:.5,hide_table_of_contents:!0,custom_edit_url:null},i=void 0,l={unversionedId:"api/modules",id:"api/modules",title:"routingjs",description:"Modules",source:"@site/docs/api/modules.md",sourceDirName:"api",slug:"/api/modules",permalink:"/routingjs/docs/api/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"routingjs",sidebar_label:"Table of Contents",sidebar_position:.5,hide_table_of_contents:!0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Readme",permalink:"/routingjs/docs/api/"},next:{title:"core",permalink:"/routingjs/docs/api/modules/core"}},s={},u=[{value:"Modules",id:"modules",level:2}],p={toc:u};function c(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"modules"},"Modules"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/routingjs/docs/api/modules/core"},"core")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/routingjs/docs/api/modules/ors"},"ors")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/routingjs/docs/api/modules/osrm"},"osrm")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"))))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/faa0839e.93935c9e.js b/assets/js/faa0839e.93935c9e.js new file mode 100644 index 0000000..207e2bb --- /dev/null +++ b/assets/js/faa0839e.93935c9e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7098],{3905:(e,a,t)=>{t.d(a,{Zo:()=>u,kt:()=>h});var l=t(7294);function n(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function r(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);a&&(l=l.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,l)}return t}function i(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?r(Object(t),!0).forEach((function(a){n(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function o(e,a){if(null==e)return{};var t,l,n=function(e,a){if(null==e)return{};var t,l,n={},r=Object.keys(e);for(l=0;l<r.length;l++)t=r[l],a.indexOf(t)>=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(l=0;l<r.length;l++)t=r[l],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var s=l.createContext({}),p=function(e){var a=l.useContext(s),t=a;return e&&(t="function"==typeof e?e(a):i(i({},a),e)),t},u=function(e){var a=p(e.components);return l.createElement(s.Provider,{value:a},e.children)},c={inlineCode:"code",wrapper:function(e){var a=e.children;return l.createElement(l.Fragment,{},a)}},d=l.forwardRef((function(e,a){var t=e.components,n=e.mdxType,r=e.originalType,s=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=p(t),h=n,f=d["".concat(s,".").concat(h)]||d[h]||c[h]||r;return t?l.createElement(f,i(i({ref:a},u),{},{components:t})):l.createElement(f,i({ref:a},u))}));function h(e,a){var t=arguments,n=a&&a.mdxType;if("string"==typeof e||n){var r=t.length,i=new Array(r);i[0]=d;var o={};for(var s in a)hasOwnProperty.call(a,s)&&(o[s]=a[s]);o.originalType=e,o.mdxType="string"==typeof e?e:n,i[1]=o;for(var p=2;p<r;p++)i[p]=t[p];return l.createElement.apply(null,i)}return l.createElement.apply(null,t)}d.displayName="MDXCreateElement"},8281:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>s,contentTitle:()=>i,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>p});var l=t(7462),n=(t(7294),t(3905));const r={id:"valhalla.ValhallaRouteResponse",title:"Interface: ValhallaRouteResponse",sidebar_label:"ValhallaRouteResponse",custom_edit_url:null},i=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaRouteResponse",id:"api/interfaces/valhalla.ValhallaRouteResponse",title:"Interface: ValhallaRouteResponse",description:"valhalla.ValhallaRouteResponse",source:"@site/docs/api/interfaces/valhalla.ValhallaRouteResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaRouteResponse",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaRouteResponse",title:"Interface: ValhallaRouteResponse",sidebar_label:"ValhallaRouteResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaRouteParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams"},next:{title:"ValhallaTraceRouteOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"alternates",id:"alternates",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"trip",id:"trip",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:p};function c(e){let{components:a,...t}=e;return(0,n.kt)("wrapper",(0,l.Z)({},u,t,{components:a,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaRouteResponse"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alternates"},"alternates"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alternates"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaRouteResponse")),"[]"),(0,n.kt)("p",null,"Alternate routes, if ",(0,n.kt)("inlineCode",{parentName:"p"},"alternates")," was set in the request."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L189"},"packages/valhalla/parameters.ts:189")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"If specified, the input ID."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L179"},"packages/valhalla/parameters.ts:179")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"trip"},"trip"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"trip"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaTrip"))),(0,n.kt)("p",null,"The route results are returned as a trip. This is a JSON object that contains\ndetails about the trip, including locations, a summary with basic information about\nthe entire trip, and a list of legs."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L185"},"packages/valhalla/parameters.ts:185")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fc4d9247.f9c3605e.js b/assets/js/fc4d9247.f9c3605e.js new file mode 100644 index 0000000..c7d5610 --- /dev/null +++ b/assets/js/fc4d9247.f9c3605e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[593],{3905:(e,a,t)=>{t.d(a,{Zo:()=>d,kt:()=>c});var n=t(7294);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function i(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);a&&(n=n.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,n)}return t}function r(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?i(Object(t),!0).forEach((function(a){l(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function o(e,a){if(null==e)return{};var t,n,l=function(e,a){if(null==e)return{};var t,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)t=i[n],a.indexOf(t)>=0||(l[t]=e[t]);return l}(e,a);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)t=i[n],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(l[t]=e[t])}return l}var p=n.createContext({}),s=function(e){var a=n.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):r(r({},a),e)),t},d=function(e){var a=s(e.components);return n.createElement(p.Provider,{value:a},e.children)},h={inlineCode:"code",wrapper:function(e){var a=e.children;return n.createElement(n.Fragment,{},a)}},u=n.forwardRef((function(e,a){var t=e.components,l=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=s(t),c=l,m=u["".concat(p,".").concat(c)]||u[c]||h[c]||i;return t?n.createElement(m,r(r({ref:a},d),{},{components:t})):n.createElement(m,r({ref:a},d))}));function c(e,a){var t=arguments,l=a&&a.mdxType;if("string"==typeof e||l){var i=t.length,r=new Array(i);r[0]=u;var o={};for(var p in a)hasOwnProperty.call(a,p)&&(o[p]=a[p]);o.originalType=e,o.mdxType="string"==typeof e?e:l,r[1]=o;for(var s=2;s<i;s++)r[s]=t[s];return n.createElement.apply(null,r)}return n.createElement.apply(null,t)}u.displayName="MDXCreateElement"},9684:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>p,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var n=t(7462),l=(t(7294),t(3905));const i={id:"valhalla.ValhallaMatrixOpts",title:"Interface: ValhallaMatrixOpts",sidebar_label:"ValhallaMatrixOpts",custom_edit_url:null},r=void 0,o={unversionedId:"api/interfaces/valhalla.ValhallaMatrixOpts",id:"api/interfaces/valhalla.ValhallaMatrixOpts",title:"Interface: ValhallaMatrixOpts",description:"valhalla.ValhallaMatrixOpts",source:"@site/docs/api/interfaces/valhalla.ValhallaMatrixOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaMatrixOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaMatrixOpts",title:"Interface: ValhallaMatrixOpts",sidebar_label:"ValhallaMatrixOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaManeuvers",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers"},next:{title:"ValhallaMatrixParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avoidLocations",id:"avoidlocations",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"avoidPolygons",id:"avoidpolygons",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"costingOpts",id:"costingopts",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"dateTime",id:"datetime",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"destinations",id:"destinations",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"preference",id:"preference",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"sources",id:"sources",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"units",id:"units",level:3},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:s};function h(e){let{components:a,...t}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,t,{components:a,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaMatrixOpts"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaBaseOpts")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaMatrixOpts"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"avoidlocations"},"avoidLocations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"avoidLocations"),": (","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"]"," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Point")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Point"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">",")[]"),(0,l.kt)("p",null,"A set of locations to exclude or avoid within a route."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.avoidLocations"),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L92"},"packages/valhalla/index.ts:92")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"avoidpolygons"},"avoidPolygons"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"avoidPolygons"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"Polygon")," ","|"," ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]","[] ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Polygon"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">",")[]"),(0,l.kt)("p",null,"Roads intersecting these polygons\nwill be avoided during path finding. If you only need to avoid a few specific roads, it's much more\nefficient to use avoid_locations. Valhalla will close open rings (i.e. copy the first coordingate to the\nlast position)."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.avoidPolygons"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L99"},"packages/valhalla/index.ts:99")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costingopts"},"costingOpts"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"costingOpts"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsAuto"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsTruck"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsBicycle"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsMotorcycle"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsPedestrian"))),(0,l.kt)("p",null,"Profiles can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path. Only specify the actual options dict, the profile\nwill be filled automatically. For more information, visit:\n",(0,l.kt)("a",{parentName:"p",href:"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options"},"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options")),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.costingOpts"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L83"},"packages/valhalla/index.ts:83")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"datetime"},"dateTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"dateTime"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDateTime"))),(0,l.kt)("p",null,"This is the local date and time at the location. Field ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),": 0: Current departure time,\n1: Specified departure time. Field ",(0,l.kt)("inlineCode",{parentName:"p"},"value"),": the date and time is specified\nin ISO 8601 format (YYYY-MM-DDThh:mm), local time."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-js"}," date_time = {type: 0, value: 2021-03-03T08:06:23}\n")),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.dateTime"),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L110"},"packages/valhalla/index.ts:110")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"destinations"},"destinations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"destinations"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L198"},"packages/valhalla/index.ts:198")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"A request ID that will be returned in the response"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.id"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L70"},"packages/valhalla/index.ts:70")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"preference"},"preference"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"preference"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"shortest"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"fastest"')),(0,l.kt)("p",null,"Convenience argument to set the cost metric, one of ","['shortest', 'fastest']",". Note,\nthat shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called ",(0,l.kt)("inlineCode",{parentName:"p"},"preference"),"\nto be in line with the already existing parameter in the ORS adapter."),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.preference"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L76"},"packages/valhalla/index.ts:76")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"sources"},"sources"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"sources"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L197"},"packages/valhalla/index.ts:197")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"units"},"units"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"units"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla#valhallarequestunit"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaRequestUnit"))),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L199"},"packages/valhalla/index.ts:199")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fd3e4606.7d6fa593.js b/assets/js/fd3e4606.7d6fa593.js new file mode 100644 index 0000000..5f4e352 --- /dev/null +++ b/assets/js/fd3e4606.7d6fa593.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8130],{3905:(e,r,p)=>{p.d(r,{Zo:()=>l,kt:()=>d});var t=p(7294);function n(e,r,p){return r in e?Object.defineProperty(e,r,{value:p,enumerable:!0,configurable:!0,writable:!0}):e[r]=p,e}function o(e,r){var p=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);r&&(t=t.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),p.push.apply(p,t)}return p}function a(e){for(var r=1;r<arguments.length;r++){var p=null!=arguments[r]?arguments[r]:{};r%2?o(Object(p),!0).forEach((function(r){n(e,r,p[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(p)):o(Object(p)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(p,r))}))}return e}function s(e,r){if(null==e)return{};var p,t,n=function(e,r){if(null==e)return{};var p,t,n={},o=Object.keys(e);for(t=0;t<o.length;t++)p=o[t],r.indexOf(p)>=0||(n[p]=e[p]);return n}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(t=0;t<o.length;t++)p=o[t],r.indexOf(p)>=0||Object.prototype.propertyIsEnumerable.call(e,p)&&(n[p]=e[p])}return n}var i=t.createContext({}),c=function(e){var r=t.useContext(i),p=r;return e&&(p="function"==typeof e?e(r):a(a({},r),e)),p},l=function(e){var r=c(e.components);return t.createElement(i.Provider,{value:r},e.children)},h={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},u=t.forwardRef((function(e,r){var p=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=c(p),d=n,f=u["".concat(i,".").concat(d)]||u[d]||h[d]||o;return p?t.createElement(f,a(a({ref:r},l),{},{components:p})):t.createElement(f,a({ref:r},l))}));function d(e,r){var p=arguments,n=r&&r.mdxType;if("string"==typeof e||n){var o=p.length,a=new Array(o);a[0]=u;var s={};for(var i in r)hasOwnProperty.call(r,i)&&(s[i]=r[i]);s.originalType=e,s.mdxType="string"==typeof e?e:n,a[1]=s;for(var c=2;c<o;c++)a[c]=p[c];return t.createElement.apply(null,a)}return t.createElement.apply(null,p)}u.displayName="MDXCreateElement"},5064:(e,r,p)=>{p.r(r),p.d(r,{assets:()=>i,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var t=p(7462),n=(p(7294),p(3905));const o={id:"graphhopper.GraphHopperIsochroneResponse",title:"Interface: GraphHopperIsochroneResponse",sidebar_label:"GraphHopperIsochroneResponse",custom_edit_url:null},a=void 0,s={unversionedId:"api/interfaces/graphhopper.GraphHopperIsochroneResponse",id:"api/interfaces/graphhopper.GraphHopperIsochroneResponse",title:"Interface: GraphHopperIsochroneResponse",description:"graphhopper.GraphHopperIsochroneResponse",source:"@site/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/graphhopper.GraphHopperIsochroneResponse",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"graphhopper.GraphHopperIsochroneResponse",title:"Interface: GraphHopperIsochroneResponse",sidebar_label:"GraphHopperIsochroneResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"GraphHopperIsochroneParams",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams"},next:{title:"GraphHopperMatrixOpts",permalink:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts"}},i={},c=[{value:"Properties",id:"properties",level:2},{value:"copyrights",id:"copyrights",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"polygons",id:"polygons",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function h(e){let{components:r,...p}=e;return(0,n.kt)("wrapper",(0,t.Z)({},l,p,{components:r,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper"},"graphhopper"),".GraphHopperIsochroneResponse"),(0,n.kt)("p",null,"The response object returned by the ",(0,n.kt)("inlineCode",{parentName:"p"},"/isochrone")," endpoint."),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"copyrights"},"copyrights"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"copyrights"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L349"},"packages/graphhopper/parameters.ts:349")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"polygons"},"polygons"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"polygons"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Polygon"),", ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/graphhopper#graphhopperisochroneprops"},(0,n.kt)("inlineCode",{parentName:"a"},"GraphHopperIsochroneProps")),">","[]"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/graphhopper/parameters.ts#L348"},"packages/graphhopper/parameters.ts:348")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ff78c6e0.03da1022.js b/assets/js/ff78c6e0.03da1022.js new file mode 100644 index 0000000..7783579 --- /dev/null +++ b/assets/js/ff78c6e0.03da1022.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[381],{3905:(e,a,t)=>{t.d(a,{Zo:()=>u,kt:()=>h});var l=t(7294);function n(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function r(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);a&&(l=l.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,l)}return t}function i(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?r(Object(t),!0).forEach((function(a){n(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function s(e,a){if(null==e)return{};var t,l,n=function(e,a){if(null==e)return{};var t,l,n={},r=Object.keys(e);for(l=0;l<r.length;l++)t=r[l],a.indexOf(t)>=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(l=0;l<r.length;l++)t=r[l],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var p=l.createContext({}),o=function(e){var a=l.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):i(i({},a),e)),t},u=function(e){var a=o(e.components);return l.createElement(p.Provider,{value:a},e.children)},d={inlineCode:"code",wrapper:function(e){var a=e.children;return l.createElement(l.Fragment,{},a)}},c=l.forwardRef((function(e,a){var t=e.components,n=e.mdxType,r=e.originalType,p=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=o(t),h=n,m=c["".concat(p,".").concat(h)]||c[h]||d[h]||r;return t?l.createElement(m,i(i({ref:a},u),{},{components:t})):l.createElement(m,i({ref:a},u))}));function h(e,a){var t=arguments,n=a&&a.mdxType;if("string"==typeof e||n){var r=t.length,i=new Array(r);i[0]=c;var s={};for(var p in a)hasOwnProperty.call(a,p)&&(s[p]=a[p]);s.originalType=e,s.mdxType="string"==typeof e?e:n,i[1]=s;for(var o=2;o<r;o++)i[o]=t[o];return l.createElement.apply(null,i)}return l.createElement.apply(null,t)}c.displayName="MDXCreateElement"},8967:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>o});var l=t(7462),n=(t(7294),t(3905));const r={id:"valhalla.ValhallaTrip",title:"Interface: ValhallaTrip",sidebar_label:"ValhallaTrip",custom_edit_url:null},i=void 0,s={unversionedId:"api/interfaces/valhalla.ValhallaTrip",id:"api/interfaces/valhalla.ValhallaTrip",title:"Interface: ValhallaTrip",description:"valhalla.ValhallaTrip",source:"@site/docs/api/interfaces/valhalla.ValhallaTrip.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaTrip",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaTrip",title:"Interface: ValhallaTrip",sidebar_label:"ValhallaTrip",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaTraceRouteParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams"}},p={},o=[{value:"Properties",id:"properties",level:2},{value:"language",id:"language",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"legs",id:"legs",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"locations",id:"locations",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"status_message",id:"status_message",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"summary",id:"summary",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"units",id:"units",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-7",level:4}],u={toc:o};function d(e){let{components:a,...t}=e;return(0,n.kt)("wrapper",(0,l.Z)({},u,t,{components:a,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaTrip"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"language"},"language"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"language"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The language of the narration instructions. If the user specified a language in the\ndirections options and the specified language was supported - this returned value will\nbe equal to the specified value. Otherwise, this value will be the default (en-US) language."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L219"},"packages/valhalla/parameters.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"legs"},"legs"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"legs"),": ",(0,n.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg"},(0,n.kt)("inlineCode",{parentName:"a"},"ValhallaLeg")),"[]"),(0,n.kt)("p",null,"A trip contains one or more legs. For n number of break locations, there are n-1 legs.\nThrough locations do not create separate legs."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L203"},"packages/valhalla/parameters.ts:203")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locations"},"locations"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"locations"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaReturnLocation"),"[]"),(0,n.kt)("p",null,"Location information is returned in the same form as it is entered with additional fields\nto indicate the side of the street."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L197"},"packages/valhalla/parameters.ts:197")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"status"},"status"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"status"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Status code."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#internal-error-codes-and-conditions"},"https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#internal-error-codes-and-conditions")," for the full list of possible status codes."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L211"},"packages/valhalla/parameters.ts:211")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"status_message"},"status","_","message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"status","_","message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L205"},"packages/valhalla/parameters.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"summary"},"summary"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"summary"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ValhallaRouteSummary")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L204"},"packages/valhalla/parameters.ts:204")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"units"},"units"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"units"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The specified units of length are returned, either kilometers or miles."),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L213"},"packages/valhalla/parameters.ts:213")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"warnings"},"warnings"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"warnings"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"This array may contain warning objects informing about deprecated request parameters, clamped values etc."),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/parameters.ts#L223"},"packages/valhalla/parameters.ts:223")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ffa310cd.bcb9ea08.js b/assets/js/ffa310cd.bcb9ea08.js new file mode 100644 index 0000000..0e81d60 --- /dev/null +++ b/assets/js/ffa310cd.bcb9ea08.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[902],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>c});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function r(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var p=n.createContext({}),s=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,i=e.originalType,p=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),u=s(a),c=l,f=u["".concat(p,".").concat(c)]||u[c]||h[c]||i;return a?n.createElement(f,o(o({ref:t},d),{},{components:a})):n.createElement(f,o({ref:t},d))}));function c(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var i=a.length,o=new Array(i);o[0]=u;var r={};for(var p in t)hasOwnProperty.call(t,p)&&(r[p]=t[p]);r.originalType=e,r.mdxType="string"==typeof e?e:l,o[1]=r;for(var s=2;s<i;s++)o[s]=a[s];return n.createElement.apply(null,o)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"},6998:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>s});var n=a(7462),l=(a(7294),a(3905));const i={id:"valhalla.ValhallaIsochroneOpts",title:"Interface: ValhallaIsochroneOpts",sidebar_label:"ValhallaIsochroneOpts",custom_edit_url:null},o=void 0,r={unversionedId:"api/interfaces/valhalla.ValhallaIsochroneOpts",id:"api/interfaces/valhalla.ValhallaIsochroneOpts",title:"Interface: ValhallaIsochroneOpts",description:"valhalla.ValhallaIsochroneOpts",source:"@site/docs/api/interfaces/valhalla.ValhallaIsochroneOpts.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/valhalla.ValhallaIsochroneOpts",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"valhalla.ValhallaIsochroneOpts",title:"Interface: ValhallaIsochroneOpts",sidebar_label:"ValhallaIsochroneOpts",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ValhallaErrorProps",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps"},next:{title:"ValhallaIsochroneParams",permalink:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avoidLocations",id:"avoidlocations",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"avoidPolygons",id:"avoidpolygons",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"colors",id:"colors",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"costingOpts",id:"costingopts",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dateTime",id:"datetime",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"denoise",id:"denoise",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"generalize",id:"generalize",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"intervalType",id:"intervaltype",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"polygons",id:"polygons",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"preference",id:"preference",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"showLocations",id:"showlocations",level:3},{value:"Defined in",id:"defined-in-11",level:4}],d={toc:s};function h(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/modules/valhalla"},"valhalla"),".ValhallaIsochroneOpts"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("inlineCode",{parentName:"p"},"ValhallaBaseOpts")),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ValhallaIsochroneOpts"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"avoidlocations"},"avoidLocations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"avoidLocations"),": (","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"]"," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Point")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Point"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">",")[]"),(0,l.kt)("p",null,"A set of locations to exclude or avoid within a route."),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.avoidLocations"),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L92"},"packages/valhalla/index.ts:92")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"avoidpolygons"},"avoidPolygons"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"avoidPolygons"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"Polygon")," ","|"," ","[",(0,l.kt)("inlineCode",{parentName:"p"},"number"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"][]","[] ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Feature"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Polygon"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"GeoJsonProperties"),">",")[]"),(0,l.kt)("p",null,"Roads intersecting these polygons\nwill be avoided during path finding. If you only need to avoid a few specific roads, it's much more\nefficient to use avoid_locations. Valhalla will close open rings (i.e. copy the first coordingate to the\nlast position)."),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.avoidPolygons"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L99"},"packages/valhalla/index.ts:99")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"colors"},"colors"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"colors"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,l.kt)("p",null,'The color for the output of the contour. Specify it as a Hex value, but without the #, such as\n"color":"ff0000" for red. If no color is specified, the isochrone service will assign a default color to the output.'),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L173"},"packages/valhalla/index.ts:173")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"costingopts"},"costingOpts"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"costingOpts"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsAuto"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsTruck"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsBicycle"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsMotorcycle"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaCostingOptsPedestrian"))),(0,l.kt)("p",null,"Profiles can have several options that can be adjusted to develop the route path,\nas well as for estimating time along the path. Only specify the actual options dict, the profile\nwill be filled automatically. For more information, visit:\n",(0,l.kt)("a",{parentName:"p",href:"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options"},"https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options")),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.costingOpts"),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L83"},"packages/valhalla/index.ts:83")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"datetime"},"dateTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"dateTime"),": ",(0,l.kt)("a",{parentName:"p",href:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime"},(0,l.kt)("inlineCode",{parentName:"a"},"ValhallaDateTime"))),(0,l.kt)("p",null,"This is the local date and time at the location. Field ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),": 0: Current departure time,\n1: Specified departure time. Field ",(0,l.kt)("inlineCode",{parentName:"p"},"value"),": the date and time is specified\nin ISO 8601 format (YYYY-MM-DDThh:mm), local time."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-js"}," date_time = {type: 0, value: 2021-03-03T08:06:23}\n")),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.dateTime"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L110"},"packages/valhalla/index.ts:110")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"denoise"},"denoise"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"denoise"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"Can be used to remove smaller contours. In range ","[0, 1]",". A value of 1 will only return the largest contour\nfor a given time value. A value of 0.5 drops any contours that are less than half the area of the largest\ncontour in the set of contours for that same time value. Default 1."),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L183"},"packages/valhalla/index.ts:183")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"generalize"},"generalize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"generalize"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"A floating point value in meters used as the tolerance for Douglas-Peucker generalization.\nNote: Generalization of contours can lead to self-intersections, as well as intersections of adjacent contours."),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L188"},"packages/valhalla/index.ts:188")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("p",null,"A request ID that will be returned in the response"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.id"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L70"},"packages/valhalla/index.ts:70")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"intervaltype"},"intervalType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"intervalType"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"time"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"distance"')),(0,l.kt)("p",null,"Set 'time' for isochrones or 'distance' for equidistants.\nDefault 'time'."),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L168"},"packages/valhalla/index.ts:168")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"polygons"},"polygons"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"polygons"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"Controls whether polygons or linestrings are returned in GeoJSON geometry. Default False."),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L177"},"packages/valhalla/index.ts:177")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"preference"},"preference"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"preference"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"shortest"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"fastest"')),(0,l.kt)("p",null,"Convenience argument to set the cost metric, one of ","['shortest', 'fastest']",". Note,\nthat shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called ",(0,l.kt)("inlineCode",{parentName:"p"},"preference"),"\nto be in line with the already existing parameter in the ORS adapter."),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"ValhallaBaseOpts.preference"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L76"},"packages/valhalla/index.ts:76")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"showlocations"},"showLocations"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"showLocations"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,"A boolean indicating whether the input locations should be returned as MultiPoint features: one feature for the exact input coordinates and one feature\nfor the coordinates of the network node it snapped to. Default false."),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/gis-ops/routingjs/blob/aa687e0/packages/valhalla/index.ts#L193"},"packages/valhalla/index.ts:193")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/main.e8b73010.js b/assets/js/main.e8b73010.js new file mode 100644 index 0000000..8f53d0b --- /dev/null +++ b/assets/js/main.e8b73010.js @@ -0,0 +1,2 @@ +/*! For license information please see main.e8b73010.js.LICENSE.txt */ +(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(7462),o=n(8356),i=n.n(o),l=n(6887);const s={"06aa6e93":[()=>n.e(691).then(n.bind(n,8781)),"@site/docs/api/interfaces/osrm.OSRMRouteParams.md",8781],"08932d0c":[()=>n.e(6070).then(n.bind(n,6985)),"@site/docs/api/interfaces/core.ClientConstructorArgs.md",6985],"1291376a":[()=>n.e(9455).then(n.bind(n,3587)),"@site/docs/api/interfaces/ors.ORSRouteParams.md",3587],"1745c884":[()=>n.e(4745).then(n.bind(n,9891)),"@site/docs/api/interfaces/valhalla.ValhallaManeuvers.md",9891],"176abf51":[()=>n.e(8710).then(n.bind(n,1899)),"@site/docs/api/interfaces/valhalla.ValhallaErrorProps.md",1899],17896441:[()=>Promise.all([n.e(532),n.e(2666),n.e(7918)]).then(n.bind(n,3332)),"@theme/DocItem",3332],"1b3415a5":[()=>n.e(917).then(n.bind(n,6710)),"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian.md",6710],"1be78505":[()=>Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,9963)),"@theme/DocPage",9963],"1cd93e92":[()=>n.e(5124).then(n.bind(n,5784)),"@site/docs/api/interfaces/graphhopper.GraphHopperMatrixParams.md",5784],"1df93b7f":[()=>Promise.all([n.e(532),n.e(3237)]).then(n.bind(n,8391)),"@site/src/pages/index.tsx",8391],"1f391b9e":[()=>Promise.all([n.e(532),n.e(2666),n.e(3085)]).then(n.bind(n,4247)),"@theme/MDXPage",4247],23817249:[()=>n.e(6030).then(n.bind(n,5940)),"@site/docs/api/interfaces/valhalla.ValhallaIsochroneParams.md",5940],27302741:[()=>n.e(7873).then(n.bind(n,7100)),"@site/docs/api/interfaces/ors.ORSMatrixResponse.md",7100],"2fbe5889":[()=>n.e(3800).then(n.bind(n,1459)),"@site/docs/api/interfaces/core.ErrorProps.md",1459],"31c5dceb":[()=>n.e(3976).then(n.bind(n,9634)),"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto.md",9634],"35a07047":[()=>n.e(7986).then(n.bind(n,8025)),"@site/docs/api/modules/osrm.md",8025],"360d8d70":[()=>n.e(9342).then(n.bind(n,6551)),"@site/docs/api/interfaces/valhalla.ValhallaIsochroneResponse.md",6551],"393be207":[()=>n.e(7414).then(n.bind(n,9286)),"@site/src/pages/markdown-page.md",9286],"3ebc895b":[()=>n.e(9818).then(n.bind(n,1883)),"@site/docs/api/interfaces/core.JSONObject.md",1883],"4105c75d":[()=>n.e(5686).then(n.bind(n,4079)),"@site/docs/api/interfaces/valhalla.ValhallaMatrixParams.md",4079],"43063e81":[()=>n.e(2241).then(n.bind(n,625)),"@site/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts.md",625],"45d0475c":[()=>n.e(7987).then(n.bind(n,151)),"@site/docs/api/interfaces/valhalla.ValhallaTraceRouteParams.md",151],"481e471a":[()=>n.e(1281).then(n.bind(n,293)),"@site/docs/api/interfaces/graphhopper.GraphHopperRouteParams.md",293],"484329c4":[()=>n.e(3599).then(n.bind(n,3513)),"@site/docs/api/classes/core.Directions.md",3513],"4aa12286":[()=>n.e(3416).then(n.bind(n,4124)),"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck.md",4124],"4ae4fd96":[()=>n.e(2716).then(n.bind(n,8995)),"@site/docs/api/interfaces/ors.ORSRoute.md",8995],"5b8d0eef":[()=>n.e(3769).then(n.bind(n,5739)),"@site/docs/api/interfaces/osrm.OSRMTableResponse.md",5739],"5ceb730d":[()=>n.e(2347).then(n.bind(n,2388)),"@site/docs/api/interfaces/ors.ORSIsochroneResponse.md",2388],"5e5ac311":[()=>n.e(1425).then(n.bind(n,6531)),"@site/docs/api/interfaces/valhalla.MapboxAuthParams.md",6531],"5e8c322a":[()=>n.e(7597).then(n.bind(n,7926)),"@site/docs/api/index.md",7926],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,6809)),"@generated/docusaurus.config",6809],"5ffeac76":[()=>n.e(5874).then(n.t.bind(n,3769,19)),"/home/runner/work/routingjs/routingjs/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],60784167:[()=>n.e(1022).then(n.bind(n,297)),"@site/docs/api/classes/valhalla.Valhalla.md",297],"629bdd40":[()=>n.e(7173).then(n.bind(n,6931)),"@site/docs/api/classes/core.Isochrones.md",6931],"6b9ea5a6":[()=>n.e(5079).then(n.bind(n,6585)),"@site/docs/api/modules/valhalla.md",6585],"6ef32316":[()=>n.e(9012).then(n.bind(n,5047)),"@site/docs/api/interfaces/osrm.OSRMRoute.md",5047],"6ffa1466":[()=>n.e(6596).then(n.bind(n,2854)),"@site/docs/api/classes/core.Direction.md",2854],"705151d0":[()=>n.e(313).then(n.bind(n,160)),"@site/docs/api/interfaces/ors.ORSMatrixParams.md",160],"7a832ccb":[()=>n.e(7384).then(n.bind(n,9519)),"@site/docs/api/interfaces/valhalla.ValhallaLeg.md",9519],"84af600f":[()=>n.e(885).then(n.bind(n,294)),"@site/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts.md",294],"855fb381":[()=>n.e(5997).then(n.bind(n,4111)),"@site/docs/api/interfaces/graphhopper.GraphHopperRoutePath.md",4111],"88cbaf7a":[()=>n.e(1673).then(n.bind(n,5946)),"@site/docs/api/interfaces/osrm.OSRMErrorProps.md",5946],"8f93cbcd":[()=>n.e(7199).then(n.bind(n,5291)),"@site/docs/api/classes/graphhopper.GraphHopper.md",5291],"8fc6b66b":[()=>n.e(5823).then(n.bind(n,2231)),"@site/docs/api/interfaces/osrm.OSRMGeometryObject.md",2231],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"94bca0b8":[()=>n.e(9796).then(n.bind(n,2366)),"@site/docs/api/interfaces/valhalla.ValhallaDirectionOpts.md",2366],"9ae98e8e":[()=>n.e(6566).then(n.bind(n,9014)),"@site/docs/api/interfaces/osrm.OSRMDirectionsOpts.md",9014],"9e00c705":[()=>n.e(130).then(n.bind(n,6957)),"@site/docs/api/classes/core.Isochrone.md",6957],"9e3cb6c3":[()=>n.e(8769).then(n.bind(n,3138)),"@site/docs/api/interfaces/valhalla.ValhallaRouteParams.md",3138],a063e0e3:[()=>n.e(4884).then(n.bind(n,3603)),"@site/docs/api/interfaces/ors.ORSAlternateRouteParam.md",3603],a557ae41:[()=>n.e(1358).then(n.bind(n,7014)),"@site/docs/api/interfaces/ors.ORSErrorProps.md",7014],aa082b57:[()=>n.e(6161).then(n.bind(n,1600)),"@site/docs/api/classes/osrm.OSRM.md",1600],acc2462d:[()=>n.e(1973).then(n.bind(n,4960)),"@site/docs/api/interfaces/valhalla.ValhallaMatrixResponse.md",4960],b009f941:[()=>n.e(2758).then(n.bind(n,1234)),"@site/docs/api/interfaces/osrm.OSRMTableParams.md",1234],b45c6e46:[()=>n.e(7494).then(n.bind(n,8116)),"@site/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams.md",8116],b4f090cd:[()=>n.e(2378).then(n.bind(n,4186)),"@site/docs/api/interfaces/core.BaseRouter.md",4186],b567fbc2:[()=>n.e(8318).then(n.bind(n,2890)),"@site/docs/api/modules/ors.md",2890],b5c59fa7:[()=>n.e(39).then(n.bind(n,8774)),"@site/docs/api/interfaces/valhalla.ValhallaContours.md",8774],bc512349:[()=>n.e(5133).then(n.bind(n,1533)),"@site/docs/api/interfaces/ors.ORSIsochroneParams.md",1533],c1888b50:[()=>n.e(3308).then(n.bind(n,9627)),"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle.md",9627],c7a53f27:[()=>n.e(5648).then(n.bind(n,5101)),"@site/docs/api/interfaces/ors.ORSRouteResponse.md",5101],cb9481a5:[()=>n.e(2673).then(n.bind(n,8938)),"@site/docs/api/interfaces/valhalla.ValhallaDateTime.md",8938],d08d5db0:[()=>n.e(7719).then(n.bind(n,1402)),"@site/docs/api/interfaces/graphhopper.GraphHopperErrorProps.md",1402],d17d046f:[()=>n.e(5825).then(n.bind(n,7800)),"@site/docs/api/classes/core.RoutingJSAPIError.md",7800],d1df3a82:[()=>n.e(3987).then(n.t.bind(n,5745,19)),"/home/runner/work/routingjs/routingjs/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],d829a3a8:[()=>n.e(3482).then(n.bind(n,4742)),"@site/docs/api/interfaces/valhalla.ValhallaLocation.md",4742],da631d65:[()=>n.e(7332).then(n.bind(n,4876)),"@site/docs/api/modules/core.md",4876],dd4f9bad:[()=>n.e(4985).then(n.bind(n,2988)),"@site/docs/api/interfaces/graphhopper.GraphHopperRouteResponse.md",2988],dd6706b8:[()=>n.e(1994).then(n.bind(n,8155)),"@site/docs/api/classes/core.Matrix.md",8155],e33a542e:[()=>n.e(6309).then(n.bind(n,118)),"@site/docs/00_quickstart.md",118],e356c530:[()=>n.e(2846).then(n.bind(n,8494)),"@site/docs/api/interfaces/osrm.OSRMRouteResponse.md",8494],e4e8843d:[()=>n.e(6856).then(n.bind(n,1006)),"@site/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle.md",1006],e69ab7fa:[()=>n.e(6401).then(n.bind(n,497)),"@site/docs/api/classes/core.Client.md",497],e6bf94c2:[()=>n.e(6588).then(n.bind(n,4518)),"@site/docs/api/modules/graphhopper.md",4518],ea776caf:[()=>n.e(7340).then(n.bind(n,1898)),"@site/docs/api/interfaces/osrm.OSRMMatrixOpts.md",1898],ebfbfacf:[()=>n.e(1751).then(n.bind(n,9049)),"@site/docs/api/classes/ors.ORS.md",9049],eca7e322:[()=>n.e(7181).then(n.bind(n,2211)),"@site/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts.md",2211],eff1c6c7:[()=>n.e(1917).then(n.bind(n,3972)),"@site/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse.md",3972],f6aebfbf:[()=>n.e(7306).then(n.bind(n,4440)),"@site/docs/api/modules.md",4440],faa0839e:[()=>n.e(7098).then(n.bind(n,8281)),"@site/docs/api/interfaces/valhalla.ValhallaRouteResponse.md",8281],fc4d9247:[()=>n.e(593).then(n.bind(n,9684)),"@site/docs/api/interfaces/valhalla.ValhallaMatrixOpts.md",9684],fd3e4606:[()=>n.e(8130).then(n.bind(n,5064)),"@site/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse.md",5064],ff78c6e0:[()=>n.e(381).then(n.bind(n,8967)),"@site/docs/api/interfaces/valhalla.ValhallaTrip.md",8967],ffa310cd:[()=>n.e(902).then(n.bind(n,6998)),"@site/docs/api/interfaces/valhalla.ValhallaIsochroneOpts.md",6998]};function c(e){let{error:t,retry:n,pastDelay:a}=e;return t?r.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,String(t)),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var u=n(9670),d=n(226);function p(e,t){if("*"===e)return i()({loading:c,loader:()=>n.e(4972).then(n.bind(n,4972)),modules:["@theme/NotFound"],webpack:()=>[4972],render(e,t){const n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});const o=l[`${e}-${t}`],p={},f=[],m=[],h=(0,u.Z)(o);return Object.entries(h).forEach((e=>{let[t,n]=e;const r=s[n];r&&(p[t]=r[0],f.push(r[1]),m.push(r[2]))})),i().Map({loading:c,loader:p,modules:f,webpack:()=>m,render(t,n){const i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let o=i;const l=n.split(".");l.slice(0,-1).forEach((e=>{o=o[e]})),o[l[l.length-1]]=a}));const l=i.__comp;delete i.__comp;const s=i.__context;return delete i.__context,r.createElement(d.z,{value:s},r.createElement(l,(0,a.Z)({},i,n)))}})}const f=[{path:"/routingjs/markdown-page",component:p("/routingjs/markdown-page","357"),exact:!0},{path:"/routingjs/docs",component:p("/routingjs/docs","772"),routes:[{path:"/routingjs/docs/api",component:p("/routingjs/docs/api","bf3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.Client",component:p("/routingjs/docs/api/classes/core.Client","a84"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.Direction",component:p("/routingjs/docs/api/classes/core.Direction","a91"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.Directions",component:p("/routingjs/docs/api/classes/core.Directions","ca0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.Isochrone",component:p("/routingjs/docs/api/classes/core.Isochrone","d03"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.Isochrones",component:p("/routingjs/docs/api/classes/core.Isochrones","1ed"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.Matrix",component:p("/routingjs/docs/api/classes/core.Matrix","d65"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/core.RoutingJSAPIError",component:p("/routingjs/docs/api/classes/core.RoutingJSAPIError","661"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/graphhopper.GraphHopper",component:p("/routingjs/docs/api/classes/graphhopper.GraphHopper","c0b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/ors.ORS",component:p("/routingjs/docs/api/classes/ors.ORS","121"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/osrm.OSRM",component:p("/routingjs/docs/api/classes/osrm.OSRM","971"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/classes/valhalla.Valhalla",component:p("/routingjs/docs/api/classes/valhalla.Valhalla","5be"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/core.BaseRouter",component:p("/routingjs/docs/api/interfaces/core.BaseRouter","397"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/core.ClientConstructorArgs",component:p("/routingjs/docs/api/interfaces/core.ClientConstructorArgs","ad5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/core.ErrorProps",component:p("/routingjs/docs/api/interfaces/core.ErrorProps","1f2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/core.JSONObject",component:p("/routingjs/docs/api/interfaces/core.JSONObject","85a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps","d4e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts","7bd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams","1bc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse","086"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts","ce2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams","d2d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse","ca7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams","b6b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath","e7c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse",component:p("/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse","410"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam",component:p("/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam","db8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSErrorProps",component:p("/routingjs/docs/api/interfaces/ors.ORSErrorProps","f4c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams",component:p("/routingjs/docs/api/interfaces/ors.ORSIsochroneParams","05e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse",component:p("/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse","fc6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSMatrixParams",component:p("/routingjs/docs/api/interfaces/ors.ORSMatrixParams","802"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse",component:p("/routingjs/docs/api/interfaces/ors.ORSMatrixResponse","4f1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSRoute",component:p("/routingjs/docs/api/interfaces/ors.ORSRoute","f00"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSRouteParams",component:p("/routingjs/docs/api/interfaces/ors.ORSRouteParams","410"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/ors.ORSRouteResponse",component:p("/routingjs/docs/api/interfaces/ors.ORSRouteResponse","198"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts",component:p("/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts","979"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps",component:p("/routingjs/docs/api/interfaces/osrm.OSRMErrorProps","1f2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject",component:p("/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject","890"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts",component:p("/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts","96c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMRoute",component:p("/routingjs/docs/api/interfaces/osrm.OSRMRoute","e41"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams",component:p("/routingjs/docs/api/interfaces/osrm.OSRMRouteParams","079"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse",component:p("/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse","5dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMTableParams",component:p("/routingjs/docs/api/interfaces/osrm.OSRMTableParams","f4a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse",component:p("/routingjs/docs/api/interfaces/osrm.OSRMTableResponse","acd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams",component:p("/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams","98d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaContours",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaContours","ad4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto","e8c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle","575"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle","957"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian","9d1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck","a96"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime","6bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts","dac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps","4b0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts","f31"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams","e1a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse","37a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaLeg","042"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaLocation","935"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers","de3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts","bd6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams","40a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse","c78"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams","698"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse","221"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts","7a7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams","ecc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip",component:p("/routingjs/docs/api/interfaces/valhalla.ValhallaTrip","1de"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/modules",component:p("/routingjs/docs/api/modules","932"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/modules/core",component:p("/routingjs/docs/api/modules/core","ec0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/modules/graphhopper",component:p("/routingjs/docs/api/modules/graphhopper","aa4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/modules/ors",component:p("/routingjs/docs/api/modules/ors","c40"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/modules/osrm",component:p("/routingjs/docs/api/modules/osrm","251"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/api/modules/valhalla",component:p("/routingjs/docs/api/modules/valhalla","76c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/routingjs/docs/quickstart",component:p("/routingjs/docs/quickstart","8f8"),exact:!0,sidebar:"tutorialSidebar"}]},{path:"/routingjs/",component:p("/routingjs/","66e"),exact:!0},{path:"*",component:p("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>o});var r=n(7294);const a=r.createContext(!1);function o(e){let{children:t}=e;const[n,o]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{o(!0)}),[]),r.createElement(a.Provider,{value:n},t)}},9383:(e,t,n)=>{"use strict";var r=n(7294),a=n(3935),o=n(3727),i=n(405),l=n(412);const s=[n(2497),n(3310),n(8320),n(2295)];var c=n(723),u=n(6550),d=n(8790);function p(e){let{children:t}=e;return r.createElement(r.Fragment,null,t)}var f=n(7462),m=n(5742),h=n(2263),g=n(4996),b=n(6668),v=n(1944),y=n(4711),w=n(9727),k=n(3320),S=n(197);function E(){const{i18n:{defaultLocale:e,localeConfigs:t}}=(0,h.Z)(),n=(0,y.l)();return r.createElement(m.Z,null,Object.entries(t).map((e=>{let[t,{htmlLang:a}]=e;return r.createElement("link",{key:t,rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:a})})),r.createElement("link",{rel:"alternate",href:n.createUrl({locale:e,fullyQualified:!0}),hrefLang:"x-default"}))}function x(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.Z)(),a=function(){const{siteConfig:{url:e}}=(0,h.Z)(),{pathname:t}=(0,u.TH)();return e+(0,g.Z)(t)}(),o=t?`${n}${t}`:a;return r.createElement(m.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function _(){const{i18n:{currentLocale:e}}=(0,h.Z)(),{metadata:t,image:n}=(0,b.L)();return r.createElement(r.Fragment,null,r.createElement(m.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:w.h})),n&&r.createElement(v.d,{image:n}),r.createElement(x,null),r.createElement(E,null),r.createElement(S.Z,{tag:k.HX,locale:e}),r.createElement(m.Z,null,t.map(((e,t)=>r.createElement("meta",(0,f.Z)({key:t},e))))))}const R=new Map;function C(e){if(R.has(e.pathname))return{...e,pathname:R.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return R.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return R.set(e.pathname,t),{...e,pathname:t}}var T=n(8934),O=n(8940);function P(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];const a=s.map((t=>{var r;const a=(null==(r=t.default)?void 0:r[e])??t[e];return null==a?void 0:a(...n)}));return()=>a.forEach((e=>null==e?void 0:e()))}const A=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,r.useLayoutEffect)((()=>{a!==n&&(a&&function(e){const{hash:t}=e;if(t){const e=decodeURIComponent(t.substring(1)),n=document.getElementById(e);null==n||n.scrollIntoView()}else window.scrollTo(0,0)}(n),P("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function j(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(c.Z,e))).flat();return Promise.all(t.map((e=>null==e.route.component.preload?void 0:e.route.component.preload())))}class L extends r.Component{constructor(e){super(e),this.previousLocation=void 0,this.routeUpdateCleanupCb=void 0,this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.canUseDOM?P("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=P("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),j(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return r.createElement(A,{previousLocation:this.previousLocation,location:t},r.createElement(u.AW,{location:t,render:()=>e}))}}const N=L,I="docusaurus-base-url-issue-banner-container",M="docusaurus-base-url-issue-banner-suggestion-container",D="__DOCUSAURUS_INSERT_BASEURL_BANNER";function F(e){return`\nwindow['${D}'] = true;\n\ndocument.addEventListener('DOMContentLoaded', maybeInsertBanner);\n\nfunction maybeInsertBanner() {\n var shouldInsert = window['${D}'];\n shouldInsert && insertBanner();\n}\n\nfunction insertBanner() {\n var bannerContainer = document.getElementById('${I}');\n if (!bannerContainer) {\n return;\n }\n var bannerHtml = ${JSON.stringify(function(e){return`\n<div id="docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">${e}</span> ${"/"===e?" (default value)":""}</p>\n <p>We suggest trying baseUrl = <span id="${M}" style="font-weight: bold; color: green;"></span></p>\n</div>\n`}(e)).replace(/</g,"\\<")};\n bannerContainer.innerHTML = bannerHtml;\n var suggestionContainer = document.getElementById('${M}');\n var actualHomePagePath = window.location.pathname;\n var suggestedBaseUrl = actualHomePagePath.substr(-1) === '/'\n ? actualHomePagePath\n : actualHomePagePath + '/';\n suggestionContainer.innerHTML = suggestedBaseUrl;\n}\n`}function B(){const{siteConfig:{baseUrl:e}}=(0,h.Z)();return(0,r.useLayoutEffect)((()=>{window[D]=!1}),[]),r.createElement(r.Fragment,null,!l.Z.canUseDOM&&r.createElement(m.Z,null,r.createElement("script",null,F(e))),r.createElement("div",{id:I}))}function z(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,h.Z)(),{pathname:n}=(0,u.TH)();return t&&n===e?r.createElement(B,null):null}function U(){const{siteConfig:{favicon:e,title:t,noIndex:n},i18n:{currentLocale:a,localeConfigs:o}}=(0,h.Z)(),i=(0,g.Z)(e),{htmlLang:l,direction:s}=o[a];return r.createElement(m.Z,null,r.createElement("html",{lang:l,dir:s}),r.createElement("title",null,t),r.createElement("meta",{property:"og:title",content:t}),r.createElement("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),n&&r.createElement("meta",{name:"robots",content:"noindex, nofollow"}),e&&r.createElement("link",{rel:"icon",href:i}))}var $=n(4763);function G(){const e=(0,d.H)(c.Z),t=(0,u.TH)();return r.createElement($.Z,null,r.createElement(O.M,null,r.createElement(T.t,null,r.createElement(p,null,r.createElement(U,null),r.createElement(_,null),r.createElement(z,null),r.createElement(N,{location:C(t)},e)))))}var H=n(6887);const V=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{var r;if("undefined"==typeof document)return void n();const a=document.createElement("link");a.setAttribute("rel","prefetch"),a.setAttribute("href",e),a.onload=()=>t(),a.onerror=()=>n();const o=document.getElementsByTagName("head")[0]??(null==(r=document.getElementsByName("script")[0])?void 0:r.parentNode);null==o||o.appendChild(a)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var q=n(9670);const Z=new Set,W=new Set,Y=()=>{var e,t;return(null==(e=navigator.connection)?void 0:e.effectiveType.includes("2g"))||(null==(t=navigator.connection)?void 0:t.saveData)},K={prefetch(e){if(!(e=>!Y()&&!W.has(e)&&!Z.has(e))(e))return!1;Z.add(e);const t=(0,d.f)(c.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(H).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,q.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?V(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!Y()&&!W.has(e))(e)&&(W.add(e),j(e))},Q=Object.freeze(K);if(l.Z.canUseDOM){window.docusaurus=Q;const e=a.hydrate;j(window.location.pathname).then((()=>{e(r.createElement(i.B6,null,r.createElement(o.VK,null,r.createElement(G,null))),document.getElementById("__docusaurus"))}))}},8940:(e,t,n)=>{"use strict";n.d(t,{_:()=>u,M:()=>d});var r=n(7294),a=n(6809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/routingjs/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/routingjs/docs","mainDocId":"quickstart","docs":[{"id":"api/classes/core.Client","path":"/routingjs/docs/api/classes/core.Client","sidebar":"tutorialSidebar"},{"id":"api/classes/core.Direction","path":"/routingjs/docs/api/classes/core.Direction","sidebar":"tutorialSidebar"},{"id":"api/classes/core.Directions","path":"/routingjs/docs/api/classes/core.Directions","sidebar":"tutorialSidebar"},{"id":"api/classes/core.Isochrone","path":"/routingjs/docs/api/classes/core.Isochrone","sidebar":"tutorialSidebar"},{"id":"api/classes/core.Isochrones","path":"/routingjs/docs/api/classes/core.Isochrones","sidebar":"tutorialSidebar"},{"id":"api/classes/core.Matrix","path":"/routingjs/docs/api/classes/core.Matrix","sidebar":"tutorialSidebar"},{"id":"api/classes/core.RoutingJSAPIError","path":"/routingjs/docs/api/classes/core.RoutingJSAPIError","sidebar":"tutorialSidebar"},{"id":"api/classes/graphhopper.GraphHopper","path":"/routingjs/docs/api/classes/graphhopper.GraphHopper","sidebar":"tutorialSidebar"},{"id":"api/classes/ors.ORS","path":"/routingjs/docs/api/classes/ors.ORS","sidebar":"tutorialSidebar"},{"id":"api/classes/osrm.OSRM","path":"/routingjs/docs/api/classes/osrm.OSRM","sidebar":"tutorialSidebar"},{"id":"api/classes/valhalla.Valhalla","path":"/routingjs/docs/api/classes/valhalla.Valhalla","sidebar":"tutorialSidebar"},{"id":"api/index","path":"/routingjs/docs/api/","sidebar":"tutorialSidebar"},{"id":"api/interfaces/core.BaseRouter","path":"/routingjs/docs/api/interfaces/core.BaseRouter","sidebar":"tutorialSidebar"},{"id":"api/interfaces/core.ClientConstructorArgs","path":"/routingjs/docs/api/interfaces/core.ClientConstructorArgs","sidebar":"tutorialSidebar"},{"id":"api/interfaces/core.ErrorProps","path":"/routingjs/docs/api/interfaces/core.ErrorProps","sidebar":"tutorialSidebar"},{"id":"api/interfaces/core.JSONObject","path":"/routingjs/docs/api/interfaces/core.JSONObject","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperErrorProps","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperIsochroneOpts","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperIsochroneParams","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperIsochroneResponse","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperMatrixOpts","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperMatrixParams","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperMatrixResponse","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperRouteParams","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperRoutePath","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath","sidebar":"tutorialSidebar"},{"id":"api/interfaces/graphhopper.GraphHopperRouteResponse","path":"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSAlternateRouteParam","path":"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSErrorProps","path":"/routingjs/docs/api/interfaces/ors.ORSErrorProps","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSIsochroneParams","path":"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSIsochroneResponse","path":"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSMatrixParams","path":"/routingjs/docs/api/interfaces/ors.ORSMatrixParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSMatrixResponse","path":"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSRoute","path":"/routingjs/docs/api/interfaces/ors.ORSRoute","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSRouteParams","path":"/routingjs/docs/api/interfaces/ors.ORSRouteParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/ors.ORSRouteResponse","path":"/routingjs/docs/api/interfaces/ors.ORSRouteResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMDirectionsOpts","path":"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMErrorProps","path":"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMGeometryObject","path":"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMMatrixOpts","path":"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMRoute","path":"/routingjs/docs/api/interfaces/osrm.OSRMRoute","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMRouteParams","path":"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMRouteResponse","path":"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMTableParams","path":"/routingjs/docs/api/interfaces/osrm.OSRMTableParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/osrm.OSRMTableResponse","path":"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.MapboxAuthParams","path":"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaContours","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaContours","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaCostingOptsAuto","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaCostingOptsBicycle","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaCostingOptsMotorcycle","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaCostingOptsPedestrian","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaCostingOptsTruck","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaDateTime","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaDirectionOpts","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaErrorProps","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaIsochroneOpts","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaIsochroneParams","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaIsochroneResponse","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaLeg","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaLocation","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaManeuvers","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaMatrixOpts","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaMatrixParams","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaMatrixResponse","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaRouteParams","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaRouteResponse","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaTraceRouteOpts","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaTraceRouteParams","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams","sidebar":"tutorialSidebar"},{"id":"api/interfaces/valhalla.ValhallaTrip","path":"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip","sidebar":"tutorialSidebar"},{"id":"api/modules","path":"/routingjs/docs/api/modules","sidebar":"tutorialSidebar"},{"id":"api/modules/core","path":"/routingjs/docs/api/modules/core","sidebar":"tutorialSidebar"},{"id":"api/modules/graphhopper","path":"/routingjs/docs/api/modules/graphhopper","sidebar":"tutorialSidebar"},{"id":"api/modules/ors","path":"/routingjs/docs/api/modules/ors","sidebar":"tutorialSidebar"},{"id":"api/modules/osrm","path":"/routingjs/docs/api/modules/osrm","sidebar":"tutorialSidebar"},{"id":"api/modules/valhalla","path":"/routingjs/docs/api/modules/valhalla","sidebar":"tutorialSidebar"},{"id":"quickstart","path":"/routingjs/docs/quickstart","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/routingjs/docs/quickstart","label":"quickstart"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(7529);const s=JSON.parse('{"docusaurusVersion":"2.2.0","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.2.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.2.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.2.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.2.0"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"0.18.0"}}}'),c={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},u=r.createContext(c);function d(e){let{children:t}=e;return r.createElement(u.Provider,{value:c},t)}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(7294),a=n(412),o=n(5742),i=n(3285);function l(e){let{error:t,tryAgain:n}=e;return r.createElement("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"center",height:"50vh",width:"100%",fontSize:"20px"}},r.createElement("h1",null,"This page crashed."),r.createElement("p",null,t.message),r.createElement("button",{type:"button",onClick:n},"Try again"))}function s(e){let{error:t,tryAgain:n}=e;return r.createElement(u,{fallback:()=>r.createElement(l,{error:t,tryAgain:n})},r.createElement(o.Z,null,r.createElement("title",null,"Page Error")),r.createElement(i.Z,null,r.createElement(l,{error:t,tryAgain:n})))}const c=e=>r.createElement(s,e);class u extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??c)(e)}return e??null}}},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(405);function o(e){return r.createElement(a.ql,e)}},9960:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7462),a=n(7294),o=n(3727),i=n(8780),l=n(2263),s=n(3919),c=n(412);const u=a.createContext({collectLink:()=>{}});var d=n(4996);function p(e,t){var n;let{isNavLink:p,to:f,href:m,activeClassName:h,isActive:g,"data-noBrokenLinkCheck":b,autoAddBaseUrl:v=!0,...y}=e;const{siteConfig:{trailingSlash:w,baseUrl:k}}=(0,l.Z)(),{withBaseUrl:S}=(0,d.C)(),E=(0,a.useContext)(u),x=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>x.current));const _=f||m;const R=(0,s.Z)(_),C=null==_?void 0:_.replace("pathname://","");let T=void 0!==C?(O=C,v&&(e=>e.startsWith("/"))(O)?S(O):O):void 0;var O;T&&R&&(T=(0,i.applyTrailingSlash)(T,{trailingSlash:w,baseUrl:k}));const P=(0,a.useRef)(!1),A=p?o.OL:o.rU,j=c.Z.canUseIntersectionObserver,L=(0,a.useRef)(),N=()=>{P.current||null==T||(window.docusaurus.preload(T),P.current=!0)};(0,a.useEffect)((()=>(!j&&R&&null!=T&&window.docusaurus.prefetch(T),()=>{j&&L.current&&L.current.disconnect()})),[L,T,j,R]);const I=(null==(n=T)?void 0:n.startsWith("#"))??!1,M=!T||!R||I;return M||b||E.collectLink(T),M?a.createElement("a",(0,r.Z)({ref:x,href:T},_&&!R&&{target:"_blank",rel:"noopener noreferrer"},y)):a.createElement(A,(0,r.Z)({},y,{onMouseEnter:N,onTouchStart:N,innerRef:e=>{x.current=e,j&&e&&R&&(L.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(L.current.unobserve(e),L.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),L.current.observe(e))},to:T},p&&{isActive:g,activeClassName:h}))}const f=a.forwardRef(p)},1875:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=()=>null},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>s,I:()=>l});var r=n(7294);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=null==t?void 0:t[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var o=n(7529);function i(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return o[t??n]??n??t}function l(e,t){let{message:n,id:r}=e;return a(i({message:n,id:r}),t)}function s(e){let{children:t,id:n,values:o}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal <Translate> children",t),new Error("The Docusaurus <Translate> component only accept simple string values");const l=i({message:t,id:n});return r.createElement(r.Fragment,null,a(l,o))}},9935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},3919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4996:(e,t,n)=>{"use strict";n.d(t,{C:()=>o,Z:()=>i});var r=n(2263),a=n(3919);function o(){const{siteConfig:{baseUrl:e,url:t}}=(0,r.Z)();return{withBaseUrl:(n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:o=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,a.b)(n))return n;if(o)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)}}function i(e,t){void 0===t&&(t={});const{withBaseUrl:n}=o();return n(e,t)}},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8940);function o(){return(0,r.useContext)(a._)}},2389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8934);function o(){return(0,r.useContext)(a._)}},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});function r(e){const t={};return function e(n,r){Object.entries(n).forEach((n=>{let[a,o]=n;const i=r?`${r}.${a}`:a;var l;"object"==typeof(l=o)&&l&&Object.keys(l).length>0?e(o,i):t[i]=o}))}(e),t}},226:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,z:()=>o});var r=n(7294);const a=r.createContext(null);function o(e){let{children:t,value:n}=e;const o=r.useContext(a),i=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...null==n?void 0:n.data};return{plugin:t.plugin,data:r}}({parent:o,value:n})),[o,n]);return r.createElement(a.Provider,{value:i},t)}},143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>h,gA:()=>p,_r:()=>u,Jo:()=>g,zh:()=>d,yW:()=>m,gB:()=>f});var r=n(6550),a=n(2263),o=n(9935);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const l=e=>e.versions.find((e=>e.isLast));function s(e,t){const n=function(e,t){const n=l(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=null==n?void 0:n.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const c={},u=()=>i("docusaurus-plugin-content-docs")??c,d=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e),a=null==r?void 0:r[t];if(!a&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return a}("docusaurus-plugin-content-docs",e,{failfast:!0});function p(e){void 0===e&&(e={});const t=u(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function f(e){return d(e).versions}function m(e){const t=d(e);return l(t)}function h(e){const t=d(e),{pathname:n}=(0,r.TH)();return s(t,n)}function g(e){const t=d(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},8320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(4865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(7410),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{n(6726)(`./prism-${e}`)})),delete globalThis.Prism}(r.Z)},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294);const a="iconExternalLink_nPIU";function o(e){let{width:t=13.5,height:n=13.5}=e;return r.createElement("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:a},r.createElement("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"}))}},3285:(e,t,n)=>{"use strict";n.d(t,{Z:()=>dt});var r=n(7294),a=n(6010),o=n(4763),i=n(1944),l=n(7462),s=n(6550),c=n(5999),u=n(5936);const d="docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,s.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,u.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,c.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function h(e){const t=e.children??m,{containerRef:n,onClick:a}=f();return r.createElement("div",{ref:n,role:"region","aria-label":m},r.createElement("a",(0,l.Z)({},e,{href:`#${d}`,onClick:a}),t))}var g=n(5281),b=n(9727);const v="skipToContent_fXgn";function y(){return r.createElement(h,{className:v})}var w=n(6668),k=n(9689);function S(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:o=1.2,className:i,...s}=e;return r.createElement("svg",(0,l.Z)({viewBox:"0 0 15 15",width:t,height:n},s),r.createElement("g",{stroke:a,strokeWidth:o},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const E="closeButton_CVFx";function x(e){return r.createElement("button",(0,l.Z)({type:"button","aria-label":(0,c.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},e,{className:(0,a.Z)("clean-btn close",E,e.className)}),r.createElement(S,{width:14,height:14,strokeWidth:3.1}))}const _="content_knG7";function R(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return r.createElement("div",(0,l.Z)({},e,{className:(0,a.Z)(_,e.className),dangerouslySetInnerHTML:{__html:n}}))}const C="announcementBar_mb4j",T="announcementBarPlaceholder_vyr4",O="announcementBarClose_gvF7",P="announcementBarContent_xLdY";function A(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,k.nT)();if(!t)return null;const{backgroundColor:a,textColor:o,isCloseable:i}=e;return r.createElement("div",{className:C,style:{backgroundColor:a,color:o},role:"banner"},i&&r.createElement("div",{className:T}),r.createElement(R,{className:P}),i&&r.createElement(x,{onClick:n,className:O}))}var j=n(2961),L=n(2466);var N=n(902),I=n(3102);const M=r.createContext(null);function D(e){let{children:t}=e;const n=function(){const e=(0,j.e)(),t=(0,I.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,N.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return r.createElement(M.Provider,{value:n},t)}function F(e){if(e.component){const t=e.component;return r.createElement(t,e.props)}}function B(){const e=(0,r.useContext)(M);if(!e)throw new N.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,I.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:F(o)})),[a,o,t])}function z(e){let{header:t,primaryMenu:n,secondaryMenu:o}=e;const{shown:i}=B();return r.createElement("div",{className:"navbar-sidebar"},t,r.createElement("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i})},r.createElement("div",{className:"navbar-sidebar__item menu"},n),r.createElement("div",{className:"navbar-sidebar__item menu"},o)))}var U=n(2949),$=n(2389);function G(e){return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function H(e){return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}const V={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function q(e){let{className:t,value:n,onChange:o}=e;const i=(0,$.Z)(),l=(0,c.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===n?(0,c.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,c.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return r.createElement("div",{className:(0,a.Z)(V.toggle,t)},r.createElement("button",{className:(0,a.Z)("clean-btn",V.toggleButton,!i&&V.toggleButtonDisabled),type:"button",onClick:()=>o("dark"===n?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite"},r.createElement(G,{className:(0,a.Z)(V.toggleIcon,V.lightToggleIcon)}),r.createElement(H,{className:(0,a.Z)(V.toggleIcon,V.darkToggleIcon)})))}const Z=r.memo(q);function W(e){let{className:t}=e;const n=(0,w.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,U.I)();return n?null:r.createElement(Z,{className:t,value:a,onChange:o})}var Y=n(1327);function K(){return r.createElement(Y.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,j.e)();return r.createElement("button",{type:"button","aria-label":(0,c.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle()},r.createElement(S,{color:"var(--ifm-color-emphasis-600)"}))}function X(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement(K,null),r.createElement(W,{className:"margin-right--md"}),r.createElement(Q,null))}var J=n(9960),ee=n(4996),te=n(3919);function ne(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var re=n(9471);function ae(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:o,label:i,html:s,isDropdownLink:c,prependBaseUrlToHref:u,...d}=e;const p=(0,ee.Z)(a),f=(0,ee.Z)(t),m=(0,ee.Z)(o,{forcePrependBaseUrl:!0}),h=i&&o&&!(0,te.Z)(o),g=s?{dangerouslySetInnerHTML:{__html:s}}:{children:r.createElement(r.Fragment,null,i,h&&r.createElement(re.Z,c&&{width:12,height:12}))};return o?r.createElement(J.Z,(0,l.Z)({href:u?m:o},d,g)):r.createElement(J.Z,(0,l.Z)({to:p,isNavLink:!0},(t||n)&&{isActive:(e,t)=>n?ne(n,t.pathname):t.pathname.startsWith(f)},d,g))}function oe(e){let{className:t,isDropdownItem:n=!1,...o}=e;const i=r.createElement(ae,(0,l.Z)({className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n},o));return n?r.createElement("li",null,i):i}function ie(e){let{className:t,isDropdownItem:n,...o}=e;return r.createElement("li",{className:"menu__list-item"},r.createElement(ae,(0,l.Z)({className:(0,a.Z)("menu__link",t)},o)))}function le(e){let{mobile:t=!1,position:n,...a}=e;const o=t?ie:oe;return r.createElement(o,(0,l.Z)({},a,{activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")}))}var se=n(6043),ce=n(8596),ue=n(2263);function de(e,t){return e.some((e=>function(e,t){return!!(0,ce.Mg)(e.to,t)||!!ne(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function pe(e){let{items:t,position:n,className:o,onClick:i,...s}=e;const c=(0,r.useRef)(null),[u,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{c.current&&!c.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e)}}),[c]),r.createElement("div",{ref:c,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":u})},r.createElement(ae,(0,l.Z)({"aria-haspopup":"true","aria-expanded":u,role:"button",href:s.to?void 0:"#",className:(0,a.Z)("navbar__link",o)},s,{onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!u))}}),s.children??s.label),r.createElement("ul",{className:"dropdown__menu"},t.map(((e,n)=>r.createElement(Re,(0,l.Z)({isDropdownItem:!0,onKeyDown:e=>{if(n===t.length-1&&"Tab"===e.key){e.preventDefault(),d(!1);const t=c.current.nextElementSibling;if(t){(t instanceof HTMLAnchorElement?t:t.querySelector("a")).focus()}}},activeClassName:"dropdown__link--active"},e,{key:n}))))))}function fe(e){let{items:t,className:n,position:o,onClick:i,...c}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,ue.Z)(),{pathname:t}=(0,s.TH)();return t.replace(e,"/")}(),d=de(t,u),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,se.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[u,d,m]),r.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p})},r.createElement(ae,(0,l.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",n)},c,{onClick:e=>{e.preventDefault(),f()}}),c.children??c.label),r.createElement(se.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p},t.map(((e,t)=>r.createElement(Re,(0,l.Z)({mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active"},e,{key:t}))))))}function me(e){let{mobile:t=!1,...n}=e;const a=t?fe:pe;return r.createElement(a,n)}var he=n(4711);function ge(e){let{width:t=20,height:n=20,...a}=e;return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0},a),r.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}const be="iconLanguage_nlXk";var ve=n(1875);const ye="searchBox_ZlJk";function we(e){let{children:t,className:n}=e;return r.createElement("div",{className:(0,a.Z)(n,ye)},t)}var ke=n(143),Se=n(2802);var Ee=n(373);const xe=e=>e.docs.find((t=>t.id===e.mainDocId));const _e={default:le,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,...o}=e;const{i18n:{currentLocale:i,locales:u,localeConfigs:d}}=(0,ue.Z)(),p=(0,he.l)(),{search:f,hash:m}=(0,s.TH)(),h=[...n,...u.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...a],g=t?(0,c.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return r.createElement(me,(0,l.Z)({},o,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(ge,{className:be}),g),items:h}))},search:function(e){let{mobile:t,className:n}=e;return t?null:r.createElement(we,{className:n},r.createElement(ve.Z,null))},dropdown:me,html:function(e){let{value:t,className:n,mobile:o=!1,isDropdownItem:i=!1}=e;const l=i?"li":"div";return r.createElement(l,{className:(0,a.Z)({navbar__item:!o&&!i,"menu__list-item":o},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,ke.Iw)(a),s=(0,Se.vY)(t,a);return null===s?null:r.createElement(le,(0,l.Z)({exact:!0},o,{isActive:()=>(null==i?void 0:i.path)===s.path||!(null==i||!i.sidebar)&&i.sidebar===s.sidebar,label:n??s.id,to:s.path}))},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,ke.Iw)(a),s=(0,Se.oz)(t,a).link;if(!s)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return r.createElement(le,(0,l.Z)({exact:!0},o,{isActive:()=>(null==i?void 0:i.sidebar)===t,label:n??s.label,to:s.path}))},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...o}=e;const i=(0,Se.lO)(a)[0],s=t??i.label,c=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return r.createElement(le,(0,l.Z)({},o,{label:s,to:c}))},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:o,dropdownItemsAfter:i,...u}=e;const{search:d,hash:p}=(0,s.TH)(),f=(0,ke.Iw)(n),m=(0,ke.gB)(n),{savePreferredVersionName:h}=(0,Ee.J)(n),g=[...o,...m.map((e=>{const t=f.alternateDocVersions[e.name]??xe(e);return{label:e.label,to:`${t.path}${d}${p}`,isActive:()=>e===f.activeVersion,onClick:()=>h(e.name)}})),...i],b=(0,Se.lO)(n)[0],v=t&&g.length>1?(0,c.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):b.label,y=t&&g.length>1?void 0:xe(b).path;return g.length<=1?r.createElement(le,(0,l.Z)({},u,{mobile:t,label:v,to:y,isActive:a?()=>!1:void 0})):r.createElement(me,(0,l.Z)({},u,{mobile:t,label:v,to:y,items:g,isActive:a?()=>!1:void 0}))}};function Re(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=_e[a];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return r.createElement(o,n)}function Ce(){const e=(0,j.e)(),t=(0,w.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map(((t,n)=>r.createElement(Re,(0,l.Z)({mobile:!0},t,{onClick:()=>e.toggle(),key:n})))))}function Te(e){return r.createElement("button",(0,l.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(c.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function Oe(){const e=0===(0,w.L)().navbar.items.length,t=B();return r.createElement(r.Fragment,null,!e&&r.createElement(Te,{onClick:()=>t.hide()}),t.content)}function Pe(){const e=(0,j.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?r.createElement(z,{header:r.createElement(X,null),primaryMenu:r.createElement(Ce,null),secondaryMenu:r.createElement(Oe,null)}):null}const Ae="navbarHideable_m1mJ",je="navbarHidden_jGov";function Le(e){return r.createElement("div",(0,l.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function Ne(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,j.e)(),{navbarRef:l,isNavbarVisible:s}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,L.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i<o.current)return void n(!0);if(a.current)return void(a.current=!1);const l=null==r?void 0:r.scrollY,s=document.documentElement.scrollHeight-o.current,c=window.innerHeight;l&&i>=l?n(!1):i+c<s&&n(!0)})),(0,u.S)((t=>{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return r.createElement("nav",{ref:l,className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Ae,!s&&je],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown})},t,r.createElement(Le,{onClick:i.toggle}),r.createElement(Pe,null))}function Ie(e){let{width:t=30,height:n=30,className:a,...o}=e;return r.createElement("svg",(0,l.Z)({className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true"},o),r.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))}function Me(){const{toggle:e,shown:t}=(0,j.e)();return r.createElement("button",{onClick:e,"aria-label":(0,c.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button"},r.createElement(Ie,null))}const De="colorModeToggle_DEke";function Fe(e){let{items:t}=e;return r.createElement(r.Fragment,null,t.map(((e,t)=>r.createElement(Re,(0,l.Z)({},e,{key:t})))))}function Be(e){let{left:t,right:n}=e;return r.createElement("div",{className:"navbar__inner"},r.createElement("div",{className:"navbar__items"},t),r.createElement("div",{className:"navbar__items navbar__items--right"},n))}function ze(){const e=(0,j.e)(),t=(0,w.L)().navbar.items,[n,a]=function(e){function t(e){return"left"===(e.position??"right")}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return r.createElement(Be,{left:r.createElement(r.Fragment,null,!e.disabled&&r.createElement(Me,null),r.createElement(K,null),r.createElement(Fe,{items:n})),right:r.createElement(r.Fragment,null,r.createElement(Fe,{items:a}),r.createElement(W,{className:De}),!o&&r.createElement(we,null,r.createElement(ve.Z,null)))})}function Ue(){return r.createElement(Ne,null,r.createElement(ze,null))}function $e(e){let{item:t}=e;const{to:n,href:a,label:o,prependBaseUrlToHref:i,...s}=t,c=(0,ee.Z)(n),u=(0,ee.Z)(a,{forcePrependBaseUrl:!0});return r.createElement(J.Z,(0,l.Z)({className:"footer__link-item"},a?{href:i?u:a}:{to:c},s),o,a&&!(0,te.Z)(a)&&r.createElement(re.Z,null))}function Ge(e){let{item:t}=e;return t.html?r.createElement("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement("li",{key:t.href??t.to,className:"footer__item"},r.createElement($e,{item:t}))}function He(e){let{column:t}=e;return r.createElement("div",{className:"col footer__col"},r.createElement("div",{className:"footer__title"},t.title),r.createElement("ul",{className:"footer__items clean-list"},t.items.map(((e,t)=>r.createElement(Ge,{key:t,item:e})))))}function Ve(e){let{columns:t}=e;return r.createElement("div",{className:"row footer__links"},t.map(((e,t)=>r.createElement(He,{key:t,column:e}))))}function qe(){return r.createElement("span",{className:"footer__link-separator"},"\xb7")}function Ze(e){let{item:t}=e;return t.html?r.createElement("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement($e,{item:t})}function We(e){let{links:t}=e;return r.createElement("div",{className:"footer__links text--center"},r.createElement("div",{className:"footer__links"},t.map(((e,n)=>r.createElement(r.Fragment,{key:n},r.createElement(Ze,{item:e}),t.length!==n+1&&r.createElement(qe,null))))))}function Ye(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?r.createElement(Ve,{columns:t}):r.createElement(We,{links:t})}var Ke=n(941);const Qe="footerLogoLink_BH7S";function Xe(e){let{logo:t}=e;const{withBaseUrl:n}=(0,ee.C)(),o={light:n(t.src),dark:n(t.srcDark??t.src)};return r.createElement(Ke.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:o,width:t.width,height:t.height,style:t.style})}function Je(e){let{logo:t}=e;return t.href?r.createElement(J.Z,{href:t.href,className:Qe,target:t.target},r.createElement(Xe,{logo:t})):r.createElement(Xe,{logo:t})}function et(e){let{copyright:t}=e;return r.createElement("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function tt(e){let{style:t,links:n,logo:o,copyright:i}=e;return r.createElement("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t})},r.createElement("div",{className:"container container-fluid"},n,(o||i)&&r.createElement("div",{className:"footer__bottom text--center"},o&&r.createElement("div",{className:"margin-bottom--sm"},o),i)))}function nt(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:a,style:o}=e;return r.createElement(tt,{style:o,links:n&&n.length>0&&r.createElement(Ye,{links:n}),logo:a&&r.createElement(Je,{logo:a}),copyright:t&&r.createElement(et,{copyright:t})})}const rt=r.memo(nt);var at=n(12);const ot="docusaurus.tab.",it=r.createContext(void 0);const lt=(0,N.Qc)([U.S,k.pl,function(e){let{children:t}=e;const n=function(){const[e,t]=(0,r.useState)({}),n=(0,r.useCallback)(((e,t)=>{(0,at.W)(`docusaurus.tab.${e}`).set(t)}),[]);(0,r.useEffect)((()=>{try{const e={};(0,at._)().forEach((t=>{if(t.startsWith(ot)){const n=t.substring(ot.length);e[n]=(0,at.W)(t).get()}})),t(e)}catch(e){console.error(e)}}),[]);const a=(0,r.useCallback)(((e,r)=>{t((t=>({...t,[e]:r}))),n(e,r)}),[n]);return(0,r.useMemo)((()=>({tabGroupChoices:e,setTabGroupChoices:a})),[e,a])}();return r.createElement(it.Provider,{value:n},t)},L.OC,Ee.L5,i.VC,function(e){let{children:t}=e;return r.createElement(I.n2,null,r.createElement(j.M,null,r.createElement(D,null,t)))}]);function st(e){let{children:t}=e;return r.createElement(lt,null,t)}function ct(e){let{error:t,tryAgain:n}=e;return r.createElement("main",{className:"container margin-vert--xl"},r.createElement("div",{className:"row"},r.createElement("div",{className:"col col--6 col--offset-3"},r.createElement("h1",{className:"hero__title"},r.createElement(c.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),r.createElement("p",null,t.message),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},r.createElement(c.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again when the page crashed"},"Try again"))))))}const ut="mainWrapper_z2l0";function dt(e){const{children:t,noFooter:n,wrapperClassName:l,title:s,description:c}=e;return(0,b.t)(),r.createElement(st,null,r.createElement(i.d,{title:s,description:c}),r.createElement(y,null),r.createElement(A,null),r.createElement(Ue,null),r.createElement("div",{id:d,className:(0,a.Z)(g.k.wrapper.main,ut,l)},r.createElement(o.Z,{fallback:e=>r.createElement(ct,e)},t)),!n&&r.createElement(rt,null))}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(7462),a=n(7294),o=n(9960),i=n(4996),l=n(2263),s=n(6668),c=n(941);function u(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,i.Z)(t.src),dark:(0,i.Z)(t.srcDark||t.src)},l=a.createElement(c.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?a.createElement("div",{className:r},l):l}function d(e){const{siteConfig:{title:t}}=(0,l.Z)(),{navbar:{title:n,logo:c}}=(0,s.L)(),{imageClassName:d,titleClassName:p,...f}=e,m=(0,i.Z)((null==c?void 0:c.href)||"/"),h=n?"":t,g=(null==c?void 0:c.alt)??h;return a.createElement(o.Z,(0,r.Z)({to:m},f,(null==c?void 0:c.target)&&{target:c.target}),c&&a.createElement(u,{logo:c,alt:g,imageClassName:d}),null!=n&&a.createElement("b",{className:p},n))}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(5742);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return r.createElement(a.Z,null,t&&r.createElement("meta",{name:"docusaurus_locale",content:t}),n&&r.createElement("meta",{name:"docusaurus_version",content:n}),o&&r.createElement("meta",{name:"docusaurus_tag",content:o}),i&&r.createElement("meta",{name:"docsearch:language",content:i}),n&&r.createElement("meta",{name:"docsearch:version",content:n}),o&&r.createElement("meta",{name:"docsearch:docusaurus_tag",content:o}))}},941:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c});var r=n(7462),a=n(7294),o=n(6010),i=n(2389),l=n(2949);const s={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function c(e){const t=(0,i.Z)(),{colorMode:n}=(0,l.I)(),{sources:c,className:u,alt:d,...p}=e,f=t?"dark"===n?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,f.map((e=>a.createElement("img",(0,r.Z)({key:e,src:c[e],alt:d,className:(0,o.Z)(s.themedImage,s[`themedImage--${e}`],u)},p)))))}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>i,z:()=>m});var r=n(7462),a=n(7294),o=n(412);function i(e){let{initialState:t}=e;const[n,r]=(0,a.useState)(t??!1),o=(0,a.useCallback)((()=>{r((e=>!e))}),[]);return{collapsed:n,setCollapsed:r,toggleCollapsed:o}}const l={display:"none",overflow:"hidden",height:"0px"},s={display:"block",overflow:"visible",height:"auto"};function c(e,t){const n=t?l:s;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function u(e){let{collapsibleRef:t,collapsed:n,animation:r}=e;const o=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,n=(null==r?void 0:r.duration)??function(e){const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${(null==r?void 0:r.easing)??"ease-in-out"}`,height:`${t}px`}}function i(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return c(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(i(),requestAnimationFrame((()=>{e.style.height=l.height,e.style.overflow=l.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{i()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,r])}function d(e){if(!o.Z.canUseDOM)return e?l:s}function p(e){let{as:t="div",collapsed:n,children:r,animation:o,onCollapseTransitionEnd:i,className:l,disableSSRStyle:s}=e;const p=(0,a.useRef)(null);return u({collapsibleRef:p,collapsed:n,animation:o}),a.createElement(t,{ref:p,style:s?void 0:d(n),onTransitionEnd:e=>{"height"===e.propertyName&&(c(p.current,n),null==i||i(n))},className:l},r)}function f(e){let{collapsed:t,...n}=e;const[o,i]=(0,a.useState)(!t),[l,s]=(0,a.useState)(t);return(0,a.useLayoutEffect)((()=>{t||i(!0)}),[t]),(0,a.useLayoutEffect)((()=>{o&&s(t)}),[o,t]),o?a.createElement(p,(0,r.Z)({},n,{collapsed:l})):null}function m(e){let{lazy:t,...n}=e;const r=t?f:p;return a.createElement(r,n)}},9689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>m,pl:()=>f});var r=n(7294),a=n(2389),o=n(12),i=n(902),l=n(6668);const s=(0,o.W)("docusaurus.announcement.dismiss"),c=(0,o.W)("docusaurus.announcement.id"),u=()=>"true"===s.get(),d=e=>s.set(String(e)),p=r.createContext(null);function f(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&u()));(0,r.useEffect)((()=>{o(u())}),[]);const i=(0,r.useCallback)((()=>{d(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=c.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;c.set(t),r&&d(!1),!r&&u()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return r.createElement(p.Provider,{value:n},t)}function m(){const e=(0,r.useContext)(p);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},2949:(e,t,n)=>{"use strict";n.d(t,{I:()=>g,S:()=>h});var r=n(7294),a=n(412),o=n(902),i=n(12),l=n(6668);const s=r.createContext(void 0),c="theme",u=(0,i.W)(c),d="light",p="dark",f=e=>e===p?p:d;function m(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[o,i]=(0,r.useState)((e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e))(e));(0,r.useEffect)((()=>{t&&u.del()}),[t]);const s=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(i(t),a&&(e=>{u.set(f(e))})(t)):(i(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p:d:e),u.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==c)return;const t=u.get();null!==t&&s(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,s]);const m=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||m.current?m.current=window.matchMedia("print").matches:s(null)};return e.addListener(r),()=>e.removeListener(r)}),[s,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:s,get isDarkTheme(){return o===p},setLightTheme(){s(d)},setDarkTheme(){s(p)}})),[o,s])}function h(e){let{children:t}=e;const n=m();return r.createElement(s.Provider,{value:n},t)}function g(){const e=(0,r.useContext)(s);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:(e,t,n)=>{"use strict";n.d(t,{J:()=>y,L5:()=>b});var r=n(7294),a=n(143),o=n(9935),i=n(6668),l=n(2802),s=n(902),c=n(12);const u=e=>`docs-preferred-version-${e}`,d=(e,t,n)=>{(0,c.W)(u(e),{persistence:t}).set(n)},p=(e,t)=>(0,c.W)(u(e),{persistence:t}).get(),f=(e,t)=>{(0,c.W)(u(e),{persistence:t}).del()};const m=r.createContext(null);function h(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>(e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}]))))(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=p(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(f(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function g(e){let{children:t}=e;const n=h();return r.createElement(m.Provider,{value:n},t)}function b(e){let{children:t}=e;return l.cE?r.createElement(g,null,t):r.createElement(r.Fragment,null,t)}function v(){const e=(0,r.useContext)(m);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function y(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=v(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>s,b:()=>l});var r=n(7294),a=n(902);const o=Symbol("EmptyContext"),i=r.createContext(o);function l(e){let{children:t,name:n,items:a}=e;const o=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return r.createElement(i.Provider,{value:o},t)}function s(){const e=(0,r.useContext)(i);if(e===o)throw new a.i6("DocsSidebarProvider");return e}},2961:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(7294),a=n(3102),o=n(7524),i=n(6550),l=n(902);function s(e){!function(e){const t=(0,i.k6)(),n=(0,l.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}var c=n(6668);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,c.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[i,l]=(0,r.useState)(!1);s((()=>{if(i)return l(!1),!1}));const u=(0,r.useCallback)((()=>{l((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:i})),[e,n,u,i])}function p(e){let{children:t}=e;const n=d();return r.createElement(u.Provider,{value:n},t)}function f(){const e=r.useContext(u);if(void 0===e)throw new l.i6("NavbarMobileSidebarProvider");return e}},3102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>l,Zo:()=>s,n2:()=>i});var r=n(7294),a=n(902);const o=r.createContext(null);function i(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return r.createElement(o.Provider,{value:n},t)}function l(){const e=(0,r.useContext)(o);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function s(e){let{component:t,props:n}=e;const i=(0,r.useContext)(o);if(!i)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=i,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>c});var r=n(7294),a=n(412);const o="desktop",i="mobile",l="ssr";function s(){return a.Z.canUseDOM?window.innerWidth>996?o:i:l}function c(){const[e,t]=(0,r.useState)((()=>s()));return(0,r.useEffect)((()=>{function e(){t(s())}return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e),clearTimeout(undefined)}}),[]),e}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},2802:(e,t,n)=>{"use strict";n.d(t,{Wl:()=>p,_F:()=>m,cE:()=>d,hI:()=>w,lO:()=>b,vY:()=>y,oz:()=>v,s1:()=>g});var r=n(7294),a=n(6550),o=n(8790),i=n(143),l=n(373),s=n(1116);function c(e){return Array.from(new Set(e))}var u=n(8596);const d=!!i._r;function p(e){if(e.href)return e.href;for(const t of e.items){if("link"===t.type)return t.href;if("category"===t.type){const e=p(t);if(e)return e}}}const f=(e,t)=>void 0!==e&&(0,u.Mg)(e,t);function m(e,t){return"link"===e.type?f(e.href,t):"category"===e.type&&(f(e.href,t)||((e,t)=>e.some((e=>m(e,t))))(e.items,t))}function h(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,u.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,u.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function g(){var e;const t=(0,s.V)(),{pathname:n}=(0,a.TH)();return!1!==(null==(e=(0,i.gA)())?void 0:e.pluginData.breadcrumbs)&&t?h({sidebarItems:t.items,pathname:n}):null}function b(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>c([t,n,a].filter(Boolean))),[t,n,a])}function v(e,t){const n=b(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\n Available sidebar ids are:\n - ${Object.keys(t).join("\n- ")}`);return r[1]}),[e,n])}function y(e,t){const n=b(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`DocNavbarItem: couldn't find any doc with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${c(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function w(e){let{route:t,versionMetadata:n}=e;const r=(0,a.TH)(),i=t.routes,l=i.find((e=>(0,a.LX)(r.pathname,e)));if(!l)return null;const s=l.sidebar,c=s?n.docsSidebars[s]:void 0;return{docElement:(0,o.H)(i),sidebarName:s,sidebarItems:c}}},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>p,d:()=>u,VC:()=>f});var r=n(7294),a=n(6010),o=n(5742),i=n(226);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),c=n(2263);function u(e){let{title:t,description:n,keywords:a,image:i,children:l}=e;const u=function(e){const{siteConfig:t}=(0,c.Z)(),{title:n,titleDelimiter:r}=t;return null!=e&&e.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,s.C)(),p=i?d(i,{absolute:!0}):void 0;return r.createElement(o.Z,null,t&&r.createElement("title",null,u),t&&r.createElement("meta",{property:"og:title",content:u}),n&&r.createElement("meta",{name:"description",content:n}),n&&r.createElement("meta",{property:"og:description",content:n}),a&&r.createElement("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),p&&r.createElement("meta",{property:"og:image",content:p}),p&&r.createElement("meta",{name:"twitter:image",content:p}),l)}const d=r.createContext(void 0);function p(e){let{className:t,children:n}=e;const i=r.useContext(d),l=(0,a.Z)(i,t);return r.createElement(d.Provider,{value:l},r.createElement(o.Z,null,r.createElement("html",{className:l})),n)}function f(e){let{children:t}=e;const n=l(),o=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const i=`plugin-id-${n.plugin.id}`;return r.createElement(p,{className:(0,a.Z)(o,i)},t)}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>i,Qc:()=>c,Ql:()=>s,i6:()=>l,zX:()=>o});var r=n(7294);const a=n(412).Z.canUseDOM?r.useLayoutEffect:r.useEffect;function o(e){const t=(0,r.useRef)(e);return a((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function i(e){const t=(0,r.useRef)();return a((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){var n,r,a;super(),this.name="ReactContextError",this.message=`Hook ${(null==(n=this.stack)||null==(r=n.split("\n")[1])||null==(a=r.match(/at (?:\w+\.)?(?<name>\w+)/))?void 0:a.groups.name)??""} is called outside the <${e}>. ${t??""}`}}function s(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function c(e){return t=>{let{children:n}=t;return r.createElement(r.Fragment,null,e.reduceRight(((e,t)=>r.createElement(t,null,e)),n))}}},8596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(7294),a=n(723),o=n(2263);function i(e,t){const n=e=>{var t;return null==(t=!e||e.endsWith("/")?e:`${e}/`)?void 0:t.toLowerCase()};return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},2466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>p,OC:()=>s,RF:()=>d});var r=n(7294),a=n(412),o=n(2389),i=n(902);const l=r.createContext(void 0);function s(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return r.createElement(l.Provider,{value:n},t)}function c(){const e=(0,r.useContext)(l);if(null==e)throw new i.i6("ScrollControllerProvider");return e}const u=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function d(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=c(),a=(0,r.useRef)(u()),o=(0,i.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=u();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function p(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&a<e)&&(t=requestAnimationFrame(r),window.scrollTo(0,Math.floor(.85*(a-e))+e))}(),()=>t&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>null==e.current?void 0:e.current()}}},3320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);const r="default";function a(e,t){return`docs-${e}-${t}`}},12:(e,t,n)=>{"use strict";n.d(t,{W:()=>l,_:()=>s});const r="localStorage";function a(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,o||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),o=!0),null}var t}let o=!1;const i={get:()=>null,set:()=>{},del:()=>{}};function l(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t}}(e);const n=a(null==t?void 0:t.persistence);return null===n?i:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{n.setItem(e,t)}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{n.removeItem(e)}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}}}}function s(e){void 0===e&&(e=r);const t=a(e);if(!t)return[];const n=[];for(let r=0;r<t.length;r+=1){const e=t.key(r);null!==e&&n.push(e)}return n}},4711:(e,t,n)=>{"use strict";n.d(t,{l:()=>o});var r=n(2263),a=n(6550);function o(){const{siteConfig:{baseUrl:e,url:t},i18n:{defaultLocale:n,currentLocale:o}}=(0,r.Z)(),{pathname:i}=(0,a.TH)(),l=o===n?e:e.replace(`/${o}/`,"/"),s=i.replace(e,"");return{createUrl:function(e){let{locale:r,fullyQualified:a}=e;return`${a?t:""}${function(e){return e===n?`${l}`:`${l}${e}/`}(r)}${s}`}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6550),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(2263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},8780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="post-content";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}})},6010:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;t<e.length;t++)e[t]&&(n=r(e[t]))&&(a&&(a+=" "),a+=n);else for(t in e)e[t]&&(a&&(a+=" "),a+=t);return a}n.d(t,{Z:()=>a});const a=function(){for(var e,t,n=0,a="";n<arguments.length;)(e=arguments[n++])&&(t=r(e))&&(a&&(a+=" "),a+=t);return a}},9318:(e,t,n)=>{"use strict";n.d(t,{lX:()=>w,q_:()=>R,ob:()=>f,PP:()=>T,Ep:()=>p});var r=n(7462);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r<a;n+=1,r+=1)e[n]=e[r];e.pop()}const i=function(e,t){void 0===t&&(t="");var n,r=e&&e.split("/")||[],i=t&&t.split("/")||[],l=e&&a(e),s=t&&a(t),c=l||s;if(e&&a(e)?i=r:r.length&&(i.pop(),i=i.concat(r)),!i.length)return"/";if(i.length){var u=i[i.length-1];n="."===u||".."===u||""===u}else n=!1;for(var d=0,p=i.length;p>=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&a(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var l=n(8776);function s(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function f(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;r<e;r++)n[r]=arguments[r];t.forEach((function(e){return e.apply(void 0,n)}))}}}var h=!("undefined"==typeof window||!window.document||!window.document.createElement);function g(e,t){t(window.confirm(e))}var b="popstate",v="hashchange";function y(){try{return window.history.state||{}}catch(e){return{}}}function w(e){void 0===e&&(e={}),h||(0,l.Z)(!1);var t,n=window.history,a=(-1===(t=window.navigator.userAgent).indexOf("Android 2.")&&-1===t.indexOf("Android 4.0")||-1===t.indexOf("Mobile Safari")||-1!==t.indexOf("Chrome")||-1!==t.indexOf("Windows Phone"))&&window.history&&"pushState"in window.history,o=!(-1===window.navigator.userAgent.indexOf("Trident")),i=e,c=i.forceRefresh,w=void 0!==c&&c,k=i.getUserConfirmation,S=void 0===k?g:k,E=i.keyLength,x=void 0===E?6:E,_=e.basename?d(s(e.basename)):"";function R(e){var t=e||{},n=t.key,r=t.state,a=window.location,o=a.pathname+a.search+a.hash;return _&&(o=u(o,_)),f(o,r,n)}function C(){return Math.random().toString(36).substr(2,x)}var T=m();function O(e){(0,r.Z)(U,e),U.length=n.length,T.notifyListeners(U.location,U.action)}function P(e){(function(e){return void 0===e.state&&-1===navigator.userAgent.indexOf("CriOS")})(e)||L(R(e.state))}function A(){L(R(y()))}var j=!1;function L(e){if(j)j=!1,O();else{T.confirmTransitionTo(e,"POP",S,(function(t){t?O({action:"POP",location:e}):function(e){var t=U.location,n=I.indexOf(t.key);-1===n&&(n=0);var r=I.indexOf(e.key);-1===r&&(r=0);var a=n-r;a&&(j=!0,D(a))}(e)}))}}var N=R(y()),I=[N.key];function M(e){return _+p(e)}function D(e){n.go(e)}var F=0;function B(e){1===(F+=e)&&1===e?(window.addEventListener(b,P),o&&window.addEventListener(v,A)):0===F&&(window.removeEventListener(b,P),o&&window.removeEventListener(v,A))}var z=!1;var U={length:n.length,action:"POP",location:N,createHref:M,push:function(e,t){var r="PUSH",o=f(e,t,C(),U.location);T.confirmTransitionTo(o,r,S,(function(e){if(e){var t=M(o),i=o.key,l=o.state;if(a)if(n.pushState({key:i,state:l},null,t),w)window.location.href=t;else{var s=I.indexOf(U.location.key),c=I.slice(0,s+1);c.push(o.key),I=c,O({action:r,location:o})}else window.location.href=t}}))},replace:function(e,t){var r="REPLACE",o=f(e,t,C(),U.location);T.confirmTransitionTo(o,r,S,(function(e){if(e){var t=M(o),i=o.key,l=o.state;if(a)if(n.replaceState({key:i,state:l},null,t),w)window.location.replace(t);else{var s=I.indexOf(U.location.key);-1!==s&&(I[s]=o.key),O({action:r,location:o})}else window.location.replace(t)}}))},go:D,goBack:function(){D(-1)},goForward:function(){D(1)},block:function(e){void 0===e&&(e=!1);var t=T.setPrompt(e);return z||(B(1),z=!0),function(){return z&&(z=!1,B(-1)),t()}},listen:function(e){var t=T.appendListener(e);return B(1),function(){B(-1),t()}}};return U}var k="hashchange",S={hashbang:{encodePath:function(e){return"!"===e.charAt(0)?e:"!/"+c(e)},decodePath:function(e){return"!"===e.charAt(0)?e.substr(1):e}},noslash:{encodePath:c,decodePath:s},slash:{encodePath:s,decodePath:s}};function E(e){var t=e.indexOf("#");return-1===t?e:e.slice(0,t)}function x(){var e=window.location.href,t=e.indexOf("#");return-1===t?"":e.substring(t+1)}function _(e){window.location.replace(E(window.location.href)+"#"+e)}function R(e){void 0===e&&(e={}),h||(0,l.Z)(!1);var t=window.history,n=(window.navigator.userAgent.indexOf("Firefox"),e),a=n.getUserConfirmation,o=void 0===a?g:a,i=n.hashType,c=void 0===i?"slash":i,b=e.basename?d(s(e.basename)):"",v=S[c],y=v.encodePath,w=v.decodePath;function R(){var e=w(x());return b&&(e=u(e,b)),f(e)}var C=m();function T(e){(0,r.Z)(z,e),z.length=t.length,C.notifyListeners(z.location,z.action)}var O=!1,P=null;function A(){var e,t,n=x(),r=y(n);if(n!==r)_(r);else{var a=R(),i=z.location;if(!O&&(t=a,(e=i).pathname===t.pathname&&e.search===t.search&&e.hash===t.hash))return;if(P===p(a))return;P=null,function(e){if(O)O=!1,T();else{var t="POP";C.confirmTransitionTo(e,t,o,(function(n){n?T({action:t,location:e}):function(e){var t=z.location,n=I.lastIndexOf(p(t));-1===n&&(n=0);var r=I.lastIndexOf(p(e));-1===r&&(r=0);var a=n-r;a&&(O=!0,M(a))}(e)}))}}(a)}}var j=x(),L=y(j);j!==L&&_(L);var N=R(),I=[p(N)];function M(e){t.go(e)}var D=0;function F(e){1===(D+=e)&&1===e?window.addEventListener(k,A):0===D&&window.removeEventListener(k,A)}var B=!1;var z={length:t.length,action:"POP",location:N,createHref:function(e){var t=document.querySelector("base"),n="";return t&&t.getAttribute("href")&&(n=E(window.location.href)),n+"#"+y(b+p(e))},push:function(e,t){var n="PUSH",r=f(e,void 0,void 0,z.location);C.confirmTransitionTo(r,n,o,(function(e){if(e){var t=p(r),a=y(b+t);if(x()!==a){P=t,function(e){window.location.hash=e}(a);var o=I.lastIndexOf(p(z.location)),i=I.slice(0,o+1);i.push(t),I=i,T({action:n,location:r})}else T()}}))},replace:function(e,t){var n="REPLACE",r=f(e,void 0,void 0,z.location);C.confirmTransitionTo(r,n,o,(function(e){if(e){var t=p(r),a=y(b+t);x()!==a&&(P=t,_(a));var o=I.indexOf(p(z.location));-1!==o&&(I[o]=t),T({action:n,location:r})}}))},go:M,goBack:function(){M(-1)},goForward:function(){M(1)},block:function(e){void 0===e&&(e=!1);var t=C.setPrompt(e);return B||(F(1),B=!0),function(){return B&&(B=!1,F(-1)),t()}},listen:function(e){var t=C.appendListener(e);return F(1),function(){F(-1),t()}}};return z}function C(e,t,n){return Math.min(Math.max(e,t),n)}function T(e){void 0===e&&(e={});var t=e,n=t.getUserConfirmation,a=t.initialEntries,o=void 0===a?["/"]:a,i=t.initialIndex,l=void 0===i?0:i,s=t.keyLength,c=void 0===s?6:s,u=m();function d(e){(0,r.Z)(w,e),w.length=w.entries.length,u.notifyListeners(w.location,w.action)}function h(){return Math.random().toString(36).substr(2,c)}var g=C(l,0,o.length-1),b=o.map((function(e){return f(e,void 0,"string"==typeof e?h():e.key||h())})),v=p;function y(e){var t=C(w.index+e,0,w.entries.length-1),r=w.entries[t];u.confirmTransitionTo(r,"POP",n,(function(e){e?d({action:"POP",location:r,index:t}):d()}))}var w={length:b.length,action:"POP",location:b[g],index:g,entries:b,createHref:v,push:function(e,t){var r="PUSH",a=f(e,t,h(),w.location);u.confirmTransitionTo(a,r,n,(function(e){if(e){var t=w.index+1,n=w.entries.slice(0);n.length>t?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=f(e,t,h(),w.location);u.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t<w.entries.length},block:function(e){return void 0===e&&(e=!1),u.setPrompt(e)},listen:function(e){return u.appendListener(e)}};return w}},8679:(e,t,n)=>{"use strict";var r=n(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=f(n);a&&a!==m&&e(t,a,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var l=s(t),h=s(n),g=0;g<i.length;++g){var b=i[g];if(!(o[b]||r&&r[b]||h&&h[b]||l&&l[b])){var v=p(n,b);try{c(t,b,v)}catch(y){}}}}return t}},1143:e=>{"use strict";e.exports=function(e,t,n,r,a,o,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,a,o,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},2497:(e,t,n)=>{"use strict";n.r(t)},2295:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>'};function a(e,t,n){return e<t?t:e>n?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),c=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),l=e?"-100":o(n.status||0),c=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},7418:e=>{"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;function a(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(a){return!1}}()?Object.assign:function(e,o){for(var i,l,s=a(e),c=1;c<arguments.length;c++){for(var u in i=Object(arguments[c]))n.call(i,u)&&(s[u]=i[u]);if(t){l=t(i);for(var d=0;d<l.length;d++)r.call(i,l[d])&&(s[l[d]]=i[l[d]])}}return s}},4779:(e,t,n)=>{var r=n(5826);e.exports=f,e.exports.parse=o,e.exports.compile=function(e,t){return l(o(e,t),t)},e.exports.tokensToFunction=l,e.exports.tokensToRegExp=p;var a=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function o(e,t){for(var n,r=[],o=0,i=0,l="",u=t&&t.delimiter||"/";null!=(n=a.exec(e));){var d=n[0],p=n[1],f=n.index;if(l+=e.slice(i,f),i=f+d.length,p)l+=p[1];else{var m=e[i],h=n[2],g=n[3],b=n[4],v=n[5],y=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=h&&null!=m&&m!==h,S="+"===y||"*"===y,E="?"===y||"*"===y,x=n[2]||u,_=b||v;r.push({name:g||o++,prefix:h||"",delimiter:x,optional:E,repeat:S,partial:k,asterisk:!!w,pattern:_?c(_):w?".*":"[^"+s(x)+"]+?"})}}return i<e.length&&(l+=e.substr(i)),l&&r.push(l),r}function i(e){return encodeURI(e).replace(/[\/?#]/g,(function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()}))}function l(e,t){for(var n=new Array(e.length),a=0;a<e.length;a++)"object"==typeof e[a]&&(n[a]=new RegExp("^(?:"+e[a].pattern+")$",d(t)));return function(t,a){for(var o="",l=t||{},s=(a||{}).pretty?i:encodeURIComponent,c=0;c<e.length;c++){var u=e[c];if("string"!=typeof u){var d,p=l[u.name];if(null==p){if(u.optional){u.partial&&(o+=u.prefix);continue}throw new TypeError('Expected "'+u.name+'" to be defined')}if(r(p)){if(!u.repeat)throw new TypeError('Expected "'+u.name+'" to not repeat, but received `'+JSON.stringify(p)+"`");if(0===p.length){if(u.optional)continue;throw new TypeError('Expected "'+u.name+'" to not be empty')}for(var f=0;f<p.length;f++){if(d=s(p[f]),!n[c].test(d))throw new TypeError('Expected all "'+u.name+'" to match "'+u.pattern+'", but received `'+JSON.stringify(d)+"`");o+=(0===f?u.prefix:u.delimiter)+d}}else{if(d=u.asterisk?encodeURI(p).replace(/[?#]/g,(function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()})):s(p),!n[c].test(d))throw new TypeError('Expected "'+u.name+'" to match "'+u.pattern+'", but received "'+d+'"');o+=u.prefix+d}}else o+=u}return o}}function s(e){return e.replace(/([.+*?=^!:${}()[\]|\/\\])/g,"\\$1")}function c(e){return e.replace(/([=!:$\/()])/g,"\\$1")}function u(e,t){return e.keys=t,e}function d(e){return e&&e.sensitive?"":"i"}function p(e,t,n){r(t)||(n=t||n,t=[]);for(var a=(n=n||{}).strict,o=!1!==n.end,i="",l=0;l<e.length;l++){var c=e[l];if("string"==typeof c)i+=s(c);else{var p=s(c.prefix),f="(?:"+c.pattern+")";t.push(c),c.repeat&&(f+="(?:"+p+f+")*"),i+=f=c.optional?c.partial?p+"("+f+")?":"(?:"+p+"("+f+"))?":p+"("+f+")"}}var m=s(n.delimiter||"/"),h=i.slice(-m.length)===m;return a||(i=(h?i.slice(0,-m.length):i)+"(?:"+m+"(?=$))?"),i+=o?"$":a&&h?"":"(?="+m+"|$)",u(new RegExp("^"+i,d(n)),t)}function f(e,t,n){return r(t)||(n=t||n,t=[]),n=n||{},e instanceof RegExp?function(e,t){var n=e.source.match(/\((?!\?)/g);if(n)for(var r=0;r<n.length;r++)t.push({name:r,prefix:null,delimiter:null,optional:!1,repeat:!1,partial:!1,asterisk:!1,pattern:null});return u(e,t)}(e,t):r(e)?function(e,t,n){for(var r=[],a=0;a<e.length;a++)r.push(f(e[a],t,n).source);return u(new RegExp("(?:"+r.join("|")+")",d(n)),t)}(e,t,n):function(e,t,n){return p(o(e,n),t,n)}(e,t,n)}},7410:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,n={},r={util:{encode:function e(t){return t instanceof a?new a(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/</g,"<").replace(/\u00a0/g," ")},type:function(e){return Object.prototype.toString.call(e).slice(8,-1)},objId:function(e){return e.__id||Object.defineProperty(e,"__id",{value:++t}),e.__id},clone:function e(t,n){var a,o;switch(n=n||{},r.util.type(t)){case"Object":if(o=r.util.objId(t),n[o])return n[o];for(var i in a={},n[o]=a,t)t.hasOwnProperty(i)&&(a[i]=e(t[i],n));return a;case"Array":return o=r.util.objId(t),n[o]?n[o]:(a=[],n[o]=a,t.forEach((function(t,r){a[r]=e(t,n)})),a);default:return t}},getLanguage:function(t){for(;t;){var n=e.exec(t.className);if(n)return n[1].toLowerCase();t=t.parentElement}return"none"},setLanguage:function(t,n){t.className=t.className.replace(RegExp(e,"gi"),""),t.classList.add("language-"+n)},isActive:function(e,t,n){for(var r="no-"+t;e;){var a=e.classList;if(a.contains(t))return!0;if(a.contains(r))return!1;e=e.parentElement}return!!n}},languages:{plain:n,plaintext:n,text:n,txt:n,extend:function(e,t){var n=r.util.clone(r.languages[e]);for(var a in t)n[a]=t[a];return n},insertBefore:function(e,t,n,a){var o=(a=a||r.languages)[e],i={};for(var l in o)if(o.hasOwnProperty(l)){if(l==t)for(var s in n)n.hasOwnProperty(s)&&(i[s]=n[s]);n.hasOwnProperty(l)||(i[l]=o[l])}var c=a[e];return a[e]=i,r.languages.DFS(r.languages,(function(t,n){n===c&&t!=e&&(this[t]=i)})),i},DFS:function e(t,n,a,o){o=o||{};var i=r.util.objId;for(var l in t)if(t.hasOwnProperty(l)){n.call(t,l,t[l],a||l);var s=t[l],c=r.util.type(s);"Object"!==c||o[i(s)]?"Array"!==c||o[i(s)]||(o[i(s)]=!0,e(s,n,l,o)):(o[i(s)]=!0,e(s,n,null,o))}}},plugins:{},highlight:function(e,t,n){var o={code:e,grammar:t,language:n};return r.hooks.run("before-tokenize",o),o.tokens=r.tokenize(o.code,o.grammar),r.hooks.run("after-tokenize",o),a.stringify(r.util.encode(o.tokens),o.language)},tokenize:function(e,t){var n=t.rest;if(n){for(var r in n)t[r]=n[r];delete t.rest}var a=new l;return s(a,a.head,e),i(e,a,t,a.head,0),function(e){var t=[],n=e.head.next;for(;n!==e.tail;)t.push(n.value),n=n.next;return t}(a)},hooks:{all:{},add:function(e,t){var n=r.hooks.all;n[e]=n[e]||[],n[e].push(t)},run:function(e,t){var n=r.hooks.all[e];if(n&&n.length)for(var a,o=0;a=n[o++];)a(t)}},Token:a};function a(e,t,n,r){this.type=e,this.content=t,this.alias=n,this.length=0|(r||"").length}function o(e,t,n,r){e.lastIndex=t;var a=e.exec(n);if(a&&r&&a[1]){var o=a[1].length;a.index+=o,a[0]=a[0].slice(o)}return a}function i(e,t,n,l,u,d){for(var p in n)if(n.hasOwnProperty(p)&&n[p]){var f=n[p];f=Array.isArray(f)?f:[f];for(var m=0;m<f.length;++m){if(d&&d.cause==p+","+m)return;var h=f[m],g=h.inside,b=!!h.lookbehind,v=!!h.greedy,y=h.alias;if(v&&!h.pattern.global){var w=h.pattern.toString().match(/[imsuy]*$/)[0];h.pattern=RegExp(h.pattern.source,w+"g")}for(var k=h.pattern||h,S=l.next,E=u;S!==t.tail&&!(d&&E>=d.reach);E+=S.value.length,S=S.next){var x=S.value;if(t.length>e.length)return;if(!(x instanceof a)){var _,R=1;if(v){if(!(_=o(k,E,e,b))||_.index>=e.length)break;var C=_.index,T=_.index+_[0].length,O=E;for(O+=S.value.length;C>=O;)O+=(S=S.next).value.length;if(E=O-=S.value.length,S.value instanceof a)continue;for(var P=S;P!==t.tail&&(O<T||"string"==typeof P.value);P=P.next)R++,O+=P.value.length;R--,x=e.slice(E,O),_.index-=E}else if(!(_=o(k,0,x,b)))continue;C=_.index;var A=_[0],j=x.slice(0,C),L=x.slice(C+A.length),N=E+x.length;d&&N>d.reach&&(d.reach=N);var I=S.prev;if(j&&(I=s(t,I,j),E+=j.length),c(t,I,R),S=s(t,I,new a(p,g?r.tokenize(A,g):A,y,A)),L&&s(t,S,L),R>1){var M={cause:p+","+m,reach:N};i(e,t,n,S.prev,E,M),d&&M.reach>d.reach&&(d.reach=M.reach)}}}}}}function l(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function s(e,t,n){var r=t.next,a={value:n,prev:t,next:r};return t.next=a,r.prev=a,e.length++,a}function c(e,t,n){for(var r=t.next,a=0;a<n&&r!==e.tail;a++)r=r.next;t.next=r,r.prev=t,e.length-=a}return a.stringify=function e(t,n){if("string"==typeof t)return t;if(Array.isArray(t)){var a="";return t.forEach((function(t){a+=e(t,n)})),a}var o={type:t.type,content:e(t.content,n),tag:"span",classes:["token",t.type],attributes:{},language:n},i=t.alias;i&&(Array.isArray(i)?Array.prototype.push.apply(o.classes,i):o.classes.push(i)),r.hooks.run("wrap",o);var l="";for(var s in o.attributes)l+=" "+s+'="'+(o.attributes[s]||"").replace(/"/g,""")+'"';return"<"+o.tag+' class="'+o.classes.join(" ")+'"'+l+">"+o.content+"</"+o.tag+">"},r}(),a=r;r.default=r,a.languages.markup={comment:{pattern:/<!--(?:(?!<!--)[\s\S])*?-->/,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/<!DOCTYPE(?:[^>"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|<!--(?:[^-]|-(?!->))*-->)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^<!|>$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},a.languages.markup.tag.inside["attr-value"].inside.entity=a.languages.markup.entity,a.languages.markup.doctype.inside["internal-subset"].inside=a.languages.markup,a.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(a.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^<!\[CDATA\[)[\s\S]+?(?=\]\]>$)/i,lookbehind:!0,inside:a.languages[t]},n.cdata=/^<!\[CDATA\[|\]\]>$/i;var r={"included-cdata":{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:a.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[^>]*>)(?:<!\[CDATA\[(?:[^\]]|\](?!\]>))*\]\]>|(?!<!\[CDATA\[)[\s\S])*?(?=<\/__>)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},a.languages.insertBefore("markup","cdata",o)}}),Object.defineProperty(a.languages.markup.tag,"addAttribute",{value:function(e,t){a.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:a.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),a.languages.html=a.languages.markup,a.languages.mathml=a.languages.markup,a.languages.svg=a.languages.markup,a.languages.xml=a.languages.extend("markup",{}),a.languages.ssml=a.languages.xml,a.languages.atom=a.languages.xml,a.languages.rss=a.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=r.variable[1].inside,i=0;i<a.length;i++)o[a[i]]=e.languages.bash[a[i]];e.languages.shell=e.languages.bash}(a),a.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0,greedy:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|trait)\s+|\bcatch\s+\()[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:break|catch|continue|do|else|finally|for|function|if|in|instanceof|new|null|return|throw|try|while)\b/,boolean:/\b(?:false|true)\b/,function:/\b\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/[<>]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},a.languages.c=a.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),a.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),a.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},a.languages.c.string],char:a.languages.c.char,comment:a.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:a.languages.c}}}}),a.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete a.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!<keyword>)\w+(?:\s*\.\s*\w+)*\b/.source.replace(/<keyword>/g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!<keyword>)\w+/.source.replace(/<keyword>/g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/<mod-name>(?:\s*:\s*<mod-name>)?|:\s*<mod-name>/.source.replace(/<mod-name>/g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(a),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(a),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:a})}(a),a.languages.javascript=a.languages.extend("clike",{"class-name":[a.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),a.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,a.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:a.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:a.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:a.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:a.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:a.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),a.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:a.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),a.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),a.languages.markup&&(a.languages.markup.tag.addInlined("script","javascript"),a.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),a.languages.js=a.languages.javascript,function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(a),function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-]<PLAIN>)(?:[ \t]*(?:(?![#:])<PLAIN>|:<PLAIN>))*/.source.replace(/<PLAIN>/g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),o=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function i(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<<prop>>[ \t]+)?)(?:<<value>>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<<prop>>/g,(function(){return r})).replace(/<<value>>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<<prop>>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<<prop>>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<<prop>>[ \t]+)?)<<key>>(?=\s*:\s)/.source.replace(/<<prop>>/g,(function(){return r})).replace(/<<key>>/g,(function(){return"(?:"+a+"|"+o+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:i(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:i(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:i(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:i(o),lookbehind:!0,greedy:!0},number:{pattern:i(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(a),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function n(e){return e=e.replace(/<inner>/g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),o=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+o+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+o+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+o+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)<inner>|_(?:(?!_)<inner>)+_)+__\b|\*\*(?:(?!\*)<inner>|\*(?:(?!\*)<inner>)+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)<inner>|__(?:(?!_)<inner>)+__)+_\b|\*(?:(?!\*)<inner>|\*\*(?:(?!\*)<inner>)+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~)<inner>)+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:n(/!?\[(?:(?!\])<inner>)+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\])<inner>)+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n<r;n++){var a=t[n];if("code"===a.type){var o=a.content[1],i=a.content[3];if(o&&i&&"code-language"===o.type&&"code-block"===i.type&&"string"==typeof o.content){var l=o.content.replace(/\b#/g,"sharp").replace(/\b\+\+/g,"pp"),s="language-"+(l=(/[a-z][\w-]*/i.exec(l)||[""])[0].toLowerCase());i.alias?"string"==typeof i.alias?i.alias=[i.alias,s]:i.alias.push(s):i.alias=[s]}}else e(a.content)}}(e.tokens)})),e.hooks.add("wrap",(function(t){if("code-block"===t.type){for(var n="",r=0,a=t.classes.length;r<a;r++){var o=t.classes[r],c=/language-(.+)/.exec(o);if(c){n=c[1];break}}var u,d=e.languages[n];if(d)t.content=e.highlight((u=t.content,u.replace(i,"").replace(/&(\w{1,8}|#x?[\da-f]{1,8});/gi,(function(e,t){var n;if("#"===(t=t.toLowerCase())[0])return n="x"===t[1]?parseInt(t.slice(2),16):Number(t.slice(1)),s(n);var r=l[t];return r||e}))),d,n);else if(n&&"none"!==n&&e.plugins.autoloader){var p="md-"+(new Date).valueOf()+"-"+Math.floor(1e16*Math.random());t.attributes.id=p,e.plugins.autoloader.loadLanguages(n,(function(){var t=document.getElementById(p);t&&(t.innerHTML=e.highlight(t.textContent,e.languages[n],n))}))}}}));var i=RegExp(e.languages.markup.tag.pattern.source,"gi"),l={amp:"&",lt:"<",gt:">",quot:'"'},s=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(a),a.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:a.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},a.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),n=0;n<t.length;){var r=t[n++];if("keyword"===r.type&&"mutation"===r.content){var a=[];if(d(["definition-mutation","punctuation"])&&"("===u(1).content){n+=2;var o=p(/^\($/,/^\)$/);if(-1===o)continue;for(;n<o;n++){var i=u(0);"variable"===i.type&&(f(i,"variable-input"),a.push(i.content))}n=o+1}if(d(["punctuation","property-query"])&&"{"===u(0).content&&(n++,f(u(0),"property-mutation"),a.length>0)){var l=p(/^\{$/,/^\}$/);if(-1===l)continue;for(var s=n;s<l;s++){var c=t[s];"variable"===c.type&&a.indexOf(c.content)>=0&&f(c,"variable-input")}}}}function u(e){return t[n+e]}function d(e,t){t=t||0;for(var n=0;n<e.length;n++){var r=u(n+t);if(!r||r.type!==e[n])return!1}return!0}function p(e,r){for(var a=1,o=n;o<t.length;o++){var i=t[o],l=i.content;if("punctuation"===i.type&&"string"==typeof l)if(e.test(l))a++;else if(r.test(l)&&0===--a)return o}return-1}function f(e,t){var n=e.alias;n?Array.isArray(n)||(e.alias=n=[n]):e.alias=n=[],n.push(t)}})),a.languages.sql={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|(?:--|\/\/|#).*)/,lookbehind:!0},variable:[{pattern:/@(["'`])(?:\\[\s\S]|(?!\1)[^\\])+\1/,greedy:!0},/@[\w.$]+/],string:{pattern:/(^|[^@\\])("|')(?:\\[\s\S]|(?!\2)[^\\]|\2\2)*\2/,greedy:!0,lookbehind:!0},identifier:{pattern:/(^|[^@\\])`(?:\\[\s\S]|[^`\\]|``)*`/,greedy:!0,lookbehind:!0,inside:{punctuation:/^`|`$/}},function:/\b(?:AVG|COUNT|FIRST|FORMAT|LAST|LCASE|LEN|MAX|MID|MIN|MOD|NOW|ROUND|SUM|UCASE)(?=\s*\()/i,keyword:/\b(?:ACTION|ADD|AFTER|ALGORITHM|ALL|ALTER|ANALYZE|ANY|APPLY|AS|ASC|AUTHORIZATION|AUTO_INCREMENT|BACKUP|BDB|BEGIN|BERKELEYDB|BIGINT|BINARY|BIT|BLOB|BOOL|BOOLEAN|BREAK|BROWSE|BTREE|BULK|BY|CALL|CASCADED?|CASE|CHAIN|CHAR(?:ACTER|SET)?|CHECK(?:POINT)?|CLOSE|CLUSTERED|COALESCE|COLLATE|COLUMNS?|COMMENT|COMMIT(?:TED)?|COMPUTE|CONNECT|CONSISTENT|CONSTRAINT|CONTAINS(?:TABLE)?|CONTINUE|CONVERT|CREATE|CROSS|CURRENT(?:_DATE|_TIME|_TIMESTAMP|_USER)?|CURSOR|CYCLE|DATA(?:BASES?)?|DATE(?:TIME)?|DAY|DBCC|DEALLOCATE|DEC|DECIMAL|DECLARE|DEFAULT|DEFINER|DELAYED|DELETE|DELIMITERS?|DENY|DESC|DESCRIBE|DETERMINISTIC|DISABLE|DISCARD|DISK|DISTINCT|DISTINCTROW|DISTRIBUTED|DO|DOUBLE|DROP|DUMMY|DUMP(?:FILE)?|DUPLICATE|ELSE(?:IF)?|ENABLE|ENCLOSED|END|ENGINE|ENUM|ERRLVL|ERRORS|ESCAPED?|EXCEPT|EXEC(?:UTE)?|EXISTS|EXIT|EXPLAIN|EXTENDED|FETCH|FIELDS|FILE|FILLFACTOR|FIRST|FIXED|FLOAT|FOLLOWING|FOR(?: EACH ROW)?|FORCE|FOREIGN|FREETEXT(?:TABLE)?|FROM|FULL|FUNCTION|GEOMETRY(?:COLLECTION)?|GLOBAL|GOTO|GRANT|GROUP|HANDLER|HASH|HAVING|HOLDLOCK|HOUR|IDENTITY(?:COL|_INSERT)?|IF|IGNORE|IMPORT|INDEX|INFILE|INNER|INNODB|INOUT|INSERT|INT|INTEGER|INTERSECT|INTERVAL|INTO|INVOKER|ISOLATION|ITERATE|JOIN|KEYS?|KILL|LANGUAGE|LAST|LEAVE|LEFT|LEVEL|LIMIT|LINENO|LINES|LINESTRING|LOAD|LOCAL|LOCK|LONG(?:BLOB|TEXT)|LOOP|MATCH(?:ED)?|MEDIUM(?:BLOB|INT|TEXT)|MERGE|MIDDLEINT|MINUTE|MODE|MODIFIES|MODIFY|MONTH|MULTI(?:LINESTRING|POINT|POLYGON)|NATIONAL|NATURAL|NCHAR|NEXT|NO|NONCLUSTERED|NULLIF|NUMERIC|OFF?|OFFSETS?|ON|OPEN(?:DATASOURCE|QUERY|ROWSET)?|OPTIMIZE|OPTION(?:ALLY)?|ORDER|OUT(?:ER|FILE)?|OVER|PARTIAL|PARTITION|PERCENT|PIVOT|PLAN|POINT|POLYGON|PRECEDING|PRECISION|PREPARE|PREV|PRIMARY|PRINT|PRIVILEGES|PROC(?:EDURE)?|PUBLIC|PURGE|QUICK|RAISERROR|READS?|REAL|RECONFIGURE|REFERENCES|RELEASE|RENAME|REPEAT(?:ABLE)?|REPLACE|REPLICATION|REQUIRE|RESIGNAL|RESTORE|RESTRICT|RETURN(?:ING|S)?|REVOKE|RIGHT|ROLLBACK|ROUTINE|ROW(?:COUNT|GUIDCOL|S)?|RTREE|RULE|SAVE(?:POINT)?|SCHEMA|SECOND|SELECT|SERIAL(?:IZABLE)?|SESSION(?:_USER)?|SET(?:USER)?|SHARE|SHOW|SHUTDOWN|SIMPLE|SMALLINT|SNAPSHOT|SOME|SONAME|SQL|START(?:ING)?|STATISTICS|STATUS|STRIPED|SYSTEM_USER|TABLES?|TABLESPACE|TEMP(?:ORARY|TABLE)?|TERMINATED|TEXT(?:SIZE)?|THEN|TIME(?:STAMP)?|TINY(?:BLOB|INT|TEXT)|TOP?|TRAN(?:SACTIONS?)?|TRIGGER|TRUNCATE|TSEQUAL|TYPES?|UNBOUNDED|UNCOMMITTED|UNDEFINED|UNION|UNIQUE|UNLOCK|UNPIVOT|UNSIGNED|UPDATE(?:TEXT)?|USAGE|USE|USER|USING|VALUES?|VAR(?:BINARY|CHAR|CHARACTER|YING)|VIEW|WAITFOR|WARNINGS|WHEN|WHERE|WHILE|WITH(?: ROLLUP|IN)?|WORK|WRITE(?:TEXT)?|YEAR)\b/i,boolean:/\b(?:FALSE|NULL|TRUE)\b/i,number:/\b0x[\da-f]+\b|\b\d+(?:\.\d*)?|\B\.\d+\b/i,operator:/[-+*\/=%^~]|&&?|\|\|?|!=?|<(?:=>?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],n=t.pattern.source,r=t.inside.interpolation,a=r.inside["interpolation-punctuation"],o=r.pattern.source;function i(t,r){if(e.languages[t])return{pattern:RegExp("((?:"+r+")\\s*)"+n),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function l(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function s(t,n,r){var a={code:t,grammar:n,language:r};return e.hooks.run("before-tokenize",a),a.tokens=e.tokenize(a.code,a.grammar),e.hooks.run("after-tokenize",a),a.tokens}function c(t){var n={};n["interpolation-punctuation"]=a;var o=e.tokenize(t,n);if(3===o.length){var i=[1,1];i.push.apply(i,s(o[1],e.languages.javascript,"javascript")),o.splice.apply(o,i)}return new e.Token("interpolation",o,r.alias,t)}function u(t,n,r){var a=e.tokenize(t,{interpolation:{pattern:RegExp(o),lookbehind:!0}}),i=0,u={},d=s(a.map((function(e){if("string"==typeof e)return e;for(var n,a=e.content;-1!==t.indexOf(n=l(i++,r)););return u[n]=a,n})).join(""),n,r),p=Object.keys(u);return i=0,function e(t){for(var n=0;n<t.length;n++){if(i>=p.length)return;var r=t[n];if("string"==typeof r||"string"==typeof r.content){var a=p[i],o="string"==typeof r?r:r.content,l=o.indexOf(a);if(-1!==l){++i;var s=o.substring(0,l),d=c(u[a]),f=o.substring(l+a.length),m=[];if(s&&m.push(s),m.push(d),f){var h=[f];e(h),m.push.apply(m,h)}"string"==typeof r?(t.splice.apply(t,[n,1].concat(m)),n+=m.length-1):r.content=m}}else{var g=r.content;Array.isArray(g)?e(g):e([g])}}}(d),new e.Token(r,d,"language-"+r,t)}e.languages.javascript["template-string"]=[i("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),i("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),i("svg",/\bsvg/.source),i("markdown",/\b(?:markdown|md)/.source),i("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),i("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function p(e){return"string"==typeof e?e:Array.isArray(e)?e.map(p).join(""):p(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(n){for(var r=0,a=n.length;r<a;r++){var o=n[r];if("string"!=typeof o){var i=o.content;if(Array.isArray(i))if("template-string"===o.type){var l=i[1];if(3===i.length&&"string"!=typeof l&&"embedded-code"===l.type){var s=p(l),c=l.alias,d=Array.isArray(c)?c[0]:c,f=e.languages[d];if(!f)continue;i[1]=u(s,f,d)}}else t(i);else"string"!=typeof i&&t([i])}}}(t.tokens)}))}(a),function(e){e.languages.typescript=e.languages.extend("javascript",{"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|type)\s+)(?!keyof\b)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?:\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(a),function(e){function t(e,t){return RegExp(e.replace(/<ID>/g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:<ID>(?:\s*,\s*(?:\*\s*as\s+<ID>|\{[^{}]*\}))?|\*\s*as\s+<ID>|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+<ID>)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?<ID>/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r<n.length;r++){var a=n[r],o=e.languages.javascript[a];"RegExp"===e.util.type(o)&&(o=e.languages.javascript[a]={pattern:o});var i=o.inside||{};o.inside=i,i["maybe-class-name"]=/^[A-Z][\s\S]*/}}(a),function(e){var t=e.util.clone(e.languages.javascript),n=/(?:\s|\/\/.*(?!.)|\/\*(?:[^*]|\*(?!\/))\*\/)/.source,r=/(?:\{(?:\{(?:\{[^{}]*\}|[^{}])*\}|[^{}])*\})/.source,a=/(?:\{<S>*\.{3}(?:[^{}]|<BRACES>)*\})/.source;function o(e,t){return e=e.replace(/<S>/g,(function(){return n})).replace(/<BRACES>/g,(function(){return r})).replace(/<SPREAD>/g,(function(){return a})),RegExp(e,t)}a=o(a).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=o(/<\/?(?:[\w.:-]+(?:<S>+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|<BRACES>))?|<SPREAD>))*<S>*\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:o(/<SPREAD>/.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:o(/=<BRACES>/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var i=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(i).join(""):""},l=function(t){for(var n=[],r=0;r<t.length;r++){var a=t[r],o=!1;if("string"!=typeof a&&("tag"===a.type&&a.content[0]&&"tag"===a.content[0].type?"</"===a.content[0].content[0].content?n.length>0&&n[n.length-1].tagName===i(a.content[0].content[1])&&n.pop():"/>"===a.content[a.content.length-1].content||n.push({tagName:i(a.content[0].content[1]),openedBraces:0}):n.length>0&&"punctuation"===a.type&&"{"===a.content?n[n.length-1].openedBraces++:n.length>0&&n[n.length-1].openedBraces>0&&"punctuation"===a.type&&"}"===a.content?n[n.length-1].openedBraces--:o=!0),(o||"string"==typeof a)&&n.length>0&&0===n[n.length-1].openedBraces){var s=i(a);r<t.length-1&&("string"==typeof t[r+1]||"plain-text"===t[r+1].type)&&(s+=i(t[r+1]),t.splice(r+1,1)),r>0&&("string"==typeof t[r-1]||"plain-text"===t[r-1].type)&&(s=i(t[r-1])+s,t.splice(r-1,1),r--),t[r]=new e.Token("plain-text",s,null,s)}a.content&&"string"!=typeof a.content&&l(a.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||l(e.tokens)}))}(a),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],a=[];/^\w+$/.test(n)||a.push(/\w+/.exec(n)[0]),"diff"===n&&a.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(a),a.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},a.languages.go=a.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),a.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete a.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,l=i.length;-1!==n.code.indexOf(a=t(r,l));)++l;return i[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(l){for(var s=0;s<l.length&&!(a>=o.length);s++){var c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=o[a],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++a;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=p.substring(m+f.length),v=[];h&&v.push.apply(v,i([h])),v.push(g),b&&v.push.apply(v,i([b])),"string"==typeof c?l.splice.apply(l,[s,1].concat(v)):c.content=v}}else c.content&&i(c.content)}return l}(n.tokens)}}}})}(a),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(a),a.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},a.languages.webmanifest=a.languages.json,a.languages.less=a.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),a.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),a.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},a.languages.objectivec=a.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<<?=?|>>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete a.languages.objectivec["class-name"],a.languages.objc=a.languages.objectivec,a.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},a.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},a.languages.python["string-interpolation"].inside.interpolation.inside.rest=a.languages.python,a.languages.py=a.languages.python,a.languages.reason=a.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),a.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete a.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(a),a.languages.scss=a.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),a.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),a.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),a.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),a.languages.scss.atrule.inside.rest=a.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(a),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(a),a.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/};const o=a},9901:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to <a href="https://webplatform.github.io/docs/">WebPlatform.org documentation</a>. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (<code>.comment</code> can become <code>.namespace--comment</code>) or replace them with your defined ones (like <code>.editor__comment</code>). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the <code>highlightAll</code> and <code>highlightAllUnder</code> methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),a=n(9642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),o.add(e)}))}i.silent=!1,e.exports=i},6726:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6726},6500:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6500},9642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n<r;n++)t[e[n]]=!0;return t}function r(e){var n={},r=[];function a(r,o){if(!(r in n)){o.push(r);var i=o.indexOf(r);if(i<o.length-1)throw new Error("Circular dependency: "+o.slice(i).join(" -> "));var l={},s=e[r];if(s){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in a(t,o),l[t]=!0,n[t])l[i]=!0}t(s.require,c),t(s.optional,c),t(s.modify,c)}n[r]=l,o.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(o,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var o=r[a];t[a]="string"==typeof o?{title:o}:o}}return t}(o),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var o=e[a];t(o&&o.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);i=i.map(c),l=(l||[]).map(c);var u=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(s),m=u;a(m);){for(var h in p={},m){var g=s[h];t(g&&g.modify,(function(e){e in d&&(p[e]=!0)}))}for(var b in d)if(!(b in u))for(var v in f(b))if(v in u){p[b]=!0;break}for(var y in m=p)u[y]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var o=a?a.series:void 0,i=a?a.parallel:e,l={},s={};function c(e){if(e in l)return l[e];s[e]=!0;var a,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)a=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var u in n)c(u);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(7418),o=n(3840);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n<arguments.length;n++)t+="&args[]="+encodeURIComponent(arguments[n]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}if(!r)throw Error(i(227));var l=new Set,s={};function c(e,t){u(e,t),u(e+"Capture",t)}function u(e,t){for(s[e]=t,e=0;e<t.length;e++)l.add(t[e])}var d=!("undefined"==typeof window||void 0===window.document||void 0===window.document.createElement),p=/^[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$/,f=Object.prototype.hasOwnProperty,m={},h={};function g(e,t,n,r,a,o,i){this.acceptsBooleans=2===t||3===t||4===t,this.attributeName=r,this.attributeNamespace=a,this.mustUseProperty=n,this.propertyName=e,this.type=t,this.sanitizeURL=o,this.removeEmptyString=i}var b={};"children dangerouslySetInnerHTML defaultValue defaultChecked innerHTML suppressContentEditableWarning suppressHydrationWarning style".split(" ").forEach((function(e){b[e]=new g(e,0,!1,e,null,!1,!1)})),[["acceptCharset","accept-charset"],["className","class"],["htmlFor","for"],["httpEquiv","http-equiv"]].forEach((function(e){var t=e[0];b[t]=new g(t,1,!1,e[1],null,!1,!1)})),["contentEditable","draggable","spellCheck","value"].forEach((function(e){b[e]=new g(e,2,!1,e.toLowerCase(),null,!1,!1)})),["autoReverse","externalResourcesRequired","focusable","preserveAlpha"].forEach((function(e){b[e]=new g(e,2,!1,e,null,!1,!1)})),"allowFullScreen async autoFocus autoPlay controls default defer disabled disablePictureInPicture disableRemotePlayback formNoValidate hidden loop noModule noValidate open playsInline readOnly required reversed scoped seamless itemScope".split(" ").forEach((function(e){b[e]=new g(e,3,!1,e.toLowerCase(),null,!1,!1)})),["checked","multiple","muted","selected"].forEach((function(e){b[e]=new g(e,3,!0,e,null,!1,!1)})),["capture","download"].forEach((function(e){b[e]=new g(e,4,!1,e,null,!1,!1)})),["cols","rows","size","span"].forEach((function(e){b[e]=new g(e,6,!1,e,null,!1,!1)})),["rowSpan","start"].forEach((function(e){b[e]=new g(e,5,!1,e.toLowerCase(),null,!1,!1)}));var v=/[\-:]([a-z])/g;function y(e){return e[1].toUpperCase()}function w(e,t,n,r){var a=b.hasOwnProperty(t)?b[t]:null;(null!==a?0===a.type:!r&&(2<t.length&&("o"===t[0]||"O"===t[0])&&("n"===t[1]||"N"===t[1])))||(function(e,t,n,r){if(null==t||function(e,t,n,r){if(null!==n&&0===n.type)return!1;switch(typeof t){case"function":case"symbol":return!0;case"boolean":return!r&&(null!==n?!n.acceptsBooleans:"data-"!==(e=e.toLowerCase().slice(0,5))&&"aria-"!==e);default:return!1}}(e,t,n,r))return!0;if(r)return!1;if(null!==n)switch(n.type){case 3:return!t;case 4:return!1===t;case 5:return isNaN(t);case 6:return isNaN(t)||1>t}return!1}(t,n,a,r)&&(n=null),r||null===a?function(e){return!!f.call(h,e)||!f.call(m,e)&&(p.test(e)?h[e]=!0:(m[e]=!0,!1))}(t)&&(null===n?e.removeAttribute(t):e.setAttribute(t,""+n)):a.mustUseProperty?e[a.propertyName]=null===n?3!==a.type&&"":n:(t=a.attributeName,r=a.attributeNamespace,null===n?e.removeAttribute(t):(n=3===(a=a.type)||4===a&&!0===n?"":""+n,r?e.setAttributeNS(r,t,n):e.setAttribute(t,n))))}"accent-height alignment-baseline arabic-form baseline-shift cap-height clip-path clip-rule color-interpolation color-interpolation-filters color-profile color-rendering dominant-baseline enable-background fill-opacity fill-rule flood-color flood-opacity font-family font-size font-size-adjust font-stretch font-style font-variant font-weight glyph-name glyph-orientation-horizontal glyph-orientation-vertical horiz-adv-x horiz-origin-x image-rendering letter-spacing lighting-color marker-end marker-mid marker-start overline-position overline-thickness paint-order panose-1 pointer-events rendering-intent shape-rendering stop-color stop-opacity strikethrough-position strikethrough-thickness stroke-dasharray stroke-dashoffset stroke-linecap stroke-linejoin stroke-miterlimit stroke-opacity stroke-width text-anchor text-decoration text-rendering underline-position underline-thickness unicode-bidi unicode-range units-per-em v-alphabetic v-hanging v-ideographic v-mathematical vector-effect vert-adv-y vert-origin-x vert-origin-y word-spacing writing-mode xmlns:xlink x-height".split(" ").forEach((function(e){var t=e.replace(v,y);b[t]=new g(t,1,!1,e,null,!1,!1)})),"xlink:actuate xlink:arcrole xlink:role xlink:show xlink:title xlink:type".split(" ").forEach((function(e){var t=e.replace(v,y);b[t]=new g(t,1,!1,e,"http://www.w3.org/1999/xlink",!1,!1)})),["xml:base","xml:lang","xml:space"].forEach((function(e){var t=e.replace(v,y);b[t]=new g(t,1,!1,e,"http://www.w3.org/XML/1998/namespace",!1,!1)})),["tabIndex","crossOrigin"].forEach((function(e){b[e]=new g(e,1,!1,e.toLowerCase(),null,!1,!1)})),b.xlinkHref=new g("xlinkHref",1,!1,"xlink:href","http://www.w3.org/1999/xlink",!0,!1),["src","href","action","formAction"].forEach((function(e){b[e]=new g(e,1,!1,e.toLowerCase(),null,!0,!0)}));var k=r.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,S=60103,E=60106,x=60107,_=60108,R=60114,C=60109,T=60110,O=60112,P=60113,A=60120,j=60115,L=60116,N=60121,I=60128,M=60129,D=60130,F=60131;if("function"==typeof Symbol&&Symbol.for){var B=Symbol.for;S=B("react.element"),E=B("react.portal"),x=B("react.fragment"),_=B("react.strict_mode"),R=B("react.profiler"),C=B("react.provider"),T=B("react.context"),O=B("react.forward_ref"),P=B("react.suspense"),A=B("react.suspense_list"),j=B("react.memo"),L=B("react.lazy"),N=B("react.block"),B("react.scope"),I=B("react.opaque.id"),M=B("react.debug_trace_mode"),D=B("react.offscreen"),F=B("react.legacy_hidden")}var z,U="function"==typeof Symbol&&Symbol.iterator;function $(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=U&&e[U]||e["@@iterator"])?e:null}function G(e){if(void 0===z)try{throw Error()}catch(n){var t=n.stack.trim().match(/\n( *(at )?)/);z=t&&t[1]||""}return"\n"+z+e}var H=!1;function V(e,t){if(!e||H)return"";H=!0;var n=Error.prepareStackTrace;Error.prepareStackTrace=void 0;try{if(t)if(t=function(){throw Error()},Object.defineProperty(t.prototype,"props",{set:function(){throw Error()}}),"object"==typeof Reflect&&Reflect.construct){try{Reflect.construct(t,[])}catch(s){var r=s}Reflect.construct(e,[],t)}else{try{t.call()}catch(s){r=s}e.call(t.prototype)}else{try{throw Error()}catch(s){r=s}e()}}catch(s){if(s&&r&&"string"==typeof s.stack){for(var a=s.stack.split("\n"),o=r.stack.split("\n"),i=a.length-1,l=o.length-1;1<=i&&0<=l&&a[i]!==o[l];)l--;for(;1<=i&&0<=l;i--,l--)if(a[i]!==o[l]){if(1!==i||1!==l)do{if(i--,0>--l||a[i]!==o[l])return"\n"+a[i].replace(" at new "," at ")}while(1<=i&&0<=l);break}}}finally{H=!1,Error.prepareStackTrace=n}return(e=e?e.displayName||e.name:"")?G(e):""}function q(e){switch(e.tag){case 5:return G(e.type);case 16:return G("Lazy");case 13:return G("Suspense");case 19:return G("SuspenseList");case 0:case 2:case 15:return e=V(e.type,!1);case 11:return e=V(e.type.render,!1);case 22:return e=V(e.type._render,!1);case 1:return e=V(e.type,!0);default:return""}}function Z(e){if(null==e)return null;if("function"==typeof e)return e.displayName||e.name||null;if("string"==typeof e)return e;switch(e){case x:return"Fragment";case E:return"Portal";case R:return"Profiler";case _:return"StrictMode";case P:return"Suspense";case A:return"SuspenseList"}if("object"==typeof e)switch(e.$$typeof){case T:return(e.displayName||"Context")+".Consumer";case C:return(e._context.displayName||"Context")+".Provider";case O:var t=e.render;return t=t.displayName||t.name||"",e.displayName||(""!==t?"ForwardRef("+t+")":"ForwardRef");case j:return Z(e.type);case N:return Z(e._render);case L:t=e._payload,e=e._init;try{return Z(e(t))}catch(n){}}return null}function W(e){switch(typeof e){case"boolean":case"number":case"object":case"string":case"undefined":return e;default:return""}}function Y(e){var t=e.type;return(e=e.nodeName)&&"input"===e.toLowerCase()&&("checkbox"===t||"radio"===t)}function K(e){e._valueTracker||(e._valueTracker=function(e){var t=Y(e)?"checked":"value",n=Object.getOwnPropertyDescriptor(e.constructor.prototype,t),r=""+e[t];if(!e.hasOwnProperty(t)&&void 0!==n&&"function"==typeof n.get&&"function"==typeof n.set){var a=n.get,o=n.set;return Object.defineProperty(e,t,{configurable:!0,get:function(){return a.call(this)},set:function(e){r=""+e,o.call(this,e)}}),Object.defineProperty(e,t,{enumerable:n.enumerable}),{getValue:function(){return r},setValue:function(e){r=""+e},stopTracking:function(){e._valueTracker=null,delete e[t]}}}}(e))}function Q(e){if(!e)return!1;var t=e._valueTracker;if(!t)return!0;var n=t.getValue(),r="";return e&&(r=Y(e)?e.checked?"true":"false":e.value),(e=r)!==n&&(t.setValue(e),!0)}function X(e){if(void 0===(e=e||("undefined"!=typeof document?document:void 0)))return null;try{return e.activeElement||e.body}catch(t){return e.body}}function J(e,t){var n=t.checked;return a({},t,{defaultChecked:void 0,defaultValue:void 0,value:void 0,checked:null!=n?n:e._wrapperState.initialChecked})}function ee(e,t){var n=null==t.defaultValue?"":t.defaultValue,r=null!=t.checked?t.checked:t.defaultChecked;n=W(null!=t.value?t.value:n),e._wrapperState={initialChecked:r,initialValue:n,controlled:"checkbox"===t.type||"radio"===t.type?null!=t.checked:null!=t.value}}function te(e,t){null!=(t=t.checked)&&w(e,"checked",t,!1)}function ne(e,t){te(e,t);var n=W(t.value),r=t.type;if(null!=n)"number"===r?(0===n&&""===e.value||e.value!=n)&&(e.value=""+n):e.value!==""+n&&(e.value=""+n);else if("submit"===r||"reset"===r)return void e.removeAttribute("value");t.hasOwnProperty("value")?ae(e,t.type,n):t.hasOwnProperty("defaultValue")&&ae(e,t.type,W(t.defaultValue)),null==t.checked&&null!=t.defaultChecked&&(e.defaultChecked=!!t.defaultChecked)}function re(e,t,n){if(t.hasOwnProperty("value")||t.hasOwnProperty("defaultValue")){var r=t.type;if(!("submit"!==r&&"reset"!==r||void 0!==t.value&&null!==t.value))return;t=""+e._wrapperState.initialValue,n||t===e.value||(e.value=t),e.defaultValue=t}""!==(n=e.name)&&(e.name=""),e.defaultChecked=!!e._wrapperState.initialChecked,""!==n&&(e.name=n)}function ae(e,t,n){"number"===t&&X(e.ownerDocument)===e||(null==n?e.defaultValue=""+e._wrapperState.initialValue:e.defaultValue!==""+n&&(e.defaultValue=""+n))}function oe(e,t){return e=a({children:void 0},t),(t=function(e){var t="";return r.Children.forEach(e,(function(e){null!=e&&(t+=e)})),t}(t.children))&&(e.children=t),e}function ie(e,t,n,r){if(e=e.options,t){t={};for(var a=0;a<n.length;a++)t["$"+n[a]]=!0;for(n=0;n<e.length;n++)a=t.hasOwnProperty("$"+e[n].value),e[n].selected!==a&&(e[n].selected=a),a&&r&&(e[n].defaultSelected=!0)}else{for(n=""+W(n),t=null,a=0;a<e.length;a++){if(e[a].value===n)return e[a].selected=!0,void(r&&(e[a].defaultSelected=!0));null!==t||e[a].disabled||(t=e[a])}null!==t&&(t.selected=!0)}}function le(e,t){if(null!=t.dangerouslySetInnerHTML)throw Error(i(91));return a({},t,{value:void 0,defaultValue:void 0,children:""+e._wrapperState.initialValue})}function se(e,t){var n=t.value;if(null==n){if(n=t.children,t=t.defaultValue,null!=n){if(null!=t)throw Error(i(92));if(Array.isArray(n)){if(!(1>=n.length))throw Error(i(93));n=n[0]}t=n}null==t&&(t=""),n=t}e._wrapperState={initialValue:W(n)}}function ce(e,t){var n=W(t.value),r=W(t.defaultValue);null!=n&&((n=""+n)!==e.value&&(e.value=n),null==t.defaultValue&&e.defaultValue!==n&&(e.defaultValue=n)),null!=r&&(e.defaultValue=""+r)}function ue(e){var t=e.textContent;t===e._wrapperState.initialValue&&""!==t&&null!==t&&(e.value=t)}var de="http://www.w3.org/1999/xhtml",pe="http://www.w3.org/2000/svg";function fe(e){switch(e){case"svg":return"http://www.w3.org/2000/svg";case"math":return"http://www.w3.org/1998/Math/MathML";default:return"http://www.w3.org/1999/xhtml"}}function me(e,t){return null==e||"http://www.w3.org/1999/xhtml"===e?fe(t):"http://www.w3.org/2000/svg"===e&&"foreignObject"===t?"http://www.w3.org/1999/xhtml":e}var he,ge,be=(ge=function(e,t){if(e.namespaceURI!==pe||"innerHTML"in e)e.innerHTML=t;else{for((he=he||document.createElement("div")).innerHTML="<svg>"+t.valueOf().toString()+"</svg>",t=he.firstChild;e.firstChild;)e.removeChild(e.firstChild);for(;t.firstChild;)e.appendChild(t.firstChild)}},"undefined"!=typeof MSApp&&MSApp.execUnsafeLocalFunction?function(e,t,n,r){MSApp.execUnsafeLocalFunction((function(){return ge(e,t)}))}:ge);function ve(e,t){if(t){var n=e.firstChild;if(n&&n===e.lastChild&&3===n.nodeType)return void(n.nodeValue=t)}e.textContent=t}var ye={animationIterationCount:!0,borderImageOutset:!0,borderImageSlice:!0,borderImageWidth:!0,boxFlex:!0,boxFlexGroup:!0,boxOrdinalGroup:!0,columnCount:!0,columns:!0,flex:!0,flexGrow:!0,flexPositive:!0,flexShrink:!0,flexNegative:!0,flexOrder:!0,gridArea:!0,gridRow:!0,gridRowEnd:!0,gridRowSpan:!0,gridRowStart:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnSpan:!0,gridColumnStart:!0,fontWeight:!0,lineClamp:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,tabSize:!0,widows:!0,zIndex:!0,zoom:!0,fillOpacity:!0,floodOpacity:!0,stopOpacity:!0,strokeDasharray:!0,strokeDashoffset:!0,strokeMiterlimit:!0,strokeOpacity:!0,strokeWidth:!0},we=["Webkit","ms","Moz","O"];function ke(e,t,n){return null==t||"boolean"==typeof t||""===t?"":n||"number"!=typeof t||0===t||ye.hasOwnProperty(e)&&ye[e]?(""+t).trim():t+"px"}function Se(e,t){for(var n in e=e.style,t)if(t.hasOwnProperty(n)){var r=0===n.indexOf("--"),a=ke(n,t[n],r);"float"===n&&(n="cssFloat"),r?e.setProperty(n,a):e[n]=a}}Object.keys(ye).forEach((function(e){we.forEach((function(t){t=t+e.charAt(0).toUpperCase()+e.substring(1),ye[t]=ye[e]}))}));var Ee=a({menuitem:!0},{area:!0,base:!0,br:!0,col:!0,embed:!0,hr:!0,img:!0,input:!0,keygen:!0,link:!0,meta:!0,param:!0,source:!0,track:!0,wbr:!0});function xe(e,t){if(t){if(Ee[e]&&(null!=t.children||null!=t.dangerouslySetInnerHTML))throw Error(i(137,e));if(null!=t.dangerouslySetInnerHTML){if(null!=t.children)throw Error(i(60));if("object"!=typeof t.dangerouslySetInnerHTML||!("__html"in t.dangerouslySetInnerHTML))throw Error(i(61))}if(null!=t.style&&"object"!=typeof t.style)throw Error(i(62))}}function _e(e,t){if(-1===e.indexOf("-"))return"string"==typeof t.is;switch(e){case"annotation-xml":case"color-profile":case"font-face":case"font-face-src":case"font-face-uri":case"font-face-format":case"font-face-name":case"missing-glyph":return!1;default:return!0}}function Re(e){return(e=e.target||e.srcElement||window).correspondingUseElement&&(e=e.correspondingUseElement),3===e.nodeType?e.parentNode:e}var Ce=null,Te=null,Oe=null;function Pe(e){if(e=ra(e)){if("function"!=typeof Ce)throw Error(i(280));var t=e.stateNode;t&&(t=oa(t),Ce(e.stateNode,e.type,t))}}function Ae(e){Te?Oe?Oe.push(e):Oe=[e]:Te=e}function je(){if(Te){var e=Te,t=Oe;if(Oe=Te=null,Pe(e),t)for(e=0;e<t.length;e++)Pe(t[e])}}function Le(e,t){return e(t)}function Ne(e,t,n,r,a){return e(t,n,r,a)}function Ie(){}var Me=Le,De=!1,Fe=!1;function Be(){null===Te&&null===Oe||(Ie(),je())}function ze(e,t){var n=e.stateNode;if(null===n)return null;var r=oa(n);if(null===r)return null;n=r[t];e:switch(t){case"onClick":case"onClickCapture":case"onDoubleClick":case"onDoubleClickCapture":case"onMouseDown":case"onMouseDownCapture":case"onMouseMove":case"onMouseMoveCapture":case"onMouseUp":case"onMouseUpCapture":case"onMouseEnter":(r=!r.disabled)||(r=!("button"===(e=e.type)||"input"===e||"select"===e||"textarea"===e)),e=!r;break e;default:e=!1}if(e)return null;if(n&&"function"!=typeof n)throw Error(i(231,t,typeof n));return n}var Ue=!1;if(d)try{var $e={};Object.defineProperty($e,"passive",{get:function(){Ue=!0}}),window.addEventListener("test",$e,$e),window.removeEventListener("test",$e,$e)}catch(ge){Ue=!1}function Ge(e,t,n,r,a,o,i,l,s){var c=Array.prototype.slice.call(arguments,3);try{t.apply(n,c)}catch(u){this.onError(u)}}var He=!1,Ve=null,qe=!1,Ze=null,We={onError:function(e){He=!0,Ve=e}};function Ye(e,t,n,r,a,o,i,l,s){He=!1,Ve=null,Ge.apply(We,arguments)}function Ke(e){var t=e,n=e;if(e.alternate)for(;t.return;)t=t.return;else{e=t;do{0!=(1026&(t=e).flags)&&(n=t.return),e=t.return}while(e)}return 3===t.tag?n:null}function Qe(e){if(13===e.tag){var t=e.memoizedState;if(null===t&&(null!==(e=e.alternate)&&(t=e.memoizedState)),null!==t)return t.dehydrated}return null}function Xe(e){if(Ke(e)!==e)throw Error(i(188))}function Je(e){if(e=function(e){var t=e.alternate;if(!t){if(null===(t=Ke(e)))throw Error(i(188));return t!==e?null:e}for(var n=e,r=t;;){var a=n.return;if(null===a)break;var o=a.alternate;if(null===o){if(null!==(r=a.return)){n=r;continue}break}if(a.child===o.child){for(o=a.child;o;){if(o===n)return Xe(a),e;if(o===r)return Xe(a),t;o=o.sibling}throw Error(i(188))}if(n.return!==r.return)n=a,r=o;else{for(var l=!1,s=a.child;s;){if(s===n){l=!0,n=a,r=o;break}if(s===r){l=!0,r=a,n=o;break}s=s.sibling}if(!l){for(s=o.child;s;){if(s===n){l=!0,n=o,r=a;break}if(s===r){l=!0,r=o,n=a;break}s=s.sibling}if(!l)throw Error(i(189))}}if(n.alternate!==r)throw Error(i(190))}if(3!==n.tag)throw Error(i(188));return n.stateNode.current===n?e:t}(e),!e)return null;for(var t=e;;){if(5===t.tag||6===t.tag)return t;if(t.child)t.child.return=t,t=t.child;else{if(t===e)break;for(;!t.sibling;){if(!t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}}return null}function et(e,t){for(var n=e.alternate;null!==t;){if(t===e||t===n)return!0;t=t.return}return!1}var tt,nt,rt,at,ot=!1,it=[],lt=null,st=null,ct=null,ut=new Map,dt=new Map,pt=[],ft="mousedown mouseup touchcancel touchend touchstart auxclick dblclick pointercancel pointerdown pointerup dragend dragstart drop compositionend compositionstart keydown keypress keyup input textInput copy cut paste click change contextmenu reset submit".split(" ");function mt(e,t,n,r,a){return{blockedOn:e,domEventName:t,eventSystemFlags:16|n,nativeEvent:a,targetContainers:[r]}}function ht(e,t){switch(e){case"focusin":case"focusout":lt=null;break;case"dragenter":case"dragleave":st=null;break;case"mouseover":case"mouseout":ct=null;break;case"pointerover":case"pointerout":ut.delete(t.pointerId);break;case"gotpointercapture":case"lostpointercapture":dt.delete(t.pointerId)}}function gt(e,t,n,r,a,o){return null===e||e.nativeEvent!==o?(e=mt(t,n,r,a,o),null!==t&&(null!==(t=ra(t))&&nt(t)),e):(e.eventSystemFlags|=r,t=e.targetContainers,null!==a&&-1===t.indexOf(a)&&t.push(a),e)}function bt(e){var t=na(e.target);if(null!==t){var n=Ke(t);if(null!==n)if(13===(t=n.tag)){if(null!==(t=Qe(n)))return e.blockedOn=t,void at(e.lanePriority,(function(){o.unstable_runWithPriority(e.priority,(function(){rt(n)}))}))}else if(3===t&&n.stateNode.hydrate)return void(e.blockedOn=3===n.tag?n.stateNode.containerInfo:null)}e.blockedOn=null}function vt(e){if(null!==e.blockedOn)return!1;for(var t=e.targetContainers;0<t.length;){var n=Jt(e.domEventName,e.eventSystemFlags,t[0],e.nativeEvent);if(null!==n)return null!==(t=ra(n))&&nt(t),e.blockedOn=n,!1;t.shift()}return!0}function yt(e,t,n){vt(e)&&n.delete(t)}function wt(){for(ot=!1;0<it.length;){var e=it[0];if(null!==e.blockedOn){null!==(e=ra(e.blockedOn))&&tt(e);break}for(var t=e.targetContainers;0<t.length;){var n=Jt(e.domEventName,e.eventSystemFlags,t[0],e.nativeEvent);if(null!==n){e.blockedOn=n;break}t.shift()}null===e.blockedOn&&it.shift()}null!==lt&&vt(lt)&&(lt=null),null!==st&&vt(st)&&(st=null),null!==ct&&vt(ct)&&(ct=null),ut.forEach(yt),dt.forEach(yt)}function kt(e,t){e.blockedOn===t&&(e.blockedOn=null,ot||(ot=!0,o.unstable_scheduleCallback(o.unstable_NormalPriority,wt)))}function St(e){function t(t){return kt(t,e)}if(0<it.length){kt(it[0],e);for(var n=1;n<it.length;n++){var r=it[n];r.blockedOn===e&&(r.blockedOn=null)}}for(null!==lt&&kt(lt,e),null!==st&&kt(st,e),null!==ct&&kt(ct,e),ut.forEach(t),dt.forEach(t),n=0;n<pt.length;n++)(r=pt[n]).blockedOn===e&&(r.blockedOn=null);for(;0<pt.length&&null===(n=pt[0]).blockedOn;)bt(n),null===n.blockedOn&&pt.shift()}function Et(e,t){var n={};return n[e.toLowerCase()]=t.toLowerCase(),n["Webkit"+e]="webkit"+t,n["Moz"+e]="moz"+t,n}var xt={animationend:Et("Animation","AnimationEnd"),animationiteration:Et("Animation","AnimationIteration"),animationstart:Et("Animation","AnimationStart"),transitionend:Et("Transition","TransitionEnd")},_t={},Rt={};function Ct(e){if(_t[e])return _t[e];if(!xt[e])return e;var t,n=xt[e];for(t in n)if(n.hasOwnProperty(t)&&t in Rt)return _t[e]=n[t];return e}d&&(Rt=document.createElement("div").style,"AnimationEvent"in window||(delete xt.animationend.animation,delete xt.animationiteration.animation,delete xt.animationstart.animation),"TransitionEvent"in window||delete xt.transitionend.transition);var Tt=Ct("animationend"),Ot=Ct("animationiteration"),Pt=Ct("animationstart"),At=Ct("transitionend"),jt=new Map,Lt=new Map,Nt=["abort","abort",Tt,"animationEnd",Ot,"animationIteration",Pt,"animationStart","canplay","canPlay","canplaythrough","canPlayThrough","durationchange","durationChange","emptied","emptied","encrypted","encrypted","ended","ended","error","error","gotpointercapture","gotPointerCapture","load","load","loadeddata","loadedData","loadedmetadata","loadedMetadata","loadstart","loadStart","lostpointercapture","lostPointerCapture","playing","playing","progress","progress","seeking","seeking","stalled","stalled","suspend","suspend","timeupdate","timeUpdate",At,"transitionEnd","waiting","waiting"];function It(e,t){for(var n=0;n<e.length;n+=2){var r=e[n],a=e[n+1];a="on"+(a[0].toUpperCase()+a.slice(1)),Lt.set(r,t),jt.set(r,a),c(a,[r])}}(0,o.unstable_now)();var Mt=8;function Dt(e){if(0!=(1&e))return Mt=15,1;if(0!=(2&e))return Mt=14,2;if(0!=(4&e))return Mt=13,4;var t=24&e;return 0!==t?(Mt=12,t):0!=(32&e)?(Mt=11,32):0!==(t=192&e)?(Mt=10,t):0!=(256&e)?(Mt=9,256):0!==(t=3584&e)?(Mt=8,t):0!=(4096&e)?(Mt=7,4096):0!==(t=4186112&e)?(Mt=6,t):0!==(t=62914560&e)?(Mt=5,t):67108864&e?(Mt=4,67108864):0!=(134217728&e)?(Mt=3,134217728):0!==(t=805306368&e)?(Mt=2,t):0!=(1073741824&e)?(Mt=1,1073741824):(Mt=8,e)}function Ft(e,t){var n=e.pendingLanes;if(0===n)return Mt=0;var r=0,a=0,o=e.expiredLanes,i=e.suspendedLanes,l=e.pingedLanes;if(0!==o)r=o,a=Mt=15;else if(0!==(o=134217727&n)){var s=o&~i;0!==s?(r=Dt(s),a=Mt):0!==(l&=o)&&(r=Dt(l),a=Mt)}else 0!==(o=n&~i)?(r=Dt(o),a=Mt):0!==l&&(r=Dt(l),a=Mt);if(0===r)return 0;if(r=n&((0>(r=31-Ht(r))?0:1<<r)<<1)-1,0!==t&&t!==r&&0==(t&i)){if(Dt(t),a<=Mt)return t;Mt=a}if(0!==(t=e.entangledLanes))for(e=e.entanglements,t&=r;0<t;)a=1<<(n=31-Ht(t)),r|=e[n],t&=~a;return r}function Bt(e){return 0!==(e=-1073741825&e.pendingLanes)?e:1073741824&e?1073741824:0}function zt(e,t){switch(e){case 15:return 1;case 14:return 2;case 12:return 0===(e=Ut(24&~t))?zt(10,t):e;case 10:return 0===(e=Ut(192&~t))?zt(8,t):e;case 8:return 0===(e=Ut(3584&~t))&&(0===(e=Ut(4186112&~t))&&(e=512)),e;case 2:return 0===(t=Ut(805306368&~t))&&(t=268435456),t}throw Error(i(358,e))}function Ut(e){return e&-e}function $t(e){for(var t=[],n=0;31>n;n++)t.push(e);return t}function Gt(e,t,n){e.pendingLanes|=t;var r=t-1;e.suspendedLanes&=r,e.pingedLanes&=r,(e=e.eventTimes)[t=31-Ht(t)]=n}var Ht=Math.clz32?Math.clz32:function(e){return 0===e?32:31-(Vt(e)/qt|0)|0},Vt=Math.log,qt=Math.LN2;var Zt=o.unstable_UserBlockingPriority,Wt=o.unstable_runWithPriority,Yt=!0;function Kt(e,t,n,r){De||Ie();var a=Xt,o=De;De=!0;try{Ne(a,e,t,n,r)}finally{(De=o)||Be()}}function Qt(e,t,n,r){Wt(Zt,Xt.bind(null,e,t,n,r))}function Xt(e,t,n,r){var a;if(Yt)if((a=0==(4&t))&&0<it.length&&-1<ft.indexOf(e))e=mt(null,e,t,n,r),it.push(e);else{var o=Jt(e,t,n,r);if(null===o)a&&ht(e,r);else{if(a){if(-1<ft.indexOf(e))return e=mt(o,e,t,n,r),void it.push(e);if(function(e,t,n,r,a){switch(t){case"focusin":return lt=gt(lt,e,t,n,r,a),!0;case"dragenter":return st=gt(st,e,t,n,r,a),!0;case"mouseover":return ct=gt(ct,e,t,n,r,a),!0;case"pointerover":var o=a.pointerId;return ut.set(o,gt(ut.get(o)||null,e,t,n,r,a)),!0;case"gotpointercapture":return o=a.pointerId,dt.set(o,gt(dt.get(o)||null,e,t,n,r,a)),!0}return!1}(o,e,t,n,r))return;ht(e,r)}Ir(e,t,r,null,n)}}}function Jt(e,t,n,r){var a=Re(r);if(null!==(a=na(a))){var o=Ke(a);if(null===o)a=null;else{var i=o.tag;if(13===i){if(null!==(a=Qe(o)))return a;a=null}else if(3===i){if(o.stateNode.hydrate)return 3===o.tag?o.stateNode.containerInfo:null;a=null}else o!==a&&(a=null)}}return Ir(e,t,r,a,n),null}var en=null,tn=null,nn=null;function rn(){if(nn)return nn;var e,t,n=tn,r=n.length,a="value"in en?en.value:en.textContent,o=a.length;for(e=0;e<r&&n[e]===a[e];e++);var i=r-e;for(t=1;t<=i&&n[r-t]===a[o-t];t++);return nn=a.slice(e,1<t?1-t:void 0)}function an(e){var t=e.keyCode;return"charCode"in e?0===(e=e.charCode)&&13===t&&(e=13):e=t,10===e&&(e=13),32<=e||13===e?e:0}function on(){return!0}function ln(){return!1}function sn(e){function t(t,n,r,a,o){for(var i in this._reactName=t,this._targetInst=r,this.type=n,this.nativeEvent=a,this.target=o,this.currentTarget=null,e)e.hasOwnProperty(i)&&(t=e[i],this[i]=t?t(a):a[i]);return this.isDefaultPrevented=(null!=a.defaultPrevented?a.defaultPrevented:!1===a.returnValue)?on:ln,this.isPropagationStopped=ln,this}return a(t.prototype,{preventDefault:function(){this.defaultPrevented=!0;var e=this.nativeEvent;e&&(e.preventDefault?e.preventDefault():"unknown"!=typeof e.returnValue&&(e.returnValue=!1),this.isDefaultPrevented=on)},stopPropagation:function(){var e=this.nativeEvent;e&&(e.stopPropagation?e.stopPropagation():"unknown"!=typeof e.cancelBubble&&(e.cancelBubble=!0),this.isPropagationStopped=on)},persist:function(){},isPersistent:on}),t}var cn,un,dn,pn={eventPhase:0,bubbles:0,cancelable:0,timeStamp:function(e){return e.timeStamp||Date.now()},defaultPrevented:0,isTrusted:0},fn=sn(pn),mn=a({},pn,{view:0,detail:0}),hn=sn(mn),gn=a({},mn,{screenX:0,screenY:0,clientX:0,clientY:0,pageX:0,pageY:0,ctrlKey:0,shiftKey:0,altKey:0,metaKey:0,getModifierState:Tn,button:0,buttons:0,relatedTarget:function(e){return void 0===e.relatedTarget?e.fromElement===e.srcElement?e.toElement:e.fromElement:e.relatedTarget},movementX:function(e){return"movementX"in e?e.movementX:(e!==dn&&(dn&&"mousemove"===e.type?(cn=e.screenX-dn.screenX,un=e.screenY-dn.screenY):un=cn=0,dn=e),cn)},movementY:function(e){return"movementY"in e?e.movementY:un}}),bn=sn(gn),vn=sn(a({},gn,{dataTransfer:0})),yn=sn(a({},mn,{relatedTarget:0})),wn=sn(a({},pn,{animationName:0,elapsedTime:0,pseudoElement:0})),kn=a({},pn,{clipboardData:function(e){return"clipboardData"in e?e.clipboardData:window.clipboardData}}),Sn=sn(kn),En=sn(a({},pn,{data:0})),xn={Esc:"Escape",Spacebar:" ",Left:"ArrowLeft",Up:"ArrowUp",Right:"ArrowRight",Down:"ArrowDown",Del:"Delete",Win:"OS",Menu:"ContextMenu",Apps:"ContextMenu",Scroll:"ScrollLock",MozPrintableKey:"Unidentified"},_n={8:"Backspace",9:"Tab",12:"Clear",13:"Enter",16:"Shift",17:"Control",18:"Alt",19:"Pause",20:"CapsLock",27:"Escape",32:" ",33:"PageUp",34:"PageDown",35:"End",36:"Home",37:"ArrowLeft",38:"ArrowUp",39:"ArrowRight",40:"ArrowDown",45:"Insert",46:"Delete",112:"F1",113:"F2",114:"F3",115:"F4",116:"F5",117:"F6",118:"F7",119:"F8",120:"F9",121:"F10",122:"F11",123:"F12",144:"NumLock",145:"ScrollLock",224:"Meta"},Rn={Alt:"altKey",Control:"ctrlKey",Meta:"metaKey",Shift:"shiftKey"};function Cn(e){var t=this.nativeEvent;return t.getModifierState?t.getModifierState(e):!!(e=Rn[e])&&!!t[e]}function Tn(){return Cn}var On=a({},mn,{key:function(e){if(e.key){var t=xn[e.key]||e.key;if("Unidentified"!==t)return t}return"keypress"===e.type?13===(e=an(e))?"Enter":String.fromCharCode(e):"keydown"===e.type||"keyup"===e.type?_n[e.keyCode]||"Unidentified":""},code:0,location:0,ctrlKey:0,shiftKey:0,altKey:0,metaKey:0,repeat:0,locale:0,getModifierState:Tn,charCode:function(e){return"keypress"===e.type?an(e):0},keyCode:function(e){return"keydown"===e.type||"keyup"===e.type?e.keyCode:0},which:function(e){return"keypress"===e.type?an(e):"keydown"===e.type||"keyup"===e.type?e.keyCode:0}}),Pn=sn(On),An=sn(a({},gn,{pointerId:0,width:0,height:0,pressure:0,tangentialPressure:0,tiltX:0,tiltY:0,twist:0,pointerType:0,isPrimary:0})),jn=sn(a({},mn,{touches:0,targetTouches:0,changedTouches:0,altKey:0,metaKey:0,ctrlKey:0,shiftKey:0,getModifierState:Tn})),Ln=sn(a({},pn,{propertyName:0,elapsedTime:0,pseudoElement:0})),Nn=a({},gn,{deltaX:function(e){return"deltaX"in e?e.deltaX:"wheelDeltaX"in e?-e.wheelDeltaX:0},deltaY:function(e){return"deltaY"in e?e.deltaY:"wheelDeltaY"in e?-e.wheelDeltaY:"wheelDelta"in e?-e.wheelDelta:0},deltaZ:0,deltaMode:0}),In=sn(Nn),Mn=[9,13,27,32],Dn=d&&"CompositionEvent"in window,Fn=null;d&&"documentMode"in document&&(Fn=document.documentMode);var Bn=d&&"TextEvent"in window&&!Fn,zn=d&&(!Dn||Fn&&8<Fn&&11>=Fn),Un=String.fromCharCode(32),$n=!1;function Gn(e,t){switch(e){case"keyup":return-1!==Mn.indexOf(t.keyCode);case"keydown":return 229!==t.keyCode;case"keypress":case"mousedown":case"focusout":return!0;default:return!1}}function Hn(e){return"object"==typeof(e=e.detail)&&"data"in e?e.data:null}var Vn=!1;var qn={color:!0,date:!0,datetime:!0,"datetime-local":!0,email:!0,month:!0,number:!0,password:!0,range:!0,search:!0,tel:!0,text:!0,time:!0,url:!0,week:!0};function Zn(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return"input"===t?!!qn[e.type]:"textarea"===t}function Wn(e,t,n,r){Ae(r),0<(t=Dr(t,"onChange")).length&&(n=new fn("onChange","change",null,n,r),e.push({event:n,listeners:t}))}var Yn=null,Kn=null;function Qn(e){Or(e,0)}function Xn(e){if(Q(aa(e)))return e}function Jn(e,t){if("change"===e)return t}var er=!1;if(d){var tr;if(d){var nr="oninput"in document;if(!nr){var rr=document.createElement("div");rr.setAttribute("oninput","return;"),nr="function"==typeof rr.oninput}tr=nr}else tr=!1;er=tr&&(!document.documentMode||9<document.documentMode)}function ar(){Yn&&(Yn.detachEvent("onpropertychange",or),Kn=Yn=null)}function or(e){if("value"===e.propertyName&&Xn(Kn)){var t=[];if(Wn(t,Kn,e,Re(e)),e=Qn,De)e(t);else{De=!0;try{Le(e,t)}finally{De=!1,Be()}}}}function ir(e,t,n){"focusin"===e?(ar(),Kn=n,(Yn=t).attachEvent("onpropertychange",or)):"focusout"===e&&ar()}function lr(e){if("selectionchange"===e||"keyup"===e||"keydown"===e)return Xn(Kn)}function sr(e,t){if("click"===e)return Xn(t)}function cr(e,t){if("input"===e||"change"===e)return Xn(t)}var ur="function"==typeof Object.is?Object.is:function(e,t){return e===t&&(0!==e||1/e==1/t)||e!=e&&t!=t},dr=Object.prototype.hasOwnProperty;function pr(e,t){if(ur(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var n=Object.keys(e),r=Object.keys(t);if(n.length!==r.length)return!1;for(r=0;r<n.length;r++)if(!dr.call(t,n[r])||!ur(e[n[r]],t[n[r]]))return!1;return!0}function fr(e){for(;e&&e.firstChild;)e=e.firstChild;return e}function mr(e,t){var n,r=fr(e);for(e=0;r;){if(3===r.nodeType){if(n=e+r.textContent.length,e<=t&&n>=t)return{node:r,offset:t-e};e=n}e:{for(;r;){if(r.nextSibling){r=r.nextSibling;break e}r=r.parentNode}r=void 0}r=fr(r)}}function hr(e,t){return!(!e||!t)&&(e===t||(!e||3!==e.nodeType)&&(t&&3===t.nodeType?hr(e,t.parentNode):"contains"in e?e.contains(t):!!e.compareDocumentPosition&&!!(16&e.compareDocumentPosition(t))))}function gr(){for(var e=window,t=X();t instanceof e.HTMLIFrameElement;){try{var n="string"==typeof t.contentWindow.location.href}catch(r){n=!1}if(!n)break;t=X((e=t.contentWindow).document)}return t}function br(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return t&&("input"===t&&("text"===e.type||"search"===e.type||"tel"===e.type||"url"===e.type||"password"===e.type)||"textarea"===t||"true"===e.contentEditable)}var vr=d&&"documentMode"in document&&11>=document.documentMode,yr=null,wr=null,kr=null,Sr=!1;function Er(e,t,n){var r=n.window===n?n.document:9===n.nodeType?n:n.ownerDocument;Sr||null==yr||yr!==X(r)||("selectionStart"in(r=yr)&&br(r)?r={start:r.selectionStart,end:r.selectionEnd}:r={anchorNode:(r=(r.ownerDocument&&r.ownerDocument.defaultView||window).getSelection()).anchorNode,anchorOffset:r.anchorOffset,focusNode:r.focusNode,focusOffset:r.focusOffset},kr&&pr(kr,r)||(kr=r,0<(r=Dr(wr,"onSelect")).length&&(t=new fn("onSelect","select",null,t,n),e.push({event:t,listeners:r}),t.target=yr)))}It("cancel cancel click click close close contextmenu contextMenu copy copy cut cut auxclick auxClick dblclick doubleClick dragend dragEnd dragstart dragStart drop drop focusin focus focusout blur input input invalid invalid keydown keyDown keypress keyPress keyup keyUp mousedown mouseDown mouseup mouseUp paste paste pause pause play play pointercancel pointerCancel pointerdown pointerDown pointerup pointerUp ratechange rateChange reset reset seeked seeked submit submit touchcancel touchCancel touchend touchEnd touchstart touchStart volumechange volumeChange".split(" "),0),It("drag drag dragenter dragEnter dragexit dragExit dragleave dragLeave dragover dragOver mousemove mouseMove mouseout mouseOut mouseover mouseOver pointermove pointerMove pointerout pointerOut pointerover pointerOver scroll scroll toggle toggle touchmove touchMove wheel wheel".split(" "),1),It(Nt,2);for(var xr="change selectionchange textInput compositionstart compositionend compositionupdate".split(" "),_r=0;_r<xr.length;_r++)Lt.set(xr[_r],0);u("onMouseEnter",["mouseout","mouseover"]),u("onMouseLeave",["mouseout","mouseover"]),u("onPointerEnter",["pointerout","pointerover"]),u("onPointerLeave",["pointerout","pointerover"]),c("onChange","change click focusin focusout input keydown keyup selectionchange".split(" ")),c("onSelect","focusout contextmenu dragend focusin keydown keyup mousedown mouseup selectionchange".split(" ")),c("onBeforeInput",["compositionend","keypress","textInput","paste"]),c("onCompositionEnd","compositionend focusout keydown keypress keyup mousedown".split(" ")),c("onCompositionStart","compositionstart focusout keydown keypress keyup mousedown".split(" ")),c("onCompositionUpdate","compositionupdate focusout keydown keypress keyup mousedown".split(" "));var Rr="abort canplay canplaythrough durationchange emptied encrypted ended error loadeddata loadedmetadata loadstart pause play playing progress ratechange seeked seeking stalled suspend timeupdate volumechange waiting".split(" "),Cr=new Set("cancel close invalid load scroll toggle".split(" ").concat(Rr));function Tr(e,t,n){var r=e.type||"unknown-event";e.currentTarget=n,function(e,t,n,r,a,o,l,s,c){if(Ye.apply(this,arguments),He){if(!He)throw Error(i(198));var u=Ve;He=!1,Ve=null,qe||(qe=!0,Ze=u)}}(r,t,void 0,e),e.currentTarget=null}function Or(e,t){t=0!=(4&t);for(var n=0;n<e.length;n++){var r=e[n],a=r.event;r=r.listeners;e:{var o=void 0;if(t)for(var i=r.length-1;0<=i;i--){var l=r[i],s=l.instance,c=l.currentTarget;if(l=l.listener,s!==o&&a.isPropagationStopped())break e;Tr(a,l,c),o=s}else for(i=0;i<r.length;i++){if(s=(l=r[i]).instance,c=l.currentTarget,l=l.listener,s!==o&&a.isPropagationStopped())break e;Tr(a,l,c),o=s}}}if(qe)throw e=Ze,qe=!1,Ze=null,e}function Pr(e,t){var n=ia(t),r=e+"__bubble";n.has(r)||(Nr(t,e,2,!1),n.add(r))}var Ar="_reactListening"+Math.random().toString(36).slice(2);function jr(e){e[Ar]||(e[Ar]=!0,l.forEach((function(t){Cr.has(t)||Lr(t,!1,e,null),Lr(t,!0,e,null)})))}function Lr(e,t,n,r){var a=4<arguments.length&&void 0!==arguments[4]?arguments[4]:0,o=n;if("selectionchange"===e&&9!==n.nodeType&&(o=n.ownerDocument),null!==r&&!t&&Cr.has(e)){if("scroll"!==e)return;a|=2,o=r}var i=ia(o),l=e+"__"+(t?"capture":"bubble");i.has(l)||(t&&(a|=4),Nr(o,e,a,t),i.add(l))}function Nr(e,t,n,r){var a=Lt.get(t);switch(void 0===a?2:a){case 0:a=Kt;break;case 1:a=Qt;break;default:a=Xt}n=a.bind(null,t,n,e),a=void 0,!Ue||"touchstart"!==t&&"touchmove"!==t&&"wheel"!==t||(a=!0),r?void 0!==a?e.addEventListener(t,n,{capture:!0,passive:a}):e.addEventListener(t,n,!0):void 0!==a?e.addEventListener(t,n,{passive:a}):e.addEventListener(t,n,!1)}function Ir(e,t,n,r,a){var o=r;if(0==(1&t)&&0==(2&t)&&null!==r)e:for(;;){if(null===r)return;var i=r.tag;if(3===i||4===i){var l=r.stateNode.containerInfo;if(l===a||8===l.nodeType&&l.parentNode===a)break;if(4===i)for(i=r.return;null!==i;){var s=i.tag;if((3===s||4===s)&&((s=i.stateNode.containerInfo)===a||8===s.nodeType&&s.parentNode===a))return;i=i.return}for(;null!==l;){if(null===(i=na(l)))return;if(5===(s=i.tag)||6===s){r=o=i;continue e}l=l.parentNode}}r=r.return}!function(e,t,n){if(Fe)return e(t,n);Fe=!0;try{Me(e,t,n)}finally{Fe=!1,Be()}}((function(){var r=o,a=Re(n),i=[];e:{var l=jt.get(e);if(void 0!==l){var s=fn,c=e;switch(e){case"keypress":if(0===an(n))break e;case"keydown":case"keyup":s=Pn;break;case"focusin":c="focus",s=yn;break;case"focusout":c="blur",s=yn;break;case"beforeblur":case"afterblur":s=yn;break;case"click":if(2===n.button)break e;case"auxclick":case"dblclick":case"mousedown":case"mousemove":case"mouseup":case"mouseout":case"mouseover":case"contextmenu":s=bn;break;case"drag":case"dragend":case"dragenter":case"dragexit":case"dragleave":case"dragover":case"dragstart":case"drop":s=vn;break;case"touchcancel":case"touchend":case"touchmove":case"touchstart":s=jn;break;case Tt:case Ot:case Pt:s=wn;break;case At:s=Ln;break;case"scroll":s=hn;break;case"wheel":s=In;break;case"copy":case"cut":case"paste":s=Sn;break;case"gotpointercapture":case"lostpointercapture":case"pointercancel":case"pointerdown":case"pointermove":case"pointerout":case"pointerover":case"pointerup":s=An}var u=0!=(4&t),d=!u&&"scroll"===e,p=u?null!==l?l+"Capture":null:l;u=[];for(var f,m=r;null!==m;){var h=(f=m).stateNode;if(5===f.tag&&null!==h&&(f=h,null!==p&&(null!=(h=ze(m,p))&&u.push(Mr(m,h,f)))),d)break;m=m.return}0<u.length&&(l=new s(l,c,null,n,a),i.push({event:l,listeners:u}))}}if(0==(7&t)){if(s="mouseout"===e||"pointerout"===e,(!(l="mouseover"===e||"pointerover"===e)||0!=(16&t)||!(c=n.relatedTarget||n.fromElement)||!na(c)&&!c[ea])&&(s||l)&&(l=a.window===a?a:(l=a.ownerDocument)?l.defaultView||l.parentWindow:window,s?(s=r,null!==(c=(c=n.relatedTarget||n.toElement)?na(c):null)&&(c!==(d=Ke(c))||5!==c.tag&&6!==c.tag)&&(c=null)):(s=null,c=r),s!==c)){if(u=bn,h="onMouseLeave",p="onMouseEnter",m="mouse","pointerout"!==e&&"pointerover"!==e||(u=An,h="onPointerLeave",p="onPointerEnter",m="pointer"),d=null==s?l:aa(s),f=null==c?l:aa(c),(l=new u(h,m+"leave",s,n,a)).target=d,l.relatedTarget=f,h=null,na(a)===r&&((u=new u(p,m+"enter",c,n,a)).target=f,u.relatedTarget=d,h=u),d=h,s&&c)e:{for(p=c,m=0,f=u=s;f;f=Fr(f))m++;for(f=0,h=p;h;h=Fr(h))f++;for(;0<m-f;)u=Fr(u),m--;for(;0<f-m;)p=Fr(p),f--;for(;m--;){if(u===p||null!==p&&u===p.alternate)break e;u=Fr(u),p=Fr(p)}u=null}else u=null;null!==s&&Br(i,l,s,u,!1),null!==c&&null!==d&&Br(i,d,c,u,!0)}if("select"===(s=(l=r?aa(r):window).nodeName&&l.nodeName.toLowerCase())||"input"===s&&"file"===l.type)var g=Jn;else if(Zn(l))if(er)g=cr;else{g=lr;var b=ir}else(s=l.nodeName)&&"input"===s.toLowerCase()&&("checkbox"===l.type||"radio"===l.type)&&(g=sr);switch(g&&(g=g(e,r))?Wn(i,g,n,a):(b&&b(e,l,r),"focusout"===e&&(b=l._wrapperState)&&b.controlled&&"number"===l.type&&ae(l,"number",l.value)),b=r?aa(r):window,e){case"focusin":(Zn(b)||"true"===b.contentEditable)&&(yr=b,wr=r,kr=null);break;case"focusout":kr=wr=yr=null;break;case"mousedown":Sr=!0;break;case"contextmenu":case"mouseup":case"dragend":Sr=!1,Er(i,n,a);break;case"selectionchange":if(vr)break;case"keydown":case"keyup":Er(i,n,a)}var v;if(Dn)e:{switch(e){case"compositionstart":var y="onCompositionStart";break e;case"compositionend":y="onCompositionEnd";break e;case"compositionupdate":y="onCompositionUpdate";break e}y=void 0}else Vn?Gn(e,n)&&(y="onCompositionEnd"):"keydown"===e&&229===n.keyCode&&(y="onCompositionStart");y&&(zn&&"ko"!==n.locale&&(Vn||"onCompositionStart"!==y?"onCompositionEnd"===y&&Vn&&(v=rn()):(tn="value"in(en=a)?en.value:en.textContent,Vn=!0)),0<(b=Dr(r,y)).length&&(y=new En(y,e,null,n,a),i.push({event:y,listeners:b}),v?y.data=v:null!==(v=Hn(n))&&(y.data=v))),(v=Bn?function(e,t){switch(e){case"compositionend":return Hn(t);case"keypress":return 32!==t.which?null:($n=!0,Un);case"textInput":return(e=t.data)===Un&&$n?null:e;default:return null}}(e,n):function(e,t){if(Vn)return"compositionend"===e||!Dn&&Gn(e,t)?(e=rn(),nn=tn=en=null,Vn=!1,e):null;switch(e){case"paste":default:return null;case"keypress":if(!(t.ctrlKey||t.altKey||t.metaKey)||t.ctrlKey&&t.altKey){if(t.char&&1<t.char.length)return t.char;if(t.which)return String.fromCharCode(t.which)}return null;case"compositionend":return zn&&"ko"!==t.locale?null:t.data}}(e,n))&&(0<(r=Dr(r,"onBeforeInput")).length&&(a=new En("onBeforeInput","beforeinput",null,n,a),i.push({event:a,listeners:r}),a.data=v))}Or(i,t)}))}function Mr(e,t,n){return{instance:e,listener:t,currentTarget:n}}function Dr(e,t){for(var n=t+"Capture",r=[];null!==e;){var a=e,o=a.stateNode;5===a.tag&&null!==o&&(a=o,null!=(o=ze(e,n))&&r.unshift(Mr(e,o,a)),null!=(o=ze(e,t))&&r.push(Mr(e,o,a))),e=e.return}return r}function Fr(e){if(null===e)return null;do{e=e.return}while(e&&5!==e.tag);return e||null}function Br(e,t,n,r,a){for(var o=t._reactName,i=[];null!==n&&n!==r;){var l=n,s=l.alternate,c=l.stateNode;if(null!==s&&s===r)break;5===l.tag&&null!==c&&(l=c,a?null!=(s=ze(n,o))&&i.unshift(Mr(n,s,l)):a||null!=(s=ze(n,o))&&i.push(Mr(n,s,l))),n=n.return}0!==i.length&&e.push({event:t,listeners:i})}function zr(){}var Ur=null,$r=null;function Gr(e,t){switch(e){case"button":case"input":case"select":case"textarea":return!!t.autoFocus}return!1}function Hr(e,t){return"textarea"===e||"option"===e||"noscript"===e||"string"==typeof t.children||"number"==typeof t.children||"object"==typeof t.dangerouslySetInnerHTML&&null!==t.dangerouslySetInnerHTML&&null!=t.dangerouslySetInnerHTML.__html}var Vr="function"==typeof setTimeout?setTimeout:void 0,qr="function"==typeof clearTimeout?clearTimeout:void 0;function Zr(e){1===e.nodeType?e.textContent="":9===e.nodeType&&(null!=(e=e.body)&&(e.textContent=""))}function Wr(e){for(;null!=e;e=e.nextSibling){var t=e.nodeType;if(1===t||3===t)break}return e}function Yr(e){e=e.previousSibling;for(var t=0;e;){if(8===e.nodeType){var n=e.data;if("$"===n||"$!"===n||"$?"===n){if(0===t)return e;t--}else"/$"===n&&t++}e=e.previousSibling}return null}var Kr=0;var Qr=Math.random().toString(36).slice(2),Xr="__reactFiber$"+Qr,Jr="__reactProps$"+Qr,ea="__reactContainer$"+Qr,ta="__reactEvents$"+Qr;function na(e){var t=e[Xr];if(t)return t;for(var n=e.parentNode;n;){if(t=n[ea]||n[Xr]){if(n=t.alternate,null!==t.child||null!==n&&null!==n.child)for(e=Yr(e);null!==e;){if(n=e[Xr])return n;e=Yr(e)}return t}n=(e=n).parentNode}return null}function ra(e){return!(e=e[Xr]||e[ea])||5!==e.tag&&6!==e.tag&&13!==e.tag&&3!==e.tag?null:e}function aa(e){if(5===e.tag||6===e.tag)return e.stateNode;throw Error(i(33))}function oa(e){return e[Jr]||null}function ia(e){var t=e[ta];return void 0===t&&(t=e[ta]=new Set),t}var la=[],sa=-1;function ca(e){return{current:e}}function ua(e){0>sa||(e.current=la[sa],la[sa]=null,sa--)}function da(e,t){sa++,la[sa]=e.current,e.current=t}var pa={},fa=ca(pa),ma=ca(!1),ha=pa;function ga(e,t){var n=e.type.contextTypes;if(!n)return pa;var r=e.stateNode;if(r&&r.__reactInternalMemoizedUnmaskedChildContext===t)return r.__reactInternalMemoizedMaskedChildContext;var a,o={};for(a in n)o[a]=t[a];return r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=t,e.__reactInternalMemoizedMaskedChildContext=o),o}function ba(e){return null!=(e=e.childContextTypes)}function va(){ua(ma),ua(fa)}function ya(e,t,n){if(fa.current!==pa)throw Error(i(168));da(fa,t),da(ma,n)}function wa(e,t,n){var r=e.stateNode;if(e=t.childContextTypes,"function"!=typeof r.getChildContext)return n;for(var o in r=r.getChildContext())if(!(o in e))throw Error(i(108,Z(t)||"Unknown",o));return a({},n,r)}function ka(e){return e=(e=e.stateNode)&&e.__reactInternalMemoizedMergedChildContext||pa,ha=fa.current,da(fa,e),da(ma,ma.current),!0}function Sa(e,t,n){var r=e.stateNode;if(!r)throw Error(i(169));n?(e=wa(e,t,ha),r.__reactInternalMemoizedMergedChildContext=e,ua(ma),ua(fa),da(fa,e)):ua(ma),da(ma,n)}var Ea=null,xa=null,_a=o.unstable_runWithPriority,Ra=o.unstable_scheduleCallback,Ca=o.unstable_cancelCallback,Ta=o.unstable_shouldYield,Oa=o.unstable_requestPaint,Pa=o.unstable_now,Aa=o.unstable_getCurrentPriorityLevel,ja=o.unstable_ImmediatePriority,La=o.unstable_UserBlockingPriority,Na=o.unstable_NormalPriority,Ia=o.unstable_LowPriority,Ma=o.unstable_IdlePriority,Da={},Fa=void 0!==Oa?Oa:function(){},Ba=null,za=null,Ua=!1,$a=Pa(),Ga=1e4>$a?Pa:function(){return Pa()-$a};function Ha(){switch(Aa()){case ja:return 99;case La:return 98;case Na:return 97;case Ia:return 96;case Ma:return 95;default:throw Error(i(332))}}function Va(e){switch(e){case 99:return ja;case 98:return La;case 97:return Na;case 96:return Ia;case 95:return Ma;default:throw Error(i(332))}}function qa(e,t){return e=Va(e),_a(e,t)}function Za(e,t,n){return e=Va(e),Ra(e,t,n)}function Wa(){if(null!==za){var e=za;za=null,Ca(e)}Ya()}function Ya(){if(!Ua&&null!==Ba){Ua=!0;var e=0;try{var t=Ba;qa(99,(function(){for(;e<t.length;e++){var n=t[e];do{n=n(!0)}while(null!==n)}})),Ba=null}catch(n){throw null!==Ba&&(Ba=Ba.slice(e+1)),Ra(ja,Wa),n}finally{Ua=!1}}}var Ka=k.ReactCurrentBatchConfig;function Qa(e,t){if(e&&e.defaultProps){for(var n in t=a({},t),e=e.defaultProps)void 0===t[n]&&(t[n]=e[n]);return t}return t}var Xa=ca(null),Ja=null,eo=null,to=null;function no(){to=eo=Ja=null}function ro(e){var t=Xa.current;ua(Xa),e.type._context._currentValue=t}function ao(e,t){for(;null!==e;){var n=e.alternate;if((e.childLanes&t)===t){if(null===n||(n.childLanes&t)===t)break;n.childLanes|=t}else e.childLanes|=t,null!==n&&(n.childLanes|=t);e=e.return}}function oo(e,t){Ja=e,to=eo=null,null!==(e=e.dependencies)&&null!==e.firstContext&&(0!=(e.lanes&t)&&(Di=!0),e.firstContext=null)}function io(e,t){if(to!==e&&!1!==t&&0!==t)if("number"==typeof t&&1073741823!==t||(to=e,t=1073741823),t={context:e,observedBits:t,next:null},null===eo){if(null===Ja)throw Error(i(308));eo=t,Ja.dependencies={lanes:0,firstContext:t,responders:null}}else eo=eo.next=t;return e._currentValue}var lo=!1;function so(e){e.updateQueue={baseState:e.memoizedState,firstBaseUpdate:null,lastBaseUpdate:null,shared:{pending:null},effects:null}}function co(e,t){e=e.updateQueue,t.updateQueue===e&&(t.updateQueue={baseState:e.baseState,firstBaseUpdate:e.firstBaseUpdate,lastBaseUpdate:e.lastBaseUpdate,shared:e.shared,effects:e.effects})}function uo(e,t){return{eventTime:e,lane:t,tag:0,payload:null,callback:null,next:null}}function po(e,t){if(null!==(e=e.updateQueue)){var n=(e=e.shared).pending;null===n?t.next=t:(t.next=n.next,n.next=t),e.pending=t}}function fo(e,t){var n=e.updateQueue,r=e.alternate;if(null!==r&&n===(r=r.updateQueue)){var a=null,o=null;if(null!==(n=n.firstBaseUpdate)){do{var i={eventTime:n.eventTime,lane:n.lane,tag:n.tag,payload:n.payload,callback:n.callback,next:null};null===o?a=o=i:o=o.next=i,n=n.next}while(null!==n);null===o?a=o=t:o=o.next=t}else a=o=t;return n={baseState:r.baseState,firstBaseUpdate:a,lastBaseUpdate:o,shared:r.shared,effects:r.effects},void(e.updateQueue=n)}null===(e=n.lastBaseUpdate)?n.firstBaseUpdate=t:e.next=t,n.lastBaseUpdate=t}function mo(e,t,n,r){var o=e.updateQueue;lo=!1;var i=o.firstBaseUpdate,l=o.lastBaseUpdate,s=o.shared.pending;if(null!==s){o.shared.pending=null;var c=s,u=c.next;c.next=null,null===l?i=u:l.next=u,l=c;var d=e.alternate;if(null!==d){var p=(d=d.updateQueue).lastBaseUpdate;p!==l&&(null===p?d.firstBaseUpdate=u:p.next=u,d.lastBaseUpdate=c)}}if(null!==i){for(p=o.baseState,l=0,d=u=c=null;;){s=i.lane;var f=i.eventTime;if((r&s)===s){null!==d&&(d=d.next={eventTime:f,lane:0,tag:i.tag,payload:i.payload,callback:i.callback,next:null});e:{var m=e,h=i;switch(s=t,f=n,h.tag){case 1:if("function"==typeof(m=h.payload)){p=m.call(f,p,s);break e}p=m;break e;case 3:m.flags=-4097&m.flags|64;case 0:if(null==(s="function"==typeof(m=h.payload)?m.call(f,p,s):m))break e;p=a({},p,s);break e;case 2:lo=!0}}null!==i.callback&&(e.flags|=32,null===(s=o.effects)?o.effects=[i]:s.push(i))}else f={eventTime:f,lane:s,tag:i.tag,payload:i.payload,callback:i.callback,next:null},null===d?(u=d=f,c=p):d=d.next=f,l|=s;if(null===(i=i.next)){if(null===(s=o.shared.pending))break;i=s.next,s.next=null,o.lastBaseUpdate=s,o.shared.pending=null}}null===d&&(c=p),o.baseState=c,o.firstBaseUpdate=u,o.lastBaseUpdate=d,Ul|=l,e.lanes=l,e.memoizedState=p}}function ho(e,t,n){if(e=t.effects,t.effects=null,null!==e)for(t=0;t<e.length;t++){var r=e[t],a=r.callback;if(null!==a){if(r.callback=null,r=n,"function"!=typeof a)throw Error(i(191,a));a.call(r)}}}var go=(new r.Component).refs;function bo(e,t,n,r){n=null==(n=n(r,t=e.memoizedState))?t:a({},t,n),e.memoizedState=n,0===e.lanes&&(e.updateQueue.baseState=n)}var vo={isMounted:function(e){return!!(e=e._reactInternals)&&Ke(e)===e},enqueueSetState:function(e,t,n){e=e._reactInternals;var r=ps(),a=fs(e),o=uo(r,a);o.payload=t,null!=n&&(o.callback=n),po(e,o),ms(e,a,r)},enqueueReplaceState:function(e,t,n){e=e._reactInternals;var r=ps(),a=fs(e),o=uo(r,a);o.tag=1,o.payload=t,null!=n&&(o.callback=n),po(e,o),ms(e,a,r)},enqueueForceUpdate:function(e,t){e=e._reactInternals;var n=ps(),r=fs(e),a=uo(n,r);a.tag=2,null!=t&&(a.callback=t),po(e,a),ms(e,r,n)}};function yo(e,t,n,r,a,o,i){return"function"==typeof(e=e.stateNode).shouldComponentUpdate?e.shouldComponentUpdate(r,o,i):!t.prototype||!t.prototype.isPureReactComponent||(!pr(n,r)||!pr(a,o))}function wo(e,t,n){var r=!1,a=pa,o=t.contextType;return"object"==typeof o&&null!==o?o=io(o):(a=ba(t)?ha:fa.current,o=(r=null!=(r=t.contextTypes))?ga(e,a):pa),t=new t(n,o),e.memoizedState=null!==t.state&&void 0!==t.state?t.state:null,t.updater=vo,e.stateNode=t,t._reactInternals=e,r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=a,e.__reactInternalMemoizedMaskedChildContext=o),t}function ko(e,t,n,r){e=t.state,"function"==typeof t.componentWillReceiveProps&&t.componentWillReceiveProps(n,r),"function"==typeof t.UNSAFE_componentWillReceiveProps&&t.UNSAFE_componentWillReceiveProps(n,r),t.state!==e&&vo.enqueueReplaceState(t,t.state,null)}function So(e,t,n,r){var a=e.stateNode;a.props=n,a.state=e.memoizedState,a.refs=go,so(e);var o=t.contextType;"object"==typeof o&&null!==o?a.context=io(o):(o=ba(t)?ha:fa.current,a.context=ga(e,o)),mo(e,n,a,r),a.state=e.memoizedState,"function"==typeof(o=t.getDerivedStateFromProps)&&(bo(e,t,o,n),a.state=e.memoizedState),"function"==typeof t.getDerivedStateFromProps||"function"==typeof a.getSnapshotBeforeUpdate||"function"!=typeof a.UNSAFE_componentWillMount&&"function"!=typeof a.componentWillMount||(t=a.state,"function"==typeof a.componentWillMount&&a.componentWillMount(),"function"==typeof a.UNSAFE_componentWillMount&&a.UNSAFE_componentWillMount(),t!==a.state&&vo.enqueueReplaceState(a,a.state,null),mo(e,n,a,r),a.state=e.memoizedState),"function"==typeof a.componentDidMount&&(e.flags|=4)}var Eo=Array.isArray;function xo(e,t,n){if(null!==(e=n.ref)&&"function"!=typeof e&&"object"!=typeof e){if(n._owner){if(n=n._owner){if(1!==n.tag)throw Error(i(309));var r=n.stateNode}if(!r)throw Error(i(147,e));var a=""+e;return null!==t&&null!==t.ref&&"function"==typeof t.ref&&t.ref._stringRef===a?t.ref:(t=function(e){var t=r.refs;t===go&&(t=r.refs={}),null===e?delete t[a]:t[a]=e},t._stringRef=a,t)}if("string"!=typeof e)throw Error(i(284));if(!n._owner)throw Error(i(290,e))}return e}function _o(e,t){if("textarea"!==e.type)throw Error(i(31,"[object Object]"===Object.prototype.toString.call(t)?"object with keys {"+Object.keys(t).join(", ")+"}":t))}function Ro(e){function t(t,n){if(e){var r=t.lastEffect;null!==r?(r.nextEffect=n,t.lastEffect=n):t.firstEffect=t.lastEffect=n,n.nextEffect=null,n.flags=8}}function n(n,r){if(!e)return null;for(;null!==r;)t(n,r),r=r.sibling;return null}function r(e,t){for(e=new Map;null!==t;)null!==t.key?e.set(t.key,t):e.set(t.index,t),t=t.sibling;return e}function a(e,t){return(e=qs(e,t)).index=0,e.sibling=null,e}function o(t,n,r){return t.index=r,e?null!==(r=t.alternate)?(r=r.index)<n?(t.flags=2,n):r:(t.flags=2,n):n}function l(t){return e&&null===t.alternate&&(t.flags=2),t}function s(e,t,n,r){return null===t||6!==t.tag?((t=Ks(n,e.mode,r)).return=e,t):((t=a(t,n)).return=e,t)}function c(e,t,n,r){return null!==t&&t.elementType===n.type?((r=a(t,n.props)).ref=xo(e,t,n),r.return=e,r):((r=Zs(n.type,n.key,n.props,null,e.mode,r)).ref=xo(e,t,n),r.return=e,r)}function u(e,t,n,r){return null===t||4!==t.tag||t.stateNode.containerInfo!==n.containerInfo||t.stateNode.implementation!==n.implementation?((t=Qs(n,e.mode,r)).return=e,t):((t=a(t,n.children||[])).return=e,t)}function d(e,t,n,r,o){return null===t||7!==t.tag?((t=Ws(n,e.mode,r,o)).return=e,t):((t=a(t,n)).return=e,t)}function p(e,t,n){if("string"==typeof t||"number"==typeof t)return(t=Ks(""+t,e.mode,n)).return=e,t;if("object"==typeof t&&null!==t){switch(t.$$typeof){case S:return(n=Zs(t.type,t.key,t.props,null,e.mode,n)).ref=xo(e,null,t),n.return=e,n;case E:return(t=Qs(t,e.mode,n)).return=e,t}if(Eo(t)||$(t))return(t=Ws(t,e.mode,n,null)).return=e,t;_o(e,t)}return null}function f(e,t,n,r){var a=null!==t?t.key:null;if("string"==typeof n||"number"==typeof n)return null!==a?null:s(e,t,""+n,r);if("object"==typeof n&&null!==n){switch(n.$$typeof){case S:return n.key===a?n.type===x?d(e,t,n.props.children,r,a):c(e,t,n,r):null;case E:return n.key===a?u(e,t,n,r):null}if(Eo(n)||$(n))return null!==a?null:d(e,t,n,r,null);_o(e,n)}return null}function m(e,t,n,r,a){if("string"==typeof r||"number"==typeof r)return s(t,e=e.get(n)||null,""+r,a);if("object"==typeof r&&null!==r){switch(r.$$typeof){case S:return e=e.get(null===r.key?n:r.key)||null,r.type===x?d(t,e,r.props.children,a,r.key):c(t,e,r,a);case E:return u(t,e=e.get(null===r.key?n:r.key)||null,r,a)}if(Eo(r)||$(r))return d(t,e=e.get(n)||null,r,a,null);_o(t,r)}return null}function h(a,i,l,s){for(var c=null,u=null,d=i,h=i=0,g=null;null!==d&&h<l.length;h++){d.index>h?(g=d,d=null):g=d.sibling;var b=f(a,d,l[h],s);if(null===b){null===d&&(d=g);break}e&&d&&null===b.alternate&&t(a,d),i=o(b,i,h),null===u?c=b:u.sibling=b,u=b,d=g}if(h===l.length)return n(a,d),c;if(null===d){for(;h<l.length;h++)null!==(d=p(a,l[h],s))&&(i=o(d,i,h),null===u?c=d:u.sibling=d,u=d);return c}for(d=r(a,d);h<l.length;h++)null!==(g=m(d,a,h,l[h],s))&&(e&&null!==g.alternate&&d.delete(null===g.key?h:g.key),i=o(g,i,h),null===u?c=g:u.sibling=g,u=g);return e&&d.forEach((function(e){return t(a,e)})),c}function g(a,l,s,c){var u=$(s);if("function"!=typeof u)throw Error(i(150));if(null==(s=u.call(s)))throw Error(i(151));for(var d=u=null,h=l,g=l=0,b=null,v=s.next();null!==h&&!v.done;g++,v=s.next()){h.index>g?(b=h,h=null):b=h.sibling;var y=f(a,h,v.value,c);if(null===y){null===h&&(h=b);break}e&&h&&null===y.alternate&&t(a,h),l=o(y,l,g),null===d?u=y:d.sibling=y,d=y,h=b}if(v.done)return n(a,h),u;if(null===h){for(;!v.done;g++,v=s.next())null!==(v=p(a,v.value,c))&&(l=o(v,l,g),null===d?u=v:d.sibling=v,d=v);return u}for(h=r(a,h);!v.done;g++,v=s.next())null!==(v=m(h,a,g,v.value,c))&&(e&&null!==v.alternate&&h.delete(null===v.key?g:v.key),l=o(v,l,g),null===d?u=v:d.sibling=v,d=v);return e&&h.forEach((function(e){return t(a,e)})),u}return function(e,r,o,s){var c="object"==typeof o&&null!==o&&o.type===x&&null===o.key;c&&(o=o.props.children);var u="object"==typeof o&&null!==o;if(u)switch(o.$$typeof){case S:e:{for(u=o.key,c=r;null!==c;){if(c.key===u){if(7===c.tag){if(o.type===x){n(e,c.sibling),(r=a(c,o.props.children)).return=e,e=r;break e}}else if(c.elementType===o.type){n(e,c.sibling),(r=a(c,o.props)).ref=xo(e,c,o),r.return=e,e=r;break e}n(e,c);break}t(e,c),c=c.sibling}o.type===x?((r=Ws(o.props.children,e.mode,s,o.key)).return=e,e=r):((s=Zs(o.type,o.key,o.props,null,e.mode,s)).ref=xo(e,r,o),s.return=e,e=s)}return l(e);case E:e:{for(c=o.key;null!==r;){if(r.key===c){if(4===r.tag&&r.stateNode.containerInfo===o.containerInfo&&r.stateNode.implementation===o.implementation){n(e,r.sibling),(r=a(r,o.children||[])).return=e,e=r;break e}n(e,r);break}t(e,r),r=r.sibling}(r=Qs(o,e.mode,s)).return=e,e=r}return l(e)}if("string"==typeof o||"number"==typeof o)return o=""+o,null!==r&&6===r.tag?(n(e,r.sibling),(r=a(r,o)).return=e,e=r):(n(e,r),(r=Ks(o,e.mode,s)).return=e,e=r),l(e);if(Eo(o))return h(e,r,o,s);if($(o))return g(e,r,o,s);if(u&&_o(e,o),void 0===o&&!c)switch(e.tag){case 1:case 22:case 0:case 11:case 15:throw Error(i(152,Z(e.type)||"Component"))}return n(e,r)}}var Co=Ro(!0),To=Ro(!1),Oo={},Po=ca(Oo),Ao=ca(Oo),jo=ca(Oo);function Lo(e){if(e===Oo)throw Error(i(174));return e}function No(e,t){switch(da(jo,t),da(Ao,e),da(Po,Oo),e=t.nodeType){case 9:case 11:t=(t=t.documentElement)?t.namespaceURI:me(null,"");break;default:t=me(t=(e=8===e?t.parentNode:t).namespaceURI||null,e=e.tagName)}ua(Po),da(Po,t)}function Io(){ua(Po),ua(Ao),ua(jo)}function Mo(e){Lo(jo.current);var t=Lo(Po.current),n=me(t,e.type);t!==n&&(da(Ao,e),da(Po,n))}function Do(e){Ao.current===e&&(ua(Po),ua(Ao))}var Fo=ca(0);function Bo(e){for(var t=e;null!==t;){if(13===t.tag){var n=t.memoizedState;if(null!==n&&(null===(n=n.dehydrated)||"$?"===n.data||"$!"===n.data))return t}else if(19===t.tag&&void 0!==t.memoizedProps.revealOrder){if(0!=(64&t.flags))return t}else if(null!==t.child){t.child.return=t,t=t.child;continue}if(t===e)break;for(;null===t.sibling;){if(null===t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}return null}var zo=null,Uo=null,$o=!1;function Go(e,t){var n=Hs(5,null,null,0);n.elementType="DELETED",n.type="DELETED",n.stateNode=t,n.return=e,n.flags=8,null!==e.lastEffect?(e.lastEffect.nextEffect=n,e.lastEffect=n):e.firstEffect=e.lastEffect=n}function Ho(e,t){switch(e.tag){case 5:var n=e.type;return null!==(t=1!==t.nodeType||n.toLowerCase()!==t.nodeName.toLowerCase()?null:t)&&(e.stateNode=t,!0);case 6:return null!==(t=""===e.pendingProps||3!==t.nodeType?null:t)&&(e.stateNode=t,!0);default:return!1}}function Vo(e){if($o){var t=Uo;if(t){var n=t;if(!Ho(e,t)){if(!(t=Wr(n.nextSibling))||!Ho(e,t))return e.flags=-1025&e.flags|2,$o=!1,void(zo=e);Go(zo,n)}zo=e,Uo=Wr(t.firstChild)}else e.flags=-1025&e.flags|2,$o=!1,zo=e}}function qo(e){for(e=e.return;null!==e&&5!==e.tag&&3!==e.tag&&13!==e.tag;)e=e.return;zo=e}function Zo(e){if(e!==zo)return!1;if(!$o)return qo(e),$o=!0,!1;var t=e.type;if(5!==e.tag||"head"!==t&&"body"!==t&&!Hr(t,e.memoizedProps))for(t=Uo;t;)Go(e,t),t=Wr(t.nextSibling);if(qo(e),13===e.tag){if(!(e=null!==(e=e.memoizedState)?e.dehydrated:null))throw Error(i(317));e:{for(e=e.nextSibling,t=0;e;){if(8===e.nodeType){var n=e.data;if("/$"===n){if(0===t){Uo=Wr(e.nextSibling);break e}t--}else"$"!==n&&"$!"!==n&&"$?"!==n||t++}e=e.nextSibling}Uo=null}}else Uo=zo?Wr(e.stateNode.nextSibling):null;return!0}function Wo(){Uo=zo=null,$o=!1}var Yo=[];function Ko(){for(var e=0;e<Yo.length;e++)Yo[e]._workInProgressVersionPrimary=null;Yo.length=0}var Qo=k.ReactCurrentDispatcher,Xo=k.ReactCurrentBatchConfig,Jo=0,ei=null,ti=null,ni=null,ri=!1,ai=!1;function oi(){throw Error(i(321))}function ii(e,t){if(null===t)return!1;for(var n=0;n<t.length&&n<e.length;n++)if(!ur(e[n],t[n]))return!1;return!0}function li(e,t,n,r,a,o){if(Jo=o,ei=t,t.memoizedState=null,t.updateQueue=null,t.lanes=0,Qo.current=null===e||null===e.memoizedState?Li:Ni,e=n(r,a),ai){o=0;do{if(ai=!1,!(25>o))throw Error(i(301));o+=1,ni=ti=null,t.updateQueue=null,Qo.current=Ii,e=n(r,a)}while(ai)}if(Qo.current=ji,t=null!==ti&&null!==ti.next,Jo=0,ni=ti=ei=null,ri=!1,t)throw Error(i(300));return e}function si(){var e={memoizedState:null,baseState:null,baseQueue:null,queue:null,next:null};return null===ni?ei.memoizedState=ni=e:ni=ni.next=e,ni}function ci(){if(null===ti){var e=ei.alternate;e=null!==e?e.memoizedState:null}else e=ti.next;var t=null===ni?ei.memoizedState:ni.next;if(null!==t)ni=t,ti=e;else{if(null===e)throw Error(i(310));e={memoizedState:(ti=e).memoizedState,baseState:ti.baseState,baseQueue:ti.baseQueue,queue:ti.queue,next:null},null===ni?ei.memoizedState=ni=e:ni=ni.next=e}return ni}function ui(e,t){return"function"==typeof t?t(e):t}function di(e){var t=ci(),n=t.queue;if(null===n)throw Error(i(311));n.lastRenderedReducer=e;var r=ti,a=r.baseQueue,o=n.pending;if(null!==o){if(null!==a){var l=a.next;a.next=o.next,o.next=l}r.baseQueue=a=o,n.pending=null}if(null!==a){a=a.next,r=r.baseState;var s=l=o=null,c=a;do{var u=c.lane;if((Jo&u)===u)null!==s&&(s=s.next={lane:0,action:c.action,eagerReducer:c.eagerReducer,eagerState:c.eagerState,next:null}),r=c.eagerReducer===e?c.eagerState:e(r,c.action);else{var d={lane:u,action:c.action,eagerReducer:c.eagerReducer,eagerState:c.eagerState,next:null};null===s?(l=s=d,o=r):s=s.next=d,ei.lanes|=u,Ul|=u}c=c.next}while(null!==c&&c!==a);null===s?o=r:s.next=l,ur(r,t.memoizedState)||(Di=!0),t.memoizedState=r,t.baseState=o,t.baseQueue=s,n.lastRenderedState=r}return[t.memoizedState,n.dispatch]}function pi(e){var t=ci(),n=t.queue;if(null===n)throw Error(i(311));n.lastRenderedReducer=e;var r=n.dispatch,a=n.pending,o=t.memoizedState;if(null!==a){n.pending=null;var l=a=a.next;do{o=e(o,l.action),l=l.next}while(l!==a);ur(o,t.memoizedState)||(Di=!0),t.memoizedState=o,null===t.baseQueue&&(t.baseState=o),n.lastRenderedState=o}return[o,r]}function fi(e,t,n){var r=t._getVersion;r=r(t._source);var a=t._workInProgressVersionPrimary;if(null!==a?e=a===r:(e=e.mutableReadLanes,(e=(Jo&e)===e)&&(t._workInProgressVersionPrimary=r,Yo.push(t))),e)return n(t._source);throw Yo.push(t),Error(i(350))}function mi(e,t,n,r){var a=Ll;if(null===a)throw Error(i(349));var o=t._getVersion,l=o(t._source),s=Qo.current,c=s.useState((function(){return fi(a,t,n)})),u=c[1],d=c[0];c=ni;var p=e.memoizedState,f=p.refs,m=f.getSnapshot,h=p.source;p=p.subscribe;var g=ei;return e.memoizedState={refs:f,source:t,subscribe:r},s.useEffect((function(){f.getSnapshot=n,f.setSnapshot=u;var e=o(t._source);if(!ur(l,e)){e=n(t._source),ur(d,e)||(u(e),e=fs(g),a.mutableReadLanes|=e&a.pendingLanes),e=a.mutableReadLanes,a.entangledLanes|=e;for(var r=a.entanglements,i=e;0<i;){var s=31-Ht(i),c=1<<s;r[s]|=e,i&=~c}}}),[n,t,r]),s.useEffect((function(){return r(t._source,(function(){var e=f.getSnapshot,n=f.setSnapshot;try{n(e(t._source));var r=fs(g);a.mutableReadLanes|=r&a.pendingLanes}catch(o){n((function(){throw o}))}}))}),[t,r]),ur(m,n)&&ur(h,t)&&ur(p,r)||((e={pending:null,dispatch:null,lastRenderedReducer:ui,lastRenderedState:d}).dispatch=u=Ai.bind(null,ei,e),c.queue=e,c.baseQueue=null,d=fi(a,t,n),c.memoizedState=c.baseState=d),d}function hi(e,t,n){return mi(ci(),e,t,n)}function gi(e){var t=si();return"function"==typeof e&&(e=e()),t.memoizedState=t.baseState=e,e=(e=t.queue={pending:null,dispatch:null,lastRenderedReducer:ui,lastRenderedState:e}).dispatch=Ai.bind(null,ei,e),[t.memoizedState,e]}function bi(e,t,n,r){return e={tag:e,create:t,destroy:n,deps:r,next:null},null===(t=ei.updateQueue)?(t={lastEffect:null},ei.updateQueue=t,t.lastEffect=e.next=e):null===(n=t.lastEffect)?t.lastEffect=e.next=e:(r=n.next,n.next=e,e.next=r,t.lastEffect=e),e}function vi(e){return e={current:e},si().memoizedState=e}function yi(){return ci().memoizedState}function wi(e,t,n,r){var a=si();ei.flags|=e,a.memoizedState=bi(1|t,n,void 0,void 0===r?null:r)}function ki(e,t,n,r){var a=ci();r=void 0===r?null:r;var o=void 0;if(null!==ti){var i=ti.memoizedState;if(o=i.destroy,null!==r&&ii(r,i.deps))return void bi(t,n,o,r)}ei.flags|=e,a.memoizedState=bi(1|t,n,o,r)}function Si(e,t){return wi(516,4,e,t)}function Ei(e,t){return ki(516,4,e,t)}function xi(e,t){return ki(4,2,e,t)}function _i(e,t){return"function"==typeof t?(e=e(),t(e),function(){t(null)}):null!=t?(e=e(),t.current=e,function(){t.current=null}):void 0}function Ri(e,t,n){return n=null!=n?n.concat([e]):null,ki(4,2,_i.bind(null,t,e),n)}function Ci(){}function Ti(e,t){var n=ci();t=void 0===t?null:t;var r=n.memoizedState;return null!==r&&null!==t&&ii(t,r[1])?r[0]:(n.memoizedState=[e,t],e)}function Oi(e,t){var n=ci();t=void 0===t?null:t;var r=n.memoizedState;return null!==r&&null!==t&&ii(t,r[1])?r[0]:(e=e(),n.memoizedState=[e,t],e)}function Pi(e,t){var n=Ha();qa(98>n?98:n,(function(){e(!0)})),qa(97<n?97:n,(function(){var n=Xo.transition;Xo.transition=1;try{e(!1),t()}finally{Xo.transition=n}}))}function Ai(e,t,n){var r=ps(),a=fs(e),o={lane:a,action:n,eagerReducer:null,eagerState:null,next:null},i=t.pending;if(null===i?o.next=o:(o.next=i.next,i.next=o),t.pending=o,i=e.alternate,e===ei||null!==i&&i===ei)ai=ri=!0;else{if(0===e.lanes&&(null===i||0===i.lanes)&&null!==(i=t.lastRenderedReducer))try{var l=t.lastRenderedState,s=i(l,n);if(o.eagerReducer=i,o.eagerState=s,ur(s,l))return}catch(c){}ms(e,a,r)}}var ji={readContext:io,useCallback:oi,useContext:oi,useEffect:oi,useImperativeHandle:oi,useLayoutEffect:oi,useMemo:oi,useReducer:oi,useRef:oi,useState:oi,useDebugValue:oi,useDeferredValue:oi,useTransition:oi,useMutableSource:oi,useOpaqueIdentifier:oi,unstable_isNewReconciler:!1},Li={readContext:io,useCallback:function(e,t){return si().memoizedState=[e,void 0===t?null:t],e},useContext:io,useEffect:Si,useImperativeHandle:function(e,t,n){return n=null!=n?n.concat([e]):null,wi(4,2,_i.bind(null,t,e),n)},useLayoutEffect:function(e,t){return wi(4,2,e,t)},useMemo:function(e,t){var n=si();return t=void 0===t?null:t,e=e(),n.memoizedState=[e,t],e},useReducer:function(e,t,n){var r=si();return t=void 0!==n?n(t):t,r.memoizedState=r.baseState=t,e=(e=r.queue={pending:null,dispatch:null,lastRenderedReducer:e,lastRenderedState:t}).dispatch=Ai.bind(null,ei,e),[r.memoizedState,e]},useRef:vi,useState:gi,useDebugValue:Ci,useDeferredValue:function(e){var t=gi(e),n=t[0],r=t[1];return Si((function(){var t=Xo.transition;Xo.transition=1;try{r(e)}finally{Xo.transition=t}}),[e]),n},useTransition:function(){var e=gi(!1),t=e[0];return vi(e=Pi.bind(null,e[1])),[e,t]},useMutableSource:function(e,t,n){var r=si();return r.memoizedState={refs:{getSnapshot:t,setSnapshot:null},source:e,subscribe:n},mi(r,e,t,n)},useOpaqueIdentifier:function(){if($o){var e=!1,t=function(e){return{$$typeof:I,toString:e,valueOf:e}}((function(){throw e||(e=!0,n("r:"+(Kr++).toString(36))),Error(i(355))})),n=gi(t)[1];return 0==(2&ei.mode)&&(ei.flags|=516,bi(5,(function(){n("r:"+(Kr++).toString(36))}),void 0,null)),t}return gi(t="r:"+(Kr++).toString(36)),t},unstable_isNewReconciler:!1},Ni={readContext:io,useCallback:Ti,useContext:io,useEffect:Ei,useImperativeHandle:Ri,useLayoutEffect:xi,useMemo:Oi,useReducer:di,useRef:yi,useState:function(){return di(ui)},useDebugValue:Ci,useDeferredValue:function(e){var t=di(ui),n=t[0],r=t[1];return Ei((function(){var t=Xo.transition;Xo.transition=1;try{r(e)}finally{Xo.transition=t}}),[e]),n},useTransition:function(){var e=di(ui)[0];return[yi().current,e]},useMutableSource:hi,useOpaqueIdentifier:function(){return di(ui)[0]},unstable_isNewReconciler:!1},Ii={readContext:io,useCallback:Ti,useContext:io,useEffect:Ei,useImperativeHandle:Ri,useLayoutEffect:xi,useMemo:Oi,useReducer:pi,useRef:yi,useState:function(){return pi(ui)},useDebugValue:Ci,useDeferredValue:function(e){var t=pi(ui),n=t[0],r=t[1];return Ei((function(){var t=Xo.transition;Xo.transition=1;try{r(e)}finally{Xo.transition=t}}),[e]),n},useTransition:function(){var e=pi(ui)[0];return[yi().current,e]},useMutableSource:hi,useOpaqueIdentifier:function(){return pi(ui)[0]},unstable_isNewReconciler:!1},Mi=k.ReactCurrentOwner,Di=!1;function Fi(e,t,n,r){t.child=null===e?To(t,null,n,r):Co(t,e.child,n,r)}function Bi(e,t,n,r,a){n=n.render;var o=t.ref;return oo(t,a),r=li(e,t,n,r,o,a),null===e||Di?(t.flags|=1,Fi(e,t,r,a),t.child):(t.updateQueue=e.updateQueue,t.flags&=-517,e.lanes&=~a,ol(e,t,a))}function zi(e,t,n,r,a,o){if(null===e){var i=n.type;return"function"!=typeof i||Vs(i)||void 0!==i.defaultProps||null!==n.compare||void 0!==n.defaultProps?((e=Zs(n.type,null,r,t,t.mode,o)).ref=t.ref,e.return=t,t.child=e):(t.tag=15,t.type=i,Ui(e,t,i,r,a,o))}return i=e.child,0==(a&o)&&(a=i.memoizedProps,(n=null!==(n=n.compare)?n:pr)(a,r)&&e.ref===t.ref)?ol(e,t,o):(t.flags|=1,(e=qs(i,r)).ref=t.ref,e.return=t,t.child=e)}function Ui(e,t,n,r,a,o){if(null!==e&&pr(e.memoizedProps,r)&&e.ref===t.ref){if(Di=!1,0==(o&a))return t.lanes=e.lanes,ol(e,t,o);0!=(16384&e.flags)&&(Di=!0)}return Hi(e,t,n,r,o)}function $i(e,t,n){var r=t.pendingProps,a=r.children,o=null!==e?e.memoizedState:null;if("hidden"===r.mode||"unstable-defer-without-hiding"===r.mode)if(0==(4&t.mode))t.memoizedState={baseLanes:0},Ss(t,n);else{if(0==(1073741824&n))return e=null!==o?o.baseLanes|n:n,t.lanes=t.childLanes=1073741824,t.memoizedState={baseLanes:e},Ss(t,e),null;t.memoizedState={baseLanes:0},Ss(t,null!==o?o.baseLanes:n)}else null!==o?(r=o.baseLanes|n,t.memoizedState=null):r=n,Ss(t,r);return Fi(e,t,a,n),t.child}function Gi(e,t){var n=t.ref;(null===e&&null!==n||null!==e&&e.ref!==n)&&(t.flags|=128)}function Hi(e,t,n,r,a){var o=ba(n)?ha:fa.current;return o=ga(t,o),oo(t,a),n=li(e,t,n,r,o,a),null===e||Di?(t.flags|=1,Fi(e,t,n,a),t.child):(t.updateQueue=e.updateQueue,t.flags&=-517,e.lanes&=~a,ol(e,t,a))}function Vi(e,t,n,r,a){if(ba(n)){var o=!0;ka(t)}else o=!1;if(oo(t,a),null===t.stateNode)null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),wo(t,n,r),So(t,n,r,a),r=!0;else if(null===e){var i=t.stateNode,l=t.memoizedProps;i.props=l;var s=i.context,c=n.contextType;"object"==typeof c&&null!==c?c=io(c):c=ga(t,c=ba(n)?ha:fa.current);var u=n.getDerivedStateFromProps,d="function"==typeof u||"function"==typeof i.getSnapshotBeforeUpdate;d||"function"!=typeof i.UNSAFE_componentWillReceiveProps&&"function"!=typeof i.componentWillReceiveProps||(l!==r||s!==c)&&ko(t,i,r,c),lo=!1;var p=t.memoizedState;i.state=p,mo(t,r,i,a),s=t.memoizedState,l!==r||p!==s||ma.current||lo?("function"==typeof u&&(bo(t,n,u,r),s=t.memoizedState),(l=lo||yo(t,n,l,r,p,s,c))?(d||"function"!=typeof i.UNSAFE_componentWillMount&&"function"!=typeof i.componentWillMount||("function"==typeof i.componentWillMount&&i.componentWillMount(),"function"==typeof i.UNSAFE_componentWillMount&&i.UNSAFE_componentWillMount()),"function"==typeof i.componentDidMount&&(t.flags|=4)):("function"==typeof i.componentDidMount&&(t.flags|=4),t.memoizedProps=r,t.memoizedState=s),i.props=r,i.state=s,i.context=c,r=l):("function"==typeof i.componentDidMount&&(t.flags|=4),r=!1)}else{i=t.stateNode,co(e,t),l=t.memoizedProps,c=t.type===t.elementType?l:Qa(t.type,l),i.props=c,d=t.pendingProps,p=i.context,"object"==typeof(s=n.contextType)&&null!==s?s=io(s):s=ga(t,s=ba(n)?ha:fa.current);var f=n.getDerivedStateFromProps;(u="function"==typeof f||"function"==typeof i.getSnapshotBeforeUpdate)||"function"!=typeof i.UNSAFE_componentWillReceiveProps&&"function"!=typeof i.componentWillReceiveProps||(l!==d||p!==s)&&ko(t,i,r,s),lo=!1,p=t.memoizedState,i.state=p,mo(t,r,i,a);var m=t.memoizedState;l!==d||p!==m||ma.current||lo?("function"==typeof f&&(bo(t,n,f,r),m=t.memoizedState),(c=lo||yo(t,n,c,r,p,m,s))?(u||"function"!=typeof i.UNSAFE_componentWillUpdate&&"function"!=typeof i.componentWillUpdate||("function"==typeof i.componentWillUpdate&&i.componentWillUpdate(r,m,s),"function"==typeof i.UNSAFE_componentWillUpdate&&i.UNSAFE_componentWillUpdate(r,m,s)),"function"==typeof i.componentDidUpdate&&(t.flags|=4),"function"==typeof i.getSnapshotBeforeUpdate&&(t.flags|=256)):("function"!=typeof i.componentDidUpdate||l===e.memoizedProps&&p===e.memoizedState||(t.flags|=4),"function"!=typeof i.getSnapshotBeforeUpdate||l===e.memoizedProps&&p===e.memoizedState||(t.flags|=256),t.memoizedProps=r,t.memoizedState=m),i.props=r,i.state=m,i.context=s,r=c):("function"!=typeof i.componentDidUpdate||l===e.memoizedProps&&p===e.memoizedState||(t.flags|=4),"function"!=typeof i.getSnapshotBeforeUpdate||l===e.memoizedProps&&p===e.memoizedState||(t.flags|=256),r=!1)}return qi(e,t,n,r,o,a)}function qi(e,t,n,r,a,o){Gi(e,t);var i=0!=(64&t.flags);if(!r&&!i)return a&&Sa(t,n,!1),ol(e,t,o);r=t.stateNode,Mi.current=t;var l=i&&"function"!=typeof n.getDerivedStateFromError?null:r.render();return t.flags|=1,null!==e&&i?(t.child=Co(t,e.child,null,o),t.child=Co(t,null,l,o)):Fi(e,t,l,o),t.memoizedState=r.state,a&&Sa(t,n,!0),t.child}function Zi(e){var t=e.stateNode;t.pendingContext?ya(0,t.pendingContext,t.pendingContext!==t.context):t.context&&ya(0,t.context,!1),No(e,t.containerInfo)}var Wi,Yi,Ki,Qi={dehydrated:null,retryLane:0};function Xi(e,t,n){var r,a=t.pendingProps,o=Fo.current,i=!1;return(r=0!=(64&t.flags))||(r=(null===e||null!==e.memoizedState)&&0!=(2&o)),r?(i=!0,t.flags&=-65):null!==e&&null===e.memoizedState||void 0===a.fallback||!0===a.unstable_avoidThisFallback||(o|=1),da(Fo,1&o),null===e?(void 0!==a.fallback&&Vo(t),e=a.children,o=a.fallback,i?(e=Ji(t,e,o,n),t.child.memoizedState={baseLanes:n},t.memoizedState=Qi,e):"number"==typeof a.unstable_expectedLoadTime?(e=Ji(t,e,o,n),t.child.memoizedState={baseLanes:n},t.memoizedState=Qi,t.lanes=33554432,e):((n=Ys({mode:"visible",children:e},t.mode,n,null)).return=t,t.child=n)):(e.memoizedState,i?(a=tl(e,t,a.children,a.fallback,n),i=t.child,o=e.child.memoizedState,i.memoizedState=null===o?{baseLanes:n}:{baseLanes:o.baseLanes|n},i.childLanes=e.childLanes&~n,t.memoizedState=Qi,a):(n=el(e,t,a.children,n),t.memoizedState=null,n))}function Ji(e,t,n,r){var a=e.mode,o=e.child;return t={mode:"hidden",children:t},0==(2&a)&&null!==o?(o.childLanes=0,o.pendingProps=t):o=Ys(t,a,0,null),n=Ws(n,a,r,null),o.return=e,n.return=e,o.sibling=n,e.child=o,n}function el(e,t,n,r){var a=e.child;return e=a.sibling,n=qs(a,{mode:"visible",children:n}),0==(2&t.mode)&&(n.lanes=r),n.return=t,n.sibling=null,null!==e&&(e.nextEffect=null,e.flags=8,t.firstEffect=t.lastEffect=e),t.child=n}function tl(e,t,n,r,a){var o=t.mode,i=e.child;e=i.sibling;var l={mode:"hidden",children:n};return 0==(2&o)&&t.child!==i?((n=t.child).childLanes=0,n.pendingProps=l,null!==(i=n.lastEffect)?(t.firstEffect=n.firstEffect,t.lastEffect=i,i.nextEffect=null):t.firstEffect=t.lastEffect=null):n=qs(i,l),null!==e?r=qs(e,r):(r=Ws(r,o,a,null)).flags|=2,r.return=t,n.return=t,n.sibling=r,t.child=n,r}function nl(e,t){e.lanes|=t;var n=e.alternate;null!==n&&(n.lanes|=t),ao(e.return,t)}function rl(e,t,n,r,a,o){var i=e.memoizedState;null===i?e.memoizedState={isBackwards:t,rendering:null,renderingStartTime:0,last:r,tail:n,tailMode:a,lastEffect:o}:(i.isBackwards=t,i.rendering=null,i.renderingStartTime=0,i.last=r,i.tail=n,i.tailMode=a,i.lastEffect=o)}function al(e,t,n){var r=t.pendingProps,a=r.revealOrder,o=r.tail;if(Fi(e,t,r.children,n),0!=(2&(r=Fo.current)))r=1&r|2,t.flags|=64;else{if(null!==e&&0!=(64&e.flags))e:for(e=t.child;null!==e;){if(13===e.tag)null!==e.memoizedState&&nl(e,n);else if(19===e.tag)nl(e,n);else if(null!==e.child){e.child.return=e,e=e.child;continue}if(e===t)break e;for(;null===e.sibling;){if(null===e.return||e.return===t)break e;e=e.return}e.sibling.return=e.return,e=e.sibling}r&=1}if(da(Fo,r),0==(2&t.mode))t.memoizedState=null;else switch(a){case"forwards":for(n=t.child,a=null;null!==n;)null!==(e=n.alternate)&&null===Bo(e)&&(a=n),n=n.sibling;null===(n=a)?(a=t.child,t.child=null):(a=n.sibling,n.sibling=null),rl(t,!1,a,n,o,t.lastEffect);break;case"backwards":for(n=null,a=t.child,t.child=null;null!==a;){if(null!==(e=a.alternate)&&null===Bo(e)){t.child=a;break}e=a.sibling,a.sibling=n,n=a,a=e}rl(t,!0,n,null,o,t.lastEffect);break;case"together":rl(t,!1,null,null,void 0,t.lastEffect);break;default:t.memoizedState=null}return t.child}function ol(e,t,n){if(null!==e&&(t.dependencies=e.dependencies),Ul|=t.lanes,0!=(n&t.childLanes)){if(null!==e&&t.child!==e.child)throw Error(i(153));if(null!==t.child){for(n=qs(e=t.child,e.pendingProps),t.child=n,n.return=t;null!==e.sibling;)e=e.sibling,(n=n.sibling=qs(e,e.pendingProps)).return=t;n.sibling=null}return t.child}return null}function il(e,t){if(!$o)switch(e.tailMode){case"hidden":t=e.tail;for(var n=null;null!==t;)null!==t.alternate&&(n=t),t=t.sibling;null===n?e.tail=null:n.sibling=null;break;case"collapsed":n=e.tail;for(var r=null;null!==n;)null!==n.alternate&&(r=n),n=n.sibling;null===r?t||null===e.tail?e.tail=null:e.tail.sibling=null:r.sibling=null}}function ll(e,t,n){var r=t.pendingProps;switch(t.tag){case 2:case 16:case 15:case 0:case 11:case 7:case 8:case 12:case 9:case 14:return null;case 1:case 17:return ba(t.type)&&va(),null;case 3:return Io(),ua(ma),ua(fa),Ko(),(r=t.stateNode).pendingContext&&(r.context=r.pendingContext,r.pendingContext=null),null!==e&&null!==e.child||(Zo(t)?t.flags|=4:r.hydrate||(t.flags|=256)),null;case 5:Do(t);var o=Lo(jo.current);if(n=t.type,null!==e&&null!=t.stateNode)Yi(e,t,n,r),e.ref!==t.ref&&(t.flags|=128);else{if(!r){if(null===t.stateNode)throw Error(i(166));return null}if(e=Lo(Po.current),Zo(t)){r=t.stateNode,n=t.type;var l=t.memoizedProps;switch(r[Xr]=t,r[Jr]=l,n){case"dialog":Pr("cancel",r),Pr("close",r);break;case"iframe":case"object":case"embed":Pr("load",r);break;case"video":case"audio":for(e=0;e<Rr.length;e++)Pr(Rr[e],r);break;case"source":Pr("error",r);break;case"img":case"image":case"link":Pr("error",r),Pr("load",r);break;case"details":Pr("toggle",r);break;case"input":ee(r,l),Pr("invalid",r);break;case"select":r._wrapperState={wasMultiple:!!l.multiple},Pr("invalid",r);break;case"textarea":se(r,l),Pr("invalid",r)}for(var c in xe(n,l),e=null,l)l.hasOwnProperty(c)&&(o=l[c],"children"===c?"string"==typeof o?r.textContent!==o&&(e=["children",o]):"number"==typeof o&&r.textContent!==""+o&&(e=["children",""+o]):s.hasOwnProperty(c)&&null!=o&&"onScroll"===c&&Pr("scroll",r));switch(n){case"input":K(r),re(r,l,!0);break;case"textarea":K(r),ue(r);break;case"select":case"option":break;default:"function"==typeof l.onClick&&(r.onclick=zr)}r=e,t.updateQueue=r,null!==r&&(t.flags|=4)}else{switch(c=9===o.nodeType?o:o.ownerDocument,e===de&&(e=fe(n)),e===de?"script"===n?((e=c.createElement("div")).innerHTML="<script><\/script>",e=e.removeChild(e.firstChild)):"string"==typeof r.is?e=c.createElement(n,{is:r.is}):(e=c.createElement(n),"select"===n&&(c=e,r.multiple?c.multiple=!0:r.size&&(c.size=r.size))):e=c.createElementNS(e,n),e[Xr]=t,e[Jr]=r,Wi(e,t),t.stateNode=e,c=_e(n,r),n){case"dialog":Pr("cancel",e),Pr("close",e),o=r;break;case"iframe":case"object":case"embed":Pr("load",e),o=r;break;case"video":case"audio":for(o=0;o<Rr.length;o++)Pr(Rr[o],e);o=r;break;case"source":Pr("error",e),o=r;break;case"img":case"image":case"link":Pr("error",e),Pr("load",e),o=r;break;case"details":Pr("toggle",e),o=r;break;case"input":ee(e,r),o=J(e,r),Pr("invalid",e);break;case"option":o=oe(e,r);break;case"select":e._wrapperState={wasMultiple:!!r.multiple},o=a({},r,{value:void 0}),Pr("invalid",e);break;case"textarea":se(e,r),o=le(e,r),Pr("invalid",e);break;default:o=r}xe(n,o);var u=o;for(l in u)if(u.hasOwnProperty(l)){var d=u[l];"style"===l?Se(e,d):"dangerouslySetInnerHTML"===l?null!=(d=d?d.__html:void 0)&&be(e,d):"children"===l?"string"==typeof d?("textarea"!==n||""!==d)&&ve(e,d):"number"==typeof d&&ve(e,""+d):"suppressContentEditableWarning"!==l&&"suppressHydrationWarning"!==l&&"autoFocus"!==l&&(s.hasOwnProperty(l)?null!=d&&"onScroll"===l&&Pr("scroll",e):null!=d&&w(e,l,d,c))}switch(n){case"input":K(e),re(e,r,!1);break;case"textarea":K(e),ue(e);break;case"option":null!=r.value&&e.setAttribute("value",""+W(r.value));break;case"select":e.multiple=!!r.multiple,null!=(l=r.value)?ie(e,!!r.multiple,l,!1):null!=r.defaultValue&&ie(e,!!r.multiple,r.defaultValue,!0);break;default:"function"==typeof o.onClick&&(e.onclick=zr)}Gr(n,r)&&(t.flags|=4)}null!==t.ref&&(t.flags|=128)}return null;case 6:if(e&&null!=t.stateNode)Ki(0,t,e.memoizedProps,r);else{if("string"!=typeof r&&null===t.stateNode)throw Error(i(166));n=Lo(jo.current),Lo(Po.current),Zo(t)?(r=t.stateNode,n=t.memoizedProps,r[Xr]=t,r.nodeValue!==n&&(t.flags|=4)):((r=(9===n.nodeType?n:n.ownerDocument).createTextNode(r))[Xr]=t,t.stateNode=r)}return null;case 13:return ua(Fo),r=t.memoizedState,0!=(64&t.flags)?(t.lanes=n,t):(r=null!==r,n=!1,null===e?void 0!==t.memoizedProps.fallback&&Zo(t):n=null!==e.memoizedState,r&&!n&&0!=(2&t.mode)&&(null===e&&!0!==t.memoizedProps.unstable_avoidThisFallback||0!=(1&Fo.current)?0===Fl&&(Fl=3):(0!==Fl&&3!==Fl||(Fl=4),null===Ll||0==(134217727&Ul)&&0==(134217727&$l)||vs(Ll,Il))),(r||n)&&(t.flags|=4),null);case 4:return Io(),null===e&&jr(t.stateNode.containerInfo),null;case 10:return ro(t),null;case 19:if(ua(Fo),null===(r=t.memoizedState))return null;if(l=0!=(64&t.flags),null===(c=r.rendering))if(l)il(r,!1);else{if(0!==Fl||null!==e&&0!=(64&e.flags))for(e=t.child;null!==e;){if(null!==(c=Bo(e))){for(t.flags|=64,il(r,!1),null!==(l=c.updateQueue)&&(t.updateQueue=l,t.flags|=4),null===r.lastEffect&&(t.firstEffect=null),t.lastEffect=r.lastEffect,r=n,n=t.child;null!==n;)e=r,(l=n).flags&=2,l.nextEffect=null,l.firstEffect=null,l.lastEffect=null,null===(c=l.alternate)?(l.childLanes=0,l.lanes=e,l.child=null,l.memoizedProps=null,l.memoizedState=null,l.updateQueue=null,l.dependencies=null,l.stateNode=null):(l.childLanes=c.childLanes,l.lanes=c.lanes,l.child=c.child,l.memoizedProps=c.memoizedProps,l.memoizedState=c.memoizedState,l.updateQueue=c.updateQueue,l.type=c.type,e=c.dependencies,l.dependencies=null===e?null:{lanes:e.lanes,firstContext:e.firstContext}),n=n.sibling;return da(Fo,1&Fo.current|2),t.child}e=e.sibling}null!==r.tail&&Ga()>ql&&(t.flags|=64,l=!0,il(r,!1),t.lanes=33554432)}else{if(!l)if(null!==(e=Bo(c))){if(t.flags|=64,l=!0,null!==(n=e.updateQueue)&&(t.updateQueue=n,t.flags|=4),il(r,!0),null===r.tail&&"hidden"===r.tailMode&&!c.alternate&&!$o)return null!==(t=t.lastEffect=r.lastEffect)&&(t.nextEffect=null),null}else 2*Ga()-r.renderingStartTime>ql&&1073741824!==n&&(t.flags|=64,l=!0,il(r,!1),t.lanes=33554432);r.isBackwards?(c.sibling=t.child,t.child=c):(null!==(n=r.last)?n.sibling=c:t.child=c,r.last=c)}return null!==r.tail?(n=r.tail,r.rendering=n,r.tail=n.sibling,r.lastEffect=t.lastEffect,r.renderingStartTime=Ga(),n.sibling=null,t=Fo.current,da(Fo,l?1&t|2:1&t),n):null;case 23:case 24:return Es(),null!==e&&null!==e.memoizedState!=(null!==t.memoizedState)&&"unstable-defer-without-hiding"!==r.mode&&(t.flags|=4),null}throw Error(i(156,t.tag))}function sl(e){switch(e.tag){case 1:ba(e.type)&&va();var t=e.flags;return 4096&t?(e.flags=-4097&t|64,e):null;case 3:if(Io(),ua(ma),ua(fa),Ko(),0!=(64&(t=e.flags)))throw Error(i(285));return e.flags=-4097&t|64,e;case 5:return Do(e),null;case 13:return ua(Fo),4096&(t=e.flags)?(e.flags=-4097&t|64,e):null;case 19:return ua(Fo),null;case 4:return Io(),null;case 10:return ro(e),null;case 23:case 24:return Es(),null;default:return null}}function cl(e,t){try{var n="",r=t;do{n+=q(r),r=r.return}while(r);var a=n}catch(o){a="\nError generating stack: "+o.message+"\n"+o.stack}return{value:e,source:t,stack:a}}function ul(e,t){try{console.error(t.value)}catch(n){setTimeout((function(){throw n}))}}Wi=function(e,t){for(var n=t.child;null!==n;){if(5===n.tag||6===n.tag)e.appendChild(n.stateNode);else if(4!==n.tag&&null!==n.child){n.child.return=n,n=n.child;continue}if(n===t)break;for(;null===n.sibling;){if(null===n.return||n.return===t)return;n=n.return}n.sibling.return=n.return,n=n.sibling}},Yi=function(e,t,n,r){var o=e.memoizedProps;if(o!==r){e=t.stateNode,Lo(Po.current);var i,l=null;switch(n){case"input":o=J(e,o),r=J(e,r),l=[];break;case"option":o=oe(e,o),r=oe(e,r),l=[];break;case"select":o=a({},o,{value:void 0}),r=a({},r,{value:void 0}),l=[];break;case"textarea":o=le(e,o),r=le(e,r),l=[];break;default:"function"!=typeof o.onClick&&"function"==typeof r.onClick&&(e.onclick=zr)}for(d in xe(n,r),n=null,o)if(!r.hasOwnProperty(d)&&o.hasOwnProperty(d)&&null!=o[d])if("style"===d){var c=o[d];for(i in c)c.hasOwnProperty(i)&&(n||(n={}),n[i]="")}else"dangerouslySetInnerHTML"!==d&&"children"!==d&&"suppressContentEditableWarning"!==d&&"suppressHydrationWarning"!==d&&"autoFocus"!==d&&(s.hasOwnProperty(d)?l||(l=[]):(l=l||[]).push(d,null));for(d in r){var u=r[d];if(c=null!=o?o[d]:void 0,r.hasOwnProperty(d)&&u!==c&&(null!=u||null!=c))if("style"===d)if(c){for(i in c)!c.hasOwnProperty(i)||u&&u.hasOwnProperty(i)||(n||(n={}),n[i]="");for(i in u)u.hasOwnProperty(i)&&c[i]!==u[i]&&(n||(n={}),n[i]=u[i])}else n||(l||(l=[]),l.push(d,n)),n=u;else"dangerouslySetInnerHTML"===d?(u=u?u.__html:void 0,c=c?c.__html:void 0,null!=u&&c!==u&&(l=l||[]).push(d,u)):"children"===d?"string"!=typeof u&&"number"!=typeof u||(l=l||[]).push(d,""+u):"suppressContentEditableWarning"!==d&&"suppressHydrationWarning"!==d&&(s.hasOwnProperty(d)?(null!=u&&"onScroll"===d&&Pr("scroll",e),l||c===u||(l=[])):"object"==typeof u&&null!==u&&u.$$typeof===I?u.toString():(l=l||[]).push(d,u))}n&&(l=l||[]).push("style",n);var d=l;(t.updateQueue=d)&&(t.flags|=4)}},Ki=function(e,t,n,r){n!==r&&(t.flags|=4)};var dl="function"==typeof WeakMap?WeakMap:Map;function pl(e,t,n){(n=uo(-1,n)).tag=3,n.payload={element:null};var r=t.value;return n.callback=function(){Kl||(Kl=!0,Ql=r),ul(0,t)},n}function fl(e,t,n){(n=uo(-1,n)).tag=3;var r=e.type.getDerivedStateFromError;if("function"==typeof r){var a=t.value;n.payload=function(){return ul(0,t),r(a)}}var o=e.stateNode;return null!==o&&"function"==typeof o.componentDidCatch&&(n.callback=function(){"function"!=typeof r&&(null===Xl?Xl=new Set([this]):Xl.add(this),ul(0,t));var e=t.stack;this.componentDidCatch(t.value,{componentStack:null!==e?e:""})}),n}var ml="function"==typeof WeakSet?WeakSet:Set;function hl(e){var t=e.ref;if(null!==t)if("function"==typeof t)try{t(null)}catch(n){zs(e,n)}else t.current=null}function gl(e,t){switch(t.tag){case 0:case 11:case 15:case 22:case 5:case 6:case 4:case 17:return;case 1:if(256&t.flags&&null!==e){var n=e.memoizedProps,r=e.memoizedState;t=(e=t.stateNode).getSnapshotBeforeUpdate(t.elementType===t.type?n:Qa(t.type,n),r),e.__reactInternalSnapshotBeforeUpdate=t}return;case 3:return void(256&t.flags&&Zr(t.stateNode.containerInfo))}throw Error(i(163))}function bl(e,t,n){switch(n.tag){case 0:case 11:case 15:case 22:if(null!==(t=null!==(t=n.updateQueue)?t.lastEffect:null)){e=t=t.next;do{if(3==(3&e.tag)){var r=e.create;e.destroy=r()}e=e.next}while(e!==t)}if(null!==(t=null!==(t=n.updateQueue)?t.lastEffect:null)){e=t=t.next;do{var a=e;r=a.next,0!=(4&(a=a.tag))&&0!=(1&a)&&(Ds(n,e),Ms(n,e)),e=r}while(e!==t)}return;case 1:return e=n.stateNode,4&n.flags&&(null===t?e.componentDidMount():(r=n.elementType===n.type?t.memoizedProps:Qa(n.type,t.memoizedProps),e.componentDidUpdate(r,t.memoizedState,e.__reactInternalSnapshotBeforeUpdate))),void(null!==(t=n.updateQueue)&&ho(n,t,e));case 3:if(null!==(t=n.updateQueue)){if(e=null,null!==n.child)switch(n.child.tag){case 5:case 1:e=n.child.stateNode}ho(n,t,e)}return;case 5:return e=n.stateNode,void(null===t&&4&n.flags&&Gr(n.type,n.memoizedProps)&&e.focus());case 6:case 4:case 12:case 19:case 17:case 20:case 21:case 23:case 24:return;case 13:return void(null===n.memoizedState&&(n=n.alternate,null!==n&&(n=n.memoizedState,null!==n&&(n=n.dehydrated,null!==n&&St(n)))))}throw Error(i(163))}function vl(e,t){for(var n=e;;){if(5===n.tag){var r=n.stateNode;if(t)"function"==typeof(r=r.style).setProperty?r.setProperty("display","none","important"):r.display="none";else{r=n.stateNode;var a=n.memoizedProps.style;a=null!=a&&a.hasOwnProperty("display")?a.display:null,r.style.display=ke("display",a)}}else if(6===n.tag)n.stateNode.nodeValue=t?"":n.memoizedProps;else if((23!==n.tag&&24!==n.tag||null===n.memoizedState||n===e)&&null!==n.child){n.child.return=n,n=n.child;continue}if(n===e)break;for(;null===n.sibling;){if(null===n.return||n.return===e)return;n=n.return}n.sibling.return=n.return,n=n.sibling}}function yl(e,t){if(xa&&"function"==typeof xa.onCommitFiberUnmount)try{xa.onCommitFiberUnmount(Ea,t)}catch(o){}switch(t.tag){case 0:case 11:case 14:case 15:case 22:if(null!==(e=t.updateQueue)&&null!==(e=e.lastEffect)){var n=e=e.next;do{var r=n,a=r.destroy;if(r=r.tag,void 0!==a)if(0!=(4&r))Ds(t,n);else{r=t;try{a()}catch(o){zs(r,o)}}n=n.next}while(n!==e)}break;case 1:if(hl(t),"function"==typeof(e=t.stateNode).componentWillUnmount)try{e.props=t.memoizedProps,e.state=t.memoizedState,e.componentWillUnmount()}catch(o){zs(t,o)}break;case 5:hl(t);break;case 4:_l(e,t)}}function wl(e){e.alternate=null,e.child=null,e.dependencies=null,e.firstEffect=null,e.lastEffect=null,e.memoizedProps=null,e.memoizedState=null,e.pendingProps=null,e.return=null,e.updateQueue=null}function kl(e){return 5===e.tag||3===e.tag||4===e.tag}function Sl(e){e:{for(var t=e.return;null!==t;){if(kl(t))break e;t=t.return}throw Error(i(160))}var n=t;switch(t=n.stateNode,n.tag){case 5:var r=!1;break;case 3:case 4:t=t.containerInfo,r=!0;break;default:throw Error(i(161))}16&n.flags&&(ve(t,""),n.flags&=-17);e:t:for(n=e;;){for(;null===n.sibling;){if(null===n.return||kl(n.return)){n=null;break e}n=n.return}for(n.sibling.return=n.return,n=n.sibling;5!==n.tag&&6!==n.tag&&18!==n.tag;){if(2&n.flags)continue t;if(null===n.child||4===n.tag)continue t;n.child.return=n,n=n.child}if(!(2&n.flags)){n=n.stateNode;break e}}r?El(e,n,t):xl(e,n,t)}function El(e,t,n){var r=e.tag,a=5===r||6===r;if(a)e=a?e.stateNode:e.stateNode.instance,t?8===n.nodeType?n.parentNode.insertBefore(e,t):n.insertBefore(e,t):(8===n.nodeType?(t=n.parentNode).insertBefore(e,n):(t=n).appendChild(e),null!=(n=n._reactRootContainer)||null!==t.onclick||(t.onclick=zr));else if(4!==r&&null!==(e=e.child))for(El(e,t,n),e=e.sibling;null!==e;)El(e,t,n),e=e.sibling}function xl(e,t,n){var r=e.tag,a=5===r||6===r;if(a)e=a?e.stateNode:e.stateNode.instance,t?n.insertBefore(e,t):n.appendChild(e);else if(4!==r&&null!==(e=e.child))for(xl(e,t,n),e=e.sibling;null!==e;)xl(e,t,n),e=e.sibling}function _l(e,t){for(var n,r,a=t,o=!1;;){if(!o){o=a.return;e:for(;;){if(null===o)throw Error(i(160));switch(n=o.stateNode,o.tag){case 5:r=!1;break e;case 3:case 4:n=n.containerInfo,r=!0;break e}o=o.return}o=!0}if(5===a.tag||6===a.tag){e:for(var l=e,s=a,c=s;;)if(yl(l,c),null!==c.child&&4!==c.tag)c.child.return=c,c=c.child;else{if(c===s)break e;for(;null===c.sibling;){if(null===c.return||c.return===s)break e;c=c.return}c.sibling.return=c.return,c=c.sibling}r?(l=n,s=a.stateNode,8===l.nodeType?l.parentNode.removeChild(s):l.removeChild(s)):n.removeChild(a.stateNode)}else if(4===a.tag){if(null!==a.child){n=a.stateNode.containerInfo,r=!0,a.child.return=a,a=a.child;continue}}else if(yl(e,a),null!==a.child){a.child.return=a,a=a.child;continue}if(a===t)break;for(;null===a.sibling;){if(null===a.return||a.return===t)return;4===(a=a.return).tag&&(o=!1)}a.sibling.return=a.return,a=a.sibling}}function Rl(e,t){switch(t.tag){case 0:case 11:case 14:case 15:case 22:var n=t.updateQueue;if(null!==(n=null!==n?n.lastEffect:null)){var r=n=n.next;do{3==(3&r.tag)&&(e=r.destroy,r.destroy=void 0,void 0!==e&&e()),r=r.next}while(r!==n)}return;case 1:case 12:case 17:return;case 5:if(null!=(n=t.stateNode)){r=t.memoizedProps;var a=null!==e?e.memoizedProps:r;e=t.type;var o=t.updateQueue;if(t.updateQueue=null,null!==o){for(n[Jr]=r,"input"===e&&"radio"===r.type&&null!=r.name&&te(n,r),_e(e,a),t=_e(e,r),a=0;a<o.length;a+=2){var l=o[a],s=o[a+1];"style"===l?Se(n,s):"dangerouslySetInnerHTML"===l?be(n,s):"children"===l?ve(n,s):w(n,l,s,t)}switch(e){case"input":ne(n,r);break;case"textarea":ce(n,r);break;case"select":e=n._wrapperState.wasMultiple,n._wrapperState.wasMultiple=!!r.multiple,null!=(o=r.value)?ie(n,!!r.multiple,o,!1):e!==!!r.multiple&&(null!=r.defaultValue?ie(n,!!r.multiple,r.defaultValue,!0):ie(n,!!r.multiple,r.multiple?[]:"",!1))}}}return;case 6:if(null===t.stateNode)throw Error(i(162));return void(t.stateNode.nodeValue=t.memoizedProps);case 3:return void((n=t.stateNode).hydrate&&(n.hydrate=!1,St(n.containerInfo)));case 13:return null!==t.memoizedState&&(Vl=Ga(),vl(t.child,!0)),void Cl(t);case 19:return void Cl(t);case 23:case 24:return void vl(t,null!==t.memoizedState)}throw Error(i(163))}function Cl(e){var t=e.updateQueue;if(null!==t){e.updateQueue=null;var n=e.stateNode;null===n&&(n=e.stateNode=new ml),t.forEach((function(t){var r=$s.bind(null,e,t);n.has(t)||(n.add(t),t.then(r,r))}))}}function Tl(e,t){return null!==e&&(null===(e=e.memoizedState)||null!==e.dehydrated)&&(null!==(t=t.memoizedState)&&null===t.dehydrated)}var Ol=Math.ceil,Pl=k.ReactCurrentDispatcher,Al=k.ReactCurrentOwner,jl=0,Ll=null,Nl=null,Il=0,Ml=0,Dl=ca(0),Fl=0,Bl=null,zl=0,Ul=0,$l=0,Gl=0,Hl=null,Vl=0,ql=1/0;function Zl(){ql=Ga()+500}var Wl,Yl=null,Kl=!1,Ql=null,Xl=null,Jl=!1,es=null,ts=90,ns=[],rs=[],as=null,os=0,is=null,ls=-1,ss=0,cs=0,us=null,ds=!1;function ps(){return 0!=(48&jl)?Ga():-1!==ls?ls:ls=Ga()}function fs(e){if(0==(2&(e=e.mode)))return 1;if(0==(4&e))return 99===Ha()?1:2;if(0===ss&&(ss=zl),0!==Ka.transition){0!==cs&&(cs=null!==Hl?Hl.pendingLanes:0),e=ss;var t=4186112&~cs;return 0===(t&=-t)&&(0===(t=(e=4186112&~e)&-e)&&(t=8192)),t}return e=Ha(),0!=(4&jl)&&98===e?e=zt(12,ss):e=zt(e=function(e){switch(e){case 99:return 15;case 98:return 10;case 97:case 96:return 8;case 95:return 2;default:return 0}}(e),ss),e}function ms(e,t,n){if(50<os)throw os=0,is=null,Error(i(185));if(null===(e=hs(e,t)))return null;Gt(e,t,n),e===Ll&&($l|=t,4===Fl&&vs(e,Il));var r=Ha();1===t?0!=(8&jl)&&0==(48&jl)?ys(e):(gs(e,n),0===jl&&(Zl(),Wa())):(0==(4&jl)||98!==r&&99!==r||(null===as?as=new Set([e]):as.add(e)),gs(e,n)),Hl=e}function hs(e,t){e.lanes|=t;var n=e.alternate;for(null!==n&&(n.lanes|=t),n=e,e=e.return;null!==e;)e.childLanes|=t,null!==(n=e.alternate)&&(n.childLanes|=t),n=e,e=e.return;return 3===n.tag?n.stateNode:null}function gs(e,t){for(var n=e.callbackNode,r=e.suspendedLanes,a=e.pingedLanes,o=e.expirationTimes,l=e.pendingLanes;0<l;){var s=31-Ht(l),c=1<<s,u=o[s];if(-1===u){if(0==(c&r)||0!=(c&a)){u=t,Dt(c);var d=Mt;o[s]=10<=d?u+250:6<=d?u+5e3:-1}}else u<=t&&(e.expiredLanes|=c);l&=~c}if(r=Ft(e,e===Ll?Il:0),t=Mt,0===r)null!==n&&(n!==Da&&Ca(n),e.callbackNode=null,e.callbackPriority=0);else{if(null!==n){if(e.callbackPriority===t)return;n!==Da&&Ca(n)}15===t?(n=ys.bind(null,e),null===Ba?(Ba=[n],za=Ra(ja,Ya)):Ba.push(n),n=Da):14===t?n=Za(99,ys.bind(null,e)):(n=function(e){switch(e){case 15:case 14:return 99;case 13:case 12:case 11:case 10:return 98;case 9:case 8:case 7:case 6:case 4:case 5:return 97;case 3:case 2:case 1:return 95;case 0:return 90;default:throw Error(i(358,e))}}(t),n=Za(n,bs.bind(null,e))),e.callbackPriority=t,e.callbackNode=n}}function bs(e){if(ls=-1,cs=ss=0,0!=(48&jl))throw Error(i(327));var t=e.callbackNode;if(Is()&&e.callbackNode!==t)return null;var n=Ft(e,e===Ll?Il:0);if(0===n)return null;var r=n,a=jl;jl|=16;var o=Rs();for(Ll===e&&Il===r||(Zl(),xs(e,r));;)try{Os();break}catch(s){_s(e,s)}if(no(),Pl.current=o,jl=a,null!==Nl?r=0:(Ll=null,Il=0,r=Fl),0!=(zl&$l))xs(e,0);else if(0!==r){if(2===r&&(jl|=64,e.hydrate&&(e.hydrate=!1,Zr(e.containerInfo)),0!==(n=Bt(e))&&(r=Cs(e,n))),1===r)throw t=Bl,xs(e,0),vs(e,n),gs(e,Ga()),t;switch(e.finishedWork=e.current.alternate,e.finishedLanes=n,r){case 0:case 1:throw Error(i(345));case 2:case 5:js(e);break;case 3:if(vs(e,n),(62914560&n)===n&&10<(r=Vl+500-Ga())){if(0!==Ft(e,0))break;if(((a=e.suspendedLanes)&n)!==n){ps(),e.pingedLanes|=e.suspendedLanes&a;break}e.timeoutHandle=Vr(js.bind(null,e),r);break}js(e);break;case 4:if(vs(e,n),(4186112&n)===n)break;for(r=e.eventTimes,a=-1;0<n;){var l=31-Ht(n);o=1<<l,(l=r[l])>a&&(a=l),n&=~o}if(n=a,10<(n=(120>(n=Ga()-n)?120:480>n?480:1080>n?1080:1920>n?1920:3e3>n?3e3:4320>n?4320:1960*Ol(n/1960))-n)){e.timeoutHandle=Vr(js.bind(null,e),n);break}js(e);break;default:throw Error(i(329))}}return gs(e,Ga()),e.callbackNode===t?bs.bind(null,e):null}function vs(e,t){for(t&=~Gl,t&=~$l,e.suspendedLanes|=t,e.pingedLanes&=~t,e=e.expirationTimes;0<t;){var n=31-Ht(t),r=1<<n;e[n]=-1,t&=~r}}function ys(e){if(0!=(48&jl))throw Error(i(327));if(Is(),e===Ll&&0!=(e.expiredLanes&Il)){var t=Il,n=Cs(e,t);0!=(zl&$l)&&(n=Cs(e,t=Ft(e,t)))}else n=Cs(e,t=Ft(e,0));if(0!==e.tag&&2===n&&(jl|=64,e.hydrate&&(e.hydrate=!1,Zr(e.containerInfo)),0!==(t=Bt(e))&&(n=Cs(e,t))),1===n)throw n=Bl,xs(e,0),vs(e,t),gs(e,Ga()),n;return e.finishedWork=e.current.alternate,e.finishedLanes=t,js(e),gs(e,Ga()),null}function ws(e,t){var n=jl;jl|=1;try{return e(t)}finally{0===(jl=n)&&(Zl(),Wa())}}function ks(e,t){var n=jl;jl&=-2,jl|=8;try{return e(t)}finally{0===(jl=n)&&(Zl(),Wa())}}function Ss(e,t){da(Dl,Ml),Ml|=t,zl|=t}function Es(){Ml=Dl.current,ua(Dl)}function xs(e,t){e.finishedWork=null,e.finishedLanes=0;var n=e.timeoutHandle;if(-1!==n&&(e.timeoutHandle=-1,qr(n)),null!==Nl)for(n=Nl.return;null!==n;){var r=n;switch(r.tag){case 1:null!=(r=r.type.childContextTypes)&&va();break;case 3:Io(),ua(ma),ua(fa),Ko();break;case 5:Do(r);break;case 4:Io();break;case 13:case 19:ua(Fo);break;case 10:ro(r);break;case 23:case 24:Es()}n=n.return}Ll=e,Nl=qs(e.current,null),Il=Ml=zl=t,Fl=0,Bl=null,Gl=$l=Ul=0}function _s(e,t){for(;;){var n=Nl;try{if(no(),Qo.current=ji,ri){for(var r=ei.memoizedState;null!==r;){var a=r.queue;null!==a&&(a.pending=null),r=r.next}ri=!1}if(Jo=0,ni=ti=ei=null,ai=!1,Al.current=null,null===n||null===n.return){Fl=1,Bl=t,Nl=null;break}e:{var o=e,i=n.return,l=n,s=t;if(t=Il,l.flags|=2048,l.firstEffect=l.lastEffect=null,null!==s&&"object"==typeof s&&"function"==typeof s.then){var c=s;if(0==(2&l.mode)){var u=l.alternate;u?(l.updateQueue=u.updateQueue,l.memoizedState=u.memoizedState,l.lanes=u.lanes):(l.updateQueue=null,l.memoizedState=null)}var d=0!=(1&Fo.current),p=i;do{var f;if(f=13===p.tag){var m=p.memoizedState;if(null!==m)f=null!==m.dehydrated;else{var h=p.memoizedProps;f=void 0!==h.fallback&&(!0!==h.unstable_avoidThisFallback||!d)}}if(f){var g=p.updateQueue;if(null===g){var b=new Set;b.add(c),p.updateQueue=b}else g.add(c);if(0==(2&p.mode)){if(p.flags|=64,l.flags|=16384,l.flags&=-2981,1===l.tag)if(null===l.alternate)l.tag=17;else{var v=uo(-1,1);v.tag=2,po(l,v)}l.lanes|=1;break e}s=void 0,l=t;var y=o.pingCache;if(null===y?(y=o.pingCache=new dl,s=new Set,y.set(c,s)):void 0===(s=y.get(c))&&(s=new Set,y.set(c,s)),!s.has(l)){s.add(l);var w=Us.bind(null,o,c,l);c.then(w,w)}p.flags|=4096,p.lanes=t;break e}p=p.return}while(null!==p);s=Error((Z(l.type)||"A React component")+" suspended while rendering, but no fallback UI was specified.\n\nAdd a <Suspense fallback=...> component higher in the tree to provide a loading indicator or placeholder to display.")}5!==Fl&&(Fl=2),s=cl(s,l),p=i;do{switch(p.tag){case 3:o=s,p.flags|=4096,t&=-t,p.lanes|=t,fo(p,pl(0,o,t));break e;case 1:o=s;var k=p.type,S=p.stateNode;if(0==(64&p.flags)&&("function"==typeof k.getDerivedStateFromError||null!==S&&"function"==typeof S.componentDidCatch&&(null===Xl||!Xl.has(S)))){p.flags|=4096,t&=-t,p.lanes|=t,fo(p,fl(p,o,t));break e}}p=p.return}while(null!==p)}As(n)}catch(E){t=E,Nl===n&&null!==n&&(Nl=n=n.return);continue}break}}function Rs(){var e=Pl.current;return Pl.current=ji,null===e?ji:e}function Cs(e,t){var n=jl;jl|=16;var r=Rs();for(Ll===e&&Il===t||xs(e,t);;)try{Ts();break}catch(a){_s(e,a)}if(no(),jl=n,Pl.current=r,null!==Nl)throw Error(i(261));return Ll=null,Il=0,Fl}function Ts(){for(;null!==Nl;)Ps(Nl)}function Os(){for(;null!==Nl&&!Ta();)Ps(Nl)}function Ps(e){var t=Wl(e.alternate,e,Ml);e.memoizedProps=e.pendingProps,null===t?As(e):Nl=t,Al.current=null}function As(e){var t=e;do{var n=t.alternate;if(e=t.return,0==(2048&t.flags)){if(null!==(n=ll(n,t,Ml)))return void(Nl=n);if(24!==(n=t).tag&&23!==n.tag||null===n.memoizedState||0!=(1073741824&Ml)||0==(4&n.mode)){for(var r=0,a=n.child;null!==a;)r|=a.lanes|a.childLanes,a=a.sibling;n.childLanes=r}null!==e&&0==(2048&e.flags)&&(null===e.firstEffect&&(e.firstEffect=t.firstEffect),null!==t.lastEffect&&(null!==e.lastEffect&&(e.lastEffect.nextEffect=t.firstEffect),e.lastEffect=t.lastEffect),1<t.flags&&(null!==e.lastEffect?e.lastEffect.nextEffect=t:e.firstEffect=t,e.lastEffect=t))}else{if(null!==(n=sl(t)))return n.flags&=2047,void(Nl=n);null!==e&&(e.firstEffect=e.lastEffect=null,e.flags|=2048)}if(null!==(t=t.sibling))return void(Nl=t);Nl=t=e}while(null!==t);0===Fl&&(Fl=5)}function js(e){var t=Ha();return qa(99,Ls.bind(null,e,t)),null}function Ls(e,t){do{Is()}while(null!==es);if(0!=(48&jl))throw Error(i(327));var n=e.finishedWork;if(null===n)return null;if(e.finishedWork=null,e.finishedLanes=0,n===e.current)throw Error(i(177));e.callbackNode=null;var r=n.lanes|n.childLanes,a=r,o=e.pendingLanes&~a;e.pendingLanes=a,e.suspendedLanes=0,e.pingedLanes=0,e.expiredLanes&=a,e.mutableReadLanes&=a,e.entangledLanes&=a,a=e.entanglements;for(var l=e.eventTimes,s=e.expirationTimes;0<o;){var c=31-Ht(o),u=1<<c;a[c]=0,l[c]=-1,s[c]=-1,o&=~u}if(null!==as&&0==(24&r)&&as.has(e)&&as.delete(e),e===Ll&&(Nl=Ll=null,Il=0),1<n.flags?null!==n.lastEffect?(n.lastEffect.nextEffect=n,r=n.firstEffect):r=n:r=n.firstEffect,null!==r){if(a=jl,jl|=32,Al.current=null,Ur=Yt,br(l=gr())){if("selectionStart"in l)s={start:l.selectionStart,end:l.selectionEnd};else e:if(s=(s=l.ownerDocument)&&s.defaultView||window,(u=s.getSelection&&s.getSelection())&&0!==u.rangeCount){s=u.anchorNode,o=u.anchorOffset,c=u.focusNode,u=u.focusOffset;try{s.nodeType,c.nodeType}catch(R){s=null;break e}var d=0,p=-1,f=-1,m=0,h=0,g=l,b=null;t:for(;;){for(var v;g!==s||0!==o&&3!==g.nodeType||(p=d+o),g!==c||0!==u&&3!==g.nodeType||(f=d+u),3===g.nodeType&&(d+=g.nodeValue.length),null!==(v=g.firstChild);)b=g,g=v;for(;;){if(g===l)break t;if(b===s&&++m===o&&(p=d),b===c&&++h===u&&(f=d),null!==(v=g.nextSibling))break;b=(g=b).parentNode}g=v}s=-1===p||-1===f?null:{start:p,end:f}}else s=null;s=s||{start:0,end:0}}else s=null;$r={focusedElem:l,selectionRange:s},Yt=!1,us=null,ds=!1,Yl=r;do{try{Ns()}catch(R){if(null===Yl)throw Error(i(330));zs(Yl,R),Yl=Yl.nextEffect}}while(null!==Yl);us=null,Yl=r;do{try{for(l=e;null!==Yl;){var y=Yl.flags;if(16&y&&ve(Yl.stateNode,""),128&y){var w=Yl.alternate;if(null!==w){var k=w.ref;null!==k&&("function"==typeof k?k(null):k.current=null)}}switch(1038&y){case 2:Sl(Yl),Yl.flags&=-3;break;case 6:Sl(Yl),Yl.flags&=-3,Rl(Yl.alternate,Yl);break;case 1024:Yl.flags&=-1025;break;case 1028:Yl.flags&=-1025,Rl(Yl.alternate,Yl);break;case 4:Rl(Yl.alternate,Yl);break;case 8:_l(l,s=Yl);var S=s.alternate;wl(s),null!==S&&wl(S)}Yl=Yl.nextEffect}}catch(R){if(null===Yl)throw Error(i(330));zs(Yl,R),Yl=Yl.nextEffect}}while(null!==Yl);if(k=$r,w=gr(),y=k.focusedElem,l=k.selectionRange,w!==y&&y&&y.ownerDocument&&hr(y.ownerDocument.documentElement,y)){null!==l&&br(y)&&(w=l.start,void 0===(k=l.end)&&(k=w),"selectionStart"in y?(y.selectionStart=w,y.selectionEnd=Math.min(k,y.value.length)):(k=(w=y.ownerDocument||document)&&w.defaultView||window).getSelection&&(k=k.getSelection(),s=y.textContent.length,S=Math.min(l.start,s),l=void 0===l.end?S:Math.min(l.end,s),!k.extend&&S>l&&(s=l,l=S,S=s),s=mr(y,S),o=mr(y,l),s&&o&&(1!==k.rangeCount||k.anchorNode!==s.node||k.anchorOffset!==s.offset||k.focusNode!==o.node||k.focusOffset!==o.offset)&&((w=w.createRange()).setStart(s.node,s.offset),k.removeAllRanges(),S>l?(k.addRange(w),k.extend(o.node,o.offset)):(w.setEnd(o.node,o.offset),k.addRange(w))))),w=[];for(k=y;k=k.parentNode;)1===k.nodeType&&w.push({element:k,left:k.scrollLeft,top:k.scrollTop});for("function"==typeof y.focus&&y.focus(),y=0;y<w.length;y++)(k=w[y]).element.scrollLeft=k.left,k.element.scrollTop=k.top}Yt=!!Ur,$r=Ur=null,e.current=n,Yl=r;do{try{for(y=e;null!==Yl;){var E=Yl.flags;if(36&E&&bl(y,Yl.alternate,Yl),128&E){w=void 0;var x=Yl.ref;if(null!==x){var _=Yl.stateNode;Yl.tag,w=_,"function"==typeof x?x(w):x.current=w}}Yl=Yl.nextEffect}}catch(R){if(null===Yl)throw Error(i(330));zs(Yl,R),Yl=Yl.nextEffect}}while(null!==Yl);Yl=null,Fa(),jl=a}else e.current=n;if(Jl)Jl=!1,es=e,ts=t;else for(Yl=r;null!==Yl;)t=Yl.nextEffect,Yl.nextEffect=null,8&Yl.flags&&((E=Yl).sibling=null,E.stateNode=null),Yl=t;if(0===(r=e.pendingLanes)&&(Xl=null),1===r?e===is?os++:(os=0,is=e):os=0,n=n.stateNode,xa&&"function"==typeof xa.onCommitFiberRoot)try{xa.onCommitFiberRoot(Ea,n,void 0,64==(64&n.current.flags))}catch(R){}if(gs(e,Ga()),Kl)throw Kl=!1,e=Ql,Ql=null,e;return 0!=(8&jl)||Wa(),null}function Ns(){for(;null!==Yl;){var e=Yl.alternate;ds||null===us||(0!=(8&Yl.flags)?et(Yl,us)&&(ds=!0):13===Yl.tag&&Tl(e,Yl)&&et(Yl,us)&&(ds=!0));var t=Yl.flags;0!=(256&t)&&gl(e,Yl),0==(512&t)||Jl||(Jl=!0,Za(97,(function(){return Is(),null}))),Yl=Yl.nextEffect}}function Is(){if(90!==ts){var e=97<ts?97:ts;return ts=90,qa(e,Fs)}return!1}function Ms(e,t){ns.push(t,e),Jl||(Jl=!0,Za(97,(function(){return Is(),null})))}function Ds(e,t){rs.push(t,e),Jl||(Jl=!0,Za(97,(function(){return Is(),null})))}function Fs(){if(null===es)return!1;var e=es;if(es=null,0!=(48&jl))throw Error(i(331));var t=jl;jl|=32;var n=rs;rs=[];for(var r=0;r<n.length;r+=2){var a=n[r],o=n[r+1],l=a.destroy;if(a.destroy=void 0,"function"==typeof l)try{l()}catch(c){if(null===o)throw Error(i(330));zs(o,c)}}for(n=ns,ns=[],r=0;r<n.length;r+=2){a=n[r],o=n[r+1];try{var s=a.create;a.destroy=s()}catch(c){if(null===o)throw Error(i(330));zs(o,c)}}for(s=e.current.firstEffect;null!==s;)e=s.nextEffect,s.nextEffect=null,8&s.flags&&(s.sibling=null,s.stateNode=null),s=e;return jl=t,Wa(),!0}function Bs(e,t,n){po(e,t=pl(0,t=cl(n,t),1)),t=ps(),null!==(e=hs(e,1))&&(Gt(e,1,t),gs(e,t))}function zs(e,t){if(3===e.tag)Bs(e,e,t);else for(var n=e.return;null!==n;){if(3===n.tag){Bs(n,e,t);break}if(1===n.tag){var r=n.stateNode;if("function"==typeof n.type.getDerivedStateFromError||"function"==typeof r.componentDidCatch&&(null===Xl||!Xl.has(r))){var a=fl(n,e=cl(t,e),1);if(po(n,a),a=ps(),null!==(n=hs(n,1)))Gt(n,1,a),gs(n,a);else if("function"==typeof r.componentDidCatch&&(null===Xl||!Xl.has(r)))try{r.componentDidCatch(t,e)}catch(o){}break}}n=n.return}}function Us(e,t,n){var r=e.pingCache;null!==r&&r.delete(t),t=ps(),e.pingedLanes|=e.suspendedLanes&n,Ll===e&&(Il&n)===n&&(4===Fl||3===Fl&&(62914560&Il)===Il&&500>Ga()-Vl?xs(e,0):Gl|=n),gs(e,t)}function $s(e,t){var n=e.stateNode;null!==n&&n.delete(t),0===(t=0)&&(0==(2&(t=e.mode))?t=1:0==(4&t)?t=99===Ha()?1:2:(0===ss&&(ss=zl),0===(t=Ut(62914560&~ss))&&(t=4194304))),n=ps(),null!==(e=hs(e,t))&&(Gt(e,t,n),gs(e,n))}function Gs(e,t,n,r){this.tag=e,this.key=n,this.sibling=this.child=this.return=this.stateNode=this.type=this.elementType=null,this.index=0,this.ref=null,this.pendingProps=t,this.dependencies=this.memoizedState=this.updateQueue=this.memoizedProps=null,this.mode=r,this.flags=0,this.lastEffect=this.firstEffect=this.nextEffect=null,this.childLanes=this.lanes=0,this.alternate=null}function Hs(e,t,n,r){return new Gs(e,t,n,r)}function Vs(e){return!(!(e=e.prototype)||!e.isReactComponent)}function qs(e,t){var n=e.alternate;return null===n?((n=Hs(e.tag,t,e.key,e.mode)).elementType=e.elementType,n.type=e.type,n.stateNode=e.stateNode,n.alternate=e,e.alternate=n):(n.pendingProps=t,n.type=e.type,n.flags=0,n.nextEffect=null,n.firstEffect=null,n.lastEffect=null),n.childLanes=e.childLanes,n.lanes=e.lanes,n.child=e.child,n.memoizedProps=e.memoizedProps,n.memoizedState=e.memoizedState,n.updateQueue=e.updateQueue,t=e.dependencies,n.dependencies=null===t?null:{lanes:t.lanes,firstContext:t.firstContext},n.sibling=e.sibling,n.index=e.index,n.ref=e.ref,n}function Zs(e,t,n,r,a,o){var l=2;if(r=e,"function"==typeof e)Vs(e)&&(l=1);else if("string"==typeof e)l=5;else e:switch(e){case x:return Ws(n.children,a,o,t);case M:l=8,a|=16;break;case _:l=8,a|=1;break;case R:return(e=Hs(12,n,t,8|a)).elementType=R,e.type=R,e.lanes=o,e;case P:return(e=Hs(13,n,t,a)).type=P,e.elementType=P,e.lanes=o,e;case A:return(e=Hs(19,n,t,a)).elementType=A,e.lanes=o,e;case D:return Ys(n,a,o,t);case F:return(e=Hs(24,n,t,a)).elementType=F,e.lanes=o,e;default:if("object"==typeof e&&null!==e)switch(e.$$typeof){case C:l=10;break e;case T:l=9;break e;case O:l=11;break e;case j:l=14;break e;case L:l=16,r=null;break e;case N:l=22;break e}throw Error(i(130,null==e?e:typeof e,""))}return(t=Hs(l,n,t,a)).elementType=e,t.type=r,t.lanes=o,t}function Ws(e,t,n,r){return(e=Hs(7,e,r,t)).lanes=n,e}function Ys(e,t,n,r){return(e=Hs(23,e,r,t)).elementType=D,e.lanes=n,e}function Ks(e,t,n){return(e=Hs(6,e,null,t)).lanes=n,e}function Qs(e,t,n){return(t=Hs(4,null!==e.children?e.children:[],e.key,t)).lanes=n,t.stateNode={containerInfo:e.containerInfo,pendingChildren:null,implementation:e.implementation},t}function Xs(e,t,n){this.tag=t,this.containerInfo=e,this.finishedWork=this.pingCache=this.current=this.pendingChildren=null,this.timeoutHandle=-1,this.pendingContext=this.context=null,this.hydrate=n,this.callbackNode=null,this.callbackPriority=0,this.eventTimes=$t(0),this.expirationTimes=$t(-1),this.entangledLanes=this.finishedLanes=this.mutableReadLanes=this.expiredLanes=this.pingedLanes=this.suspendedLanes=this.pendingLanes=0,this.entanglements=$t(0),this.mutableSourceEagerHydrationData=null}function Js(e,t,n){var r=3<arguments.length&&void 0!==arguments[3]?arguments[3]:null;return{$$typeof:E,key:null==r?null:""+r,children:e,containerInfo:t,implementation:n}}function ec(e,t,n,r){var a=t.current,o=ps(),l=fs(a);e:if(n){t:{if(Ke(n=n._reactInternals)!==n||1!==n.tag)throw Error(i(170));var s=n;do{switch(s.tag){case 3:s=s.stateNode.context;break t;case 1:if(ba(s.type)){s=s.stateNode.__reactInternalMemoizedMergedChildContext;break t}}s=s.return}while(null!==s);throw Error(i(171))}if(1===n.tag){var c=n.type;if(ba(c)){n=wa(n,c,s);break e}}n=s}else n=pa;return null===t.context?t.context=n:t.pendingContext=n,(t=uo(o,l)).payload={element:e},null!==(r=void 0===r?null:r)&&(t.callback=r),po(a,t),ms(a,l,o),l}function tc(e){return(e=e.current).child?(e.child.tag,e.child.stateNode):null}function nc(e,t){if(null!==(e=e.memoizedState)&&null!==e.dehydrated){var n=e.retryLane;e.retryLane=0!==n&&n<t?n:t}}function rc(e,t){nc(e,t),(e=e.alternate)&&nc(e,t)}function ac(e,t,n){var r=null!=n&&null!=n.hydrationOptions&&n.hydrationOptions.mutableSources||null;if(n=new Xs(e,t,null!=n&&!0===n.hydrate),t=Hs(3,null,null,2===t?7:1===t?3:0),n.current=t,t.stateNode=n,so(t),e[ea]=n.current,jr(8===e.nodeType?e.parentNode:e),r)for(e=0;e<r.length;e++){var a=(t=r[e])._getVersion;a=a(t._source),null==n.mutableSourceEagerHydrationData?n.mutableSourceEagerHydrationData=[t,a]:n.mutableSourceEagerHydrationData.push(t,a)}this._internalRoot=n}function oc(e){return!(!e||1!==e.nodeType&&9!==e.nodeType&&11!==e.nodeType&&(8!==e.nodeType||" react-mount-point-unstable "!==e.nodeValue))}function ic(e,t,n,r,a){var o=n._reactRootContainer;if(o){var i=o._internalRoot;if("function"==typeof a){var l=a;a=function(){var e=tc(i);l.call(e)}}ec(t,i,e,a)}else{if(o=n._reactRootContainer=function(e,t){if(t||(t=!(!(t=e?9===e.nodeType?e.documentElement:e.firstChild:null)||1!==t.nodeType||!t.hasAttribute("data-reactroot"))),!t)for(var n;n=e.lastChild;)e.removeChild(n);return new ac(e,0,t?{hydrate:!0}:void 0)}(n,r),i=o._internalRoot,"function"==typeof a){var s=a;a=function(){var e=tc(i);s.call(e)}}ks((function(){ec(t,i,e,a)}))}return tc(i)}function lc(e,t){var n=2<arguments.length&&void 0!==arguments[2]?arguments[2]:null;if(!oc(t))throw Error(i(200));return Js(e,t,null,n)}Wl=function(e,t,n){var r=t.lanes;if(null!==e)if(e.memoizedProps!==t.pendingProps||ma.current)Di=!0;else{if(0==(n&r)){switch(Di=!1,t.tag){case 3:Zi(t),Wo();break;case 5:Mo(t);break;case 1:ba(t.type)&&ka(t);break;case 4:No(t,t.stateNode.containerInfo);break;case 10:r=t.memoizedProps.value;var a=t.type._context;da(Xa,a._currentValue),a._currentValue=r;break;case 13:if(null!==t.memoizedState)return 0!=(n&t.child.childLanes)?Xi(e,t,n):(da(Fo,1&Fo.current),null!==(t=ol(e,t,n))?t.sibling:null);da(Fo,1&Fo.current);break;case 19:if(r=0!=(n&t.childLanes),0!=(64&e.flags)){if(r)return al(e,t,n);t.flags|=64}if(null!==(a=t.memoizedState)&&(a.rendering=null,a.tail=null,a.lastEffect=null),da(Fo,Fo.current),r)break;return null;case 23:case 24:return t.lanes=0,$i(e,t,n)}return ol(e,t,n)}Di=0!=(16384&e.flags)}else Di=!1;switch(t.lanes=0,t.tag){case 2:if(r=t.type,null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),e=t.pendingProps,a=ga(t,fa.current),oo(t,n),a=li(null,t,r,e,a,n),t.flags|=1,"object"==typeof a&&null!==a&&"function"==typeof a.render&&void 0===a.$$typeof){if(t.tag=1,t.memoizedState=null,t.updateQueue=null,ba(r)){var o=!0;ka(t)}else o=!1;t.memoizedState=null!==a.state&&void 0!==a.state?a.state:null,so(t);var l=r.getDerivedStateFromProps;"function"==typeof l&&bo(t,r,l,e),a.updater=vo,t.stateNode=a,a._reactInternals=t,So(t,r,e,n),t=qi(null,t,r,!0,o,n)}else t.tag=0,Fi(null,t,a,n),t=t.child;return t;case 16:a=t.elementType;e:{switch(null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),e=t.pendingProps,a=(o=a._init)(a._payload),t.type=a,o=t.tag=function(e){if("function"==typeof e)return Vs(e)?1:0;if(null!=e){if((e=e.$$typeof)===O)return 11;if(e===j)return 14}return 2}(a),e=Qa(a,e),o){case 0:t=Hi(null,t,a,e,n);break e;case 1:t=Vi(null,t,a,e,n);break e;case 11:t=Bi(null,t,a,e,n);break e;case 14:t=zi(null,t,a,Qa(a.type,e),r,n);break e}throw Error(i(306,a,""))}return t;case 0:return r=t.type,a=t.pendingProps,Hi(e,t,r,a=t.elementType===r?a:Qa(r,a),n);case 1:return r=t.type,a=t.pendingProps,Vi(e,t,r,a=t.elementType===r?a:Qa(r,a),n);case 3:if(Zi(t),r=t.updateQueue,null===e||null===r)throw Error(i(282));if(r=t.pendingProps,a=null!==(a=t.memoizedState)?a.element:null,co(e,t),mo(t,r,null,n),(r=t.memoizedState.element)===a)Wo(),t=ol(e,t,n);else{if((o=(a=t.stateNode).hydrate)&&(Uo=Wr(t.stateNode.containerInfo.firstChild),zo=t,o=$o=!0),o){if(null!=(e=a.mutableSourceEagerHydrationData))for(a=0;a<e.length;a+=2)(o=e[a])._workInProgressVersionPrimary=e[a+1],Yo.push(o);for(n=To(t,null,r,n),t.child=n;n;)n.flags=-3&n.flags|1024,n=n.sibling}else Fi(e,t,r,n),Wo();t=t.child}return t;case 5:return Mo(t),null===e&&Vo(t),r=t.type,a=t.pendingProps,o=null!==e?e.memoizedProps:null,l=a.children,Hr(r,a)?l=null:null!==o&&Hr(r,o)&&(t.flags|=16),Gi(e,t),Fi(e,t,l,n),t.child;case 6:return null===e&&Vo(t),null;case 13:return Xi(e,t,n);case 4:return No(t,t.stateNode.containerInfo),r=t.pendingProps,null===e?t.child=Co(t,null,r,n):Fi(e,t,r,n),t.child;case 11:return r=t.type,a=t.pendingProps,Bi(e,t,r,a=t.elementType===r?a:Qa(r,a),n);case 7:return Fi(e,t,t.pendingProps,n),t.child;case 8:case 12:return Fi(e,t,t.pendingProps.children,n),t.child;case 10:e:{r=t.type._context,a=t.pendingProps,l=t.memoizedProps,o=a.value;var s=t.type._context;if(da(Xa,s._currentValue),s._currentValue=o,null!==l)if(s=l.value,0===(o=ur(s,o)?0:0|("function"==typeof r._calculateChangedBits?r._calculateChangedBits(s,o):1073741823))){if(l.children===a.children&&!ma.current){t=ol(e,t,n);break e}}else for(null!==(s=t.child)&&(s.return=t);null!==s;){var c=s.dependencies;if(null!==c){l=s.child;for(var u=c.firstContext;null!==u;){if(u.context===r&&0!=(u.observedBits&o)){1===s.tag&&((u=uo(-1,n&-n)).tag=2,po(s,u)),s.lanes|=n,null!==(u=s.alternate)&&(u.lanes|=n),ao(s.return,n),c.lanes|=n;break}u=u.next}}else l=10===s.tag&&s.type===t.type?null:s.child;if(null!==l)l.return=s;else for(l=s;null!==l;){if(l===t){l=null;break}if(null!==(s=l.sibling)){s.return=l.return,l=s;break}l=l.return}s=l}Fi(e,t,a.children,n),t=t.child}return t;case 9:return a=t.type,r=(o=t.pendingProps).children,oo(t,n),r=r(a=io(a,o.unstable_observedBits)),t.flags|=1,Fi(e,t,r,n),t.child;case 14:return o=Qa(a=t.type,t.pendingProps),zi(e,t,a,o=Qa(a.type,o),r,n);case 15:return Ui(e,t,t.type,t.pendingProps,r,n);case 17:return r=t.type,a=t.pendingProps,a=t.elementType===r?a:Qa(r,a),null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),t.tag=1,ba(r)?(e=!0,ka(t)):e=!1,oo(t,n),wo(t,r,a),So(t,r,a,n),qi(null,t,r,!0,e,n);case 19:return al(e,t,n);case 23:case 24:return $i(e,t,n)}throw Error(i(156,t.tag))},ac.prototype.render=function(e){ec(e,this._internalRoot,null,null)},ac.prototype.unmount=function(){var e=this._internalRoot,t=e.containerInfo;ec(null,e,null,(function(){t[ea]=null}))},tt=function(e){13===e.tag&&(ms(e,4,ps()),rc(e,4))},nt=function(e){13===e.tag&&(ms(e,67108864,ps()),rc(e,67108864))},rt=function(e){if(13===e.tag){var t=ps(),n=fs(e);ms(e,n,t),rc(e,n)}},at=function(e,t){return t()},Ce=function(e,t,n){switch(t){case"input":if(ne(e,n),t=n.name,"radio"===n.type&&null!=t){for(n=e;n.parentNode;)n=n.parentNode;for(n=n.querySelectorAll("input[name="+JSON.stringify(""+t)+'][type="radio"]'),t=0;t<n.length;t++){var r=n[t];if(r!==e&&r.form===e.form){var a=oa(r);if(!a)throw Error(i(90));Q(r),ne(r,a)}}}break;case"textarea":ce(e,n);break;case"select":null!=(t=n.value)&&ie(e,!!n.multiple,t,!1)}},Le=ws,Ne=function(e,t,n,r,a){var o=jl;jl|=4;try{return qa(98,e.bind(null,t,n,r,a))}finally{0===(jl=o)&&(Zl(),Wa())}},Ie=function(){0==(49&jl)&&(function(){if(null!==as){var e=as;as=null,e.forEach((function(e){e.expiredLanes|=24&e.pendingLanes,gs(e,Ga())}))}Wa()}(),Is())},Me=function(e,t){var n=jl;jl|=2;try{return e(t)}finally{0===(jl=n)&&(Zl(),Wa())}};var sc={Events:[ra,aa,oa,Ae,je,Is,{current:!1}]},cc={findFiberByHostInstance:na,bundleType:0,version:"17.0.2",rendererPackageName:"react-dom"},uc={bundleType:cc.bundleType,version:cc.version,rendererPackageName:cc.rendererPackageName,rendererConfig:cc.rendererConfig,overrideHookState:null,overrideHookStateDeletePath:null,overrideHookStateRenamePath:null,overrideProps:null,overridePropsDeletePath:null,overridePropsRenamePath:null,setSuspenseHandler:null,scheduleUpdate:null,currentDispatcherRef:k.ReactCurrentDispatcher,findHostInstanceByFiber:function(e){return null===(e=Je(e))?null:e.stateNode},findFiberByHostInstance:cc.findFiberByHostInstance||function(){return null},findHostInstancesForRefresh:null,scheduleRefresh:null,scheduleRoot:null,setRefreshHandler:null,getCurrentFiber:null};if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__){var dc=__REACT_DEVTOOLS_GLOBAL_HOOK__;if(!dc.isDisabled&&dc.supportsFiber)try{Ea=dc.inject(uc),xa=dc}catch(ge){}}t.hydrate=function(e,t,n){if(!oc(t))throw Error(i(200));return ic(null,e,t,!0,n)}},3935:(e,t,n)=>{"use strict";!function e(){if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__&&"function"==typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE)try{__REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE(e)}catch(t){console.error(t)}}(),e.exports=n(4448)},9590:e=>{var t="undefined"!=typeof Element,n="function"==typeof Map,r="function"==typeof Set,a="function"==typeof ArrayBuffer&&!!ArrayBuffer.isView;function o(e,i){if(e===i)return!0;if(e&&i&&"object"==typeof e&&"object"==typeof i){if(e.constructor!==i.constructor)return!1;var l,s,c,u;if(Array.isArray(e)){if((l=e.length)!=i.length)return!1;for(s=l;0!=s--;)if(!o(e[s],i[s]))return!1;return!0}if(n&&e instanceof Map&&i instanceof Map){if(e.size!==i.size)return!1;for(u=e.entries();!(s=u.next()).done;)if(!i.has(s.value[0]))return!1;for(u=e.entries();!(s=u.next()).done;)if(!o(s.value[1],i.get(s.value[0])))return!1;return!0}if(r&&e instanceof Set&&i instanceof Set){if(e.size!==i.size)return!1;for(u=e.entries();!(s=u.next()).done;)if(!i.has(s.value[0]))return!1;return!0}if(a&&ArrayBuffer.isView(e)&&ArrayBuffer.isView(i)){if((l=e.length)!=i.length)return!1;for(s=l;0!=s--;)if(e[s]!==i[s])return!1;return!0}if(e.constructor===RegExp)return e.source===i.source&&e.flags===i.flags;if(e.valueOf!==Object.prototype.valueOf)return e.valueOf()===i.valueOf();if(e.toString!==Object.prototype.toString)return e.toString()===i.toString();if((l=(c=Object.keys(e)).length)!==Object.keys(i).length)return!1;for(s=l;0!=s--;)if(!Object.prototype.hasOwnProperty.call(i,c[s]))return!1;if(t&&e instanceof Element)return!1;for(s=l;0!=s--;)if(("_owner"!==c[s]&&"__v"!==c[s]&&"__o"!==c[s]||!e.$$typeof)&&!o(e[c[s]],i[c[s]]))return!1;return!0}return e!=e&&i!=i}e.exports=function(e,t){try{return o(e,t)}catch(n){if((n.message||"").match(/stack|recursion/i))return console.warn("react-fast-compare cannot handle circular refs"),!1;throw n}}},405:(e,t,n)=>{"use strict";n.d(t,{B6:()=>V,ql:()=>J});var r=n(7294),a=n(5697),o=n.n(a),i=n(9590),l=n.n(i),s=n(1143),c=n.n(s),u=n(6774),d=n.n(u);function p(){return p=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},p.apply(this,arguments)}function f(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,m(e,t)}function m(e,t){return m=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},m(e,t)}function h(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)t.indexOf(n=o[r])>=0||(a[n]=e[n]);return a}var g={BASE:"base",BODY:"body",HEAD:"head",HTML:"html",LINK:"link",META:"meta",NOSCRIPT:"noscript",SCRIPT:"script",STYLE:"style",TITLE:"title",FRAGMENT:"Symbol(react.fragment)"},b={rel:["amphtml","canonical","alternate"]},v={type:["application/ld+json"]},y={charset:"",name:["robots","description"],property:["og:type","og:title","og:url","og:image","og:image:alt","og:description","twitter:url","twitter:title","twitter:description","twitter:image","twitter:image:alt","twitter:card","twitter:site"]},w=Object.keys(g).map((function(e){return g[e]})),k={accesskey:"accessKey",charset:"charSet",class:"className",contenteditable:"contentEditable",contextmenu:"contextMenu","http-equiv":"httpEquiv",itemprop:"itemProp",tabindex:"tabIndex"},S=Object.keys(k).reduce((function(e,t){return e[k[t]]=t,e}),{}),E=function(e,t){for(var n=e.length-1;n>=0;n-=1){var r=e[n];if(Object.prototype.hasOwnProperty.call(r,t))return r[t]}return null},x=function(e){var t=E(e,g.TITLE),n=E(e,"titleTemplate");if(Array.isArray(t)&&(t=t.join("")),n&&t)return n.replace(/%s/g,(function(){return t}));var r=E(e,"defaultTitle");return t||r||void 0},_=function(e){return E(e,"onChangeClientState")||function(){}},R=function(e,t){return t.filter((function(t){return void 0!==t[e]})).map((function(t){return t[e]})).reduce((function(e,t){return p({},e,t)}),{})},C=function(e,t){return t.filter((function(e){return void 0!==e[g.BASE]})).map((function(e){return e[g.BASE]})).reverse().reduce((function(t,n){if(!t.length)for(var r=Object.keys(n),a=0;a<r.length;a+=1){var o=r[a].toLowerCase();if(-1!==e.indexOf(o)&&n[o])return t.concat(n)}return t}),[])},T=function(e,t,n){var r={};return n.filter((function(t){return!!Array.isArray(t[e])||(void 0!==t[e]&&console&&"function"==typeof console.warn&&console.warn("Helmet: "+e+' should be of type "Array". Instead found type "'+typeof t[e]+'"'),!1)})).map((function(t){return t[e]})).reverse().reduce((function(e,n){var a={};n.filter((function(e){for(var n,o=Object.keys(e),i=0;i<o.length;i+=1){var l=o[i],s=l.toLowerCase();-1===t.indexOf(s)||"rel"===n&&"canonical"===e[n].toLowerCase()||"rel"===s&&"stylesheet"===e[s].toLowerCase()||(n=s),-1===t.indexOf(l)||"innerHTML"!==l&&"cssText"!==l&&"itemprop"!==l||(n=l)}if(!n||!e[n])return!1;var c=e[n].toLowerCase();return r[n]||(r[n]={}),a[n]||(a[n]={}),!r[n][c]&&(a[n][c]=!0,!0)})).reverse().forEach((function(t){return e.push(t)}));for(var o=Object.keys(a),i=0;i<o.length;i+=1){var l=o[i],s=p({},r[l],a[l]);r[l]=s}return e}),[]).reverse()},O=function(e,t){if(Array.isArray(e)&&e.length)for(var n=0;n<e.length;n+=1)if(e[n][t])return!0;return!1},P=function(e){return Array.isArray(e)?e.join(""):e},A=function(e,t){return Array.isArray(e)?e.reduce((function(e,n){return function(e,t){for(var n=Object.keys(e),r=0;r<n.length;r+=1)if(t[n[r]]&&t[n[r]].includes(e[n[r]]))return!0;return!1}(n,t)?e.priority.push(n):e.default.push(n),e}),{priority:[],default:[]}):{default:e}},j=function(e,t){var n;return p({},e,((n={})[t]=void 0,n))},L=[g.NOSCRIPT,g.SCRIPT,g.STYLE],N=function(e,t){return void 0===t&&(t=!0),!1===t?String(e):String(e).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'")},I=function(e){return Object.keys(e).reduce((function(t,n){var r=void 0!==e[n]?n+'="'+e[n]+'"':""+n;return t?t+" "+r:r}),"")},M=function(e,t){return void 0===t&&(t={}),Object.keys(e).reduce((function(t,n){return t[k[n]||n]=e[n],t}),t)},D=function(e,t){return t.map((function(t,n){var a,o=((a={key:n})["data-rh"]=!0,a);return Object.keys(t).forEach((function(e){var n=k[e]||e;"innerHTML"===n||"cssText"===n?o.dangerouslySetInnerHTML={__html:t.innerHTML||t.cssText}:o[n]=t[e]})),r.createElement(e,o)}))},F=function(e,t,n){switch(e){case g.TITLE:return{toComponent:function(){return n=t.titleAttributes,(a={key:e=t.title})["data-rh"]=!0,o=M(n,a),[r.createElement(g.TITLE,o,e)];var e,n,a,o},toString:function(){return function(e,t,n,r){var a=I(n),o=P(t);return a?"<"+e+' data-rh="true" '+a+">"+N(o,r)+"</"+e+">":"<"+e+' data-rh="true">'+N(o,r)+"</"+e+">"}(e,t.title,t.titleAttributes,n)}};case"bodyAttributes":case"htmlAttributes":return{toComponent:function(){return M(t)},toString:function(){return I(t)}};default:return{toComponent:function(){return D(e,t)},toString:function(){return function(e,t,n){return t.reduce((function(t,r){var a=Object.keys(r).filter((function(e){return!("innerHTML"===e||"cssText"===e)})).reduce((function(e,t){var a=void 0===r[t]?t:t+'="'+N(r[t],n)+'"';return e?e+" "+a:a}),""),o=r.innerHTML||r.cssText||"",i=-1===L.indexOf(e);return t+"<"+e+' data-rh="true" '+a+(i?"/>":">"+o+"</"+e+">")}),"")}(e,t,n)}}}},B=function(e){var t=e.baseTag,n=e.bodyAttributes,r=e.encode,a=e.htmlAttributes,o=e.noscriptTags,i=e.styleTags,l=e.title,s=void 0===l?"":l,c=e.titleAttributes,u=e.linkTags,d=e.metaTags,p=e.scriptTags,f={toComponent:function(){},toString:function(){return""}};if(e.prioritizeSeoTags){var m=function(e){var t=e.linkTags,n=e.scriptTags,r=e.encode,a=A(e.metaTags,y),o=A(t,b),i=A(n,v);return{priorityMethods:{toComponent:function(){return[].concat(D(g.META,a.priority),D(g.LINK,o.priority),D(g.SCRIPT,i.priority))},toString:function(){return F(g.META,a.priority,r)+" "+F(g.LINK,o.priority,r)+" "+F(g.SCRIPT,i.priority,r)}},metaTags:a.default,linkTags:o.default,scriptTags:i.default}}(e);f=m.priorityMethods,u=m.linkTags,d=m.metaTags,p=m.scriptTags}return{priority:f,base:F(g.BASE,t,r),bodyAttributes:F("bodyAttributes",n,r),htmlAttributes:F("htmlAttributes",a,r),link:F(g.LINK,u,r),meta:F(g.META,d,r),noscript:F(g.NOSCRIPT,o,r),script:F(g.SCRIPT,p,r),style:F(g.STYLE,i,r),title:F(g.TITLE,{title:s,titleAttributes:c},r)}},z=[],U=function(e,t){var n=this;void 0===t&&(t="undefined"!=typeof document),this.instances=[],this.value={setHelmet:function(e){n.context.helmet=e},helmetInstances:{get:function(){return n.canUseDOM?z:n.instances},add:function(e){(n.canUseDOM?z:n.instances).push(e)},remove:function(e){var t=(n.canUseDOM?z:n.instances).indexOf(e);(n.canUseDOM?z:n.instances).splice(t,1)}}},this.context=e,this.canUseDOM=t,t||(e.helmet=B({baseTag:[],bodyAttributes:{},encodeSpecialCharacters:!0,htmlAttributes:{},linkTags:[],metaTags:[],noscriptTags:[],scriptTags:[],styleTags:[],title:"",titleAttributes:{}}))},$=r.createContext({}),G=o().shape({setHelmet:o().func,helmetInstances:o().shape({get:o().func,add:o().func,remove:o().func})}),H="undefined"!=typeof document,V=function(e){function t(n){var r;return(r=e.call(this,n)||this).helmetData=new U(r.props.context,t.canUseDOM),r}return f(t,e),t.prototype.render=function(){return r.createElement($.Provider,{value:this.helmetData.value},this.props.children)},t}(r.Component);V.canUseDOM=H,V.propTypes={context:o().shape({helmet:o().shape()}),children:o().node.isRequired},V.defaultProps={context:{}},V.displayName="HelmetProvider";var q=function(e,t){var n,r=document.head||document.querySelector(g.HEAD),a=r.querySelectorAll(e+"[data-rh]"),o=[].slice.call(a),i=[];return t&&t.length&&t.forEach((function(t){var r=document.createElement(e);for(var a in t)Object.prototype.hasOwnProperty.call(t,a)&&("innerHTML"===a?r.innerHTML=t.innerHTML:"cssText"===a?r.styleSheet?r.styleSheet.cssText=t.cssText:r.appendChild(document.createTextNode(t.cssText)):r.setAttribute(a,void 0===t[a]?"":t[a]));r.setAttribute("data-rh","true"),o.some((function(e,t){return n=t,r.isEqualNode(e)}))?o.splice(n,1):i.push(r)})),o.forEach((function(e){return e.parentNode.removeChild(e)})),i.forEach((function(e){return r.appendChild(e)})),{oldTags:o,newTags:i}},Z=function(e,t){var n=document.getElementsByTagName(e)[0];if(n){for(var r=n.getAttribute("data-rh"),a=r?r.split(","):[],o=[].concat(a),i=Object.keys(t),l=0;l<i.length;l+=1){var s=i[l],c=t[s]||"";n.getAttribute(s)!==c&&n.setAttribute(s,c),-1===a.indexOf(s)&&a.push(s);var u=o.indexOf(s);-1!==u&&o.splice(u,1)}for(var d=o.length-1;d>=0;d-=1)n.removeAttribute(o[d]);a.length===o.length?n.removeAttribute("data-rh"):n.getAttribute("data-rh")!==i.join(",")&&n.setAttribute("data-rh",i.join(","))}},W=function(e,t){var n=e.baseTag,r=e.htmlAttributes,a=e.linkTags,o=e.metaTags,i=e.noscriptTags,l=e.onChangeClientState,s=e.scriptTags,c=e.styleTags,u=e.title,d=e.titleAttributes;Z(g.BODY,e.bodyAttributes),Z(g.HTML,r),function(e,t){void 0!==e&&document.title!==e&&(document.title=P(e)),Z(g.TITLE,t)}(u,d);var p={baseTag:q(g.BASE,n),linkTags:q(g.LINK,a),metaTags:q(g.META,o),noscriptTags:q(g.NOSCRIPT,i),scriptTags:q(g.SCRIPT,s),styleTags:q(g.STYLE,c)},f={},m={};Object.keys(p).forEach((function(e){var t=p[e],n=t.newTags,r=t.oldTags;n.length&&(f[e]=n),r.length&&(m[e]=p[e].oldTags)})),t&&t(),l(e,f,m)},Y=null,K=function(e){function t(){for(var t,n=arguments.length,r=new Array(n),a=0;a<n;a++)r[a]=arguments[a];return(t=e.call.apply(e,[this].concat(r))||this).rendered=!1,t}f(t,e);var n=t.prototype;return n.shouldComponentUpdate=function(e){return!d()(e,this.props)},n.componentDidUpdate=function(){this.emitChange()},n.componentWillUnmount=function(){this.props.context.helmetInstances.remove(this),this.emitChange()},n.emitChange=function(){var e,t,n=this.props.context,r=n.setHelmet,a=null,o=(e=n.helmetInstances.get().map((function(e){var t=p({},e.props);return delete t.context,t})),{baseTag:C(["href"],e),bodyAttributes:R("bodyAttributes",e),defer:E(e,"defer"),encode:E(e,"encodeSpecialCharacters"),htmlAttributes:R("htmlAttributes",e),linkTags:T(g.LINK,["rel","href"],e),metaTags:T(g.META,["name","charset","http-equiv","property","itemprop"],e),noscriptTags:T(g.NOSCRIPT,["innerHTML"],e),onChangeClientState:_(e),scriptTags:T(g.SCRIPT,["src","innerHTML"],e),styleTags:T(g.STYLE,["cssText"],e),title:x(e),titleAttributes:R("titleAttributes",e),prioritizeSeoTags:O(e,"prioritizeSeoTags")});V.canUseDOM?(t=o,Y&&cancelAnimationFrame(Y),t.defer?Y=requestAnimationFrame((function(){W(t,(function(){Y=null}))})):(W(t),Y=null)):B&&(a=B(o)),r(a)},n.init=function(){this.rendered||(this.rendered=!0,this.props.context.helmetInstances.add(this),this.emitChange())},n.render=function(){return this.init(),null},t}(r.Component);K.propTypes={context:G.isRequired},K.displayName="HelmetDispatcher";var Q=["children"],X=["children"],J=function(e){function t(){return e.apply(this,arguments)||this}f(t,e);var n=t.prototype;return n.shouldComponentUpdate=function(e){return!l()(j(this.props,"helmetData"),j(e,"helmetData"))},n.mapNestedChildrenToProps=function(e,t){if(!t)return null;switch(e.type){case g.SCRIPT:case g.NOSCRIPT:return{innerHTML:t};case g.STYLE:return{cssText:t};default:throw new Error("<"+e.type+" /> elements are self-closing and can not contain children. Refer to our API for more information.")}},n.flattenArrayTypeChildren=function(e){var t,n=e.child,r=e.arrayTypeChildren;return p({},r,((t={})[n.type]=[].concat(r[n.type]||[],[p({},e.newChildProps,this.mapNestedChildrenToProps(n,e.nestedChildren))]),t))},n.mapObjectTypeChildren=function(e){var t,n,r=e.child,a=e.newProps,o=e.newChildProps,i=e.nestedChildren;switch(r.type){case g.TITLE:return p({},a,((t={})[r.type]=i,t.titleAttributes=p({},o),t));case g.BODY:return p({},a,{bodyAttributes:p({},o)});case g.HTML:return p({},a,{htmlAttributes:p({},o)});default:return p({},a,((n={})[r.type]=p({},o),n))}},n.mapArrayTypeChildrenToProps=function(e,t){var n=p({},t);return Object.keys(e).forEach((function(t){var r;n=p({},n,((r={})[t]=e[t],r))})),n},n.warnOnInvalidChildren=function(e,t){return c()(w.some((function(t){return e.type===t})),"function"==typeof e.type?"You may be attempting to nest <Helmet> components within each other, which is not allowed. Refer to our API for more information.":"Only elements types "+w.join(", ")+" are allowed. Helmet does not support rendering <"+e.type+"> elements. Refer to our API for more information."),c()(!t||"string"==typeof t||Array.isArray(t)&&!t.some((function(e){return"string"!=typeof e})),"Helmet expects a string as a child of <"+e.type+">. Did you forget to wrap your children in braces? ( <"+e.type+">{``}</"+e.type+"> ) Refer to our API for more information."),!0},n.mapChildrenToProps=function(e,t){var n=this,a={};return r.Children.forEach(e,(function(e){if(e&&e.props){var r=e.props,o=r.children,i=h(r,Q),l=Object.keys(i).reduce((function(e,t){return e[S[t]||t]=i[t],e}),{}),s=e.type;switch("symbol"==typeof s?s=s.toString():n.warnOnInvalidChildren(e,o),s){case g.FRAGMENT:t=n.mapChildrenToProps(o,t);break;case g.LINK:case g.META:case g.NOSCRIPT:case g.SCRIPT:case g.STYLE:a=n.flattenArrayTypeChildren({child:e,arrayTypeChildren:a,newChildProps:l,nestedChildren:o});break;default:t=n.mapObjectTypeChildren({child:e,newProps:t,newChildProps:l,nestedChildren:o})}}})),this.mapArrayTypeChildrenToProps(a,t)},n.render=function(){var e=this.props,t=e.children,n=h(e,X),a=p({},n),o=n.helmetData;return t&&(a=this.mapChildrenToProps(t,a)),!o||o instanceof U||(o=new U(o.context,o.instances)),o?r.createElement(K,p({},a,{context:o.value,helmetData:void 0})):r.createElement($.Consumer,null,(function(e){return r.createElement(K,p({},a,{context:e}))}))},t}(r.Component);J.propTypes={base:o().object,bodyAttributes:o().object,children:o().oneOfType([o().arrayOf(o().node),o().node]),defaultTitle:o().string,defer:o().bool,encodeSpecialCharacters:o().bool,htmlAttributes:o().object,link:o().arrayOf(o().object),meta:o().arrayOf(o().object),noscript:o().arrayOf(o().object),onChangeClientState:o().func,script:o().arrayOf(o().object),style:o().arrayOf(o().object),title:o().string,titleAttributes:o().object,titleTemplate:o().string,prioritizeSeoTags:o().bool,helmetData:o().object},J.defaultProps={defer:!0,encodeSpecialCharacters:!0,prioritizeSeoTags:!1},J.displayName="Helmet"},9921:(e,t)=>{"use strict";var n="function"==typeof Symbol&&Symbol.for,r=n?Symbol.for("react.element"):60103,a=n?Symbol.for("react.portal"):60106,o=n?Symbol.for("react.fragment"):60107,i=n?Symbol.for("react.strict_mode"):60108,l=n?Symbol.for("react.profiler"):60114,s=n?Symbol.for("react.provider"):60109,c=n?Symbol.for("react.context"):60110,u=n?Symbol.for("react.async_mode"):60111,d=n?Symbol.for("react.concurrent_mode"):60111,p=n?Symbol.for("react.forward_ref"):60112,f=n?Symbol.for("react.suspense"):60113,m=n?Symbol.for("react.suspense_list"):60120,h=n?Symbol.for("react.memo"):60115,g=n?Symbol.for("react.lazy"):60116,b=n?Symbol.for("react.block"):60121,v=n?Symbol.for("react.fundamental"):60117,y=n?Symbol.for("react.responder"):60118,w=n?Symbol.for("react.scope"):60119;function k(e){if("object"==typeof e&&null!==e){var t=e.$$typeof;switch(t){case r:switch(e=e.type){case u:case d:case o:case l:case i:case f:return e;default:switch(e=e&&e.$$typeof){case c:case p:case g:case h:case s:return e;default:return t}}case a:return t}}}function S(e){return k(e)===d}t.AsyncMode=u,t.ConcurrentMode=d,t.ContextConsumer=c,t.ContextProvider=s,t.Element=r,t.ForwardRef=p,t.Fragment=o,t.Lazy=g,t.Memo=h,t.Portal=a,t.Profiler=l,t.StrictMode=i,t.Suspense=f,t.isAsyncMode=function(e){return S(e)||k(e)===u},t.isConcurrentMode=S,t.isContextConsumer=function(e){return k(e)===c},t.isContextProvider=function(e){return k(e)===s},t.isElement=function(e){return"object"==typeof e&&null!==e&&e.$$typeof===r},t.isForwardRef=function(e){return k(e)===p},t.isFragment=function(e){return k(e)===o},t.isLazy=function(e){return k(e)===g},t.isMemo=function(e){return k(e)===h},t.isPortal=function(e){return k(e)===a},t.isProfiler=function(e){return k(e)===l},t.isStrictMode=function(e){return k(e)===i},t.isSuspense=function(e){return k(e)===f},t.isValidElementType=function(e){return"string"==typeof e||"function"==typeof e||e===o||e===d||e===l||e===i||e===f||e===m||"object"==typeof e&&null!==e&&(e.$$typeof===g||e.$$typeof===h||e.$$typeof===s||e.$$typeof===c||e.$$typeof===p||e.$$typeof===v||e.$$typeof===y||e.$$typeof===w||e.$$typeof===b)},t.typeOf=k},9864:(e,t,n)=>{"use strict";e.exports=n(9921)},8356:(e,t,n)=>{"use strict";function r(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,e.__proto__=t}function a(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(){return i=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},i.apply(this,arguments)}var l=n(7294),s=n(5697),c=[],u=[];function d(e){var t=e(),n={loading:!0,loaded:null,error:null};return n.promise=t.then((function(e){return n.loading=!1,n.loaded=e,e})).catch((function(e){throw n.loading=!1,n.error=e,e})),n}function p(e){var t={loading:!1,loaded:{},error:null},n=[];try{Object.keys(e).forEach((function(r){var a=d(e[r]);a.loading?t.loading=!0:(t.loaded[r]=a.loaded,t.error=a.error),n.push(a.promise),a.promise.then((function(e){t.loaded[r]=e})).catch((function(e){t.error=e}))}))}catch(r){t.error=r}return t.promise=Promise.all(n).then((function(e){return t.loading=!1,e})).catch((function(e){throw t.loading=!1,e})),t}function f(e,t){return l.createElement((n=e)&&n.__esModule?n.default:n,t);var n}function m(e,t){var d,p;if(!t.loading)throw new Error("react-loadable requires a `loading` component");var m=i({loader:null,loading:null,delay:200,timeout:null,render:f,webpack:null,modules:null},t),h=null;function g(){return h||(h=e(m.loader)),h.promise}return c.push(g),"function"==typeof m.webpack&&u.push((function(){if((0,m.webpack)().every((function(e){return void 0!==e&&void 0!==n.m[e]})))return g()})),p=d=function(t){function n(n){var r;return o(a(a(r=t.call(this,n)||this)),"retry",(function(){r.setState({error:null,loading:!0,timedOut:!1}),h=e(m.loader),r._loadModule()})),g(),r.state={error:h.error,pastDelay:!1,timedOut:!1,loading:h.loading,loaded:h.loaded},r}r(n,t),n.preload=function(){return g()};var i=n.prototype;return i.UNSAFE_componentWillMount=function(){this._loadModule()},i.componentDidMount=function(){this._mounted=!0},i._loadModule=function(){var e=this;if(this.context.loadable&&Array.isArray(m.modules)&&m.modules.forEach((function(t){e.context.loadable.report(t)})),h.loading){var t=function(t){e._mounted&&e.setState(t)};"number"==typeof m.delay&&(0===m.delay?this.setState({pastDelay:!0}):this._delay=setTimeout((function(){t({pastDelay:!0})}),m.delay)),"number"==typeof m.timeout&&(this._timeout=setTimeout((function(){t({timedOut:!0})}),m.timeout));var n=function(){t({error:h.error,loaded:h.loaded,loading:h.loading}),e._clearTimeouts()};h.promise.then((function(){return n(),null})).catch((function(e){return n(),null}))}},i.componentWillUnmount=function(){this._mounted=!1,this._clearTimeouts()},i._clearTimeouts=function(){clearTimeout(this._delay),clearTimeout(this._timeout)},i.render=function(){return this.state.loading||this.state.error?l.createElement(m.loading,{isLoading:this.state.loading,pastDelay:this.state.pastDelay,timedOut:this.state.timedOut,error:this.state.error,retry:this.retry}):this.state.loaded?m.render(this.state.loaded,this.props):null},n}(l.Component),o(d,"contextTypes",{loadable:s.shape({report:s.func.isRequired})}),p}function h(e){return m(d,e)}h.Map=function(e){if("function"!=typeof e.render)throw new Error("LoadableMap requires a `render(loaded, props)` function");return m(p,e)};var g=function(e){function t(){return e.apply(this,arguments)||this}r(t,e);var n=t.prototype;return n.getChildContext=function(){return{loadable:{report:this.props.report}}},n.render=function(){return l.Children.only(this.props.children)},t}(l.Component);function b(e){for(var t=[];e.length;){var n=e.pop();t.push(n())}return Promise.all(t).then((function(){if(e.length)return b(e)}))}o(g,"propTypes",{report:s.func.isRequired}),o(g,"childContextTypes",{loadable:s.shape({report:s.func.isRequired}).isRequired}),h.Capture=g,h.preloadAll=function(){return new Promise((function(e,t){b(c).then(e,t)}))},h.preloadReady=function(){return new Promise((function(e,t){b(u).then(e,e)}))},e.exports=h},8790:(e,t,n)=>{"use strict";n.d(t,{H:()=>l,f:()=>i});var r=n(6550),a=n(7462),o=n(7294);function i(e,t,n){return void 0===n&&(n=[]),e.some((function(e){var a=e.path?(0,r.LX)(t,e):n.length?n[n.length-1].match:r.F0.computeRootMatch(t);return a&&(n.push({route:e,match:a}),e.routes&&i(e.routes,t,n)),a})),n}function l(e,t,n){return void 0===t&&(t={}),void 0===n&&(n={}),e?o.createElement(r.rs,n,e.map((function(e,n){return o.createElement(r.AW,{key:e.key||n,path:e.path,exact:e.exact,strict:e.strict,render:function(n){return e.render?e.render((0,a.Z)({},n,{},t,{route:e})):o.createElement(e.component,(0,a.Z)({},n,t,{route:e}))}})}))):null}},3727:(e,t,n)=>{"use strict";n.d(t,{OL:()=>y,VK:()=>u,rU:()=>g});var r=n(6550),a=n(5068),o=n(7294),i=n(9318),l=n(7462),s=n(3366),c=n(8776),u=function(e){function t(){for(var t,n=arguments.length,r=new Array(n),a=0;a<n;a++)r[a]=arguments[a];return(t=e.call.apply(e,[this].concat(r))||this).history=(0,i.lX)(t.props),t}return(0,a.Z)(t,e),t.prototype.render=function(){return o.createElement(r.F0,{history:this.history,children:this.props.children})},t}(o.Component);o.Component;var d=function(e,t){return"function"==typeof e?e(t):e},p=function(e,t){return"string"==typeof e?(0,i.ob)(e,null,null,t):e},f=function(e){return e},m=o.forwardRef;void 0===m&&(m=f);var h=m((function(e,t){var n=e.innerRef,r=e.navigate,a=e.onClick,i=(0,s.Z)(e,["innerRef","navigate","onClick"]),c=i.target,u=(0,l.Z)({},i,{onClick:function(e){try{a&&a(e)}catch(t){throw e.preventDefault(),t}e.defaultPrevented||0!==e.button||c&&"_self"!==c||function(e){return!!(e.metaKey||e.altKey||e.ctrlKey||e.shiftKey)}(e)||(e.preventDefault(),r())}});return u.ref=f!==m&&t||n,o.createElement("a",u)}));var g=m((function(e,t){var n=e.component,a=void 0===n?h:n,u=e.replace,g=e.to,b=e.innerRef,v=(0,s.Z)(e,["component","replace","to","innerRef"]);return o.createElement(r.s6.Consumer,null,(function(e){e||(0,c.Z)(!1);var n=e.history,r=p(d(g,e.location),e.location),s=r?n.createHref(r):"",h=(0,l.Z)({},v,{href:s,navigate:function(){var t=d(g,e.location),r=(0,i.Ep)(e.location)===(0,i.Ep)(p(t));(u||r?n.replace:n.push)(t)}});return f!==m?h.ref=t||b:h.innerRef=b,o.createElement(a,h)}))})),b=function(e){return e},v=o.forwardRef;void 0===v&&(v=b);var y=v((function(e,t){var n=e["aria-current"],a=void 0===n?"page":n,i=e.activeClassName,u=void 0===i?"active":i,f=e.activeStyle,m=e.className,h=e.exact,y=e.isActive,w=e.location,k=e.sensitive,S=e.strict,E=e.style,x=e.to,_=e.innerRef,R=(0,s.Z)(e,["aria-current","activeClassName","activeStyle","className","exact","isActive","location","sensitive","strict","style","to","innerRef"]);return o.createElement(r.s6.Consumer,null,(function(e){e||(0,c.Z)(!1);var n=w||e.location,i=p(d(x,n),n),s=i.pathname,C=s&&s.replace(/([.+*?=^!:${}()[\]|/\\])/g,"\\$1"),T=C?(0,r.LX)(n.pathname,{path:C,exact:h,sensitive:k,strict:S}):null,O=!!(y?y(T,n):T),P="function"==typeof m?m(O):m,A="function"==typeof E?E(O):E;O&&(P=function(){for(var e=arguments.length,t=new Array(e),n=0;n<e;n++)t[n]=arguments[n];return t.filter((function(e){return e})).join(" ")}(P,u),A=(0,l.Z)({},A,f));var j=(0,l.Z)({"aria-current":O&&a||null,className:P,style:A,to:i},R);return b!==v?j.ref=t||_:j.innerRef=_,o.createElement(g,j)}))}))},6550:(e,t,n)=>{"use strict";n.d(t,{AW:()=>x,F0:()=>w,LX:()=>E,TH:()=>L,k6:()=>j,rs:()=>P,s6:()=>y});var r=n(5068),a=n(7294),o=n(5697),i=n.n(o),l=n(9318),s=n(8776),c=n(7462),u=n(4779),d=n.n(u),p=(n(9864),n(3366)),f=(n(8679),1073741823),m="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:void 0!==n.g?n.g:{};function h(e){var t=[];return{on:function(e){t.push(e)},off:function(e){t=t.filter((function(t){return t!==e}))},get:function(){return e},set:function(n,r){e=n,t.forEach((function(t){return t(e,r)}))}}}var g=a.createContext||function(e,t){var n,o,l="__create-react-context-"+function(){var e="__global_unique_id__";return m[e]=(m[e]||0)+1}()+"__",s=function(e){function n(){for(var t,n=arguments.length,r=new Array(n),a=0;a<n;a++)r[a]=arguments[a];return(t=e.call.apply(e,[this].concat(r))||this).emitter=h(t.props.value),t}(0,r.Z)(n,e);var a=n.prototype;return a.getChildContext=function(){var e;return(e={})[l]=this.emitter,e},a.componentWillReceiveProps=function(e){if(this.props.value!==e.value){var n,r=this.props.value,a=e.value;((o=r)===(i=a)?0!==o||1/o==1/i:o!=o&&i!=i)?n=0:(n="function"==typeof t?t(r,a):f,0!==(n|=0)&&this.emitter.set(e.value,n))}var o,i},a.render=function(){return this.props.children},n}(a.Component);s.childContextTypes=((n={})[l]=i().object.isRequired,n);var c=function(t){function n(){for(var e,n=arguments.length,r=new Array(n),a=0;a<n;a++)r[a]=arguments[a];return(e=t.call.apply(t,[this].concat(r))||this).observedBits=void 0,e.state={value:e.getValue()},e.onUpdate=function(t,n){0!=((0|e.observedBits)&n)&&e.setState({value:e.getValue()})},e}(0,r.Z)(n,t);var a=n.prototype;return a.componentWillReceiveProps=function(e){var t=e.observedBits;this.observedBits=null==t?f:t},a.componentDidMount=function(){this.context[l]&&this.context[l].on(this.onUpdate);var e=this.props.observedBits;this.observedBits=null==e?f:e},a.componentWillUnmount=function(){this.context[l]&&this.context[l].off(this.onUpdate)},a.getValue=function(){return this.context[l]?this.context[l].get():e},a.render=function(){return(e=this.props.children,Array.isArray(e)?e[0]:e)(this.state.value);var e},n}(a.Component);return c.contextTypes=((o={})[l]=i().object,o),{Provider:s,Consumer:c}},b=function(e){var t=g();return t.displayName=e,t},v=b("Router-History"),y=b("Router"),w=function(e){function t(t){var n;return(n=e.call(this,t)||this).state={location:t.history.location},n._isMounted=!1,n._pendingLocation=null,t.staticContext||(n.unlisten=t.history.listen((function(e){n._pendingLocation=e}))),n}(0,r.Z)(t,e),t.computeRootMatch=function(e){return{path:"/",url:"/",params:{},isExact:"/"===e}};var n=t.prototype;return n.componentDidMount=function(){var e=this;this._isMounted=!0,this.unlisten&&this.unlisten(),this.props.staticContext||(this.unlisten=this.props.history.listen((function(t){e._isMounted&&e.setState({location:t})}))),this._pendingLocation&&this.setState({location:this._pendingLocation})},n.componentWillUnmount=function(){this.unlisten&&(this.unlisten(),this._isMounted=!1,this._pendingLocation=null)},n.render=function(){return a.createElement(y.Provider,{value:{history:this.props.history,location:this.state.location,match:t.computeRootMatch(this.state.location.pathname),staticContext:this.props.staticContext}},a.createElement(v.Provider,{children:this.props.children||null,value:this.props.history}))},t}(a.Component);a.Component;a.Component;var k={},S=0;function E(e,t){void 0===t&&(t={}),("string"==typeof t||Array.isArray(t))&&(t={path:t});var n=t,r=n.path,a=n.exact,o=void 0!==a&&a,i=n.strict,l=void 0!==i&&i,s=n.sensitive,c=void 0!==s&&s;return[].concat(r).reduce((function(t,n){if(!n&&""!==n)return null;if(t)return t;var r=function(e,t){var n=""+t.end+t.strict+t.sensitive,r=k[n]||(k[n]={});if(r[e])return r[e];var a=[],o={regexp:d()(e,a,t),keys:a};return S<1e4&&(r[e]=o,S++),o}(n,{end:o,strict:l,sensitive:c}),a=r.regexp,i=r.keys,s=a.exec(e);if(!s)return null;var u=s[0],p=s.slice(1),f=e===u;return o&&!f?null:{path:n,url:"/"===n&&""===u?"/":u,isExact:f,params:i.reduce((function(e,t,n){return e[t.name]=p[n],e}),{})}}),null)}var x=function(e){function t(){return e.apply(this,arguments)||this}return(0,r.Z)(t,e),t.prototype.render=function(){var e=this;return a.createElement(y.Consumer,null,(function(t){t||(0,s.Z)(!1);var n=e.props.location||t.location,r=e.props.computedMatch?e.props.computedMatch:e.props.path?E(n.pathname,e.props):t.match,o=(0,c.Z)({},t,{location:n,match:r}),i=e.props,l=i.children,u=i.component,d=i.render;return Array.isArray(l)&&function(e){return 0===a.Children.count(e)}(l)&&(l=null),a.createElement(y.Provider,{value:o},o.match?l?"function"==typeof l?l(o):l:u?a.createElement(u,o):d?d(o):null:"function"==typeof l?l(o):null)}))},t}(a.Component);function _(e){return"/"===e.charAt(0)?e:"/"+e}function R(e,t){if(!e)return t;var n=_(e);return 0!==t.pathname.indexOf(n)?t:(0,c.Z)({},t,{pathname:t.pathname.substr(n.length)})}function C(e){return"string"==typeof e?e:(0,l.Ep)(e)}function T(e){return function(){(0,s.Z)(!1)}}function O(){}a.Component;var P=function(e){function t(){return e.apply(this,arguments)||this}return(0,r.Z)(t,e),t.prototype.render=function(){var e=this;return a.createElement(y.Consumer,null,(function(t){t||(0,s.Z)(!1);var n,r,o=e.props.location||t.location;return a.Children.forEach(e.props.children,(function(e){if(null==r&&a.isValidElement(e)){n=e;var i=e.props.path||e.props.from;r=i?E(o.pathname,(0,c.Z)({},e.props,{path:i})):t.match}})),r?a.cloneElement(n,{location:o,computedMatch:r}):null}))},t}(a.Component);var A=a.useContext;function j(){return A(v)}function L(){return A(y).location}},2408:(e,t,n)=>{"use strict";var r=n(7418),a=60103,o=60106;t.Fragment=60107,t.StrictMode=60108,t.Profiler=60114;var i=60109,l=60110,s=60112;t.Suspense=60113;var c=60115,u=60116;if("function"==typeof Symbol&&Symbol.for){var d=Symbol.for;a=d("react.element"),o=d("react.portal"),t.Fragment=d("react.fragment"),t.StrictMode=d("react.strict_mode"),t.Profiler=d("react.profiler"),i=d("react.provider"),l=d("react.context"),s=d("react.forward_ref"),t.Suspense=d("react.suspense"),c=d("react.memo"),u=d("react.lazy")}var p="function"==typeof Symbol&&Symbol.iterator;function f(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n<arguments.length;n++)t+="&args[]="+encodeURIComponent(arguments[n]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}var m={isMounted:function(){return!1},enqueueForceUpdate:function(){},enqueueReplaceState:function(){},enqueueSetState:function(){}},h={};function g(e,t,n){this.props=e,this.context=t,this.refs=h,this.updater=n||m}function b(){}function v(e,t,n){this.props=e,this.context=t,this.refs=h,this.updater=n||m}g.prototype.isReactComponent={},g.prototype.setState=function(e,t){if("object"!=typeof e&&"function"!=typeof e&&null!=e)throw Error(f(85));this.updater.enqueueSetState(this,e,t,"setState")},g.prototype.forceUpdate=function(e){this.updater.enqueueForceUpdate(this,e,"forceUpdate")},b.prototype=g.prototype;var y=v.prototype=new b;y.constructor=v,r(y,g.prototype),y.isPureReactComponent=!0;var w={current:null},k=Object.prototype.hasOwnProperty,S={key:!0,ref:!0,__self:!0,__source:!0};function E(e,t,n){var r,o={},i=null,l=null;if(null!=t)for(r in void 0!==t.ref&&(l=t.ref),void 0!==t.key&&(i=""+t.key),t)k.call(t,r)&&!S.hasOwnProperty(r)&&(o[r]=t[r]);var s=arguments.length-2;if(1===s)o.children=n;else if(1<s){for(var c=Array(s),u=0;u<s;u++)c[u]=arguments[u+2];o.children=c}if(e&&e.defaultProps)for(r in s=e.defaultProps)void 0===o[r]&&(o[r]=s[r]);return{$$typeof:a,type:e,key:i,ref:l,props:o,_owner:w.current}}function x(e){return"object"==typeof e&&null!==e&&e.$$typeof===a}var _=/\/+/g;function R(e,t){return"object"==typeof e&&null!==e&&null!=e.key?function(e){var t={"=":"=0",":":"=2"};return"$"+e.replace(/[=:]/g,(function(e){return t[e]}))}(""+e.key):t.toString(36)}function C(e,t,n,r,i){var l=typeof e;"undefined"!==l&&"boolean"!==l||(e=null);var s=!1;if(null===e)s=!0;else switch(l){case"string":case"number":s=!0;break;case"object":switch(e.$$typeof){case a:case o:s=!0}}if(s)return i=i(s=e),e=""===r?"."+R(s,0):r,Array.isArray(i)?(n="",null!=e&&(n=e.replace(_,"$&/")+"/"),C(i,t,n,"",(function(e){return e}))):null!=i&&(x(i)&&(i=function(e,t){return{$$typeof:a,type:e.type,key:t,ref:e.ref,props:e.props,_owner:e._owner}}(i,n+(!i.key||s&&s.key===i.key?"":(""+i.key).replace(_,"$&/")+"/")+e)),t.push(i)),1;if(s=0,r=""===r?".":r+":",Array.isArray(e))for(var c=0;c<e.length;c++){var u=r+R(l=e[c],c);s+=C(l,t,n,u,i)}else if(u=function(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=p&&e[p]||e["@@iterator"])?e:null}(e),"function"==typeof u)for(e=u.call(e),c=0;!(l=e.next()).done;)s+=C(l=l.value,t,n,u=r+R(l,c++),i);else if("object"===l)throw t=""+e,Error(f(31,"[object Object]"===t?"object with keys {"+Object.keys(e).join(", ")+"}":t));return s}function T(e,t,n){if(null==e)return e;var r=[],a=0;return C(e,r,"","",(function(e){return t.call(n,e,a++)})),r}function O(e){if(-1===e._status){var t=e._result;t=t(),e._status=0,e._result=t,t.then((function(t){0===e._status&&(t=t.default,e._status=1,e._result=t)}),(function(t){0===e._status&&(e._status=2,e._result=t)}))}if(1===e._status)return e._result;throw e._result}var P={current:null};function A(){var e=P.current;if(null===e)throw Error(f(321));return e}var j={ReactCurrentDispatcher:P,ReactCurrentBatchConfig:{transition:0},ReactCurrentOwner:w,IsSomeRendererActing:{current:!1},assign:r};t.Children={map:T,forEach:function(e,t,n){T(e,(function(){t.apply(this,arguments)}),n)},count:function(e){var t=0;return T(e,(function(){t++})),t},toArray:function(e){return T(e,(function(e){return e}))||[]},only:function(e){if(!x(e))throw Error(f(143));return e}},t.Component=g,t.PureComponent=v,t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED=j,t.cloneElement=function(e,t,n){if(null==e)throw Error(f(267,e));var o=r({},e.props),i=e.key,l=e.ref,s=e._owner;if(null!=t){if(void 0!==t.ref&&(l=t.ref,s=w.current),void 0!==t.key&&(i=""+t.key),e.type&&e.type.defaultProps)var c=e.type.defaultProps;for(u in t)k.call(t,u)&&!S.hasOwnProperty(u)&&(o[u]=void 0===t[u]&&void 0!==c?c[u]:t[u])}var u=arguments.length-2;if(1===u)o.children=n;else if(1<u){c=Array(u);for(var d=0;d<u;d++)c[d]=arguments[d+2];o.children=c}return{$$typeof:a,type:e.type,key:i,ref:l,props:o,_owner:s}},t.createContext=function(e,t){return void 0===t&&(t=null),(e={$$typeof:l,_calculateChangedBits:t,_currentValue:e,_currentValue2:e,_threadCount:0,Provider:null,Consumer:null}).Provider={$$typeof:i,_context:e},e.Consumer=e},t.createElement=E,t.createFactory=function(e){var t=E.bind(null,e);return t.type=e,t},t.createRef=function(){return{current:null}},t.forwardRef=function(e){return{$$typeof:s,render:e}},t.isValidElement=x,t.lazy=function(e){return{$$typeof:u,_payload:{_status:-1,_result:e},_init:O}},t.memo=function(e,t){return{$$typeof:c,type:e,compare:void 0===t?null:t}},t.useCallback=function(e,t){return A().useCallback(e,t)},t.useContext=function(e,t){return A().useContext(e,t)},t.useDebugValue=function(){},t.useEffect=function(e,t){return A().useEffect(e,t)},t.useImperativeHandle=function(e,t,n){return A().useImperativeHandle(e,t,n)},t.useLayoutEffect=function(e,t){return A().useLayoutEffect(e,t)},t.useMemo=function(e,t){return A().useMemo(e,t)},t.useReducer=function(e,t,n){return A().useReducer(e,t,n)},t.useRef=function(e){return A().useRef(e)},t.useState=function(e){return A().useState(e)},t.version="17.0.2"},7294:(e,t,n)=>{"use strict";e.exports=n(2408)},53:(e,t)=>{"use strict";var n,r,a,o;if("object"==typeof performance&&"function"==typeof performance.now){var i=performance;t.unstable_now=function(){return i.now()}}else{var l=Date,s=l.now();t.unstable_now=function(){return l.now()-s}}if("undefined"==typeof window||"function"!=typeof MessageChannel){var c=null,u=null,d=function(){if(null!==c)try{var e=t.unstable_now();c(!0,e),c=null}catch(n){throw setTimeout(d,0),n}};n=function(e){null!==c?setTimeout(n,0,e):(c=e,setTimeout(d,0))},r=function(e,t){u=setTimeout(e,t)},a=function(){clearTimeout(u)},t.unstable_shouldYield=function(){return!1},o=t.unstable_forceFrameRate=function(){}}else{var p=window.setTimeout,f=window.clearTimeout;if("undefined"!=typeof console){var m=window.cancelAnimationFrame;"function"!=typeof window.requestAnimationFrame&&console.error("This browser doesn't support requestAnimationFrame. Make sure that you load a polyfill in older browsers. https://reactjs.org/link/react-polyfills"),"function"!=typeof m&&console.error("This browser doesn't support cancelAnimationFrame. Make sure that you load a polyfill in older browsers. https://reactjs.org/link/react-polyfills")}var h=!1,g=null,b=-1,v=5,y=0;t.unstable_shouldYield=function(){return t.unstable_now()>=y},o=function(){},t.unstable_forceFrameRate=function(e){0>e||125<e?console.error("forceFrameRate takes a positive int between 0 and 125, forcing frame rates higher than 125 fps is not supported"):v=0<e?Math.floor(1e3/e):5};var w=new MessageChannel,k=w.port2;w.port1.onmessage=function(){if(null!==g){var e=t.unstable_now();y=e+v;try{g(!0,e)?k.postMessage(null):(h=!1,g=null)}catch(n){throw k.postMessage(null),n}}else h=!1},n=function(e){g=e,h||(h=!0,k.postMessage(null))},r=function(e,n){b=p((function(){e(t.unstable_now())}),n)},a=function(){f(b),b=-1}}function S(e,t){var n=e.length;e.push(t);e:for(;;){var r=n-1>>>1,a=e[r];if(!(void 0!==a&&0<_(a,t)))break e;e[r]=t,e[n]=a,n=r}}function E(e){return void 0===(e=e[0])?null:e}function x(e){var t=e[0];if(void 0!==t){var n=e.pop();if(n!==t){e[0]=n;e:for(var r=0,a=e.length;r<a;){var o=2*(r+1)-1,i=e[o],l=o+1,s=e[l];if(void 0!==i&&0>_(i,n))void 0!==s&&0>_(s,i)?(e[r]=s,e[l]=n,r=l):(e[r]=i,e[o]=n,r=o);else{if(!(void 0!==s&&0>_(s,n)))break e;e[r]=s,e[l]=n,r=l}}}return t}return null}function _(e,t){var n=e.sortIndex-t.sortIndex;return 0!==n?n:e.id-t.id}var R=[],C=[],T=1,O=null,P=3,A=!1,j=!1,L=!1;function N(e){for(var t=E(C);null!==t;){if(null===t.callback)x(C);else{if(!(t.startTime<=e))break;x(C),t.sortIndex=t.expirationTime,S(R,t)}t=E(C)}}function I(e){if(L=!1,N(e),!j)if(null!==E(R))j=!0,n(M);else{var t=E(C);null!==t&&r(I,t.startTime-e)}}function M(e,n){j=!1,L&&(L=!1,a()),A=!0;var o=P;try{for(N(n),O=E(R);null!==O&&(!(O.expirationTime>n)||e&&!t.unstable_shouldYield());){var i=O.callback;if("function"==typeof i){O.callback=null,P=O.priorityLevel;var l=i(O.expirationTime<=n);n=t.unstable_now(),"function"==typeof l?O.callback=l:O===E(R)&&x(R),N(n)}else x(R);O=E(R)}if(null!==O)var s=!0;else{var c=E(C);null!==c&&r(I,c.startTime-n),s=!1}return s}finally{O=null,P=o,A=!1}}var D=o;t.unstable_IdlePriority=5,t.unstable_ImmediatePriority=1,t.unstable_LowPriority=4,t.unstable_NormalPriority=3,t.unstable_Profiling=null,t.unstable_UserBlockingPriority=2,t.unstable_cancelCallback=function(e){e.callback=null},t.unstable_continueExecution=function(){j||A||(j=!0,n(M))},t.unstable_getCurrentPriorityLevel=function(){return P},t.unstable_getFirstCallbackNode=function(){return E(R)},t.unstable_next=function(e){switch(P){case 1:case 2:case 3:var t=3;break;default:t=P}var n=P;P=t;try{return e()}finally{P=n}},t.unstable_pauseExecution=function(){},t.unstable_requestPaint=D,t.unstable_runWithPriority=function(e,t){switch(e){case 1:case 2:case 3:case 4:case 5:break;default:e=3}var n=P;P=e;try{return t()}finally{P=n}},t.unstable_scheduleCallback=function(e,o,i){var l=t.unstable_now();switch("object"==typeof i&&null!==i?i="number"==typeof(i=i.delay)&&0<i?l+i:l:i=l,e){case 1:var s=-1;break;case 2:s=250;break;case 5:s=1073741823;break;case 4:s=1e4;break;default:s=5e3}return e={id:T++,callback:o,priorityLevel:e,startTime:i,expirationTime:s=i+s,sortIndex:-1},i>l?(e.sortIndex=i,S(C,e),null===E(R)&&e===E(C)&&(L?a():L=!0,r(I,i-l))):(e.sortIndex=s,S(R,e),j||A||(j=!0,n(M))),e},t.unstable_wrapCallback=function(e){var t=P;return function(){var n=P;P=t;try{return e.apply(this,arguments)}finally{P=n}}}},3840:(e,t,n)=>{"use strict";e.exports=n(53)},6774:e=>{e.exports=function(e,t,n,r){var a=n?n.call(r,e,t):void 0;if(void 0!==a)return!!a;if(e===t)return!0;if("object"!=typeof e||!e||"object"!=typeof t||!t)return!1;var o=Object.keys(e),i=Object.keys(t);if(o.length!==i.length)return!1;for(var l=Object.prototype.hasOwnProperty.bind(t),s=0;s<o.length;s++){var c=o[s];if(!l(c))return!1;var u=e[c],d=t[c];if(!1===(a=n?n.call(r,u,d,c):void 0)||void 0===a&&u!==d)return!1}return!0}},6809:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>r});const r={title:"RoutingJS Documentation",tagline:"Consistent access to Open Source Routing Engines",url:"https://gis-ops.github.io",trailingSlash:!1,baseUrl:"/routingjs/",onBrokenLinks:"throw",onBrokenMarkdownLinks:"warn",organizationName:"gis-ops",projectName:"routingjs",i18n:{defaultLocale:"en",locales:["en"],path:"i18n",localeConfigs:{}},presets:[["classic",{docs:{sidebarPath:"/home/runner/work/routingjs/routingjs/docs/sidebars.js",editUrl:"https://github.com/gis-ops/routingjs/"},blog:!1,theme:{customCss:"/home/runner/work/routingjs/routingjs/docs/src/css/custom.css"}}]],themeConfig:{navbar:{title:"RoutingJS",items:[{to:"/docs/api",label:"docs",position:"left"},{href:"https://github.com/gis-ops/routingjs",label:"GitHub",position:"right"}],hideOnScroll:!1},footer:{style:"dark",links:[{title:"Docs",items:[{label:"Quickstart",to:"/docs/quickstart"},{label:"Docs",to:"/docs/api/"}]},{title:"Community",items:[{label:"Twitter",href:"https://twitter.com/gis_ops"},{label:"LinkedIn",href:"https://linkedin.com/gis-ops"}]},{title:"More",items:[{label:"GIS-OPS",href:"https://gis-ops.com"},{label:"GitHub",href:"https://github.com/gis-ops/routingjs"}]}],copyright:'Copyright \xa9 2024 GIS-OPS UG. Icons by <a href="https://tabler-icons.io">tabler</a>.'},prism:{theme:{plain:{color:"#393A34",backgroundColor:"#f6f8fa"},styles:[{types:["comment","prolog","doctype","cdata"],style:{color:"#999988",fontStyle:"italic"}},{types:["namespace"],style:{opacity:.7}},{types:["string","attr-value"],style:{color:"#e3116c"}},{types:["punctuation","operator"],style:{color:"#393A34"}},{types:["entity","url","symbol","number","boolean","variable","constant","property","regex","inserted"],style:{color:"#36acaa"}},{types:["atrule","keyword","attr-name","selector"],style:{color:"#00a4db"}},{types:["function","deleted","tag"],style:{color:"#d73a49"}},{types:["function-variable"],style:{color:"#6f42c1"}},{types:["tag","selector","keyword"],style:{color:"#00009f"}}]},darkTheme:{plain:{color:"#F8F8F2",backgroundColor:"#282A36"},styles:[{types:["prolog","constant","builtin"],style:{color:"rgb(189, 147, 249)"}},{types:["inserted","function"],style:{color:"rgb(80, 250, 123)"}},{types:["deleted"],style:{color:"rgb(255, 85, 85)"}},{types:["changed"],style:{color:"rgb(255, 184, 108)"}},{types:["punctuation","symbol"],style:{color:"rgb(248, 248, 242)"}},{types:["string","char","tag","selector"],style:{color:"rgb(255, 121, 198)"}},{types:["keyword","variable"],style:{color:"rgb(189, 147, 249)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(98, 114, 164)"}},{types:["attr-name"],style:{color:"rgb(241, 250, 140)"}}]},additionalLanguages:[],magicComments:[{className:"theme-code-block-highlighted-line",line:"highlight-next-line",block:{start:"highlight-start",end:"highlight-end"}}]},colorMode:{defaultMode:"light",disableSwitch:!1,respectPrefersColorScheme:!1},docs:{versionPersistence:"localStorage",sidebar:{hideable:!1,autoCollapseCategories:!1}},metadata:[],tableOfContents:{minHeadingLevel:2,maxHeadingLevel:3}},plugins:[["docusaurus-plugin-typedoc",{entryPoints:["../packages/core/index.ts","../packages/valhalla/index.ts","../packages/osrm/index.ts","../packages/ors/index.ts","../packages/graphhopper/index.ts"],tsconfig:"../tsconfig.doc.json"}]],baseUrlIssueBanner:!0,onDuplicateRoutes:"warn",staticDirectories:["static"],customFields:{},themes:[],scripts:[],headTags:[],stylesheets:[],clientModules:[],titleDelimiter:"|",noIndex:!1,markdown:{mermaid:!1}}},7462:(e,t,n)=>{"use strict";function r(){return r=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},r.apply(this,arguments)}n.d(t,{Z:()=>r})},5068:(e,t,n)=>{"use strict";function r(e,t){return r=Object.setPrototypeOf?Object.setPrototypeOf.bind():function(e,t){return e.__proto__=t,e},r(e,t)}function a(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,r(e,t)}n.d(t,{Z:()=>a})},3366:(e,t,n)=>{"use strict";function r(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}n.d(t,{Z:()=>r})},8776:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r="Invariant failed";function a(e,t){if(!e)throw new Error(r)}},7529:e=>{"use strict";e.exports={}},6887:e=>{"use strict";e.exports=JSON.parse('{"/routingjs/markdown-page-357":{"__comp":"1f391b9e","__context":{"plugin":"d1df3a82"},"content":"393be207"},"/routingjs/docs-772":{"__comp":"1be78505","__context":{"plugin":"5ffeac76"},"versionMetadata":"935f2afb"},"/routingjs/docs/api-bf3":{"__comp":"17896441","content":"5e8c322a"},"/routingjs/docs/api/classes/core.Client-a84":{"__comp":"17896441","content":"e69ab7fa"},"/routingjs/docs/api/classes/core.Direction-a91":{"__comp":"17896441","content":"6ffa1466"},"/routingjs/docs/api/classes/core.Directions-ca0":{"__comp":"17896441","content":"484329c4"},"/routingjs/docs/api/classes/core.Isochrone-d03":{"__comp":"17896441","content":"9e00c705"},"/routingjs/docs/api/classes/core.Isochrones-1ed":{"__comp":"17896441","content":"629bdd40"},"/routingjs/docs/api/classes/core.Matrix-d65":{"__comp":"17896441","content":"dd6706b8"},"/routingjs/docs/api/classes/core.RoutingJSAPIError-661":{"__comp":"17896441","content":"d17d046f"},"/routingjs/docs/api/classes/graphhopper.GraphHopper-c0b":{"__comp":"17896441","content":"8f93cbcd"},"/routingjs/docs/api/classes/ors.ORS-121":{"__comp":"17896441","content":"ebfbfacf"},"/routingjs/docs/api/classes/osrm.OSRM-971":{"__comp":"17896441","content":"aa082b57"},"/routingjs/docs/api/classes/valhalla.Valhalla-5be":{"__comp":"17896441","content":"60784167"},"/routingjs/docs/api/interfaces/core.BaseRouter-397":{"__comp":"17896441","content":"b4f090cd"},"/routingjs/docs/api/interfaces/core.ClientConstructorArgs-ad5":{"__comp":"17896441","content":"08932d0c"},"/routingjs/docs/api/interfaces/core.ErrorProps-1f2":{"__comp":"17896441","content":"2fbe5889"},"/routingjs/docs/api/interfaces/core.JSONObject-85a":{"__comp":"17896441","content":"3ebc895b"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorProps-d4e":{"__comp":"17896441","content":"d08d5db0"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts-7bd":{"__comp":"17896441","content":"84af600f"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams-1bc":{"__comp":"17896441","content":"b45c6e46"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse-086":{"__comp":"17896441","content":"fd3e4606"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts-ce2":{"__comp":"17896441","content":"eca7e322"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParams-d2d":{"__comp":"17896441","content":"1cd93e92"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse-ca7":{"__comp":"17896441","content":"eff1c6c7"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParams-b6b":{"__comp":"17896441","content":"481e471a"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePath-e7c":{"__comp":"17896441","content":"855fb381"},"/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponse-410":{"__comp":"17896441","content":"dd4f9bad"},"/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParam-db8":{"__comp":"17896441","content":"a063e0e3"},"/routingjs/docs/api/interfaces/ors.ORSErrorProps-f4c":{"__comp":"17896441","content":"a557ae41"},"/routingjs/docs/api/interfaces/ors.ORSIsochroneParams-05e":{"__comp":"17896441","content":"bc512349"},"/routingjs/docs/api/interfaces/ors.ORSIsochroneResponse-fc6":{"__comp":"17896441","content":"5ceb730d"},"/routingjs/docs/api/interfaces/ors.ORSMatrixParams-802":{"__comp":"17896441","content":"705151d0"},"/routingjs/docs/api/interfaces/ors.ORSMatrixResponse-4f1":{"__comp":"17896441","content":"27302741"},"/routingjs/docs/api/interfaces/ors.ORSRoute-f00":{"__comp":"17896441","content":"4ae4fd96"},"/routingjs/docs/api/interfaces/ors.ORSRouteParams-410":{"__comp":"17896441","content":"1291376a"},"/routingjs/docs/api/interfaces/ors.ORSRouteResponse-198":{"__comp":"17896441","content":"c7a53f27"},"/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOpts-979":{"__comp":"17896441","content":"9ae98e8e"},"/routingjs/docs/api/interfaces/osrm.OSRMErrorProps-1f2":{"__comp":"17896441","content":"88cbaf7a"},"/routingjs/docs/api/interfaces/osrm.OSRMGeometryObject-890":{"__comp":"17896441","content":"8fc6b66b"},"/routingjs/docs/api/interfaces/osrm.OSRMMatrixOpts-96c":{"__comp":"17896441","content":"ea776caf"},"/routingjs/docs/api/interfaces/osrm.OSRMRoute-e41":{"__comp":"17896441","content":"6ef32316"},"/routingjs/docs/api/interfaces/osrm.OSRMRouteParams-079":{"__comp":"17896441","content":"06aa6e93"},"/routingjs/docs/api/interfaces/osrm.OSRMRouteResponse-5dd":{"__comp":"17896441","content":"e356c530"},"/routingjs/docs/api/interfaces/osrm.OSRMTableParams-f4a":{"__comp":"17896441","content":"b009f941"},"/routingjs/docs/api/interfaces/osrm.OSRMTableResponse-acd":{"__comp":"17896441","content":"5b8d0eef"},"/routingjs/docs/api/interfaces/valhalla.MapboxAuthParams-98d":{"__comp":"17896441","content":"5e5ac311"},"/routingjs/docs/api/interfaces/valhalla.ValhallaContours-ad4":{"__comp":"17896441","content":"b5c59fa7"},"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto-e8c":{"__comp":"17896441","content":"31c5dceb"},"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle-575":{"__comp":"17896441","content":"e4e8843d"},"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle-957":{"__comp":"17896441","content":"c1888b50"},"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian-9d1":{"__comp":"17896441","content":"1b3415a5"},"/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck-a96":{"__comp":"17896441","content":"4aa12286"},"/routingjs/docs/api/interfaces/valhalla.ValhallaDateTime-6bf":{"__comp":"17896441","content":"cb9481a5"},"/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOpts-dac":{"__comp":"17896441","content":"94bca0b8"},"/routingjs/docs/api/interfaces/valhalla.ValhallaErrorProps-4b0":{"__comp":"17896441","content":"176abf51"},"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOpts-f31":{"__comp":"17896441","content":"ffa310cd"},"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParams-e1a":{"__comp":"17896441","content":"23817249"},"/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponse-37a":{"__comp":"17896441","content":"360d8d70"},"/routingjs/docs/api/interfaces/valhalla.ValhallaLeg-042":{"__comp":"17896441","content":"7a832ccb"},"/routingjs/docs/api/interfaces/valhalla.ValhallaLocation-935":{"__comp":"17896441","content":"d829a3a8"},"/routingjs/docs/api/interfaces/valhalla.ValhallaManeuvers-de3":{"__comp":"17896441","content":"1745c884"},"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOpts-bd6":{"__comp":"17896441","content":"fc4d9247"},"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParams-40a":{"__comp":"17896441","content":"4105c75d"},"/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponse-c78":{"__comp":"17896441","content":"acc2462d"},"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParams-698":{"__comp":"17896441","content":"9e3cb6c3"},"/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponse-221":{"__comp":"17896441","content":"faa0839e"},"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts-7a7":{"__comp":"17896441","content":"43063e81"},"/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParams-ecc":{"__comp":"17896441","content":"45d0475c"},"/routingjs/docs/api/interfaces/valhalla.ValhallaTrip-1de":{"__comp":"17896441","content":"ff78c6e0"},"/routingjs/docs/api/modules-932":{"__comp":"17896441","content":"f6aebfbf"},"/routingjs/docs/api/modules/core-ec0":{"__comp":"17896441","content":"da631d65"},"/routingjs/docs/api/modules/graphhopper-aa4":{"__comp":"17896441","content":"e6bf94c2"},"/routingjs/docs/api/modules/ors-c40":{"__comp":"17896441","content":"b567fbc2"},"/routingjs/docs/api/modules/osrm-251":{"__comp":"17896441","content":"35a07047"},"/routingjs/docs/api/modules/valhalla-76c":{"__comp":"17896441","content":"6b9ea5a6"},"/routingjs/docs/quickstart-8f8":{"__comp":"17896441","content":"e33a542e"},"/routingjs/-66e":{"__comp":"1df93b7f","__context":{"plugin":"d1df3a82"},"config":"5e9f5e1a"}}')}},e=>{e.O(0,[532],(()=>{return t=9383,e(e.s=t);var t}));e.O()}]); \ No newline at end of file diff --git a/assets/js/main.e8b73010.js.LICENSE.txt b/assets/js/main.e8b73010.js.LICENSE.txt new file mode 100644 index 0000000..6e08db2 --- /dev/null +++ b/assets/js/main.e8b73010.js.LICENSE.txt @@ -0,0 +1,53 @@ +/* +object-assign +(c) Sindre Sorhus +@license MIT +*/ + +/* NProgress, (c) 2013, 2014 Rico Sta. Cruz - http://ricostacruz.com/nprogress + * @license MIT */ + +/** + * Prism: Lightweight, robust, elegant syntax highlighting + * + * @license MIT <https://opensource.org/licenses/MIT> + * @author Lea Verou <https://lea.verou.me> + * @namespace + * @public + */ + +/** @license React v0.20.2 + * scheduler.production.min.js + * + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +/** @license React v16.13.1 + * react-is.production.min.js + * + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +/** @license React v17.0.2 + * react-dom.production.min.js + * + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +/** @license React v17.0.2 + * react.production.min.js + * + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ diff --git a/assets/js/runtime~main.f9709a1b.js b/assets/js/runtime~main.f9709a1b.js new file mode 100644 index 0000000..b53509c --- /dev/null +++ b/assets/js/runtime~main.f9709a1b.js @@ -0,0 +1 @@ +(()=>{"use strict";var e,a,f,c,b,d={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var f=t[e]={id:e,loaded:!1,exports:{}};return d[e].call(f.exports,f,f.exports,r),f.loaded=!0,f.exports}r.m=d,r.c=t,e=[],r.O=(a,f,c,b)=>{if(!f){var d=1/0;for(i=0;i<e.length;i++){f=e[i][0],c=e[i][1],b=e[i][2];for(var t=!0,o=0;o<f.length;o++)(!1&b||d>=b)&&Object.keys(r.O).every((e=>r.O[e](f[o])))?f.splice(o--,1):(t=!1,b<d&&(d=b));if(t){e.splice(i--,1);var n=c();void 0!==n&&(a=n)}}return a}b=b||0;for(var i=e.length;i>0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[f,c,b]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},f=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var b=Object.create(null);r.r(b);var d={};a=a||[null,f({}),f([]),f(f)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=f(t))Object.getOwnPropertyNames(t).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,r.d(b,d),b},r.d=(e,a)=>{for(var f in a)r.o(a,f)&&!r.o(e,f)&&Object.defineProperty(e,f,{enumerable:!0,get:a[f]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,f)=>(r.f[f](e,a),a)),[])),r.u=e=>"assets/js/"+({39:"b5c59fa7",53:"935f2afb",130:"9e00c705",313:"705151d0",381:"ff78c6e0",593:"fc4d9247",691:"06aa6e93",885:"84af600f",902:"ffa310cd",917:"1b3415a5",1022:"60784167",1281:"481e471a",1358:"a557ae41",1425:"5e5ac311",1673:"88cbaf7a",1751:"ebfbfacf",1917:"eff1c6c7",1973:"acc2462d",1994:"dd6706b8",2241:"43063e81",2347:"5ceb730d",2378:"b4f090cd",2673:"cb9481a5",2716:"4ae4fd96",2758:"b009f941",2846:"e356c530",3085:"1f391b9e",3237:"1df93b7f",3308:"c1888b50",3416:"4aa12286",3482:"d829a3a8",3599:"484329c4",3769:"5b8d0eef",3800:"2fbe5889",3976:"31c5dceb",3987:"d1df3a82",4745:"1745c884",4884:"a063e0e3",4985:"dd4f9bad",5079:"6b9ea5a6",5124:"1cd93e92",5133:"bc512349",5648:"c7a53f27",5686:"4105c75d",5823:"8fc6b66b",5825:"d17d046f",5874:"5ffeac76",5997:"855fb381",6030:"23817249",6070:"08932d0c",6161:"aa082b57",6309:"e33a542e",6401:"e69ab7fa",6566:"9ae98e8e",6588:"e6bf94c2",6596:"6ffa1466",6856:"e4e8843d",7098:"faa0839e",7173:"629bdd40",7181:"eca7e322",7199:"8f93cbcd",7306:"f6aebfbf",7332:"da631d65",7340:"ea776caf",7384:"7a832ccb",7414:"393be207",7494:"b45c6e46",7597:"5e8c322a",7719:"d08d5db0",7873:"27302741",7918:"17896441",7986:"35a07047",7987:"45d0475c",8130:"fd3e4606",8318:"b567fbc2",8710:"176abf51",8769:"9e3cb6c3",9012:"6ef32316",9342:"360d8d70",9455:"1291376a",9514:"1be78505",9796:"94bca0b8",9818:"3ebc895b"}[e]||e)+"."+{39:"efc789c1",53:"6170d225",130:"62314703",313:"0b912d8e",381:"03da1022",593:"f9c3605e",691:"e3ab1d1f",885:"1020d227",902:"bcb9ea08",917:"5a55eebb",1022:"b1cb172b",1281:"726e49b0",1358:"12866256",1425:"a22b72ee",1673:"5df204b2",1751:"f056dca4",1917:"1faf84b4",1973:"9d970edb",1994:"2ce48e5c",2241:"8d1a3974",2347:"364ede46",2378:"61d7a88c",2666:"ce488b35",2673:"d3c8ed64",2716:"ec60fc41",2758:"3423c09d",2846:"7fc81d28",3085:"c498ac94",3237:"f73b5933",3308:"bd558eb1",3416:"b5f66a60",3482:"f55ffe4f",3599:"102fb0cd",3769:"bf78469c",3800:"a6fde2fd",3976:"27072439",3987:"d57692bb",4745:"31ca9265",4884:"4c88e1cc",4972:"9fc7005b",4985:"62095289",5079:"b5a80d15",5124:"e54ec8a4",5133:"1db77f72",5648:"453117d5",5686:"a91d4a6a",5823:"31d71cf9",5825:"6cd65e6a",5874:"c3005cc5",5997:"8c218cb5",6030:"2b67b94e",6070:"41ecc58a",6161:"519bb473",6309:"a0c64b08",6401:"3303323d",6566:"84b27e6a",6588:"f8f565f8",6596:"8c205006",6856:"9a39db58",7098:"93935c9e",7173:"7e90bfdd",7181:"e29f95f5",7199:"615cc490",7306:"9650982f",7332:"afcd01b7",7340:"0adea3b3",7384:"67f95331",7414:"9fbb9d65",7494:"e5ecd680",7597:"55775b71",7719:"9bc72761",7873:"23bac3b0",7918:"01530e94",7986:"b08de4a7",7987:"30a21dfa",8130:"7d6fa593",8318:"889188ad",8710:"20663a38",8769:"49ec0a48",9012:"a297b114",9342:"3410e1f1",9455:"47701dfe",9514:"5e726ffb",9796:"da649158",9818:"1f1b94eb"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},b="docs:",r.l=(e,a,f,d)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==f)for(var n=document.getElementsByTagName("script"),i=0;i<n.length;i++){var u=n[i];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==b+f){t=u;break}}t||(o=!0,(t=document.createElement("script")).charset="utf-8",t.timeout=120,r.nc&&t.setAttribute("nonce",r.nc),t.setAttribute("data-webpack",b+f),t.src=e),c[e]=[a];var l=(a,f)=>{t.onerror=t.onload=null,clearTimeout(s);var b=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.forEach((e=>e(f))),a)return a(f)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/routingjs/",r.gca=function(e){return e={17896441:"7918",23817249:"6030",27302741:"7873",60784167:"1022",b5c59fa7:"39","935f2afb":"53","9e00c705":"130","705151d0":"313",ff78c6e0:"381",fc4d9247:"593","06aa6e93":"691","84af600f":"885",ffa310cd:"902","1b3415a5":"917","481e471a":"1281",a557ae41:"1358","5e5ac311":"1425","88cbaf7a":"1673",ebfbfacf:"1751",eff1c6c7:"1917",acc2462d:"1973",dd6706b8:"1994","43063e81":"2241","5ceb730d":"2347",b4f090cd:"2378",cb9481a5:"2673","4ae4fd96":"2716",b009f941:"2758",e356c530:"2846","1f391b9e":"3085","1df93b7f":"3237",c1888b50:"3308","4aa12286":"3416",d829a3a8:"3482","484329c4":"3599","5b8d0eef":"3769","2fbe5889":"3800","31c5dceb":"3976",d1df3a82:"3987","1745c884":"4745",a063e0e3:"4884",dd4f9bad:"4985","6b9ea5a6":"5079","1cd93e92":"5124",bc512349:"5133",c7a53f27:"5648","4105c75d":"5686","8fc6b66b":"5823",d17d046f:"5825","5ffeac76":"5874","855fb381":"5997","08932d0c":"6070",aa082b57:"6161",e33a542e:"6309",e69ab7fa:"6401","9ae98e8e":"6566",e6bf94c2:"6588","6ffa1466":"6596",e4e8843d:"6856",faa0839e:"7098","629bdd40":"7173",eca7e322:"7181","8f93cbcd":"7199",f6aebfbf:"7306",da631d65:"7332",ea776caf:"7340","7a832ccb":"7384","393be207":"7414",b45c6e46:"7494","5e8c322a":"7597",d08d5db0:"7719","35a07047":"7986","45d0475c":"7987",fd3e4606:"8130",b567fbc2:"8318","176abf51":"8710","9e3cb6c3":"8769","6ef32316":"9012","360d8d70":"9342","1291376a":"9455","1be78505":"9514","94bca0b8":"9796","3ebc895b":"9818"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,f)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)f.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((f,b)=>c=e[a]=[f,b]));f.push(c[2]=b);var d=r.p+r.u(a),t=new Error;r.l(d,(f=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var b=f&&("load"===f.type?"missing":f.type),d=f&&f.target&&f.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",t.name="ChunkLoadError",t.type=b,t.request=d,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,f)=>{var c,b,d=f[0],t=f[1],o=f[2],n=0;if(d.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(f);n<d.length;n++)b=d[n],r.o(e,b)&&e[b]&&e[b][0](),e[b]=0;return r.O(i)},f=self.webpackChunkdocs=self.webpackChunkdocs||[];f.forEach(a.bind(null,0)),f.push=a.bind(null,f.push.bind(f))})()})(); \ No newline at end of file diff --git a/docs/api.html b/docs/api.html new file mode 100644 index 0000000..b3cca0e --- /dev/null +++ b/docs/api.html @@ -0,0 +1,18 @@ +<!doctype html> +<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-api/index"> +<head> +<meta charset="UTF-8"> +<meta name="generator" content="Docusaurus v2.2.0"> +<title data-rh="true">routingjs | RoutingJS Documentation + + + + +
+

RoutingJS

example workflow

One lib to route them all : RoutingJS is a promise-based web client for accessing different +routing web services, analogous to our Python client routingpy. Get unified access to several routing services with the power of modern asynchronous JavaScript fully typed thanks to the power of TypeScript!

We currently support the following routers:

Future support for other service (like the ones routingpy is supporting) might come at a later stage.

Installation

Router clients are installable individually:

npm install @routingjs/valhalla

Examples

RoutingJS offers directions, matrix and reachability methods where available (e.g. OSRM does not support reachability/isochrones).

import { Valhalla } from "@routingjs/valhalla"

const v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de
v.directions(
[
[47.380742, 8.512516], // pass as [lat, lon]
[47.359467, 8.557835],
],
"auto"
).then((d) => {
// do stuff with the directions response
d.directions.forEach((direction) => {
console.log(direction.feature) // get the route as GeoJSON feature
console.log(direction.feature.properties.distance) // get the route distance
console.log(direction.feature.properties.duration) // get the route duration
})
})

v.reachability([47.380742, 8.512516], "pedestrian", [30, 90]).then((i) => {
i.isochrones.forEach((isochrone) => {
console.log(i.interval) // 30/90
console.log(i.intervalType) // "time"
console.log(i.feature) // GeoJSON feature
})
})

v.matrix(
[
[47.380742, 8.512516], // pass as [lat, lon]
[47.359467, 8.557835],
],
"auto"
).then((m) => {
console.log(m.durations) // get the durations array for each location
console.log(m.distances) // get the distances array for each location
})

Documentation

See here for the full documentation.

Contributing

Contributions are welcome! We are open to improvements of existing clients, as well as additions of +new ones :-)

+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.Client.html b/docs/api/classes/core.Client.html new file mode 100644 index 0000000..dfa2fde --- /dev/null +++ b/docs/api/classes/core.Client.html @@ -0,0 +1,18 @@ + + + + + +Class: Client<ResponseType, GetParams, PostParams> | RoutingJS Documentation + + + + +
+

Class: Client<ResponseType, GetParams, PostParams>

core.Client

The client class from which all underlying requests to the routing eninges' servers are made.

Type parameters

NameType
ResponseTypeResponseType
GetParamsextends Record<string | number, any> | undefined = undefined
PostParamsextends Record<string | number, any> | undefined = undefined

Implements

  • ClientInterface

Constructors

constructor

new Client<ResponseType, GetParams, PostParams>(baseURL, userAgent?, timeout?, retryOverQueryLimit?, headers?, maxRetries?, additionalAxiosOpts?)

Create a new client instance

Type parameters

NameType
ResponseTypeResponseType
GetParamsextends undefined | Record<string | number, any> = undefined
PostParamsextends undefined | Record<string | number, any> = undefined

Parameters

NameTypeDefault valueDescription
baseURLstringundefinedthe base URL that requests will be made to
userAgentstringoptions.defaultUserAgentdefine a custom user agent to be passed in each request header
timeoutnumberoptions.defaultTimeoutthe time to await a response
retryOverQueryLimitbooleanfalsewhether or not requests should be retried when receiving a status 429 response
headers?Objectundefinedadditional headers to be passed with each request
maxRetriesnumberoptions.defaultMaxRetriesthe maximum number of retries made by axios-retry
additionalAxiosOpts?AxiosRequestConfig<any>undefinedany additional options that are passed to the axios instance

Defined in

packages/core/Client.ts:77

Properties

additionalAxiosOpts

Optional additionalAxiosOpts: AxiosRequestConfig<any>

any additional options that are passed to the axios instance

Defined in

packages/core/Client.ts:84


axiosInstance

Protected axiosInstance: Axios

Defined in

packages/core/Client.ts:61


axiosOptions

Protected axiosOptions: AxiosRequestConfig<any>

Defined in

packages/core/Client.ts:62


baseURL

baseURL: string

the base URL that requests will be made to

Implementation of

ClientInterface.baseURL

Defined in

packages/core/Client.ts:78


headers

Optional Readonly headers: Object

additional headers to be passed with each request

Index signature

[k: string]: string | number

Defined in

packages/core/Client.ts:82


maxRetries

maxRetries: number = options.defaultMaxRetries

the maximum number of retries made by axios-retry

Implementation of

ClientInterface.maxRetries

Defined in

packages/core/Client.ts:83


proxy

Optional Readonly proxy: false | AxiosProxyConfig

Implementation of

ClientInterface.proxy

Defined in

packages/core/Client.ts:63


retryOverQueryLimit

retryOverQueryLimit: boolean = false

whether or not requests should be retried when +receiving a status 429 response

Implementation of

ClientInterface.retryOverQueryLimit

Defined in

packages/core/Client.ts:81


timeout

Readonly timeout: number = options.defaultTimeout

the time to await a response

Implementation of

ClientInterface.timeout

Defined in

packages/core/Client.ts:80


userAgent

userAgent: string = options.defaultUserAgent

define a custom user agent to be passed in each request header

Implementation of

ClientInterface.userAgent

Defined in

packages/core/Client.ts:79

Methods

request

request(requestArgs): Promise<string | ResponseType>

The main request method. Decides whether a GET or POST request is to be made depending on +the passed arguments.

Parameters

NameTypeDescription
requestArgsrequestArgs<GetParams, PostParams>the parameters passed as an object

Returns

Promise<string | ResponseType>

Defined in

packages/core/Client.ts:121

+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.Direction.html b/docs/api/classes/core.Direction.html new file mode 100644 index 0000000..eb5c41a --- /dev/null +++ b/docs/api/classes/core.Direction.html @@ -0,0 +1,16 @@ + + + + + +Class: Direction<T> | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.Directions.html b/docs/api/classes/core.Directions.html new file mode 100644 index 0000000..79529d8 --- /dev/null +++ b/docs/api/classes/core.Directions.html @@ -0,0 +1,16 @@ + + + + + +Class: Directions<T, U> | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.Isochrone.html b/docs/api/classes/core.Isochrone.html new file mode 100644 index 0000000..894863a --- /dev/null +++ b/docs/api/classes/core.Isochrone.html @@ -0,0 +1,16 @@ + + + + + +Class: Isochrone<T> | RoutingJS Documentation + + + + +
+

Class: Isochrone<T>

core.Isochrone

Type parameters

Name
T

Constructors

constructor

new Isochrone<T>(center, interval, intervalType, feature)

Type parameters

Name
T

Parameters

NameType
center[number, number]
intervalnumber
intervalTypestring
featureFeature<Geometry, T>

Defined in

packages/core/Isochrone.ts:11

Properties

center

Readonly center: [number, number]

Defined in

packages/core/Isochrone.ts:12


feature

Readonly feature: Feature<Geometry, T>

Defined in

packages/core/Isochrone.ts:15


interval

Readonly interval: number

Defined in

packages/core/Isochrone.ts:13


intervalType

Readonly intervalType: string

Defined in

packages/core/Isochrone.ts:14

+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.Isochrones.html b/docs/api/classes/core.Isochrones.html new file mode 100644 index 0000000..a65d27c --- /dev/null +++ b/docs/api/classes/core.Isochrones.html @@ -0,0 +1,16 @@ + + + + + +Class: Isochrones<T, U> | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.Matrix.html b/docs/api/classes/core.Matrix.html new file mode 100644 index 0000000..e79b794 --- /dev/null +++ b/docs/api/classes/core.Matrix.html @@ -0,0 +1,16 @@ + + + + + +Class: Matrix<T> | RoutingJS Documentation + + + + +
+

Class: Matrix<T>

core.Matrix

Type parameters

Name
T

Constructors

constructor

new Matrix<T>(durations, distances, raw)

Type parameters

Name
T

Parameters

NameType
durations(undefined | null | number)[][]
distances(undefined | null | number)[][]
rawT

Defined in

packages/core/Matrix.ts:2

Properties

distances

Readonly distances: (undefined | null | number)[][]

Defined in

packages/core/Matrix.ts:4


durations

Readonly durations: (undefined | null | number)[][]

Defined in

packages/core/Matrix.ts:3


raw

Readonly raw: T

Defined in

packages/core/Matrix.ts:5

+ + + + \ No newline at end of file diff --git a/docs/api/classes/core.RoutingJSAPIError.html b/docs/api/classes/core.RoutingJSAPIError.html new file mode 100644 index 0000000..922f4a4 --- /dev/null +++ b/docs/api/classes/core.RoutingJSAPIError.html @@ -0,0 +1,17 @@ + + + + + +Class: RoutingJSAPIError<T> | RoutingJS Documentation + + + + +
+

Class: RoutingJSAPIError<T>

core.RoutingJSAPIError

RoutingJSAPIError is the error class used to handle errors thrown by different routing +engines.

Type parameters

NameType
Textends ErrorProps

Hierarchy

  • Error

    RoutingJSAPIError

Constructors

constructor

new RoutingJSAPIError<T>(message, properties)

Type parameters

NameType
Textends ErrorProps

Parameters

NameType
messagestring
propertiesT

Overrides

Error.constructor

Defined in

packages/core/error.ts:21

Properties

message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1041


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1040


properties

Readonly properties: T

Defined in

packages/core/error.ts:19


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1042


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/ts4.8/globals.d.ts:11


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/ts4.8/globals.d.ts:13

Methods

toJSON

toJSON(): Object

Returns

Object

NameType
messagestring
propertiesT

Defined in

packages/core/error.ts:26


captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/ts4.8/globals.d.ts:4

+ + + + \ No newline at end of file diff --git a/docs/api/classes/graphhopper.GraphHopper.html b/docs/api/classes/graphhopper.GraphHopper.html new file mode 100644 index 0000000..cc0219e --- /dev/null +++ b/docs/api/classes/graphhopper.GraphHopper.html @@ -0,0 +1,17 @@ + + + + + +Class: GraphHopper | RoutingJS Documentation + + + + +
+

Class: GraphHopper

graphhopper.GraphHopper

Performs requests to the GraphHopper API. Default public URL is +https://graphhopper.com/api/1.

For the full documentation, see https://docs.graphhopper.com.

Implements

Constructors

constructor

new GraphHopper(clientArgs?)

Parameters

NameType
clientArgs?ClientConstructorArgs

Defined in

packages/graphhopper/index.ts:126

Properties

apiKey

Optional apiKey: string

Defined in

packages/graphhopper/index.ts:124


client

client: GraphHopperClient

Implementation of

BaseRouter.client

Defined in

packages/graphhopper/index.ts:123

Methods

directions

directions(locations, profile, directionsOpts?, dryRun?): Promise<GraphHopperDirections>

Get directions between two or more points. For the complete documentation, please see https://docs.graphhopper.com/#operation/postRoute.

Parameters

NameTypeDescription
locations[number, number][]coordinate tuples in lat/lon format
profileGraphHopperProfileone of GraphHopperProfile
directionsOpts?GraphHopperDirectionsOptsoptional parameters that are passed to the route endpoint. See GraphHopperDirectionsOpts
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<GraphHopperDirections>

Implementation of

BaseRouter.directions

Defined in

packages/graphhopper/index.ts:163

directions(locations, profile, directionsOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profileGraphHopperProfile
directionsOptsGraphHopperDirectionsOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.directions

Defined in

packages/graphhopper/index.ts:169


matrix

matrix(locations, profile, matrixOpts?, dryRun?): Promise<GraphHopperMatrix>

Makes a request to the /matrix endpoint.

Remarks

Currently not available on the open source version.

See

https://docs.graphhopper.com/#tag/Matrix-API for the full documentation.

Parameters

NameTypeDescription
locations[number, number][]Specify multiple points for which the weight-, route-, time- or distance-matrix should be calculated. In this case the starts are identical to the destinations. If there are N points, then NxN entries will be calculated. Format: [lat, lon]
profileGraphHopperProfileSpecifies the mode of transport.
matrixOpts?GraphHopperMatrixOptsadditional options specific to the matrix endpoint
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<GraphHopperMatrix>

Implementation of

BaseRouter.matrix

Defined in

packages/graphhopper/index.ts:369

matrix(locations, profile, matrixOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profileGraphHopperProfile
matrixOptsGraphHopperMatrixOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.matrix

Defined in

packages/graphhopper/index.ts:375


reachability

reachability(location, profile, intervals, isochronesOpts?, dryRun?): Promise<GraphHopperIsochrones>

Gets isochrones or equidistants for a range of time/distance values around a given set of coordinates.

See

https://docs.graphhopper.com/#tag/Isochrone-API for the full documentation.

Parameters

NameTypeDescription
location[number, number]One coordinate pair denoting the location. Format: [lat, lon]
profileGraphHopperProfileSpecifies the mode of transport.
intervals[number]Maximum range to calculate distances/durations for. You can also specify the buckets variable to break the single value into more isochrones. For compatibility reasons, this parameter is expressed as list. In meters or seconds depending on interval_type.
isochronesOpts?GraphHopperIsochroneOptsadditional options specific to the isochrone endpoint.
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<GraphHopperIsochrones>

Implementation of

BaseRouter.reachability

Defined in

packages/graphhopper/index.ts:265

reachability(location, profile, intervals, isochronesOpts, dryRun): Promise<string>

Parameters

NameType
location[number, number]
profileGraphHopperProfile
intervals[number]
isochronesOptsGraphHopperIsochroneOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.reachability

Defined in

packages/graphhopper/index.ts:272


parseDirectionsResponse

Static parseDirectionsResponse(response): GraphHopperDirections

Parse a response object returned from the /route endpoint and returns an Isochrone object.

Parameters

NameTypeDescription
responseGraphHopperRouteResponsethe response from the server

Returns

GraphHopperDirections

a new Directions object

Defined in

packages/graphhopper/index.ts:222


parseIsochroneResponse

Static parseIsochroneResponse(response, center, intervalType): GraphHopperIsochrones

Parses a response returned from the /isochrone endpoint and returns an Isochrones object.

Parameters

NameTypeDescription
responseGraphHopperIsochroneResponsea graphhopper isochrone response
center[number, number]the originally requested location
intervalType"time" | "distance"whether isodistances or isochrones were requested

Returns

GraphHopperIsochrones

a new Isochrones instance

Defined in

packages/graphhopper/index.ts:334


parseMatrixResponse

Static parseMatrixResponse(response): GraphHopperMatrix

Parse a response returned from the /matrix endpoint.

Parameters

NameTypeDescription
responseGraphHopperMatrixResponsea GraphHopper Matrix response

Returns

GraphHopperMatrix

a new Matrix instance

Defined in

packages/graphhopper/index.ts:431

+ + + + \ No newline at end of file diff --git a/docs/api/classes/ors.ORS.html b/docs/api/classes/ors.ORS.html new file mode 100644 index 0000000..f795e95 --- /dev/null +++ b/docs/api/classes/ors.ORS.html @@ -0,0 +1,16 @@ + + + + + +Class: ORS | RoutingJS Documentation + + + + +
+

Class: ORS

ors.ORS

Implements

Constructors

constructor

new ORS(clientArgs?)

Parameters

NameType
clientArgs?ClientConstructorArgs

Defined in

packages/ors/index.ts:91

Properties

apiKey

Optional apiKey: string

Defined in

packages/ors/index.ts:90


client

client: ORSClient

Implementation of

BaseRouter.client

Defined in

packages/ors/index.ts:89

Methods

directions

directions(locations, profile, directionsOpts?, dryRun?, format?): Promise<ORSDirections>

Parameters

NameType
locations[number, number][]
profileORSProfile
directionsOpts?ORSDirectionsOpts
dryRun?false
format?ORSFormat

Returns

Promise<ORSDirections>

Implementation of

BaseRouter.directions

Defined in

packages/ors/index.ts:120

directions(locations, profile, directionsOpts, dryRun, format?): Promise<string>

Parameters

NameType
locations[number, number][]
profileORSProfile
directionsOptsORSDirectionsOpts
dryRuntrue
format?ORSFormat

Returns

Promise<string>

Implementation of

BaseRouter.directions

Defined in

packages/ors/index.ts:127


matrix

matrix(locations, profile, matrixOpts?, dryRun?): Promise<ORSMatrix>

Parameters

NameType
locations[number, number][]
profileORSProfile
matrixOpts?ORSMatrixOpts
dryRun?false

Returns

Promise<ORSMatrix>

Implementation of

BaseRouter.matrix

Defined in

packages/ors/index.ts:315

matrix(locations, profile, matrixOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profileORSProfile
matrixOptsORSMatrixOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.matrix

Defined in

packages/ors/index.ts:321


reachability

reachability(location, profile, intervals, isochronesOpts?, dryRun?): Promise<ORSIsochrones>

Parameters

NameType
location[number, number]
profilestring
intervalsnumber[]
isochronesOpts?ORSIsochroneOpts
dryRun?false

Returns

Promise<ORSIsochrones>

Implementation of

BaseRouter.reachability

Defined in

packages/ors/index.ts:247

reachability(location, profile, intervals, isochronesOpts, dryRun): Promise<string>

Parameters

NameType
location[number, number]
profilestring
intervalsnumber[]
isochronesOptsORSIsochroneOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.reachability

Defined in

packages/ors/index.ts:254


parseDirectionsResponse

Static parseDirectionsResponse(response, format, units?): ORSDirections

Parameters

NameType
responseORSRouteResponse
formatORSFormat
units?ORSUnit

Returns

ORSDirections

Defined in

packages/ors/index.ts:183


parseIsochroneResponse

Static parseIsochroneResponse(response, intervalType?): ORSIsochrones

Parameters

NameType
responseORSIsochroneResponse
intervalType?"time" | "distance"

Returns

ORSIsochrones

Defined in

packages/ors/index.ts:295


parseMatrixResponse

Static parseMatrixResponse(response): ORSMatrix

Parameters

NameType
responseORSMatrixResponse

Returns

ORSMatrix

Defined in

packages/ors/index.ts:356

+ + + + \ No newline at end of file diff --git a/docs/api/classes/osrm.OSRM.html b/docs/api/classes/osrm.OSRM.html new file mode 100644 index 0000000..bd707ea --- /dev/null +++ b/docs/api/classes/osrm.OSRM.html @@ -0,0 +1,16 @@ + + + + + +Class: OSRM | RoutingJS Documentation + + + + +
+

Class: OSRM

osrm.OSRM

Implements

Constructors

constructor

new OSRM(clientArgs?)

Parameters

NameType
clientArgs?ClientConstructorArgs

Defined in

packages/osrm/index.ts:107

Properties

apiKey

Optional apiKey: string

Defined in

packages/osrm/index.ts:106


client

client: OSRMClient

Implementation of

BaseRouter.client

Defined in

packages/osrm/index.ts:105

Methods

directions

directions(locations, profile, directionsOpts?, dryRun?): Promise<OSRMDirections>

Makes a request to OSRM's /route endpoint.

Parameters

NameTypeDescription
locations[number, number][]The coordinates tuple the route should be calculated from in order of visit. Format: [lat, lon]
profilestringSpecifies the mode of transport (superfluous for OSRM)
directionsOpts?OSRMDirectionsOptsAdditional parameters
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<OSRMDirections>

Implementation of

BaseRouter.directions

Defined in

packages/osrm/index.ts:143

directions(locations, profile, directionsOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profilestring
directionsOptsOSRMDirectionsOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.directions

Defined in

packages/osrm/index.ts:149


matrix

matrix(locations, profile, matrixOpts?, dryRun?): Promise<OSRMMatrix>

Parameters

NameType
locations[number, number][]
profilestring
matrixOpts?OSRMMatrixOpts
dryRun?false

Returns

Promise<OSRMMatrix>

Implementation of

BaseRouter.matrix

Defined in

packages/osrm/index.ts:280

matrix(locations, profile, matrixOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profilestring
matrixOptsOSRMMatrixOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.matrix

Defined in

packages/osrm/index.ts:286


getDirectionParams

Static Protected getDirectionParams(directionsOpts?): Partial<OSRMRouteParams>

Parameters

NameType
directionsOptsOSRMDirectionsOpts

Returns

Partial<OSRMRouteParams>

Defined in

packages/osrm/index.ts:179


getMatrixParams

Static Protected getMatrixParams(matrixOpts): Partial<OSRMTableParams>

Parameters

NameType
matrixOptsOSRMMatrixOpts

Returns

Partial<OSRMTableParams>

Defined in

packages/osrm/index.ts:316


parseDirectionsResponse

Static parseDirectionsResponse(response, geometryFormat?): OSRMDirections

Parameters

NameType
responseOSRMRouteResponse
geometryFormat?OSRMGeometryType

Returns

OSRMDirections

Defined in

packages/osrm/index.ts:230


parseGeometry

Static Protected parseGeometry(routeGeometry?, geometryFormat?): undefined | OSRMGeometryObject

Parameters

NameType
routeGeometry?string | OSRMGeometryObject
geometryFormat?OSRMGeometryType

Returns

undefined | OSRMGeometryObject

Defined in

packages/osrm/index.ts:254


parseMatrixResponse

Static parseMatrixResponse(response): OSRMMatrix

Parameters

NameType
responseOSRMTableResponse

Returns

OSRMMatrix

Defined in

packages/osrm/index.ts:349

+ + + + \ No newline at end of file diff --git a/docs/api/classes/valhalla.Valhalla.html b/docs/api/classes/valhalla.Valhalla.html new file mode 100644 index 0000000..299f465 --- /dev/null +++ b/docs/api/classes/valhalla.Valhalla.html @@ -0,0 +1,16 @@ + + + + + +Class: Valhalla | RoutingJS Documentation + + + + +
+

Class: Valhalla

valhalla.Valhalla

Implements

Constructors

constructor

new Valhalla(clientArgs?)

Parameters

NameType
clientArgs?ClientConstructorArgs

Defined in

packages/valhalla/index.ts:283

Properties

apiKey

Optional apiKey: string

Defined in

packages/valhalla/index.ts:282


client

client: ValhallaClient

Implementation of

BaseRouter.client

Defined in

packages/valhalla/index.ts:281

Methods

directions

directions(locations, profile, directionsOpts?, dryRun?): Promise<ValhallaDirections>

Makes a request to Valhalla's /route endpoint.

See

ValhallaCostingType for available profiles

Parameters

NameTypeDescription
locations[number, number][]The coordinates tuple the route should be calculated from in order of visit. Format: [lat, lon]
profileValhallaCostingTypeSpecifies the mode of transport
directionsOpts?ValhallaDirectionOptsAdditional parameters, such as costing options.
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<ValhallaDirections>

Implementation of

BaseRouter.directions

Defined in

packages/valhalla/index.ts:319

directions(locations, profile, directionsOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profileValhallaCostingType
directionsOptsValhallaDirectionOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.directions

Defined in

packages/valhalla/index.ts:325


mapMatch

mapMatch(locations, profile, mapMatchOpts?, dryRun?): Promise<ValhallaDirections>

Makes a request to Valhalla's /trace_route endpoint.

See

ValhallaCostingType for available profiles

Parameters

NameTypeDescription
locations[number, number][]Format: [lat, lon]
profileValhallaCostingTypeSpecifies the mode of transport
mapMatchOpts?ValhallaTraceRouteOptsAdditional parameters, such as costing options.
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<ValhallaDirections>

Implementation of

BaseRouter.mapMatch

Defined in

packages/valhalla/index.ts:898

mapMatch(locations, profile, mapMatchOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profileValhallaCostingType
mapMatchOptsValhallaTraceRouteOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.mapMatch

Defined in

packages/valhalla/index.ts:904


matrix

matrix(locations, profile, matrixOpts?, dryRun?): Promise<ValhallaMatrix>

Makes a request to Valhalla's /matrix endpoint.

See

ValhallaCostingType for available profiles

Parameters

NameTypeDescription
locations[number, number][]Format: [lat, lon]
profileValhallaCostingTypeSpecifies the mode of transport
matrixOpts?ValhallaMatrixOptsAdditional parameters, such as costing options.
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<ValhallaMatrix>

Implementation of

BaseRouter.matrix

Defined in

packages/valhalla/index.ts:734

matrix(locations, profile, matrixOpts, dryRun): Promise<string>

Parameters

NameType
locations[number, number][]
profileValhallaCostingType
matrixOptsValhallaMatrixOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.matrix

Defined in

packages/valhalla/index.ts:740


parseDirectionsResponse

parseDirectionsResponse(response, type): ValhallaDirections

Parameters

NameType
responseValhallaRouteResponse
type"main"

Returns

ValhallaDirections

Defined in

packages/valhalla/index.ts:461

parseDirectionsResponse(response, type): Direction<ValhallaRouteResponse>

Parameters

NameType
responseValhallaRouteResponse
type"alternative"

Returns

Direction<ValhallaRouteResponse>

Defined in

packages/valhalla/index.ts:465


reachability

reachability(location, profile, intervals, isochronesOpts?, dryRun?): Promise<ValhallaIsochrones>

Makes a request to Valhalla's /isochrone endpoint.

See

ValhallaCostingType for available profiles

Parameters

NameTypeDescription
location[number, number]The coordinates tuple that represents the starting location. Format: [lat, lon]
profileValhallaCostingTypeSpecifies the mode of transport
intervalsnumber[]-
isochronesOpts?ValhallaIsochroneOptsAdditional parameters, such as costing options.
dryRun?falseif true, will not make the request and instead return an info string containing the URL and request parameters; for debugging

Returns

Promise<ValhallaIsochrones>

Implementation of

BaseRouter.reachability

Defined in

packages/valhalla/index.ts:539

reachability(location, profile, intervals, isochronesOpts, dryRun): Promise<string>

Parameters

NameType
location[number, number]
profileValhallaCostingType
intervalsnumber[]
isochronesOptsValhallaIsochroneOpts
dryRuntrue

Returns

Promise<string>

Implementation of

BaseRouter.reachability

Defined in

packages/valhalla/index.ts:546


_buildLocations

Static _buildLocations(coordinates): ValhallaLocation[]

Parameters

NameType
coordinates[number, number][]

Returns

ValhallaLocation[]

Defined in

packages/valhalla/index.ts:992

Static _buildLocations(coordinates): [ValhallaLocation]

Parameters

NameType
coordinates[number, number]

Returns

[ValhallaLocation]

Defined in

packages/valhalla/index.ts:995


getDirectionParams

Static getDirectionParams(locations, profile, directionsOpts?): ValhallaRouteParams

Parameters

NameType
locations[number, number][]
profileValhallaCostingType
directionsOptsValhallaDirectionOpts

Returns

ValhallaRouteParams

Defined in

packages/valhalla/index.ts:367


getIsochroneParams

Static getIsochroneParams(location, profile, intervals, isochroneOpts?): ValhallaIsochroneParams

Parameters

NameType
location[number, number]
profileValhallaCostingType
intervalsnumber[]
isochroneOptsValhallaIsochroneOpts

Returns

ValhallaIsochroneParams

Defined in

packages/valhalla/index.ts:594


getMatrixParams

Static getMatrixParams(locations, profile, matrixOpts?): ValhallaMatrixParams

Parameters

NameType
locations[number, number][]
profileValhallaCostingType
matrixOptsValhallaMatrixOpts

Returns

ValhallaMatrixParams

Defined in

packages/valhalla/index.ts:777


getTraceRouteParams

Static getTraceRouteParams(locations, profile, traceRouteOpts?): ValhallaTraceRouteParams

Parameters

NameType
locations[number, number][]
profileValhallaCostingType
traceRouteOptsValhallaTraceRouteOpts

Returns

ValhallaTraceRouteParams

Defined in

packages/valhalla/index.ts:945


parseIsochroneResponse

Static parseIsochroneResponse(response, location, intervals, intervalType): ValhallaIsochrones

Parameters

NameType
responseValhallaIsochroneResponse
location[number, number]
intervalsnumber[]
intervalType"time" | "distance"

Returns

ValhallaIsochrones

Defined in

packages/valhalla/index.ts:701


parseMatrixResponse

Static parseMatrixResponse(response, units): ValhallaMatrix

Parameters

NameType
responseValhallaMatrixResponse
unitsValhallaRequestUnit

Returns

ValhallaMatrix

Defined in

packages/valhalla/index.ts:869

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/core.BaseRouter.html b/docs/api/interfaces/core.BaseRouter.html new file mode 100644 index 0000000..9bd04e8 --- /dev/null +++ b/docs/api/interfaces/core.BaseRouter.html @@ -0,0 +1,16 @@ + + + + + +Interface: BaseRouter | RoutingJS Documentation + + + + +
+

Interface: BaseRouter

core.BaseRouter

Implemented by

Properties

client

client: Client<Record<string | number, any>, undefined | Record<string | number, any>, undefined | Record<string | number, any>>

Defined in

packages/core/BaseRouter.ts:52


directions

directions: (locations: number[][], profile: string, directionsOpts?: Record<string | number | symbol, JSONValue>, dryRun?: boolean) => Promise<string | Directions<any, any>>

Type declaration

▸ (locations, profile, directionsOpts?, dryRun?): Promise<string | Directions<any, any>>

Parameters
NameType
locationsnumber[][]
profilestring
directionsOpts?Record<string | number | symbol, JSONValue>
dryRun?boolean
Returns

Promise<string | Directions<any, any>>

Defined in

packages/core/BaseRouter.ts:58


mapMatch

Optional mapMatch: (locations: [number, number][], profile: string, mapMatchOpts?: JSONObject, dryRun?: boolean) => Promise<string | Directions<any, any>>

Type declaration

▸ (locations, profile, mapMatchOpts?, dryRun?): Promise<string | Directions<any, any>>

Parameters
NameType
locations[number, number][]
profilestring
mapMatchOpts?JSONObject
dryRun?boolean
Returns

Promise<string | Directions<any, any>>

Defined in

packages/core/BaseRouter.ts:80


matrix

matrix: (locations: [number, number][], profile: string, matrixOpts?: JSONObject, dryRun?: boolean) => Promise<string | Matrix<any>>

Type declaration

▸ (locations, profile, matrixOpts?, dryRun?): Promise<string | Matrix<any>>

Parameters
NameType
locations[number, number][]
profilestring
matrixOpts?JSONObject
dryRun?boolean
Returns

Promise<string | Matrix<any>>

Defined in

packages/core/BaseRouter.ts:65


reachability

Optional reachability: (location: [number, number], profile: string, intervals: number[], isochronesOpts?: JSONObject, dryRun?: boolean) => Promise<string | Isochrones<any, any>>

Type declaration

▸ (location, profile, intervals, isochronesOpts?, dryRun?): Promise<string | Isochrones<any, any>>

Parameters
NameType
location[number, number]
profilestring
intervalsnumber[]
isochronesOpts?JSONObject
dryRun?boolean
Returns

Promise<string | Isochrones<any, any>>

Defined in

packages/core/BaseRouter.ts:72

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/core.ClientConstructorArgs.html b/docs/api/interfaces/core.ClientConstructorArgs.html new file mode 100644 index 0000000..b5d4a42 --- /dev/null +++ b/docs/api/interfaces/core.ClientConstructorArgs.html @@ -0,0 +1,17 @@ + + + + + +Interface: ClientConstructorArgs | RoutingJS Documentation + + + + +
+

Interface: ClientConstructorArgs

core.ClientConstructorArgs

Properties

apiKey

Optional Readonly apiKey: string

Optional API key that is passed as part of the URL params

Defined in

packages/core/BaseRouter.ts:18


axiosOpts

Optional Readonly axiosOpts: AxiosRequestConfig<any>

other options passed to the axios instance

Defined in

packages/core/BaseRouter.ts:48


baseUrl

Optional Readonly baseUrl: string

Base URL that all requests are directed to. If not specified, +the router's default public API at is used (API key may be required)

Defined in

packages/core/BaseRouter.ts:13


headers

Optional Readonly headers: Object

additional headers passed to be passed in the request

Index signature

[k: string]: string

Defined in

packages/core/BaseRouter.ts:28


maxRetries

Optional Readonly maxRetries: number

maximum number of retries performed by axios-retry

Defined in

packages/core/BaseRouter.ts:43


retryOverQueryLimit

Optional Readonly retryOverQueryLimit: boolean

Whether requests should be retried on status code 429 responses

Defined in

packages/core/BaseRouter.ts:38


timeout

Optional Readonly timeout: number

Custom request timeout

Defined in

packages/core/BaseRouter.ts:33


userAgent

Optional Readonly userAgent: string

overwrites the default user agent header.

Defined in

packages/core/BaseRouter.ts:23

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/core.ErrorProps.html b/docs/api/interfaces/core.ErrorProps.html new file mode 100644 index 0000000..4da7570 --- /dev/null +++ b/docs/api/interfaces/core.ErrorProps.html @@ -0,0 +1,17 @@ + + + + + +Interface: ErrorProps | RoutingJS Documentation + + + + +
+

Interface: ErrorProps

core.ErrorProps

ErrorProps is the type of the properties field of the RoutingJSAPIError class. +It is used to provide additional information about the error.

Hierarchy

Properties

errorMessage

Optional errorMessage: string

errorMessage explains the error specific to that routing engine

Defined in

packages/core/error.ts:11


status

Optional status: string

status gives detailed info about that response

Defined in

packages/core/error.ts:9


statusCode

Optional statusCode: number

statusCode stands for the HTTP response status code

Defined in

packages/core/error.ts:7

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/core.JSONObject.html b/docs/api/interfaces/core.JSONObject.html new file mode 100644 index 0000000..3841533 --- /dev/null +++ b/docs/api/interfaces/core.JSONObject.html @@ -0,0 +1,16 @@ + + + + + +Interface: JSONObject | RoutingJS Documentation + + + + + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperErrorProps.html b/docs/api/interfaces/graphhopper.GraphHopperErrorProps.html new file mode 100644 index 0000000..933ac31 --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperErrorProps.html @@ -0,0 +1,18 @@ + + + + + +Interface: GraphHopperErrorProps | RoutingJS Documentation + + + + +
+

Interface: GraphHopperErrorProps

graphhopper.GraphHopperErrorProps

GraphHopperErrorProps returns additional information about the error thrown by the +GraphHopper routing engine. It sends a JSON response including an error message along with +a hints array.

Hierarchy

Properties

errorMessage

Optional errorMessage: string

errorMessage explains the error specific to that routing engine

Inherited from

ErrorProps.errorMessage

Defined in

packages/core/error.ts:11


hints

hints: GraphHopperHint[]

Defined in

packages/graphhopper/index.ts:46


status

Optional status: string

status gives detailed info about that response

Inherited from

ErrorProps.status

Defined in

packages/core/error.ts:9


statusCode

Optional statusCode: number

statusCode stands for the HTTP response status code

Inherited from

ErrorProps.statusCode

Defined in

packages/core/error.ts:7

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts.html b/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts.html new file mode 100644 index 0000000..27e36cd --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperIsochroneOpts.html @@ -0,0 +1,18 @@ + + + + + +Interface: GraphHopperIsochroneOpts | RoutingJS Documentation + + + + +
+

Interface: GraphHopperIsochroneOpts

graphhopper.GraphHopperIsochroneOpts

Hierarchy

Properties

buckets

Optional buckets: number

Number by which to divide the given time_limit / distance_limit to create buckets nested +isochrones of time intervals limit-n * limit / buckets.

Default Value

Defaults to 1.

Inherited from

Omit.buckets

Defined in

packages/graphhopper/parameters.ts:239


interval_type

Optional interval_type: "time" | "distance"

Defined in

packages/graphhopper/index.ts:90


reverse_flow

Optional reverse_flow: boolean

If false the flow goes from point to the polygon, if true the flow goes from the +polygon "inside" to the point.

Default Value

Defaults to false.

Inherited from

Omit.reverse_flow

Defined in

packages/graphhopper/parameters.ts:247

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams.html b/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams.html new file mode 100644 index 0000000..dc0357c --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperIsochroneParams.html @@ -0,0 +1,18 @@ + + + + + +Interface: GraphHopperIsochroneParams | RoutingJS Documentation + + + + +
+

Interface: GraphHopperIsochroneParams

graphhopper.GraphHopperIsochroneParams

All parameters accepted by the /isocrhone endpoint

Hierarchy

  • GraphHopperBaseParams

    GraphHopperIsochroneParams

Properties

buckets

Optional buckets: number

Number by which to divide the given time_limit / distance_limit to create buckets nested +isochrones of time intervals limit-n * limit / buckets.

Default Value

Defaults to 1.

Defined in

packages/graphhopper/parameters.ts:239


distance_limit

Optional distance_limit: number

Specify which distance the vehicle should travel. In meters.

Defined in

packages/graphhopper/parameters.ts:231


point

point: [number, number]

A single Lon/Lat tuple.

Defined in

packages/graphhopper/parameters.ts:222


profile

profile: GraphHopperProfile

The vehicle for which the route should be calculated.

Inherited from

GraphHopperBaseParams.profile

Defined in

packages/graphhopper/parameters.ts:9


reverse_flow

Optional reverse_flow: boolean

If false the flow goes from point to the polygon, if true the flow goes from the +polygon "inside" to the point.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:247


time_limit

Optional time_limit: number

Specify which time the vehicle should travel. In seconds.

Default Value

Defaults to 600.

Defined in

packages/graphhopper/parameters.ts:229

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse.html b/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse.html new file mode 100644 index 0000000..dc77da4 --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponse.html @@ -0,0 +1,16 @@ + + + + + +Interface: GraphHopperIsochroneResponse | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts.html b/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts.html new file mode 100644 index 0000000..73281eb --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperMatrixOpts.html @@ -0,0 +1,35 @@ + + + + + +Interface: GraphHopperMatrixOpts | RoutingJS Documentation + + + + +
+

Interface: GraphHopperMatrixOpts

graphhopper.GraphHopperMatrixOpts

Hierarchy

  • GraphHopperMatrixBaseOpts

    GraphHopperMatrixOpts

Properties

destinations

Optional destinations: number[]

Defined in

packages/graphhopper/index.ts:82


fail_fast

Optional fail_fast: boolean

Specifies whether or not the matrix calculation should return with an error as soon as +possible in case some points cannot be found or some points are not connected. If set +to false the time/weight/distance matrix will be calculated for all valid points and contain +the null value for all entries that could not be calculated. The hint field of the response +will also contain additional information about what went wrong.

Default Value

Defaults to true.

Inherited from

GraphHopperMatrixBaseOpts.fail_fast

Defined in

packages/graphhopper/parameters.ts:336


from_curbsides

Optional from_curbsides: GraphHopperCurbside[]

Specifies on which side a point should be relative to the driver when she leaves/arrives +at a start/target/via point. You need to specify this parameter for either none or all points. +Only supported for motor vehicles and OpenStreetMap.

Remarks

Array length needs to match from_points array length.

Inherited from

GraphHopperMatrixBaseOpts.from_curbsides

Defined in

packages/graphhopper/parameters.ts:308


from_point_hints

Optional from_point_hints: string[]

Specifies a hint for each from_point parameter to prefer a certain street for the closest +location lookup. E.g. if there is an address or house with two or more neighboring streets +you can control for which street the closest location is looked up.

Remarks

Array length needs to match from_points array length.

Inherited from

GraphHopperMatrixBaseOpts.from_point_hints

Defined in

packages/graphhopper/parameters.ts:280


out_arrays

Optional out_arrays: GraphHopperMatrixOut[]

Specifies which arrays should be included in the response. Specify one or more of +the following options 'weights', 'times', 'distances'. To specify more than one array +use e.g. out_array=times&out_array=distances. The units of the entries of distances +are meters, of times are seconds and of weights is arbitrary and it can differ for different +vehicles or versions of this API.

Inherited from

GraphHopperMatrixBaseOpts.out_arrays

Defined in

packages/graphhopper/parameters.ts:325


snap_preventions

Optional snap_preventions: string[]

Optional parameter to avoid snapping to a certain road class or road environment. +Multiple values are specified like snap_prevention=ferry&snap_prevention=motorway. +Please note that this feature does not e.g. avoid motorways for the route - it +only avoids it for the "location snap".

Remarks

Array length needs to match from_points array length.

Inherited from

GraphHopperMatrixBaseOpts.snap_preventions

Defined in

packages/graphhopper/parameters.ts:299


sources

Optional sources: number[]

Defined in

packages/graphhopper/index.ts:81


to_curbsides

Optional to_curbsides: GraphHopperCurbside[]

Specifies on which side a point should be relative to the driver when she leaves/arrives +at a start/target/via point. You need to specify this parameter for either none or all points. +Only supported for motor vehicles and OpenStreetMap.

Remarks

Array length needs to match from_points array length.

Inherited from

GraphHopperMatrixBaseOpts.to_curbsides

Defined in

packages/graphhopper/parameters.ts:317


to_point_hints

Optional to_point_hints: string[]

Specifies a hint for each from_point parameter to prefer a certain street for the closest +location lookup. E.g. if there is an address or house with two or more neighboring streets +you can control for which street the closest location is looked up.

Remarks

Array length needs to match from_points array length.

Inherited from

GraphHopperMatrixBaseOpts.to_point_hints

Defined in

packages/graphhopper/parameters.ts:289

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperMatrixParams.html b/docs/api/interfaces/graphhopper.GraphHopperMatrixParams.html new file mode 100644 index 0000000..fb4c994 --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperMatrixParams.html @@ -0,0 +1,37 @@ + + + + + +Interface: GraphHopperMatrixParams | RoutingJS Documentation + + + + +
+

Interface: GraphHopperMatrixParams

graphhopper.GraphHopperMatrixParams

All parameters accepted by the /matrix endpoint.

Hierarchy

  • GraphHopperBaseParams

    GraphHopperMatrixParams

Properties

fail_fast

Optional fail_fast: boolean

Specifies whether or not the matrix calculation should return with an error as soon as +possible in case some points cannot be found or some points are not connected. If set +to false the time/weight/distance matrix will be calculated for all valid points and contain +the null value for all entries that could not be calculated. The hint field of the response +will also contain additional information about what went wrong.

Default Value

Defaults to true.

Defined in

packages/graphhopper/parameters.ts:336


from_curbsides

Optional from_curbsides: GraphHopperCurbside[]

Specifies on which side a point should be relative to the driver when she leaves/arrives +at a start/target/via point. You need to specify this parameter for either none or all points. +Only supported for motor vehicles and OpenStreetMap.

Remarks

Array length needs to match from_points array length.

Defined in

packages/graphhopper/parameters.ts:308


from_point_hints

Optional from_point_hints: string[]

Specifies a hint for each from_point parameter to prefer a certain street for the closest +location lookup. E.g. if there is an address or house with two or more neighboring streets +you can control for which street the closest location is looked up.

Remarks

Array length needs to match from_points array length.

Defined in

packages/graphhopper/parameters.ts:280


from_points

from_points: [number, number][]

The starting points for the routes in an array of [longitude,latitude]. +For instance, if you want to calculate three routes from point A such as A->1, A->2, A->3 +then you have one from_point parameter and three to_point parameters.

Defined in

packages/graphhopper/parameters.ts:267


out_arrays

Optional out_arrays: GraphHopperMatrixOut[]

Specifies which arrays should be included in the response. Specify one or more of +the following options 'weights', 'times', 'distances'. To specify more than one array +use e.g. out_array=times&out_array=distances. The units of the entries of distances +are meters, of times are seconds and of weights is arbitrary and it can differ for different +vehicles or versions of this API.

Defined in

packages/graphhopper/parameters.ts:325


profile

profile: GraphHopperProfile

The vehicle for which the route should be calculated.

Inherited from

GraphHopperBaseParams.profile

Defined in

packages/graphhopper/parameters.ts:9


snap_preventions

Optional snap_preventions: string[]

Optional parameter to avoid snapping to a certain road class or road environment. +Multiple values are specified like snap_prevention=ferry&snap_prevention=motorway. +Please note that this feature does not e.g. avoid motorways for the route - it +only avoids it for the "location snap".

Remarks

Array length needs to match from_points array length.

Defined in

packages/graphhopper/parameters.ts:299


to_curbsides

Optional to_curbsides: GraphHopperCurbside[]

Specifies on which side a point should be relative to the driver when she leaves/arrives +at a start/target/via point. You need to specify this parameter for either none or all points. +Only supported for motor vehicles and OpenStreetMap.

Remarks

Array length needs to match from_points array length.

Defined in

packages/graphhopper/parameters.ts:317


to_point_hints

Optional to_point_hints: string[]

Specifies a hint for each from_point parameter to prefer a certain street for the closest +location lookup. E.g. if there is an address or house with two or more neighboring streets +you can control for which street the closest location is looked up.

Remarks

Array length needs to match from_points array length.

Defined in

packages/graphhopper/parameters.ts:289


to_points

to_points: [number, number][]

The destination points for the routes in an array of [longitude,latitude].

Defined in

packages/graphhopper/parameters.ts:271

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse.html b/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse.html new file mode 100644 index 0000000..faf079f --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperMatrixResponse.html @@ -0,0 +1,22 @@ + + + + + +Interface: GraphHopperMatrixResponse | RoutingJS Documentation + + + + +
+

Interface: GraphHopperMatrixResponse

graphhopper.GraphHopperMatrixResponse

The response object returned by the /matrix endpoint.

Properties

distances

Optional distances: number[][]

The distance matrix for the specified points in the same order as the time matrix. +The distances are in meters. If fail_fast=false the matrix will contain null for connections +that could not be found.

Defined in

packages/graphhopper/parameters.ts:359


hints

Optional hints: GraphHopperMatrixHint[]

Optional. Additional response data.

Defined in

packages/graphhopper/parameters.ts:376


info

info: GraphHopperResponseInfo

Additional information for your request

Defined in

packages/graphhopper/parameters.ts:374


times

Optional times: number[][]

The time matrix for the specified points in the order [[from1->to1, from1->to2, ...], [from2->to1, from2->to2, ...], ...]. +The times are in seconds. If fail_fast=false the matrix will contain null for connections that could not be found.

Defined in

packages/graphhopper/parameters.ts:365


weights

Optional weights: number[][]

The weight matrix for the specified points in the same order as the time matrix. +The weights for different vehicle profiles can have a different unit but the weights array +is perfectly suited as input for Vehicle Routing Problems as it is currently faster to calculate. +If fail_fast=false the matrix will contain null for connections that could not be found.

Defined in

packages/graphhopper/parameters.ts:372

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperRouteParams.html b/docs/api/interfaces/graphhopper.GraphHopperRouteParams.html new file mode 100644 index 0000000..f3b1c33 --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperRouteParams.html @@ -0,0 +1,49 @@ + + + + + +Interface: GraphHopperRouteParams | RoutingJS Documentation + + + + +
+

Interface: GraphHopperRouteParams

graphhopper.GraphHopperRouteParams

All parameters accepted by the /route endpoint

Hierarchy

  • GraphHopperBaseParams

    GraphHopperRouteParams

Properties

algorithm

Optional algorithm: GraphHopperAlgorithm

Rather than looking for the shortest or fastest path, this parameter lets you solve two +different problems related to routing: With alternative_route, we give you not one but several +routes that are close to optimal, but not too similar to each other. With round_trip, the +route will get you back to where you started. This is meant for fun (think of a bike trip), +so we will add some randomness.

Remarks

Requires ch.disabled = true.

Defined in

packages/graphhopper/parameters.ts:150


alternative_route.max_paths

Optional alternative_route.max_paths: number

This parameter sets the number of maximum +paths which should be calculated. Increasing can lead to worse alternatives.

Remarks

Requires ch.disabled = true. +Requires algorithm=alternative_route.

Default Value

Defaults to 2.

Defined in

packages/graphhopper/parameters.ts:186


alternative_route.max_share_factor

Optional alternative_route.max_share_factor: number

This parameter specifies how similar an alternative route can be to the optimal route. +Increasing can lead to worse alternatives.

Remarks

Requires ch.disabled = true. +Requires algorithm=alternative_route.

Default Value

Defaults to 0.6.

Defined in

packages/graphhopper/parameters.ts:214


alternative_route.max_weight_factor

Optional alternative_route.max_weight_factor: number

This parameter sets the factor by which the alternatives routes can be longer +than the optimal route. Increasing can lead to worse alternatives.

Remarks

Requires ch.disabled = true. +Requires algorithm=alternative_route.

Default Value

Defaults to 1.4.

Defined in

packages/graphhopper/parameters.ts:200


calc_points

Optional calc_points: boolean

Whether the points for the route should be calculated at all. If true, only returns +time and distance.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:72


ch.disable

Optional ch.disable: boolean

If certain optional parameters are set, contraction hierarchies need to be disabled using this flag. +Is detected automatically in the .directions() method, so no need to pass explicitly.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:93


curbsides

Optional curbsides: GraphHopperCurbside[]

Specifies on which side a point should be relative to the driver when she +leaves/arrives at a start/target/via point. You need to specify this parameter +for either none or all points. Only supported for motor vehicle profiles and OpenStreetMap.

Defined in

packages/graphhopper/parameters.ts:34


custom_model

Optional custom_model: JSONObject

The custom_model modifies the routing behaviour of the specified profile.

See

https://docs.graphhopper.com/#section/Custom-Model for full documentation.

Defined in

packages/graphhopper/parameters.ts:99


debug

Optional debug: boolean

If true, output will be formatted.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:78


details

Optional details: GraphHopperDetail[]

Enables additional attributes to be added to the returned path(s).

Defined in

packages/graphhopper/parameters.ts:48


elevation

Optional elevation: boolean

If true, a third coordinate, the altitude, is included with all positions in the response. +This changes the format of the points and snapped_waypoints fields of the response, in both +their encodings. Unless you switch off the points_encoded parameter, you need special code on +the client side that can handle three-dimensional coordinates.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:46


heading_penalty

Optional heading_penalty: number

Time penalty in seconds for not obeying a specified heading.

Remarks

Requires ch.disabled = true.

Default Value

Defaults to 120.

Defined in

packages/graphhopper/parameters.ts:124


headings

Optional headings: number[]

Favour a heading direction for a certain point. Specify either one heading for the start +point or as many as there are points. In this case headings are associated by their order +to the specific points. Headings are given as north based clockwise angle between 0 and 360 +degree. This parameter also influences the tour generated with algorithm=round_trip and forces +the initial direction.

Remarks

Requires ch.disabled = true.

Defined in

packages/graphhopper/parameters.ts:112


instructions

Optional instructions: boolean

If true, detailed instructions are returned.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:64


locale

Optional locale: string

The locale of the resulting turn instructions. Defaults to "en".

Defined in

packages/graphhopper/parameters.ts:36


optimize

Optional optimize: boolean

Normally, the calculated route will visit the points in the order you specified them. +If you have more than two points, you can set this parameter to "true" and the points may +be re-ordered to minimize the total travel time. Keep in mind that the limits on the number +of locations of the Route Optimization API applies, and the request costs more credits.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:58


pass_through

Optional pass_through: boolean

If true, u-turns are avoided at via-points with regard to the heading_penalty.

Remarks

Requires ch.disabled = true.

Default Value

Defaults to false.

Defined in

packages/graphhopper/parameters.ts:136


point_hints

Optional point_hints: string[]

Specifies a hint for each point in the points array to prefer a +certain street for the closest location lookup. E.g. if there is an +address or house with two or more neighboring streets you can control for +which street the closest location is looked up. Make sure you do not +include the house number of city name and only the street name to improve the +quality of the matching.

Defined in

packages/graphhopper/parameters.ts:26


points

points: [number, number][]

The points for the route in an array of [longitude,latitude].

Defined in

packages/graphhopper/parameters.ts:17


points_encoded

Optional points_encoded: boolean

If False the coordinates in point and snapped_waypoints are returned as array using the order +[lon,lat,elevation] for every point. If true the coordinates will be encoded as string leading to less bandwith usage.

Default Value

Defaults to true.

Defined in

packages/graphhopper/parameters.ts:85


profile

profile: GraphHopperProfile

The vehicle for which the route should be calculated.

Inherited from

GraphHopperBaseParams.profile

Defined in

packages/graphhopper/parameters.ts:9


round_trip.distance

Optional round_trip.distance: number

This parameter configures approximative length of the +resulting round trip.

Remarks

Requires ch.disabled = true. +Requires algorithm=round_trip.

Default Value

Defaults to 10000.

Defined in

packages/graphhopper/parameters.ts:163


round_trip.seed

Optional round_trip.seed: number

This sets the random seed. Change this to get a different tour for each value.

Remarks

Requires ch.disabled = true. +Requires algorithm=round_trip.

Defined in

packages/graphhopper/parameters.ts:172


snap_preventions

Optional snap_preventions: GraphHopperSnapPrevention[]

Parameter to avoid snapping to a certain road class or road environment

Defined in

packages/graphhopper/parameters.ts:28

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperRoutePath.html b/docs/api/interfaces/graphhopper.GraphHopperRoutePath.html new file mode 100644 index 0000000..c3a103d --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperRoutePath.html @@ -0,0 +1,22 @@ + + + + + +Interface: GraphHopperRoutePath | RoutingJS Documentation + + + + +
+

Interface: GraphHopperRoutePath

graphhopper.GraphHopperRoutePath

A route path object that includes the points along the route as well as additional route attributes.

Properties

ascend

ascend: number

The total ascent, in meters.

Defined in

packages/graphhopper/parameters.ts:470


bbox

bbox: [number, number, number, number]

The bounding box of the route geometry.

Defined in

packages/graphhopper/parameters.ts:483


descend

descend: number

The total descent, in meters.

Defined in

packages/graphhopper/parameters.ts:472


details

details: Object

Details, as requested with the details parameter. +Consider the value {"street_name": [[0,2,"Frankfurter Straße"],[2,6,"Zollweg"]]}. +In this example, the route uses two streets: The first, Frankfurter Straße, is used +between points[0] and points[2], and the second, Zollweg, between points[2] and points[6].

Type declaration

NameTypeDescription
lengthJSONValueReturns the length of a String object.
[iterator]-
anchor-
at-
big-
blink-
bold-
charAt-
charCodeAt-
codePointAt-
concat-
endsWith-
fixed-
fontcolor-
fontsize-
includes-
indexOf-
italics-
lastIndexOf-
link-
localeCompare-
match-
matchAll-
normalize-
padEnd-
padStart-
repeat-
replace-
search-
slice-
small-
split-
startsWith-
strike-
sub-
substr-
substring-
sup-
toLocaleLowerCase-
toLocaleUpperCase-
toLowerCase-
toString-
toUpperCase-
trim-
trimEnd-
trimLeft-
trimRight-
trimStart-
valueOf-

Defined in

packages/graphhopper/parameters.ts:495


distance

distance: number

The total distance, in meters.

See

https://www.graphhopper.com/blog/2019/11/28/routing-api-using-path-details/ for more details.

Defined in

packages/graphhopper/parameters.ts:462


instructions

instructions: GraphHopperInstruction[]

The instructions for this route. This feature is under active development, and our +instructions can sometimes be misleading, so be mindful when using them for navigation.

Defined in

packages/graphhopper/parameters.ts:488


points

Optional points: string | LineString

The geometry of the route. The format depends on the value of points_encoded.

Defined in

packages/graphhopper/parameters.ts:474


points_encoded

points_encoded: boolean

Whether the points and snapped_waypoints fields are polyline-encoded strings rather than +JSON arrays of coordinates. See the field description for more information on the two formats.

Defined in

packages/graphhopper/parameters.ts:481


points_order

points_order: number[]

An array of indices (zero-based), specifiying the order in which the input points are visited. +Only present if the optimize parameter was used.

Defined in

packages/graphhopper/parameters.ts:500


snapped_waypoints

snapped_waypoints: string | LineString

The snapped input points. The format depends on the value of points_encoded.

Defined in

packages/graphhopper/parameters.ts:476


time

time: number

The total travel time, in milliseconds.

See

https://www.graphhopper.com/blog/2019/11/28/routing-api-using-path-details/ for more details.

Defined in

packages/graphhopper/parameters.ts:468

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/graphhopper.GraphHopperRouteResponse.html b/docs/api/interfaces/graphhopper.GraphHopperRouteResponse.html new file mode 100644 index 0000000..912a046 --- /dev/null +++ b/docs/api/interfaces/graphhopper.GraphHopperRouteResponse.html @@ -0,0 +1,16 @@ + + + + + +Interface: GraphHopperRouteResponse | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSAlternateRouteParam.html b/docs/api/interfaces/ors.ORSAlternateRouteParam.html new file mode 100644 index 0000000..5aadb38 --- /dev/null +++ b/docs/api/interfaces/ors.ORSAlternateRouteParam.html @@ -0,0 +1,16 @@ + + + + + +Interface: ORSAlternateRouteParam | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSErrorProps.html b/docs/api/interfaces/ors.ORSErrorProps.html new file mode 100644 index 0000000..766da6f --- /dev/null +++ b/docs/api/interfaces/ors.ORSErrorProps.html @@ -0,0 +1,19 @@ + + + + + +Interface: ORSErrorProps | RoutingJS Documentation + + + + +
+

Interface: ORSErrorProps

ors.ORSErrorProps

ORSErrorProps returns additional information about the error thrown by the +ORS routing engine. It sends a JSON response with two props: error and info where the error +prop contains the error code and message. The info prop contains the engine version and +build date.

Hierarchy

Properties

errorCode

Optional errorCode: number

Defined in

packages/ors/index.ts:48


errorMessage

Optional errorMessage: string

errorMessage explains the error specific to that routing engine

Inherited from

ErrorProps.errorMessage

Defined in

packages/core/error.ts:11


status

Optional status: string

status gives detailed info about that response

Inherited from

ErrorProps.status

Defined in

packages/core/error.ts:9


statusCode

Optional statusCode: number

statusCode stands for the HTTP response status code

Inherited from

ErrorProps.statusCode

Defined in

packages/core/error.ts:7

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSIsochroneParams.html b/docs/api/interfaces/ors.ORSIsochroneParams.html new file mode 100644 index 0000000..6adb31b --- /dev/null +++ b/docs/api/interfaces/ors.ORSIsochroneParams.html @@ -0,0 +1,19 @@ + + + + + +Interface: ORSIsochroneParams | RoutingJS Documentation + + + + +
+

Interface: ORSIsochroneParams

ors.ORSIsochroneParams

Hierarchy

  • ORSBaseParams

    ORSIsochroneParams

Properties

area_units

Optional area_units: ORSUnit

Specifies the area unit.

Default Value

m

Defined in

packages/ors/parameters.ts:157


attributes

Optional attributes: ORSIsoAttribute[]

List of isochrones attributes

Defined in

packages/ors/parameters.ts:120


id

Optional id: string

Arbitrary identification string of the request reflected in the meta information.

Inherited from

ORSBaseParams.id

Defined in

packages/ors/parameters.ts:16


intersections

Optional intersections: boolean

Specifies whether to return intersecting polygons.

Default Value

false

Defined in

packages/ors/parameters.ts:127


interval

Optional interval: number

Interval of isochrones or equidistants. This is only used if a single range value is given. +Value in seconds for time and meters for distance.

Default Value

false

Defined in

packages/ors/parameters.ts:135


location_type

Optional location_type: "start" | "destination"

start treats the location(s) as starting point, destination as goal.

Default Value

start

Defined in

packages/ors/parameters.ts:142


locations

locations: [number, number][]

The locations to use for the route as an array of longitude/latitude pairs

Defined in

packages/ors/parameters.ts:113


options

Optional options: object

Additional options for the isochrones request

Defined in

packages/ors/parameters.ts:151


range

range: number[]

Maximum range value of the analysis in seconds for time and metres for distance. Alternatively +a comma separated list of specific range values. Ranges will be the same for all locations.

Defined in

packages/ors/parameters.ts:118


range_type

Optional range_type: "time" | "distance"

Specifies the isochrones reachability type.

Defined in

packages/ors/parameters.ts:144


smoothing

Optional smoothing: number

Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor +between 0 and 100.0.

Defined in

packages/ors/parameters.ts:149


time

Optional time: string

Departure date and time provided in local time zone

Defined in

packages/ors/parameters.ts:159


units

Optional units: ORSUnit

Specifies the distance units only if range_type is set to distance.

Default Value

Default: m.

Inherited from

ORSBaseParams.units

Defined in

packages/ors/parameters.ts:23

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSIsochroneResponse.html b/docs/api/interfaces/ors.ORSIsochroneResponse.html new file mode 100644 index 0000000..f69006b --- /dev/null +++ b/docs/api/interfaces/ors.ORSIsochroneResponse.html @@ -0,0 +1,16 @@ + + + + + +Interface: ORSIsochroneResponse | RoutingJS Documentation + + + + +
+

Interface: ORSIsochroneResponse

ors.ORSIsochroneResponse

Hierarchy

  • ORSBaseResponse

    ORSIsochroneResponse

Properties

bbox

bbox: ORSBbox

Bounding box that covers all returned isochrones

Defined in

packages/ors/parameters.ts:238


features

features: Feature<Geometry, any>[]

The features containing the isochrone/isodistance geometries

Defined in

packages/ors/parameters.ts:240


metadata

metadata: ORSMetaData

Information about the service and request

Inherited from

ORSBaseResponse.metadata

Defined in

packages/ors/parameters.ts:223


type

type: string

FeatureCollection

Defined in

packages/ors/parameters.ts:242

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSMatrixParams.html b/docs/api/interfaces/ors.ORSMatrixParams.html new file mode 100644 index 0000000..2643486 --- /dev/null +++ b/docs/api/interfaces/ors.ORSMatrixParams.html @@ -0,0 +1,22 @@ + + + + + +Interface: ORSMatrixParams | RoutingJS Documentation + + + + +
+

Interface: ORSMatrixParams

ors.ORSMatrixParams

Hierarchy

  • ORSBaseParams

    ORSMatrixParams

Properties

destinations

Optional destinations: number[]

A list of indices that refers to the list of locations (starting with 0). +{index_1},{index_2}[,{index_N} ...] or all (default). [0,3] for the first and +fourth locations

Default Value

all

Defined in

packages/ors/parameters.ts:173


id

Optional id: string

Arbitrary identification string of the request reflected in the meta information.

Inherited from

ORSBaseParams.id

Defined in

packages/ors/parameters.ts:16


locations

locations: [number, number][]

List of comma separated lists of longitude,latitude coordinates.

Defined in

packages/ors/parameters.ts:164


metrics

Optional metrics: ("distance" | "duration")[]

Arbitrary identification string of the request reflected in the meta information.

Defined in

packages/ors/parameters.ts:177


resolve_locations

Optional resolve_locations: boolean

Specifies whether given locations are resolved or not. If the parameter value set to true, +every element in destinations and sources will contain a name element that identifies the name +of the closest street.

Default Value

Default is false.

Defined in

packages/ors/parameters.ts:186


sources

Optional sources: number[]

A list of indices that refers to the list of locations (starting with 0). +{index_1},{index_2}[,{index_N} ...] or all (default). [0,3] for the first and +fourth locations

Default Value

all

Defined in

packages/ors/parameters.ts:195


units

Optional units: ORSUnit

Specifies the distance units only if range_type is set to distance.

Default Value

Default: m.

Inherited from

ORSBaseParams.units

Defined in

packages/ors/parameters.ts:23

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSMatrixResponse.html b/docs/api/interfaces/ors.ORSMatrixResponse.html new file mode 100644 index 0000000..d7c8b37 --- /dev/null +++ b/docs/api/interfaces/ors.ORSMatrixResponse.html @@ -0,0 +1,16 @@ + + + + + +Interface: ORSMatrixResponse | RoutingJS Documentation + + + + +
+

Interface: ORSMatrixResponse

ors.ORSMatrixResponse

Hierarchy

  • ORSBaseResponse

    ORSMatrixResponse

Properties

destinations

destinations: ORSMatrixResult[]

The individual destinations of the matrix calculations.

Defined in

packages/ors/parameters.ts:249


distances

distances: number[][]

The distances of the matrix calculations.

Defined in

packages/ors/parameters.ts:251


durations

durations: number[][]

The durations of the matrix calculations.

Defined in

packages/ors/parameters.ts:253


metadata

metadata: ORSMetaData

Information about the service and request

Inherited from

ORSBaseResponse.metadata

Defined in

packages/ors/parameters.ts:223


sources

sources: ORSMatrixResult[]

The individual sourcesof the matrix calculations.

Defined in

packages/ors/parameters.ts:247

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSRoute.html b/docs/api/interfaces/ors.ORSRoute.html new file mode 100644 index 0000000..14012f8 --- /dev/null +++ b/docs/api/interfaces/ors.ORSRoute.html @@ -0,0 +1,16 @@ + + + + + +Interface: ORSRoute | RoutingJS Documentation + + + + +
+

Interface: ORSRoute

ors.ORSRoute

Properties

arrival

arrival: string

Arrival date and time

Defined in

packages/ors/parameters.ts:300


bbox

bbox: ORSBbox

A bounding box which contains the entire route

Defined in

packages/ors/parameters.ts:302


departure

departure: string

Departure date and time

Defined in

packages/ors/parameters.ts:304


extras

extras: object[]

List of extra info objects representing the extra info items that were requested for the route.

Defined in

packages/ors/parameters.ts:308


geometry

Optional geometry: string

The route geometry as a decoded polyline

Defined in

packages/ors/parameters.ts:318


segments

segments: ORSSegment[]

List containing the segments and its corresponding steps which make up the route.

Defined in

packages/ors/parameters.ts:310


summary

summary: ORSSummary

Summary information about the route

Defined in

packages/ors/parameters.ts:312


warnings

Optional warnings: ORSWarning[]

List of warnings that have been generated for the route

Defined in

packages/ors/parameters.ts:314


way_points

Optional way_points: number[]

List containing the indices of way points corresponding to the geometry.

Defined in

packages/ors/parameters.ts:316

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSRouteParams.html b/docs/api/interfaces/ors.ORSRouteParams.html new file mode 100644 index 0000000..882e773 --- /dev/null +++ b/docs/api/interfaces/ors.ORSRouteParams.html @@ -0,0 +1,25 @@ + + + + + +Interface: ORSRouteParams | RoutingJS Documentation + + + + +
+

Interface: ORSRouteParams

ors.ORSRouteParams

Hierarchy

  • ORSBaseParams

    ORSRouteParams

Properties

alternative_routes

Optional alternative_routes: ORSAlternateRouteParam

Specifies whether alternative routes are computed, and parameters for the algorithm determining +suitable alternatives.

Defined in

packages/ors/parameters.ts:33


attrributes

Optional attrributes: ORSAttribute[]

List of route attributes

Defined in

packages/ors/parameters.ts:35


continue_straight

Optional continue_straight: boolean

Forces the route to keep going straight at waypoints restricting uturns there even if it would be faster.

Defined in

packages/ors/parameters.ts:37


coordinates

coordinates: [number, number][]

The locations to use for the route as an array of longitude/latitude pairs

Defined in

packages/ors/parameters.ts:28


elevation

Optional elevation: boolean

Specifies whether to return elevation values for points. Please note that elevation also gets +encoded for json response encoded polyline.

Defined in

packages/ors/parameters.ts:48


extra_info

Optional extra_info: ORSExtraInfo[]

The extra info items to include in the response

Defined in

packages/ors/parameters.ts:50


geometry

Optional geometry: boolean

Specifies whether to return geometry.

Default Value

true

Defined in

packages/ors/parameters.ts:102


geometry_simplify

Optional geometry_simplify: boolean

Specifies whether to simplify the geometry. Simplify geometry cannot be applied to routes +with more than one segment and when extra_info is required.

Defined in

packages/ors/parameters.ts:55


id

Optional id: string

Arbitrary identification string of the request reflected in the meta information.

Inherited from

ORSBaseParams.id

Defined in

packages/ors/parameters.ts:16


instructions

Optional instructions: boolean

Specifies whether to return instructions.

Defined in

packages/ors/parameters.ts:57


instructions_format

Optional instructions_format: ORSInstructionFormat

Select html for more verbose instructions.

Defined in

packages/ors/parameters.ts:59


language

Optional language: string

Language for the route instructions.

Defined in

packages/ors/parameters.ts:61


maneuvers

Optional maneuvers: boolean

Specifies whether the maneuver object is included into the step object or not.

Default Value

false

Defined in

packages/ors/parameters.ts:68


maximum_speed

Optional maximum_speed: number

The maximum speed specified by user.

Defined in

packages/ors/parameters.ts:106


options

Optional options: object

For advanced options formatted as json object.

See

https://giscience.github.io/openrouteservice/documentation/routing-options/Examples.html for examples.

Defined in

packages/ors/parameters.ts:43


preference

Optional preference: ORSPreference

Specifies the route preference.

Defined in

packages/ors/parameters.ts:70


radiuses

Optional radiuses: number[]

A list of maximum distances (measured in metres) that limit the search of nearby road segments +to every given waypoint. The values must be greater than 0, the value of -1 specifies using the +maximum possible search radius. The number of radiuses correspond to the number of waypoints. +If only a single value is given, it will be applied to all waypoints.

Defined in

packages/ors/parameters.ts:77


roundabout_exits

Optional roundabout_exits: boolean

Provides bearings of the entrance and all passed roundabout exits. Adds the exit_bearings +array to the step object in the response.

Defined in

packages/ors/parameters.ts:82


skip_segments

Optional skip_segments: number[]

Specifies the segments that should be skipped in the route calculation. A segment is the +connection between two given coordinates and the counting starts with 1 for the connection +between the first and second coordinate.

Defined in

packages/ors/parameters.ts:88


suppress_warnings

Optional suppress_warnings: boolean

Suppress warning messages in the response

Default Value

false

Defined in

packages/ors/parameters.ts:95


units

Optional units: ORSUnit

Specifies the distance units only if range_type is set to distance.

Default Value

Default: m.

Inherited from

ORSBaseParams.units

Defined in

packages/ors/parameters.ts:23

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/ors.ORSRouteResponse.html b/docs/api/interfaces/ors.ORSRouteResponse.html new file mode 100644 index 0000000..25f1e72 --- /dev/null +++ b/docs/api/interfaces/ors.ORSRouteResponse.html @@ -0,0 +1,16 @@ + + + + + +Interface: ORSRouteResponse | RoutingJS Documentation + + + + +
+

Interface: ORSRouteResponse

ors.ORSRouteResponse

Hierarchy

  • ORSBaseResponse

    ORSRouteResponse

Properties

bbox

bbox: ORSBbox

Defined in

packages/ors/parameters.ts:227


features

Optional features: Feature<LineString, any>[]

If the /geojson endpoint was requested

Defined in

packages/ors/parameters.ts:233


metadata

metadata: ORSMetaData

Information about the service and request

Inherited from

ORSBaseResponse.metadata

Defined in

packages/ors/parameters.ts:223


routes

Optional routes: ORSRoute[]

A list of routes returned from the request

Defined in

packages/ors/parameters.ts:229


type

Optional type: "FeatureCollection"

If the /geojson endpoint was requested

Defined in

packages/ors/parameters.ts:231

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMDirectionsOpts.html b/docs/api/interfaces/osrm.OSRMDirectionsOpts.html new file mode 100644 index 0000000..56b1e41 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMDirectionsOpts.html @@ -0,0 +1,19 @@ + + + + + +Interface: OSRMDirectionsOpts | RoutingJS Documentation + + + + +
+

Interface: OSRMDirectionsOpts

osrm.OSRMDirectionsOpts

Hierarchy

Properties

alternatives

Optional alternatives: number | false

Search for alternative routes and return as well.

Remarks

Please note that even if an alternative route is requested, a result cannot be guaranteed.

Defined in

packages/osrm/index.ts:69


annotations

Optional annotations: boolean

Returns additional metadata for each coordinate along the route geometry.

Defined in

packages/osrm/index.ts:78


bearings

Optional bearings: (null | [number, null | number])[]

Limits the search to segments with given bearing in degrees towards true north in +clockwise direction.

Inherited from

OSRMBaseOpts.bearings

Defined in

packages/osrm/index.ts:59


continueStraight

Optional continueStraight: boolean | "default"

Forces the route to keep going straight at waypoints constraining uturns there even if +it would be faster. Default value depends on the profile.

Defined in

packages/osrm/index.ts:76


geometries

Optional geometries: OSRMGeometryType

Returned route geometry format (influences overview and per step)

Defined in

packages/osrm/index.ts:80


overview

Optional overview: OSRMOverviewType

Add overview geometry either full, simplified according to highest zoom level it +could be display on, or not at all.

Defined in

packages/osrm/index.ts:85


radiuses

Optional radiuses: (null | number)[]

Limits the search to given radius in meters.

Inherited from

OSRMBaseOpts.radiuses

Defined in

packages/osrm/index.ts:54


steps

Optional steps: boolean

Return route steps for each route leg

Defined in

packages/osrm/index.ts:71

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMErrorProps.html b/docs/api/interfaces/osrm.OSRMErrorProps.html new file mode 100644 index 0000000..01363f7 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMErrorProps.html @@ -0,0 +1,18 @@ + + + + + +Interface: OSRMErrorProps | RoutingJS Documentation + + + + +
+

Interface: OSRMErrorProps

osrm.OSRMErrorProps

OSRMErrorProps returns additional information about the error thrown by the +OSRM routing engine. It sends a JSON response with the following fields: code and message, +where the specific code defines the kind of error that occurred.

Hierarchy

Properties

errorCode

Optional errorCode: number

Defined in

packages/osrm/index.ts:37


errorMessage

Optional errorMessage: string

errorMessage explains the error specific to that routing engine

Inherited from

ErrorProps.errorMessage

Defined in

packages/core/error.ts:11


status

Optional status: string

status gives detailed info about that response

Inherited from

ErrorProps.status

Defined in

packages/core/error.ts:9


statusCode

Optional statusCode: number

statusCode stands for the HTTP response status code

Inherited from

ErrorProps.statusCode

Defined in

packages/core/error.ts:7

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMGeometryObject.html b/docs/api/interfaces/osrm.OSRMGeometryObject.html new file mode 100644 index 0000000..2bca19a --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMGeometryObject.html @@ -0,0 +1,16 @@ + + + + + +Interface: OSRMGeometryObject | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMMatrixOpts.html b/docs/api/interfaces/osrm.OSRMMatrixOpts.html new file mode 100644 index 0000000..d461c49 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMMatrixOpts.html @@ -0,0 +1,19 @@ + + + + + +Interface: OSRMMatrixOpts | RoutingJS Documentation + + + + +
+

Interface: OSRMMatrixOpts

osrm.OSRMMatrixOpts

Hierarchy

Properties

alternatives

Optional alternatives: number | false

Search for alternative routes and return as well.

Remarks

Please note that even if an alternative route is requested, a result cannot be guaranteed.

Inherited from

OSRMDirectionsOpts.alternatives

Defined in

packages/osrm/index.ts:69


annotations

Optional annotations: boolean

Returns additional metadata for each coordinate along the route geometry.

Inherited from

OSRMDirectionsOpts.annotations

Defined in

packages/osrm/index.ts:78


bearings

Optional bearings: (null | [number, null | number])[]

Limits the search to segments with given bearing in degrees towards true north in +clockwise direction.

Inherited from

OSRMDirectionsOpts.bearings

Defined in

packages/osrm/index.ts:59


continueStraight

Optional continueStraight: boolean | "default"

Forces the route to keep going straight at waypoints constraining uturns there even if +it would be faster. Default value depends on the profile.

Inherited from

OSRMDirectionsOpts.continueStraight

Defined in

packages/osrm/index.ts:76


destinations

Optional destinations: number[]

Use location with given index as destination.

Defined in

packages/osrm/index.ts:92


geometries

Optional geometries: OSRMGeometryType

Returned route geometry format (influences overview and per step)

Inherited from

OSRMDirectionsOpts.geometries

Defined in

packages/osrm/index.ts:80


overview

Optional overview: OSRMOverviewType

Add overview geometry either full, simplified according to highest zoom level it +could be display on, or not at all.

Inherited from

OSRMDirectionsOpts.overview

Defined in

packages/osrm/index.ts:85


radiuses

Optional radiuses: (null | number)[]

Limits the search to given radius in meters.

Inherited from

OSRMDirectionsOpts.radiuses

Defined in

packages/osrm/index.ts:54


sources

Optional sources: number[]

Use location with given index as source.

Defined in

packages/osrm/index.ts:90


steps

Optional steps: boolean

Return route steps for each route leg

Inherited from

OSRMDirectionsOpts.steps

Defined in

packages/osrm/index.ts:71

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMRoute.html b/docs/api/interfaces/osrm.OSRMRoute.html new file mode 100644 index 0000000..37ba989 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMRoute.html @@ -0,0 +1,17 @@ + + + + + +Interface: OSRMRoute | RoutingJS Documentation + + + + +
+

Interface: OSRMRoute

osrm.OSRMRoute

Properties

distance

distance: number

The distance traveled by the route, in float meters.

Defined in

packages/osrm/parameters.ts:82


duration

duration: number

The estimated travel time, in float number of seconds.

Defined in

packages/osrm/parameters.ts:84


geometry

Optional geometry: string | OSRMGeometryObject

The whole geometry of the route value depending on overview parameter, format depending +on the geometries parameter. See RouteStep's geometry field for a parameter documentation.

Defined in

packages/osrm/parameters.ts:78


legs

legs: OSRMLeg[]

The legs between the given waypoints, an array of RouteLeg objects.

Defined in

packages/osrm/parameters.ts:80

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMRouteParams.html b/docs/api/interfaces/osrm.OSRMRouteParams.html new file mode 100644 index 0000000..fa05849 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMRouteParams.html @@ -0,0 +1,21 @@ + + + + + +Interface: OSRMRouteParams | RoutingJS Documentation + + + + +
+

Interface: OSRMRouteParams

osrm.OSRMRouteParams

Hierarchy

  • OSRMBaseParams

    OSRMRouteParams

Properties

alternatives

Optional alternatives: string

Search for alternative routes and return as well.

Remarks

Please note that even if an alternative route is requested, a result cannot be guaranteed.

Defined in

packages/osrm/parameters.ts:32


annotations

Optional annotations: string

Returns additional metadata for each coordinate along the route geometry.

Defined in

packages/osrm/parameters.ts:36


bearings

Optional bearings: string

Limits the search to segments with given bearing in degrees towards true north in +clockwise direction.

Inherited from

OSRMBaseParams.bearings

Defined in

packages/osrm/parameters.ts:18


continue_straight

Optional continue_straight: string

Forces the route to keep going straight at waypoints constraining uturns there even if +it would be faster. Default value depends on the profile.

Defined in

packages/osrm/parameters.ts:48


coordinates

coordinates: string

String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] +or polyline({polyline}).

Inherited from

OSRMBaseParams.coordinates

Defined in

packages/osrm/parameters.ts:8


geometries

Optional geometries: OSRMGeometryType

Returned route geometry format (influences overview and per step)

Defined in

packages/osrm/parameters.ts:38


hint

Optional hint: string

Hint from previous request to derive position in street network.

Inherited from

OSRMBaseParams.hint

Defined in

packages/osrm/parameters.ts:22


overview

Optional overview: OSRMOverviewType

Add overview geometry either full, simplified according to highest zoom level it +could be display on, or not at all.

Defined in

packages/osrm/parameters.ts:43


profile

profile: string

Mode of transportation, is determined statically by the Lua profile that is used to prepare +the data using osrm-extract. Typically car, bike or foot if using one of the supplied profiles.

Inherited from

OSRMBaseParams.profile

Defined in

packages/osrm/parameters.ts:13


radiuses

Optional radiuses: string

Limits the search to given radius in meters.

Inherited from

OSRMBaseParams.radiuses

Defined in

packages/osrm/parameters.ts:20


steps

Optional steps: string

Return route steps for each route leg

Defined in

packages/osrm/parameters.ts:34

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMRouteResponse.html b/docs/api/interfaces/osrm.OSRMRouteResponse.html new file mode 100644 index 0000000..bc693d9 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMRouteResponse.html @@ -0,0 +1,17 @@ + + + + + +Interface: OSRMRouteResponse | RoutingJS Documentation + + + + +
+

Interface: OSRMRouteResponse

osrm.OSRMRouteResponse

Hierarchy

  • OSRMBaseResponse

    OSRMRouteResponse

Properties

code

code: OSRMResponseCode

Every response object has a code field containing one of the strings below or a +service dependent code:

Inherited from

OSRMBaseResponse.code

Defined in

packages/osrm/parameters.ts:59


message

Optional message: string

Optional human-readable error message. All other status types are service dependent.

Inherited from

OSRMBaseResponse.message

Defined in

packages/osrm/parameters.ts:61


routes

routes: OSRMRoute[]

An array of Route objects, ordered by descending recommendation rank.

Defined in

packages/osrm/parameters.ts:70


waypoints

Optional waypoints: OSRMWayPoint[]

Array of Waypoint objects representing all waypoints in order

Defined in

packages/osrm/parameters.ts:66

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMTableParams.html b/docs/api/interfaces/osrm.OSRMTableParams.html new file mode 100644 index 0000000..58a25c3 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMTableParams.html @@ -0,0 +1,19 @@ + + + + + +Interface: OSRMTableParams | RoutingJS Documentation + + + + +
+

Interface: OSRMTableParams

osrm.OSRMTableParams

Hierarchy

  • OSRMBaseParams

    OSRMTableParams

Properties

bearings

Optional bearings: string

Limits the search to segments with given bearing in degrees towards true north in +clockwise direction.

Inherited from

OSRMBaseParams.bearings

Defined in

packages/osrm/parameters.ts:18


coordinates

coordinates: string

String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] +or polyline({polyline}).

Inherited from

OSRMBaseParams.coordinates

Defined in

packages/osrm/parameters.ts:8


destinations

destinations: string

Use location with given index as destination.

Defined in

packages/osrm/parameters.ts:225


hint

Optional hint: string

Hint from previous request to derive position in street network.

Inherited from

OSRMBaseParams.hint

Defined in

packages/osrm/parameters.ts:22


profile

profile: string

Mode of transportation, is determined statically by the Lua profile that is used to prepare +the data using osrm-extract. Typically car, bike or foot if using one of the supplied profiles.

Inherited from

OSRMBaseParams.profile

Defined in

packages/osrm/parameters.ts:13


radiuses

Optional radiuses: string

Limits the search to given radius in meters.

Inherited from

OSRMBaseParams.radiuses

Defined in

packages/osrm/parameters.ts:20


sources

sources: string

Use location with given index as source.

Defined in

packages/osrm/parameters.ts:223

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/osrm.OSRMTableResponse.html b/docs/api/interfaces/osrm.OSRMTableResponse.html new file mode 100644 index 0000000..e28f291 --- /dev/null +++ b/docs/api/interfaces/osrm.OSRMTableResponse.html @@ -0,0 +1,18 @@ + + + + + +Interface: OSRMTableResponse | RoutingJS Documentation + + + + +
+

Interface: OSRMTableResponse

osrm.OSRMTableResponse

Hierarchy

  • OSRMBaseResponse

    OSRMTableResponse

Properties

code

code: OSRMResponseCode

Every response object has a code field containing one of the strings below or a +service dependent code:

Inherited from

OSRMBaseResponse.code

Defined in

packages/osrm/parameters.ts:59


destinations

destinations: OSRMWayPoint[]

array of Waypoint objects describing all destinations in order

Defined in

packages/osrm/parameters.ts:238


distances

distances: number[][]

Defined in

packages/osrm/parameters.ts:234


durations

durations: number[][]

array of arrays that stores the matrix in row-major order. durations[i][j] gives the travel +time from the i-th waypoint to the j-th waypoint. Values are given in seconds.

Defined in

packages/osrm/parameters.ts:233


message

Optional message: string

Optional human-readable error message. All other status types are service dependent.

Inherited from

OSRMBaseResponse.message

Defined in

packages/osrm/parameters.ts:61


sources

sources: OSRMWayPoint[]

array of Waypoint objects describing all sources in order

Defined in

packages/osrm/parameters.ts:236

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.MapboxAuthParams.html b/docs/api/interfaces/valhalla.MapboxAuthParams.html new file mode 100644 index 0000000..08aaefa --- /dev/null +++ b/docs/api/interfaces/valhalla.MapboxAuthParams.html @@ -0,0 +1,16 @@ + + + + + +Interface: MapboxAuthParams | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaContours.html b/docs/api/interfaces/valhalla.ValhallaContours.html new file mode 100644 index 0000000..69bf37d --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaContours.html @@ -0,0 +1,18 @@ + + + + + +Interface: ValhallaContours | RoutingJS Documentation + + + + +
+

Interface: ValhallaContours

valhalla.ValhallaContours

Properties

color

Optional color: string

The color for the output of the contour. Specify it as a Hex value, but without the #, +such as "color":"ff0000" for red. If no color is specified, the isochrone service will +assign a default color to the output.

Defined in

packages/valhalla/parameters.ts:172


distance

Optional distance: number

A floating point value specifying the distance in kilometers for the contour.

Defined in

packages/valhalla/parameters.ts:166


time

Optional time: number

A floating point value specifying the time in minutes for the contour.

Defined in

packages/valhalla/parameters.ts:164

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto.html b/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto.html new file mode 100644 index 0000000..68db850 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaCostingOptsAuto.html @@ -0,0 +1,52 @@ + + + + + +Interface: ValhallaCostingOptsAuto | RoutingJS Documentation + + + + +
+

Interface: ValhallaCostingOptsAuto

valhalla.ValhallaCostingOptsAuto

Hierarchy

Properties

closure_factor

Optional closure_factor: number

A factor that penalizes the cost when traversing a closed edge (eg: if +search_filter.exclude_closures is false for origin and/or destination location and the +route starts/ends on closed edges). Its value can range from 1.0 - don't penalize closed +edges, to 10.0 - apply high cost penalty to closed edges.

Default Value

Default value is 9.0.

Remarks

Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle, +motor_scooter, bus, truck & taxi

Defined in

packages/valhalla/parameters.ts:979


country_crossing_cost

Optional country_crossing_cost: number

A cost applied when encountering an international border. This cost is added to the +estimated and elapsed times.

Default Value

The default cost is 600 seconds.

Inherited from

ValhallaCostingOptsWheels.country_crossing_cost

Defined in

packages/valhalla/parameters.ts:746


country_crossing_penalty

Optional country_crossing_penalty: number

A penalty applied for a country crossing. This penalty can be used to create paths that +avoid spanning country boundaries.

Default Value

The default penalty is 0.

Inherited from

ValhallaCostingOptsWheels.country_crossing_penalty

Defined in

packages/valhalla/parameters.ts:754


exclude_cash_only_tolls

Optional exclude_cash_only_tolls: boolean

A boolean value which indicates the desire to avoid routes with cash-only tolls.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:1009


exclude_unpaved

Optional exclude_unpaved: boolean | 1

This value indicates whether or not the path may include unpaved roads. If exclude_unpaved +is set to 1 it is allowed to start and end with unpaved roads, but is not allowed to +have them in the middle of the route path, otherwise they are allowed.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:1002


ferry_cost

Optional ferry_cost: number

A cost applied when entering a ferry. This cost is added to the estimated and elapsed times.

Default Value

The default cost is 300 seconds (5 minutes).

Defined in

packages/valhalla/parameters.ts:892


fixed_speed

Optional fixed_speed: number

Fixed speed the vehicle can go. Used to override the calculated speed. Can be useful if +speed of vehicle is known. fixed_speed must be between 1 and 252 KPH.

Default Value

The default value is 0 KPH which disables fixed speed and falls back to the standard +calculated speed based on the road attribution.

Defined in

packages/valhalla/parameters.ts:955


gate_cost

Optional gate_cost: number

Inherited from

ValhallaCostingOptsWheels.gate_cost

Defined in

packages/valhalla/parameters.ts:737


gate_penalty

Optional gate_penalty: number

Inherited from

ValhallaCostingOptsWheels.gate_penalty

Defined in

packages/valhalla/parameters.ts:738


height

Optional height: number

The height of the vehicle (in meters).

Default Value

Default 1.9 for car, bus, taxi and 4.11 for truck.

Defined in

packages/valhalla/parameters.ts:986


ignore_closures

Optional ignore_closures: number

If set to true, ignores all closures, marked due to live traffic closures, +during routing.

Remarks

Note: This option cannot be set if location.search_filter.exclude_closures is also +specified in the request and will return an error if it is.

Defined in

packages/valhalla/parameters.ts:965


include_hot

Optional include_hot: boolean

A boolean value which indicates the desire to include tolled HOV roads which require the driver +to pay a toll if the occupant requirement isn't met.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:1033


include_hov2

Optional include_hov2: boolean

A boolean value which indicates the desire to include HOV roads with a 2-occupant requirement +in the route when advantageous.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:1017


include_hov3

Optional include_hov3: boolean

A boolean value which indicates the desire to include HOV roads with a 3-occupant requirement +in the route when advantageous.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:1025


maneuver_penalty

Optional maneuver_penalty: number

Inherited from

ValhallaCostingOptsWheels.maneuver_penalty

Defined in

packages/valhalla/parameters.ts:736


private_access_penalty

Optional private_access_penalty: number

A penalty applied when transitioning between roads that do not have consistent +naming–in other words, no road names in common. This penalty can be used to create +simpler routes that tend to have fewer maneuvers or narrative guidance instructions.

Default Value

The default maneuver penalty is five seconds.

Defined in

packages/valhalla/parameters.ts:869


service_factor

Optional service_factor: number

A factor that modifies (multiplies) the cost when generic service roads are encountered.

Default Value

The default service_factor is 1.

Defined in

packages/valhalla/parameters.ts:938


service_penalty

Optional service_penalty: number

A penalty applied for transition to generic service road. The default penalty is 0 for +trucks and 15 for cars, buses, motor scooters and motorcycles.

Inherited from

ValhallaCostingOptsWheels.service_penalty

Defined in

packages/valhalla/parameters.ts:719


shortest

Optional shortest: boolean

Changes the metric to quasi-shortest, i.e. purely distance-based costing.

Remarks

Note, this will disable all other costings & penalties. Also note, shortest will not +disable hierarchy pruning, leading to potentially sub-optimal routes for some costing +models.

Default Value

The default is false.

Inherited from

ValhallaCostingOptsWheels.shortest

Defined in

packages/valhalla/parameters.ts:732


toll_booth_cost

Optional toll_booth_cost: number

A cost applied when a toll booth is encountered. This cost is added to the estimated and +elapsed times.

Default Value

The default cost is 15 seconds.

Defined in

packages/valhalla/parameters.ts:877


toll_booth_penalty

Optional toll_booth_penalty: number

A penalty applied to the cost when a toll booth is encountered. This penalty can be used to +create paths that avoid toll roads.

Default Value

The default toll booth penalty is 0.

Defined in

packages/valhalla/parameters.ts:885


top_speed

Optional top_speed: number

Top speed the vehicle can go. Also used to avoid roads with higher speeds than this +value. top_speed must be between 10 and 252 KPH.

Default Value

The default value is 140 KPH.

Defined in

packages/valhalla/parameters.ts:946


use_ferry

Optional use_ferry: number

This value indicates the willingness to take ferries. This is a range of values +between 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries.

Default Value

The default value is 0.5.

Remarks

Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely.

Inherited from

ValhallaCostingOptsWheels.use_ferry

Defined in

packages/valhalla/parameters.ts:700


use_highways

Optional use_highways: number

This value indicates the willingness to take highways. This is a range of values between 0 +and 1. Values near 0 attempt to avoid highways and values near 1 will favor highways.

Default Value

The default value is 1.0.

Remarks

Note that sometimes highways are required to complete a route so +values of 0 are not guaranteed to avoid highways entirely.

Defined in

packages/valhalla/parameters.ts:904


use_living_streets

Optional use_living_streets: number

This value indicates the willingness to take living streets. This is a range of values +between 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will +favor living streets.

Default Value

The default value is 0 for trucks, 0.1 for cars, buses, motor +scooters and motorcycles.

Remarks

Note that sometimes living streets are required to complete +a route so values of 0 are not guaranteed to avoid living streets entirely.

Inherited from

ValhallaCostingOptsWheels.use_living_streets

Defined in

packages/valhalla/parameters.ts:714


use_tolls

Optional use_tolls: number

This value indicates the willingness to take roads with tolls. This is a range of values +between 0 and 1. Values near 0 attempt to avoid tolls and values near 1 will not attempt +to avoid them.

Default Value

The default value is 0.5.

Remarks

Note that sometimes roads with tolls are +required to complete a route so values of 0 are not guaranteed to avoid them entirely.

Defined in

packages/valhalla/parameters.ts:917


use_tracks

Optional use_tracks: number

This value indicates the willingness to take track roads. This is a range of values between +0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a +little bit.

Default Value

The default value is 0 for autos, 0.5 for motor scooters and motorcycles.

Remarks

Note that sometimes tracks are required to complete a route so values of 0 are +not guaranteed to avoid tracks entirely.

Defined in

packages/valhalla/parameters.ts:931


width

Optional width: number

The width of the vehicle (in meters).

Default Value

Default 1.6 for car, bus, taxi and 2.6 for truck.

Defined in

packages/valhalla/parameters.ts:993

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle.html b/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle.html new file mode 100644 index 0000000..deb96ee --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycle.html @@ -0,0 +1,51 @@ + + + + + +Interface: ValhallaCostingOptsBicycle | RoutingJS Documentation + + + + +
+

Interface: ValhallaCostingOptsBicycle

valhalla.ValhallaCostingOptsBicycle

Hierarchy

  • ValhallaCostingOptsWheels

    ValhallaCostingOptsBicycle

Properties

avoid_bad_surfaces

Optional avoid_bad_surfaces: number

This value is meant to represent how much a cyclist wants to avoid roads with poor surfaces +relative to the bicycle type being used. This is a range of values between 0 and 1. When the +value is 0, there is no penalization of roads with different surface types; only bicycle speed +on each surface is taken into account. As the value approaches 1, roads with poor surfaces for +the bike are penalized heavier so that they are only taken if they significantly +improve travel time. When the value is equal to 1, all bad surfaces are completely disallowed +from routing, including start and end points.

Default Value

The default value is 0.25.

Defined in

packages/valhalla/parameters.ts:1133


bicycle_type

Optional bicycle_type: ValhallaBicycleType

The type of bicycle.

Default Value

The default type is Hybrid.

Defined in

packages/valhalla/parameters.ts:1081


bss_return_cost

Optional bss_return_cost: number

This value is useful when bikeshare is chosen as travel mode. It is meant to give the time +will be used to return a rental bike. This value will be displayed in the final directions +and used to calculate the whole duation.

Default Value

The default value is 120 seconds.

Defined in

packages/valhalla/parameters.ts:1142


bss_return_penalty

Optional bss_return_penalty: number

This value is useful when bikeshare is chosen as travel mode. It is meant to describe the +potential effort to return a rental bike. This value won't be displayed and used only +inside of the algorithm.

Defined in

packages/valhalla/parameters.ts:1148


country_crossing_cost

Optional country_crossing_cost: number

A cost applied when encountering an international border. This cost is added to the +estimated and elapsed times.

Default Value

The default cost is 600 seconds.

Inherited from

ValhallaCostingOptsWheels.country_crossing_cost

Defined in

packages/valhalla/parameters.ts:746


country_crossing_penalty

Optional country_crossing_penalty: number

A penalty applied for a country crossing. This penalty can be used to create paths that +avoid spanning country boundaries.

Default Value

The default penalty is 0.

Inherited from

ValhallaCostingOptsWheels.country_crossing_penalty

Defined in

packages/valhalla/parameters.ts:754


cycling_speed

Optional cycling_speed: number

Cycling speed is the average travel speed along smooth, flat roads. This is meant to be the +speed a rider can comfortably maintain over the desired distance of the route.

Remarks

It can be modified (in the costing method) by surface type in conjunction with bicycle type +and (coming soon) by hilliness of the road section. When no speed is specifically provided, +the default speed is determined by the bicycle type and are as follows: +Road = 25 KPH (15.5 MPH), Cross = 20 KPH (13 MPH), Hybrid/City = 18 KPH (11.5 MPH), and +Mountain = 16 KPH (10 MPH).

Defined in

packages/valhalla/parameters.ts:1093


gate_cost

Optional gate_cost: number

Inherited from

ValhallaCostingOptsWheels.gate_cost

Defined in

packages/valhalla/parameters.ts:737


gate_penalty

Optional gate_penalty: number

Inherited from

ValhallaCostingOptsWheels.gate_penalty

Defined in

packages/valhalla/parameters.ts:738


maneuver_penalty

Optional maneuver_penalty: number

Inherited from

ValhallaCostingOptsWheels.maneuver_penalty

Defined in

packages/valhalla/parameters.ts:736


service_penalty

Optional service_penalty: number

A penalty applied for transition to generic service road. The default penalty is 0 for +trucks and 15 for cars, buses, motor scooters and motorcycles.

Inherited from

ValhallaCostingOptsWheels.service_penalty

Defined in

packages/valhalla/parameters.ts:719


shortest

Optional shortest: boolean

Changes the metric to quasi-shortest, i.e. purely distance-based costing.

Remarks

Note, this will disable all other costings & penalties. Also note, shortest will not +disable hierarchy pruning, leading to potentially sub-optimal routes for some costing +models.

Default Value

The default is false.

Inherited from

ValhallaCostingOptsWheels.shortest

Defined in

packages/valhalla/parameters.ts:732


use_ferry

Optional use_ferry: number

This value indicates the willingness to take ferries. This is a range of values +between 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries.

Default Value

The default value is 0.5.

Remarks

Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely.

Inherited from

ValhallaCostingOptsWheels.use_ferry

Defined in

packages/valhalla/parameters.ts:700


use_hills

Optional use_hills: number

A cyclist's desire to tackle hills in their routes. This is a range of values from 0 to 1, +where 0 attempts to avoid hills and steep grades even if it means a longer (time and distance) +path, while 1 indicates the rider does not fear hills and steeper grades. Based on the +use_hills factor, penalties are applied to roads based on elevation change and grade. These +penalties help the path avoid hilly roads in favor of flatter roads or less steep grades where +available. Note that it is not always possible to find alternate paths to avoid +hills (for example when route locations are in mountainous areas).

Default Value

The default value is 0.5.

Defined in

packages/valhalla/parameters.ts:1120


use_living_streets

Optional use_living_streets: number

This value indicates the willingness to take living streets. This is a range of values +between 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will +favor living streets.

Default Value

The default value is 0 for trucks, 0.1 for cars, buses, motor +scooters and motorcycles.

Remarks

Note that sometimes living streets are required to complete +a route so values of 0 are not guaranteed to avoid living streets entirely.

Inherited from

ValhallaCostingOptsWheels.use_living_streets

Defined in

packages/valhalla/parameters.ts:714


use_roads

Optional use_roads: number

A cyclist's propensity to use roads alongside other vehicles. This is a range of values +from 0 to 1, where 0 attempts to avoid roads and stay on cycleways and paths, and 1 indicates +the rider is more comfortable riding on roads.

Remarks

Based on the use_roads factor, roads with +certain classifications and higher speeds are penalized in an attempt to avoid them when +finding the best path.

Default Value

The default value is 0.5.

Defined in

packages/valhalla/parameters.ts:1107

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle.html b/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle.html new file mode 100644 index 0000000..d35a099 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycle.html @@ -0,0 +1,54 @@ + + + + + +Interface: ValhallaCostingOptsMotorcycle | RoutingJS Documentation + + + + +
+

Interface: ValhallaCostingOptsMotorcycle

valhalla.ValhallaCostingOptsMotorcycle

Hierarchy

Properties

closure_factor

Optional closure_factor: number

A factor that penalizes the cost when traversing a closed edge (eg: if +search_filter.exclude_closures is false for origin and/or destination location and the +route starts/ends on closed edges). Its value can range from 1.0 - don't penalize closed +edges, to 10.0 - apply high cost penalty to closed edges.

Default Value

Default value is 9.0.

Remarks

Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle, +motor_scooter, bus, truck & taxi

Inherited from

ValhallaCostingOptsAuto.closure_factor

Defined in

packages/valhalla/parameters.ts:979


country_crossing_cost

Optional country_crossing_cost: number

A cost applied when encountering an international border. This cost is added to the +estimated and elapsed times.

Default Value

The default cost is 600 seconds.

Inherited from

ValhallaCostingOptsAuto.country_crossing_cost

Defined in

packages/valhalla/parameters.ts:746


country_crossing_penalty

Optional country_crossing_penalty: number

A penalty applied for a country crossing. This penalty can be used to create paths that +avoid spanning country boundaries.

Default Value

The default penalty is 0.

Inherited from

ValhallaCostingOptsAuto.country_crossing_penalty

Defined in

packages/valhalla/parameters.ts:754


exclude_cash_only_tolls

Optional exclude_cash_only_tolls: boolean

A boolean value which indicates the desire to avoid routes with cash-only tolls.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.exclude_cash_only_tolls

Defined in

packages/valhalla/parameters.ts:1009


exclude_unpaved

Optional exclude_unpaved: boolean | 1

This value indicates whether or not the path may include unpaved roads. If exclude_unpaved +is set to 1 it is allowed to start and end with unpaved roads, but is not allowed to +have them in the middle of the route path, otherwise they are allowed.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.exclude_unpaved

Defined in

packages/valhalla/parameters.ts:1002


ferry_cost

Optional ferry_cost: number

A cost applied when entering a ferry. This cost is added to the estimated and elapsed times.

Default Value

The default cost is 300 seconds (5 minutes).

Inherited from

ValhallaCostingOptsAuto.ferry_cost

Defined in

packages/valhalla/parameters.ts:892


fixed_speed

Optional fixed_speed: number

Fixed speed the vehicle can go. Used to override the calculated speed. Can be useful if +speed of vehicle is known. fixed_speed must be between 1 and 252 KPH.

Default Value

The default value is 0 KPH which disables fixed speed and falls back to the standard +calculated speed based on the road attribution.

Inherited from

ValhallaCostingOptsAuto.fixed_speed

Defined in

packages/valhalla/parameters.ts:955


gate_cost

Optional gate_cost: number

Inherited from

ValhallaCostingOptsAuto.gate_cost

Defined in

packages/valhalla/parameters.ts:737


gate_penalty

Optional gate_penalty: number

Inherited from

ValhallaCostingOptsAuto.gate_penalty

Defined in

packages/valhalla/parameters.ts:738


height

Optional height: number

The height of the vehicle (in meters).

Default Value

Default 1.9 for car, bus, taxi and 4.11 for truck.

Inherited from

ValhallaCostingOptsAuto.height

Defined in

packages/valhalla/parameters.ts:986


ignore_closures

Optional ignore_closures: number

If set to true, ignores all closures, marked due to live traffic closures, +during routing.

Remarks

Note: This option cannot be set if location.search_filter.exclude_closures is also +specified in the request and will return an error if it is.

Inherited from

ValhallaCostingOptsAuto.ignore_closures

Defined in

packages/valhalla/parameters.ts:965


include_hot

Optional include_hot: boolean

A boolean value which indicates the desire to include tolled HOV roads which require the driver +to pay a toll if the occupant requirement isn't met.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.include_hot

Defined in

packages/valhalla/parameters.ts:1033


include_hov2

Optional include_hov2: boolean

A boolean value which indicates the desire to include HOV roads with a 2-occupant requirement +in the route when advantageous.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.include_hov2

Defined in

packages/valhalla/parameters.ts:1017


include_hov3

Optional include_hov3: boolean

A boolean value which indicates the desire to include HOV roads with a 3-occupant requirement +in the route when advantageous.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.include_hov3

Defined in

packages/valhalla/parameters.ts:1025


maneuver_penalty

Optional maneuver_penalty: number

Inherited from

ValhallaCostingOptsAuto.maneuver_penalty

Defined in

packages/valhalla/parameters.ts:736


private_access_penalty

Optional private_access_penalty: number

A penalty applied when transitioning between roads that do not have consistent +naming–in other words, no road names in common. This penalty can be used to create +simpler routes that tend to have fewer maneuvers or narrative guidance instructions.

Default Value

The default maneuver penalty is five seconds.

Inherited from

ValhallaCostingOptsAuto.private_access_penalty

Defined in

packages/valhalla/parameters.ts:869


service_factor

Optional service_factor: number

A factor that modifies (multiplies) the cost when generic service roads are encountered.

Default Value

The default service_factor is 1.

Inherited from

ValhallaCostingOptsAuto.service_factor

Defined in

packages/valhalla/parameters.ts:938


service_penalty

Optional service_penalty: number

A penalty applied for transition to generic service road. The default penalty is 0 for +trucks and 15 for cars, buses, motor scooters and motorcycles.

Inherited from

ValhallaCostingOptsAuto.service_penalty

Defined in

packages/valhalla/parameters.ts:719


shortest

Optional shortest: boolean

Changes the metric to quasi-shortest, i.e. purely distance-based costing.

Remarks

Note, this will disable all other costings & penalties. Also note, shortest will not +disable hierarchy pruning, leading to potentially sub-optimal routes for some costing +models.

Default Value

The default is false.

Inherited from

ValhallaCostingOptsAuto.shortest

Defined in

packages/valhalla/parameters.ts:732


toll_booth_cost

Optional toll_booth_cost: number

A cost applied when a toll booth is encountered. This cost is added to the estimated and +elapsed times.

Default Value

The default cost is 15 seconds.

Inherited from

ValhallaCostingOptsAuto.toll_booth_cost

Defined in

packages/valhalla/parameters.ts:877


toll_booth_penalty

Optional toll_booth_penalty: number

A penalty applied to the cost when a toll booth is encountered. This penalty can be used to +create paths that avoid toll roads.

Default Value

The default toll booth penalty is 0.

Inherited from

ValhallaCostingOptsAuto.toll_booth_penalty

Defined in

packages/valhalla/parameters.ts:885


top_speed

Optional top_speed: number

Top speed the vehicle can go. Also used to avoid roads with higher speeds than this +value. top_speed must be between 10 and 252 KPH.

Default Value

The default value is 140 KPH.

Inherited from

ValhallaCostingOptsAuto.top_speed

Defined in

packages/valhalla/parameters.ts:946


use_ferry

Optional use_ferry: number

This value indicates the willingness to take ferries. This is a range of values +between 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries.

Default Value

The default value is 0.5.

Remarks

Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely.

Inherited from

ValhallaCostingOptsAuto.use_ferry

Defined in

packages/valhalla/parameters.ts:700


use_highways

Optional use_highways: number

This value indicates the willingness to take highways. This is a range of values between 0 +and 1. Values near 0 attempt to avoid highways and values near 1 will favor highways.

Default Value

The default value is 1.0.

Remarks

Note that sometimes highways are required to complete a route so +values of 0 are not guaranteed to avoid highways entirely.

Inherited from

ValhallaCostingOptsAuto.use_highways

Defined in

packages/valhalla/parameters.ts:904


use_living_streets

Optional use_living_streets: number

This value indicates the willingness to take living streets. This is a range of values +between 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will +favor living streets.

Default Value

The default value is 0 for trucks, 0.1 for cars, buses, motor +scooters and motorcycles.

Remarks

Note that sometimes living streets are required to complete +a route so values of 0 are not guaranteed to avoid living streets entirely.

Inherited from

ValhallaCostingOptsAuto.use_living_streets

Defined in

packages/valhalla/parameters.ts:714


use_tolls

Optional use_tolls: number

This value indicates the willingness to take roads with tolls. This is a range of values +between 0 and 1. Values near 0 attempt to avoid tolls and values near 1 will not attempt +to avoid them.

Default Value

The default value is 0.5.

Remarks

Note that sometimes roads with tolls are +required to complete a route so values of 0 are not guaranteed to avoid them entirely.

Inherited from

ValhallaCostingOptsAuto.use_tolls

Defined in

packages/valhalla/parameters.ts:917


use_tracks

Optional use_tracks: number

This value indicates the willingness to take track roads. This is a range of values between +0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a +little bit.

Default Value

The default value is 0 for autos, 0.5 for motor scooters and motorcycles.

Remarks

Note that sometimes tracks are required to complete a route so values of 0 are +not guaranteed to avoid tracks entirely.

Inherited from

ValhallaCostingOptsAuto.use_tracks

Defined in

packages/valhalla/parameters.ts:931


use_trails

Optional use_trails: boolean

A riders's desire for adventure in their routes. This is a range of values from 0 to 1, +where 0 will avoid trails, tracks, unclassified or bad surfaces and values towards 1 will +tend to avoid major roads and route on secondary roads.

Default Value

The default value is 0.0.

Defined in

packages/valhalla/parameters.ts:1160


width

Optional width: number

The width of the vehicle (in meters).

Default Value

Default 1.6 for car, bus, taxi and 2.6 for truck.

Inherited from

ValhallaCostingOptsAuto.width

Defined in

packages/valhalla/parameters.ts:993

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian.html b/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian.html new file mode 100644 index 0000000..da7cfbf --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrian.html @@ -0,0 +1,39 @@ + + + + + +Interface: ValhallaCostingOptsPedestrian | RoutingJS Documentation + + + + +
+

Interface: ValhallaCostingOptsPedestrian

valhalla.ValhallaCostingOptsPedestrian

Hierarchy

  • ValhallaCostingOptsBase

    ValhallaCostingOptsPedestrian

Properties

alley_factor

Optional alley_factor: number

A factor that modifies (multiplies) the cost when alleys are encountered. Pedestrian routes +generally want to avoid alleys or narrow service roads between buildings.

Default Value

The default alley_factor is 2.0.

Defined in

packages/valhalla/parameters.ts:789


bss_rent_cost

Optional bss_rent_cost: number

This value is useful when bikeshare is chosen as travel mode. It is meant to give the time will +be used to rent a bike from a bike share station. This value will be displayed in the final +directions and used to calculate the whole duation.

Default Value

The default value is 120 seconds.

Defined in

packages/valhalla/parameters.ts:851


bss_rent_penalty

Optional bss_rent_penalty: number

This value is useful when bikeshare is chosen as travel mode. It is meant to describe +the potential effort to rent a bike from a bike share station. This value won't be +displayed and used only inside of the algorithm.

Defined in

packages/valhalla/parameters.ts:857


driveway_factor

Optional driveway_factor: number

A factor that modifies (multiplies) the cost when encountering a driveway, which is often a +private, service road. Pedestrian routes generally want to avoid driveways (private).

Default Value

The default driveway factor is 5.0.

Defined in

packages/valhalla/parameters.ts:797


max_hiking_difficulty

Optional max_hiking_difficulty: number

This value indicates the maximum difficulty of hiking trails that is allowed. Values between 0 +and 6 are allowed.

See

https://wiki.openstreetmap.org/wiki/Key:sac_scale the corresponding sac_scale values within OpenStreetMap.

Default Value

The default value is 1 which means that well cleared trails that are mostly flat or slightly sloped are allowed. Higher difficulty trails can be allowed by specifying a higher value for max_hiking_difficulty.

Defined in

packages/valhalla/parameters.ts:842


service_factor

Optional service_factor: number

A factor that modifies (multiplies) the cost when generic service roads are encountered.

Default Value

The default service_factor is 1.

Defined in

packages/valhalla/parameters.ts:832


service_penalty

Optional service_penalty: number

A penalty applied for transition to generic service road.

Default Value

The default penalty is 0.

Overrides

ValhallaCostingOptsBase.service_penalty

Defined in

packages/valhalla/parameters.ts:825


shortest

Optional shortest: boolean

Changes the metric to quasi-shortest, i.e. purely distance-based costing.

Remarks

Note, this will disable all other costings & penalties. Also note, shortest will not +disable hierarchy pruning, leading to potentially sub-optimal routes for some costing +models.

Default Value

The default is false.

Inherited from

ValhallaCostingOptsBase.shortest

Defined in

packages/valhalla/parameters.ts:732


sidewalk_factor

Optional sidewalk_factor: number

A factor that modifies the cost when encountering roads with dedicated sidewalks. Pedestrian +routes generally attempt to favor using sidewalks.

Default Value

The default sidewalk_factor is 1.0.

Defined in

packages/valhalla/parameters.ts:781


step_penalty

Optional step_penalty: number

A penalty in seconds added to each transition onto a path with steps or stairs. Higher values +apply larger cost penalties to avoid paths that contain flights of steps.

Defined in

packages/valhalla/parameters.ts:802


use_ferry

Optional use_ferry: number

This value indicates the willingness to take ferries. This is a range of values +between 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries.

Default Value

The default value is 0.5.

Remarks

Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely.

Inherited from

ValhallaCostingOptsBase.use_ferry

Defined in

packages/valhalla/parameters.ts:700


use_hills

Optional use_hills: number

This is a range of values from 0 to 1, where 0 attempts to avoid hills and steep grades even if +it means a longer (time and distance) path, while 1 indicates the pedestrian does not fear +hills and steeper grades. Based on the use_hills factor, penalties are applied to roads based +on elevation change and grade. These penalties help the path avoid hilly roads in favor of flatter roads or less steep grades where available. Note that it is not always possible to find alternate paths to avoid hills (for example when route locations are in mountainous areas). The default value is 0.5.

Defined in

packages/valhalla/parameters.ts:818


use_living_streets

Optional use_living_streets: number

This value indicates the willingness to take living streets. This is a range of values +between 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will +favor living streets.

Default Value

The default value is 0 for trucks, 0.1 for cars, buses, motor +scooters and motorcycles.

Remarks

Note that sometimes living streets are required to complete +a route so values of 0 are not guaranteed to avoid living streets entirely.

Inherited from

ValhallaCostingOptsBase.use_living_streets

Defined in

packages/valhalla/parameters.ts:714


use_tracks

Optional use_tracks: number

This value indicates the willingness to take track roads. This is a range of values between +0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a +little bit.

Default Value

The default value is 0.5. Note that sometimes tracks are required to complete a route so values of 0 are not guaranteed to avoid tracks entirely.

Defined in

packages/valhalla/parameters.ts:811


walking_speed

Optional walking_speed: number

Walking speed in kilometers per hour. Must be between 0.5 and 25 km/hr.

Default Value

Defaults to 5.1 km/hr (3.1 miles/hour).

Defined in

packages/valhalla/parameters.ts:764


walkway_factor

Optional walkway_factor: number

A factor that modifies the cost when encountering roads classified as footway (no motorized +vehicles allowed), which may be designated footpaths or designated sidewalks along residential +roads. Pedestrian routes generally attempt to favor using these walkways and sidewalks.

Default Value

The default walkway_factor is 1.0.

Defined in

packages/valhalla/parameters.ts:773

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck.html b/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck.html new file mode 100644 index 0000000..d296944 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaCostingOptsTruck.html @@ -0,0 +1,52 @@ + + + + + +Interface: ValhallaCostingOptsTruck | RoutingJS Documentation + + + + +
+

Interface: ValhallaCostingOptsTruck

valhalla.ValhallaCostingOptsTruck

Hierarchy

Properties

axle_count

Optional axle_count: number

The axle count of the truck.

Default Value

Default 5.

Defined in

packages/valhalla/parameters.ts:1064


axle_load

Optional axle_load: number

The axle load of the truck (in metric tons).

Default Value

Default 9.07.

Defined in

packages/valhalla/parameters.ts:1057


closure_factor

Optional closure_factor: number

A factor that penalizes the cost when traversing a closed edge (eg: if +search_filter.exclude_closures is false for origin and/or destination location and the +route starts/ends on closed edges). Its value can range from 1.0 - don't penalize closed +edges, to 10.0 - apply high cost penalty to closed edges.

Default Value

Default value is 9.0.

Remarks

Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle, +motor_scooter, bus, truck & taxi

Inherited from

ValhallaCostingOptsAuto.closure_factor

Defined in

packages/valhalla/parameters.ts:979


country_crossing_cost

Optional country_crossing_cost: number

A cost applied when encountering an international border. This cost is added to the +estimated and elapsed times.

Default Value

The default cost is 600 seconds.

Inherited from

ValhallaCostingOptsAuto.country_crossing_cost

Defined in

packages/valhalla/parameters.ts:746


country_crossing_penalty

Optional country_crossing_penalty: number

A penalty applied for a country crossing. This penalty can be used to create paths that +avoid spanning country boundaries.

Default Value

The default penalty is 0.

Inherited from

ValhallaCostingOptsAuto.country_crossing_penalty

Defined in

packages/valhalla/parameters.ts:754


exclude_cash_only_tolls

Optional exclude_cash_only_tolls: boolean

A boolean value which indicates the desire to avoid routes with cash-only tolls.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.exclude_cash_only_tolls

Defined in

packages/valhalla/parameters.ts:1009


exclude_unpaved

Optional exclude_unpaved: boolean | 1

This value indicates whether or not the path may include unpaved roads. If exclude_unpaved +is set to 1 it is allowed to start and end with unpaved roads, but is not allowed to +have them in the middle of the route path, otherwise they are allowed.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.exclude_unpaved

Defined in

packages/valhalla/parameters.ts:1002


ferry_cost

Optional ferry_cost: number

A cost applied when entering a ferry. This cost is added to the estimated and elapsed times.

Default Value

The default cost is 300 seconds (5 minutes).

Inherited from

ValhallaCostingOptsAuto.ferry_cost

Defined in

packages/valhalla/parameters.ts:892


fixed_speed

Optional fixed_speed: number

Fixed speed the vehicle can go. Used to override the calculated speed. Can be useful if +speed of vehicle is known. fixed_speed must be between 1 and 252 KPH.

Default Value

The default value is 0 KPH which disables fixed speed and falls back to the standard +calculated speed based on the road attribution.

Inherited from

ValhallaCostingOptsAuto.fixed_speed

Defined in

packages/valhalla/parameters.ts:955


gate_cost

Optional gate_cost: number

Inherited from

ValhallaCostingOptsAuto.gate_cost

Defined in

packages/valhalla/parameters.ts:737


gate_penalty

Optional gate_penalty: number

Inherited from

ValhallaCostingOptsAuto.gate_penalty

Defined in

packages/valhalla/parameters.ts:738


hazmat

Optional hazmat: boolean

A value indicating if the truck is carrying hazardous materials.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:1071


height

Optional height: number

The height of the vehicle (in meters).

Default Value

Default 1.9 for car, bus, taxi and 4.11 for truck.

Inherited from

ValhallaCostingOptsAuto.height

Defined in

packages/valhalla/parameters.ts:986


ignore_closures

Optional ignore_closures: number

If set to true, ignores all closures, marked due to live traffic closures, +during routing.

Remarks

Note: This option cannot be set if location.search_filter.exclude_closures is also +specified in the request and will return an error if it is.

Inherited from

ValhallaCostingOptsAuto.ignore_closures

Defined in

packages/valhalla/parameters.ts:965


include_hot

Optional include_hot: boolean

A boolean value which indicates the desire to include tolled HOV roads which require the driver +to pay a toll if the occupant requirement isn't met.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.include_hot

Defined in

packages/valhalla/parameters.ts:1033


include_hov2

Optional include_hov2: boolean

A boolean value which indicates the desire to include HOV roads with a 2-occupant requirement +in the route when advantageous.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.include_hov2

Defined in

packages/valhalla/parameters.ts:1017


include_hov3

Optional include_hov3: boolean

A boolean value which indicates the desire to include HOV roads with a 3-occupant requirement +in the route when advantageous.

Default Value

Default false.

Inherited from

ValhallaCostingOptsAuto.include_hov3

Defined in

packages/valhalla/parameters.ts:1025


length

Optional length: number

The length of the truck (in meters).

Default Value

Default 21.64.

Defined in

packages/valhalla/parameters.ts:1043


maneuver_penalty

Optional maneuver_penalty: number

Inherited from

ValhallaCostingOptsAuto.maneuver_penalty

Defined in

packages/valhalla/parameters.ts:736


private_access_penalty

Optional private_access_penalty: number

A penalty applied when transitioning between roads that do not have consistent +naming–in other words, no road names in common. This penalty can be used to create +simpler routes that tend to have fewer maneuvers or narrative guidance instructions.

Default Value

The default maneuver penalty is five seconds.

Inherited from

ValhallaCostingOptsAuto.private_access_penalty

Defined in

packages/valhalla/parameters.ts:869


service_factor

Optional service_factor: number

A factor that modifies (multiplies) the cost when generic service roads are encountered.

Default Value

The default service_factor is 1.

Inherited from

ValhallaCostingOptsAuto.service_factor

Defined in

packages/valhalla/parameters.ts:938


service_penalty

Optional service_penalty: number

A penalty applied for transition to generic service road. The default penalty is 0 for +trucks and 15 for cars, buses, motor scooters and motorcycles.

Inherited from

ValhallaCostingOptsAuto.service_penalty

Defined in

packages/valhalla/parameters.ts:719


shortest

Optional shortest: boolean

Changes the metric to quasi-shortest, i.e. purely distance-based costing.

Remarks

Note, this will disable all other costings & penalties. Also note, shortest will not +disable hierarchy pruning, leading to potentially sub-optimal routes for some costing +models.

Default Value

The default is false.

Inherited from

ValhallaCostingOptsAuto.shortest

Defined in

packages/valhalla/parameters.ts:732


toll_booth_cost

Optional toll_booth_cost: number

A cost applied when a toll booth is encountered. This cost is added to the estimated and +elapsed times.

Default Value

The default cost is 15 seconds.

Inherited from

ValhallaCostingOptsAuto.toll_booth_cost

Defined in

packages/valhalla/parameters.ts:877


toll_booth_penalty

Optional toll_booth_penalty: number

A penalty applied to the cost when a toll booth is encountered. This penalty can be used to +create paths that avoid toll roads.

Default Value

The default toll booth penalty is 0.

Inherited from

ValhallaCostingOptsAuto.toll_booth_penalty

Defined in

packages/valhalla/parameters.ts:885


top_speed

Optional top_speed: number

Top speed the vehicle can go. Also used to avoid roads with higher speeds than this +value. top_speed must be between 10 and 252 KPH.

Default Value

The default value is 140 KPH.

Inherited from

ValhallaCostingOptsAuto.top_speed

Defined in

packages/valhalla/parameters.ts:946


use_ferry

Optional use_ferry: number

This value indicates the willingness to take ferries. This is a range of values +between 0 and 1. Values near 0 attempt to avoid ferries and values near 1 will favor ferries.

Default Value

The default value is 0.5.

Remarks

Note that sometimes ferries are required to complete a route so values of 0 are not guaranteed to avoid ferries entirely.

Inherited from

ValhallaCostingOptsAuto.use_ferry

Defined in

packages/valhalla/parameters.ts:700


use_highways

Optional use_highways: number

This value indicates the willingness to take highways. This is a range of values between 0 +and 1. Values near 0 attempt to avoid highways and values near 1 will favor highways.

Default Value

The default value is 1.0.

Remarks

Note that sometimes highways are required to complete a route so +values of 0 are not guaranteed to avoid highways entirely.

Inherited from

ValhallaCostingOptsAuto.use_highways

Defined in

packages/valhalla/parameters.ts:904


use_living_streets

Optional use_living_streets: number

This value indicates the willingness to take living streets. This is a range of values +between 0 and 1. Values near 0 attempt to avoid living streets and values near 1 will +favor living streets.

Default Value

The default value is 0 for trucks, 0.1 for cars, buses, motor +scooters and motorcycles.

Remarks

Note that sometimes living streets are required to complete +a route so values of 0 are not guaranteed to avoid living streets entirely.

Inherited from

ValhallaCostingOptsAuto.use_living_streets

Defined in

packages/valhalla/parameters.ts:714


use_tolls

Optional use_tolls: number

This value indicates the willingness to take roads with tolls. This is a range of values +between 0 and 1. Values near 0 attempt to avoid tolls and values near 1 will not attempt +to avoid them.

Default Value

The default value is 0.5.

Remarks

Note that sometimes roads with tolls are +required to complete a route so values of 0 are not guaranteed to avoid them entirely.

Inherited from

ValhallaCostingOptsAuto.use_tolls

Defined in

packages/valhalla/parameters.ts:917


use_tracks

Optional use_tracks: number

This value indicates the willingness to take track roads. This is a range of values between +0 and 1. Values near 0 attempt to avoid tracks and values near 1 will favor tracks a +little bit.

Default Value

The default value is 0 for autos, 0.5 for motor scooters and motorcycles.

Remarks

Note that sometimes tracks are required to complete a route so values of 0 are +not guaranteed to avoid tracks entirely.

Inherited from

ValhallaCostingOptsAuto.use_tracks

Defined in

packages/valhalla/parameters.ts:931


weight

Optional weight: number

The weight of the truck (in metric tons).

Default Value

Default 21.77.

Defined in

packages/valhalla/parameters.ts:1050


width

Optional width: number

The width of the vehicle (in meters).

Default Value

Default 1.6 for car, bus, taxi and 2.6 for truck.

Inherited from

ValhallaCostingOptsAuto.width

Defined in

packages/valhalla/parameters.ts:993

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaDateTime.html b/docs/api/interfaces/valhalla.ValhallaDateTime.html new file mode 100644 index 0000000..a784f3f --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaDateTime.html @@ -0,0 +1,16 @@ + + + + + +Interface: ValhallaDateTime | RoutingJS Documentation + + + + +
+
+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaDirectionOpts.html b/docs/api/interfaces/valhalla.ValhallaDirectionOpts.html new file mode 100644 index 0000000..074f868 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaDirectionOpts.html @@ -0,0 +1,34 @@ + + + + + +Interface: ValhallaDirectionOpts | RoutingJS Documentation + + + + +
+

Interface: ValhallaDirectionOpts

valhalla.ValhallaDirectionOpts

Hierarchy

  • ValhallaBaseOpts

    ValhallaDirectionOpts

Properties

alternatives

Optional alternatives: number

A number denoting how many alternate routes should be provided. +There may be no alternates or less alternates than the user specifies. +Alternates are not yet supported on multipoint routes (that is, routes with +more than 2 locations). They are also not supported on time dependent routes.

Defined in

packages/valhalla/index.ts:142


avoidLocations

Optional avoidLocations: ([number, number] | Point | Feature<Point, GeoJsonProperties>)[]

A set of locations to exclude or avoid within a route.

Inherited from

ValhallaBaseOpts.avoidLocations

Defined in

packages/valhalla/index.ts:92


avoidPolygons

Optional avoidPolygons: (Polygon | [number, number][][] | Feature<Polygon, GeoJsonProperties>)[]

Roads intersecting these polygons +will be avoided during path finding. If you only need to avoid a few specific roads, it's much more +efficient to use avoid_locations. Valhalla will close open rings (i.e. copy the first coordingate to the +last position).

Inherited from

ValhallaBaseOpts.avoidPolygons

Defined in

packages/valhalla/index.ts:99


costingOpts

Optional costingOpts: ValhallaCostingOptsAuto | ValhallaCostingOptsTruck | ValhallaCostingOptsBicycle | ValhallaCostingOptsMotorcycle | ValhallaCostingOptsPedestrian

Profiles can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path. Only specify the actual options dict, the profile +will be filled automatically. For more information, visit: +https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options

Inherited from

ValhallaBaseOpts.costingOpts

Defined in

packages/valhalla/index.ts:83


dateTime

Optional dateTime: ValhallaDateTime

This is the local date and time at the location. Field type: 0: Current departure time, +1: Specified departure time. Field value: the date and time is specified +in ISO 8601 format (YYYY-MM-DDThh:mm), local time.

Example

   date_time = {type: 0, value: 2021-03-03T08:06:23}

Inherited from

ValhallaBaseOpts.dateTime

Defined in

packages/valhalla/index.ts:110


directionsType

Optional directionsType: ValhallaDirectionsType

'none': no instructions are returned. 'maneuvers': only maneuvers are returned. +'instructions': maneuvers with instructions are returned. Default 'instructions'

Defined in

packages/valhalla/index.ts:160


id

Optional id: string

A request ID that will be returned in the response

Inherited from

ValhallaBaseOpts.id

Defined in

packages/valhalla/index.ts:70


instructions

Optional instructions: boolean

Whether to return turn-by-turn instructions. Named for compatibility with other +providers. Valhalla's parameter here is 'narrative'.

Defined in

packages/valhalla/index.ts:136


language

Optional language: string

The language of the narration instructions based on the IETF BCP 47 language tag string. +If no language is specified or the specified language is unsupported, United States-based +English (en-US) is used.

See here for a list of supported languages: https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#supported-language-tags

Defined in

packages/valhalla/index.ts:155


preference

Optional preference: "shortest" | "fastest"

Convenience argument to set the cost metric, one of ['shortest', 'fastest']. Note, +that shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called preference +to be in line with the already existing parameter in the ORS adapter.

Inherited from

ValhallaBaseOpts.preference

Defined in

packages/valhalla/index.ts:76


units

Optional units: ValhallaRequestUnit

Distance units for output. Allowable unit types are miles (or mi) and kilometers (or km). +If no unit type is specified, the units default to kilometers.

Defined in

packages/valhalla/index.ts:147

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaErrorProps.html b/docs/api/interfaces/valhalla.ValhallaErrorProps.html new file mode 100644 index 0000000..a65bbf6 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaErrorProps.html @@ -0,0 +1,18 @@ + + + + + +Interface: ValhallaErrorProps | RoutingJS Documentation + + + + +
+

Interface: ValhallaErrorProps

valhalla.ValhallaErrorProps

ValhallaErrorProps returns additional information about the error thrown by the +Valhalla routing engine. It sends back the status_code, status, error_code and error +message where the error_code is specific to Valhalla.

Hierarchy

Properties

errorCode

Optional errorCode: number

Defined in

packages/valhalla/index.ts:53


errorMessage

Optional errorMessage: string

errorMessage explains the error specific to that routing engine

Inherited from

ErrorProps.errorMessage

Defined in

packages/core/error.ts:11


status

Optional status: string

status gives detailed info about that response

Inherited from

ErrorProps.status

Defined in

packages/core/error.ts:9


statusCode

Optional statusCode: number

statusCode stands for the HTTP response status code

Inherited from

ErrorProps.statusCode

Defined in

packages/core/error.ts:7

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaIsochroneOpts.html b/docs/api/interfaces/valhalla.ValhallaIsochroneOpts.html new file mode 100644 index 0000000..92a1461 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaIsochroneOpts.html @@ -0,0 +1,32 @@ + + + + + +Interface: ValhallaIsochroneOpts | RoutingJS Documentation + + + + +
+

Interface: ValhallaIsochroneOpts

valhalla.ValhallaIsochroneOpts

Hierarchy

  • ValhallaBaseOpts

    ValhallaIsochroneOpts

Properties

avoidLocations

Optional avoidLocations: ([number, number] | Point | Feature<Point, GeoJsonProperties>)[]

A set of locations to exclude or avoid within a route.

Inherited from

ValhallaBaseOpts.avoidLocations

Defined in

packages/valhalla/index.ts:92


avoidPolygons

Optional avoidPolygons: (Polygon | [number, number][][] | Feature<Polygon, GeoJsonProperties>)[]

Roads intersecting these polygons +will be avoided during path finding. If you only need to avoid a few specific roads, it's much more +efficient to use avoid_locations. Valhalla will close open rings (i.e. copy the first coordingate to the +last position).

Inherited from

ValhallaBaseOpts.avoidPolygons

Defined in

packages/valhalla/index.ts:99


colors

Optional colors: string[]

The color for the output of the contour. Specify it as a Hex value, but without the #, such as +"color":"ff0000" for red. If no color is specified, the isochrone service will assign a default color to the output.

Defined in

packages/valhalla/index.ts:173


costingOpts

Optional costingOpts: ValhallaCostingOptsAuto | ValhallaCostingOptsTruck | ValhallaCostingOptsBicycle | ValhallaCostingOptsMotorcycle | ValhallaCostingOptsPedestrian

Profiles can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path. Only specify the actual options dict, the profile +will be filled automatically. For more information, visit: +https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options

Inherited from

ValhallaBaseOpts.costingOpts

Defined in

packages/valhalla/index.ts:83


dateTime

Optional dateTime: ValhallaDateTime

This is the local date and time at the location. Field type: 0: Current departure time, +1: Specified departure time. Field value: the date and time is specified +in ISO 8601 format (YYYY-MM-DDThh:mm), local time.

Example

   date_time = {type: 0, value: 2021-03-03T08:06:23}

Inherited from

ValhallaBaseOpts.dateTime

Defined in

packages/valhalla/index.ts:110


denoise

Optional denoise: number

Can be used to remove smaller contours. In range [0, 1]. A value of 1 will only return the largest contour +for a given time value. A value of 0.5 drops any contours that are less than half the area of the largest +contour in the set of contours for that same time value. Default 1.

Defined in

packages/valhalla/index.ts:183


generalize

Optional generalize: number

A floating point value in meters used as the tolerance for Douglas-Peucker generalization. +Note: Generalization of contours can lead to self-intersections, as well as intersections of adjacent contours.

Defined in

packages/valhalla/index.ts:188


id

Optional id: string

A request ID that will be returned in the response

Inherited from

ValhallaBaseOpts.id

Defined in

packages/valhalla/index.ts:70


intervalType

Optional intervalType: "time" | "distance"

Set 'time' for isochrones or 'distance' for equidistants. +Default 'time'.

Defined in

packages/valhalla/index.ts:168


polygons

Optional polygons: boolean

Controls whether polygons or linestrings are returned in GeoJSON geometry. Default False.

Defined in

packages/valhalla/index.ts:177


preference

Optional preference: "shortest" | "fastest"

Convenience argument to set the cost metric, one of ['shortest', 'fastest']. Note, +that shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called preference +to be in line with the already existing parameter in the ORS adapter.

Inherited from

ValhallaBaseOpts.preference

Defined in

packages/valhalla/index.ts:76


showLocations

Optional showLocations: boolean

A boolean indicating whether the input locations should be returned as MultiPoint features: one feature for the exact input coordinates and one feature +for the coordinates of the network node it snapped to. Default false.

Defined in

packages/valhalla/index.ts:193

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaIsochroneParams.html b/docs/api/interfaces/valhalla.ValhallaIsochroneParams.html new file mode 100644 index 0000000..4e35629 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaIsochroneParams.html @@ -0,0 +1,35 @@ + + + + + +Interface: ValhallaIsochroneParams | RoutingJS Documentation + + + + +
+

Interface: ValhallaIsochroneParams

valhalla.ValhallaIsochroneParams

Hierarchy

  • ValhallaRequestParams

    ValhallaIsochroneParams

Properties

contours

contours: ValhallaContours[]

A JSON array of contour objects with the time in minutes or distance in kilometers and +color to use for each isochrone contour. You can specify up to four contours (by default).

Defined in

packages/valhalla/parameters.ts:122


costing

costing: ValhallaCostingType

Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route +request must include the name of the costing model and can include optional parameters available +for the chosen costing model.

Inherited from

ValhallaRequestParams.costing

Defined in

packages/valhalla/parameters.ts:81


costing_options

Optional costing_options: ValhallaCostingOptTypes

Costing methods can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path.

Inherited from

ValhallaRequestParams.costing_options

Defined in

packages/valhalla/parameters.ts:86


date_time

Optional date_time: ValhallaDateTime

The local date and time at the location. These parameters apply only for multimodal +requests and are not used with other costing methods.

Defined in

packages/valhalla/parameters.ts:117


denoise

Optional denoise: number

A floating point value from 0 to 1 (default of 1) which can be used to remove smaller contours. +A value of 1 will only return the largest contour for a given time value. A value of 0.5 drops +any contours that are less than half the area of the largest contour in the set of contours for +that same time value.

Defined in

packages/valhalla/parameters.ts:137


exclude_locations

Optional exclude_locations: [number, number][]

A set of locations to exclude or avoid within a route can be specified using a JSON array +of avoid_locations. The avoid_locations have the same format as the locations list. At a +minimum each avoid location must include latitude and longitude. The avoid_locations are +mapped to the closest road or roads and these roads are excluded from the route path computation.

Inherited from

ValhallaRequestParams.exclude_locations

Defined in

packages/valhalla/parameters.ts:97


exclude_polygons

Optional exclude_polygons: [number, number][][] | [number, number][][][]

One or multiple exterior rings of polygons in the form of nested JSON arrays, e.g. +[[[lon1, lat1], [lon2,lat2]],[[lon1,lat1],[lon2,lat2]]]. Roads intersecting these rings +will be avoided during path finding. If you only need to avoid a few specific roads, +it's much more efficient to use exclude_locations. Valhalla will close open rings (i.e. +copy the first coordingate to the last position).

Inherited from

ValhallaRequestParams.exclude_polygons

Defined in

packages/valhalla/parameters.ts:105


generalize

Optional generalize: number

A floating point value in meters used as the tolerance for Douglas-Peucker generalization.

Remarks

Note: Generalization of contours can lead to self-intersections, as well as intersections of +adjacent contours.

Defined in

packages/valhalla/parameters.ts:145


id

Optional id: string

Name your route request. If id is specified, the naming will be sent thru to the response.

Inherited from

ValhallaRequestParams.id

Defined in

packages/valhalla/parameters.ts:90


locations

locations: [ValhallaLocation]

Only single location can be specified.

Defined in

packages/valhalla/parameters.ts:112


polygons

Optional polygons: boolean

A Boolean value to determine whether to return geojson polygons or linestrings as the contours. +The default is false, which returns lines; when true, polygons are returned.

Remarks

When polygons is true, any contour that forms a ring is returned as a polygon.

Defined in

packages/valhalla/parameters.ts:130


show_locations

Optional show_locations: boolean

A boolean indicating whether the input locations should be returned as MultiPoint features: +one feature for the exact input coordinates and one feature for the coordinates of the network +node it snapped to.

Default Value

Default false.

Defined in

packages/valhalla/parameters.ts:154

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaIsochroneResponse.html b/docs/api/interfaces/valhalla.ValhallaIsochroneResponse.html new file mode 100644 index 0000000..b78d7a5 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaIsochroneResponse.html @@ -0,0 +1,22 @@ + + + + + +Interface: ValhallaIsochroneResponse | RoutingJS Documentation + + + + +
+

Interface: ValhallaIsochroneResponse

valhalla.ValhallaIsochroneResponse

In the service response, the isochrone contours are returned as GeoJSON, which can be integrated +into mapping applications.

Hierarchy

  • FeatureCollection

    ValhallaIsochroneResponse

Properties

bbox

Optional bbox: BBox

Bounding box of the coordinate range of the object's Geometries, Features, or Feature Collections. +The value of the bbox member is an array of length 2*n where n is the number of dimensions +represented in the contained geometries, with all axes of the most southwesterly point +followed by all axes of the more northeasterly point. +The axes order of a bbox follows the axes order of geometries. +https://tools.ietf.org/html/rfc7946#section-5

Inherited from

FeatureCollection.bbox

Defined in

node_modules/@types/geojson/index.d.ts:67


features

features: Feature<Geometry, GeoJsonProperties>[]

Inherited from

FeatureCollection.features

Defined in

node_modules/@types/geojson/index.d.ts:174


id

Optional id: string

Defined in

packages/valhalla/parameters.ts:364


type

type: "FeatureCollection"

Inherited from

FeatureCollection.type

Defined in

node_modules/@types/geojson/index.d.ts:173

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaLeg.html b/docs/api/interfaces/valhalla.ValhallaLeg.html new file mode 100644 index 0000000..bdc2f7f --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaLeg.html @@ -0,0 +1,16 @@ + + + + + +Interface: ValhallaLeg | RoutingJS Documentation + + + + +
+

Interface: ValhallaLeg

valhalla.ValhallaLeg

Properties

maneuvers

Optional maneuvers: ValhallaManeuvers[]

Defined in

packages/valhalla/parameters.ts:235


shape

Optional shape: string

The shape is an encoded polyline of the route path (with 6 digits decimal precision).

Defined in

packages/valhalla/parameters.ts:234


summary

summary: ValhallaRouteSummary

A leg summary is comprised of the same information as a trip summary but applied to the single leg of the trip.

Defined in

packages/valhalla/parameters.ts:230

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaLocation.html b/docs/api/interfaces/valhalla.ValhallaLocation.html new file mode 100644 index 0000000..f6a04a1 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaLocation.html @@ -0,0 +1,63 @@ + + + + + +Interface: ValhallaLocation | RoutingJS Documentation + + + + +
+

Interface: ValhallaLocation

valhalla.ValhallaLocation

Properties

city

Optional city: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:626


country

Optional country: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:644


date_time

Optional date_time: string

Remarks

This information is carried through the request and returned as a convenience. +Response only.

Defined in

packages/valhalla/parameters.ts:670


display_lat

Optional display_lat: number

Latitude of the map location in degrees.

Remarks

If provided the lat and lon parameters will be treated as the routing location and the +display_lat and display_lon will be used to determine the side of street. Both display_lat +and display_lon must be provided and valid to achieve the desired effect.

Defined in

packages/valhalla/parameters.ts:575


display_lon

Optional display_lon: number

Longitude of the map location in degrees.

Remarks

If provided the lat and lon parameters will be treated as the routing location and the +display_lat and display_lon will be used to determine the side of street. Both display_lat +and display_lon must be provided and valid to achieve the desired effect.

Defined in

packages/valhalla/parameters.ts:586


heading

Optional heading: number

Preferred direction of travel for the start from the location.

Remarks

This can be useful for mobile +routing where a vehicle is traveling in a specific direction along a road, and the route should +start in that direction. The heading is indicated in degrees from north in a clockwise direction, +where north is 0°, east is 90°, south is 180°, and west is 270°.

Defined in

packages/valhalla/parameters.ts:484


heading_tolerance

Optional heading_tolerance: number

How close in degrees a given street's angle must be in order for it to be considered as in the +same direction of the heading parameter.

Default Value

The default value is 60 degrees.

Defined in

packages/valhalla/parameters.ts:492


lat

lat: number

Latitude of the location in degrees. This is assumed to be both the routing location and +the display location if no display_lat and display_lon are provided.

Defined in

packages/valhalla/parameters.ts:453


lon

lon: number

Longitude of the location in degrees. This is assumed to be both the routing location and the +display location if no display_lat and display_lon are provided.

Defined in

packages/valhalla/parameters.ts:458


minimum_reachability

Optional minimum_reachability: number

Minimum number of nodes (intersections) reachable for a given edge (road between intersections) to +consider that edge as belonging to a connected region.

Remarks

When correlating this location to the route network, try to find candidates who are reachable +from this many or more nodes (intersections). If a given candidate edge reaches less than +this number of nodes its considered to be a disconnected island and we'll search for more +candidates until we find at least one that isn't considered a disconnected island. If this +value is larger than the configured service limit it will be clamped to that limit.

Default Value

The default is a minimum of 50 reachable nodes.

Defined in

packages/valhalla/parameters.ts:524


name

Optional name: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:620


node_snap_tolerance

Optional node_snap_tolerance: number

During edge correlation this is the tolerance used to determine whether or not to snap +to the intersection rather than along the street, if the snap location is within this +distance from the intersection the intersection is used instead.

Default Value

The default is 5 meters.

Defined in

packages/valhalla/parameters.ts:600


phone

Optional phone: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:650


postal_code

Optional postal_code: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:638


preferred_side

Optional preferred_side: ValhallaPreferredSiteType

If the location is not offset from the road centerline or is closest to an intersection this +option has no effect. Otherwise the determined side of street is used to determine whether +or not the location should be visited from the same, opposite or either side of the road with +respect to the side of the road the given locale drives on.

Remarks

In Germany (driving on the right +side of the road), passing a value of same will only allow you to leave from or arrive at a +location such that the location will be on your right. In Australia (driving on the left side +of the road), passing a value of same will force the location to be on your left. A value of +opposite will enforce arriving/departing from a location on the opposite side of the road from +that which you would be driving on while a value of either will make no attempt limit the side +of street that is available for the route.

Defined in

packages/valhalla/parameters.ts:564


radius

Optional radius: number

The number of meters about this input location within which edges (roads between intersections) +will be considered as candidates for said location. When correlating this location to the +route network, try to only return results within this distance (meters) from this location. +If there are no candidates within this distance it will return the closest candidate within +reason. If this value is larger than the configured service limit it will be clamped to that +limit.

Default Value

The default is 0 meters.

Defined in

packages/valhalla/parameters.ts:536


rank_candidates

Optional rank_candidates: boolean

Whether or not to rank the edge candidates for this location.

Remarks

The ranking is used as a penalty +within the routing algorithm so that some edges will be penalized more heavily than others. +If true candidates will be ranked according to their distance from the input and various other +attributes. If false the candidates will all be treated as equal which should lead to routes +that are just the most optimal path with emphasis about which edges were selected.

Defined in

packages/valhalla/parameters.ts:547


search_cutoff

Optional search_cutoff: number

The cutoff at which we will assume the input is too far away from civilisation to be worth +correlating to the nearest graph elements

Defined in

packages/valhalla/parameters.ts:591


search_filter

Optional search_filter: ValhallaSearchFilter

A set of optional filters to exclude candidate edges based on their attribution.

Defined in

packages/valhalla/parameters.ts:614


side_of_street

Optional side_of_street: ValhallaSideOfStreet

Remarks

This information is carried through the request and returned as a convenience. +Response only.

Defined in

packages/valhalla/parameters.ts:663


state

Optional state: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:632


street

Optional street: string

Street name. The street name may be used to assist finding the correct routing location at +the specified latitude, longitude.

Remarks

This is not currently implemented.

Defined in

packages/valhalla/parameters.ts:500


street_side_max_distance

Optional street_side_max_distance: number

The max distance in meters that the input coordinates or display ll can be from the edge +centerline for them to be used for determining the side of street. Beyond this distance +the side of street is set to none.

Defined in

packages/valhalla/parameters.ts:612


street_side_tolerance

Optional street_side_tolerance: number

If your input coordinate is less than this tolerance away from the edge centerline then we set +your side of street to none otherwise your side of street will be left or right depending on +direction of travel.

Defined in

packages/valhalla/parameters.ts:606


type

Optional type: ValhallaLocationType

Type of location, either break, through, via or break_through.

Remarks

Each type controls two characteristics: whether or not to allow a u-turn at the location and +whether or not to generate guidance/legs at the location. The types of the first and last locations are ignored and +are treated as breaks.

Default Value

If no type is provided, +the type is assumed to be a break.

Defined in

packages/valhalla/parameters.ts:473


url

Optional url: string

Remarks

This information is carried through the request and returned as a convenience.

Defined in

packages/valhalla/parameters.ts:656


way_id

Optional way_id: number

OpenStreetMap identification number for a polyline way. The way ID may be used to assist +finding the correct routing location at the specified latitude, longitude.

Remarks

This is not currently implemented.

Defined in

packages/valhalla/parameters.ts:509

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaManeuvers.html b/docs/api/interfaces/valhalla.ValhallaManeuvers.html new file mode 100644 index 0000000..a36fc70 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaManeuvers.html @@ -0,0 +1,22 @@ + + + + + +Interface: ValhallaManeuvers | RoutingJS Documentation + + + + +
+

Interface: ValhallaManeuvers

valhalla.ValhallaManeuvers

Properties

arrive_instruction

Optional arrive_instruction: string

Written arrive time instruction. Typically used with a transit maneuver.

Example

"Arrive: 8:10 AM at 34 St - Herald Sq"

Defined in

packages/valhalla/parameters.ts:323


begin_shape_index

Optional begin_shape_index: number

Index into the list of shape points for the start of the maneuver.

Defined in

packages/valhalla/parameters.ts:284


begin_street_names

Optional begin_street_names: string[]

When present, these are the street names at the beginning (transition point) of the +nonobvious maneuver (if they are different than the names that are consistent along the +entire nonobvious maneuver).

Defined in

packages/valhalla/parameters.ts:278


bss_maneuver_type

Optional bss_maneuver_type: "NoneAction" | "RentBikeAtBikeShare" | "ReturnBikeAtBikeShare"

Used when travel_mode is bikeshare. Describes bike share maneuver.

Default Value

The default value is "NoneAction".

Defined in

packages/valhalla/parameters.ts:353


depart_instruction

Optional depart_instruction: string

Written depart time instruction. Typically used with a transit maneuver,

Example

"Depart: 8:04 AM from 8 St - NYU"

Defined in

packages/valhalla/parameters.ts:310


end_shape_index

Optional end_shape_index: number

Index into the list of shape points for the end of the maneuver.

Defined in

packages/valhalla/parameters.ts:286


ferry

Optional ferry: boolean

True if a ferry is encountered on this maneuver.

Defined in

packages/valhalla/parameters.ts:296


gate

Optional gate: boolean

True if a gate is encountered on this maneuver.

Defined in

packages/valhalla/parameters.ts:294


highway

Optional highway: boolean

True if a highway is encountered on this maneuver.

Defined in

packages/valhalla/parameters.ts:290


instruction

Optional instruction: string

Written maneuver instruction. Describes the maneuver.

Example

"Turn right onto Main Street"

Defined in

packages/valhalla/parameters.ts:247


length

Optional length: number

Maneuver length in the units specified.

Defined in

packages/valhalla/parameters.ts:282


rough

Optional rough: boolean

True if the maneuver is unpaved or rough pavement, or has any portions that have rough pavement.

Defined in

packages/valhalla/parameters.ts:292


roundabout_exit_count

Optional roundabout_exit_count: number

The spoke to exit roundabout after entering.

Defined in

packages/valhalla/parameters.ts:303


sign

Optional sign: Object

Contains the interchange guide information at a road junction associated with this maneuver.

See

https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#trip-legs-and-maneuvers the list of maneuver types for details.

Index signature

[k: string]: string[]

Defined in

packages/valhalla/parameters.ts:301


street_names

Optional street_names: string[]

List of street names that are consistent along the entire nonobvious maneuver.

Defined in

packages/valhalla/parameters.ts:272


time

Optional time: number

Estimated time along the maneuver in seconds.

Defined in

packages/valhalla/parameters.ts:280


toll

Optional toll: boolean

True if the maneuver has any toll, or portions of the maneuver are subject to a toll.

Defined in

packages/valhalla/parameters.ts:288


transit_info

Optional transit_info: Object

Contains the attributes that describe a specific transit route.

See

https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#trip-legs-and-maneuvers the list of maneuver types for details.

Index signature

[k: string]: any

Defined in

packages/valhalla/parameters.ts:336


travel_mode

Optional travel_mode: ValhallaTravelMode

Defined in

packages/valhalla/parameters.ts:342


travel_type

Optional travel_type: ValhallaTravelType

Travel type for drive.

Defined in

packages/valhalla/parameters.ts:346


type

Optional type: number

Defined in

packages/valhalla/parameters.ts:239


verbal_arrive_instruction

Optional verbal_arrive_instruction: string

Text suitable for use as a verbal arrive time instruction. Typically used with a transit +maneuver.

Example

"Arrive at 8:10 AM at 34 St - Herald Sq"

Defined in

packages/valhalla/parameters.ts:330


verbal_depart_instruction

Optional verbal_depart_instruction: string

Text suitable for use as a verbal depart time instruction. Typically used with a +transit maneuver.

Example

"Depart at 8:04 AM from 8 St - NYU"

Defined in

packages/valhalla/parameters.ts:317


verbal_multi_cue

Optional verbal_multi_cue: boolean

True if the verbal_pre_transition_instruction has been appended with the verbal +instruction of the next maneuver.

Defined in

packages/valhalla/parameters.ts:341


verbal_post_transition_instruction

Optional verbal_post_transition_instruction: string

Text suitable for use as a verbal message immediately after the maneuver transition.

Example

"Continue on U.S. 2 22 for 3.9 miles"

Defined in

packages/valhalla/parameters.ts:270


verbal_pre_transition_instruction

Optional verbal_pre_transition_instruction: string

Text suitable for use as a verbal message immediately prior to the maneuver transition.

Example

"Turn right onto North Prince Street, U.S. 2 22"

Defined in

packages/valhalla/parameters.ts:262


verbal_transition_alert_instruction

Optional verbal_transition_alert_instruction: string

Text suitable for use as a verbal alert in a navigation application. The transition alert +instruction will prepare the user for the forthcoming transition.

Example

"Turn right onto North Prince Street"

Defined in

packages/valhalla/parameters.ts:255

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaMatrixOpts.html b/docs/api/interfaces/valhalla.ValhallaMatrixOpts.html new file mode 100644 index 0000000..e00e2e7 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaMatrixOpts.html @@ -0,0 +1,26 @@ + + + + + +Interface: ValhallaMatrixOpts | RoutingJS Documentation + + + + +
+

Interface: ValhallaMatrixOpts

valhalla.ValhallaMatrixOpts

Hierarchy

  • ValhallaBaseOpts

    ValhallaMatrixOpts

Properties

avoidLocations

Optional avoidLocations: ([number, number] | Point | Feature<Point, GeoJsonProperties>)[]

A set of locations to exclude or avoid within a route.

Inherited from

ValhallaBaseOpts.avoidLocations

Defined in

packages/valhalla/index.ts:92


avoidPolygons

Optional avoidPolygons: (Polygon | [number, number][][] | Feature<Polygon, GeoJsonProperties>)[]

Roads intersecting these polygons +will be avoided during path finding. If you only need to avoid a few specific roads, it's much more +efficient to use avoid_locations. Valhalla will close open rings (i.e. copy the first coordingate to the +last position).

Inherited from

ValhallaBaseOpts.avoidPolygons

Defined in

packages/valhalla/index.ts:99


costingOpts

Optional costingOpts: ValhallaCostingOptsAuto | ValhallaCostingOptsTruck | ValhallaCostingOptsBicycle | ValhallaCostingOptsMotorcycle | ValhallaCostingOptsPedestrian

Profiles can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path. Only specify the actual options dict, the profile +will be filled automatically. For more information, visit: +https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options

Inherited from

ValhallaBaseOpts.costingOpts

Defined in

packages/valhalla/index.ts:83


dateTime

Optional dateTime: ValhallaDateTime

This is the local date and time at the location. Field type: 0: Current departure time, +1: Specified departure time. Field value: the date and time is specified +in ISO 8601 format (YYYY-MM-DDThh:mm), local time.

Example

   date_time = {type: 0, value: 2021-03-03T08:06:23}

Inherited from

ValhallaBaseOpts.dateTime

Defined in

packages/valhalla/index.ts:110


destinations

Optional destinations: number[]

Defined in

packages/valhalla/index.ts:198


id

Optional id: string

A request ID that will be returned in the response

Inherited from

ValhallaBaseOpts.id

Defined in

packages/valhalla/index.ts:70


preference

Optional preference: "shortest" | "fastest"

Convenience argument to set the cost metric, one of ['shortest', 'fastest']. Note, +that shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called preference +to be in line with the already existing parameter in the ORS adapter.

Inherited from

ValhallaBaseOpts.preference

Defined in

packages/valhalla/index.ts:76


sources

Optional sources: number[]

Defined in

packages/valhalla/index.ts:197


units

Optional units: ValhallaRequestUnit

Defined in

packages/valhalla/index.ts:199

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaMatrixParams.html b/docs/api/interfaces/valhalla.ValhallaMatrixParams.html new file mode 100644 index 0000000..f964726 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaMatrixParams.html @@ -0,0 +1,26 @@ + + + + + +Interface: ValhallaMatrixParams | RoutingJS Documentation + + + + +
+

Interface: ValhallaMatrixParams

valhalla.ValhallaMatrixParams

Hierarchy

  • ValhallaRequestParams

    ValhallaMatrixParams

Properties

costing

costing: ValhallaCostingType

Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route +request must include the name of the costing model and can include optional parameters available +for the chosen costing model.

Inherited from

ValhallaRequestParams.costing

Defined in

packages/valhalla/parameters.ts:81


costing_options

Optional costing_options: ValhallaCostingOptTypes

Costing methods can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path.

Inherited from

ValhallaRequestParams.costing_options

Defined in

packages/valhalla/parameters.ts:86


exclude_locations

Optional exclude_locations: [number, number][]

A set of locations to exclude or avoid within a route can be specified using a JSON array +of avoid_locations. The avoid_locations have the same format as the locations list. At a +minimum each avoid location must include latitude and longitude. The avoid_locations are +mapped to the closest road or roads and these roads are excluded from the route path computation.

Inherited from

ValhallaRequestParams.exclude_locations

Defined in

packages/valhalla/parameters.ts:97


exclude_polygons

Optional exclude_polygons: [number, number][][] | [number, number][][][]

One or multiple exterior rings of polygons in the form of nested JSON arrays, e.g. +[[[lon1, lat1], [lon2,lat2]],[[lon1,lat1],[lon2,lat2]]]. Roads intersecting these rings +will be avoided during path finding. If you only need to avoid a few specific roads, +it's much more efficient to use exclude_locations. Valhalla will close open rings (i.e. +copy the first coordingate to the last position).

Inherited from

ValhallaRequestParams.exclude_polygons

Defined in

packages/valhalla/parameters.ts:105


id

Optional id: string

Name your route request. If id is specified, the naming will be sent thru to the response.

Inherited from

ValhallaRequestParams.id

Defined in

packages/valhalla/parameters.ts:90


sources

sources: ValhallaLocation[]

Defined in

packages/valhalla/parameters.ts:158


targets

targets: ValhallaLocation[]

Defined in

packages/valhalla/parameters.ts:159

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaMatrixResponse.html b/docs/api/interfaces/valhalla.ValhallaMatrixResponse.html new file mode 100644 index 0000000..61c4527 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaMatrixResponse.html @@ -0,0 +1,16 @@ + + + + + +Interface: ValhallaMatrixResponse | RoutingJS Documentation + + + + +
+

Interface: ValhallaMatrixResponse

valhalla.ValhallaMatrixResponse

Properties

locations

Optional locations: ValhallaReturnLocation[]

Defined in

packages/valhalla/parameters.ts:371


sources

sources: ValhallaReturnLocation[][]

Defined in

packages/valhalla/parameters.ts:369


sources_to_targets

sources_to_targets: ValhallaMatrixItem[][]

Defined in

packages/valhalla/parameters.ts:368


targets

targets: ValhallaReturnLocation[][]

Defined in

packages/valhalla/parameters.ts:370


units

Optional units: string

Defined in

packages/valhalla/parameters.ts:372


warnings

Optional warnings: { [k: string]: any; }[]

Defined in

packages/valhalla/parameters.ts:373

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaRouteParams.html b/docs/api/interfaces/valhalla.ValhallaRouteParams.html new file mode 100644 index 0000000..47e5a2d --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaRouteParams.html @@ -0,0 +1,35 @@ + + + + + +Interface: ValhallaRouteParams | RoutingJS Documentation + + + + +
+

Interface: ValhallaRouteParams

valhalla.ValhallaRouteParams

You specify locations as an ordered list of two or more locations within a JSON array. +Locations are visited in the order specified.

Hierarchy

  • ValhallaRequestParams

    ValhallaRouteParams

Properties

alternates

Optional alternates: number

A number denoting how many alternate routes should be provided. There may be no alternates or +less alternates than the user specifies. Alternates are not yet supported on multipoint +routes (that is, routes with more than 2 locations). They are also not supported on time +dependent routes.

Defined in

packages/valhalla/parameters.ts:33


costing

costing: ValhallaCostingType

Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route +request must include the name of the costing model and can include optional parameters available +for the chosen costing model.

Inherited from

ValhallaRequestParams.costing

Defined in

packages/valhalla/parameters.ts:81


costing_options

Optional costing_options: ValhallaCostingOptTypes

Costing methods can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path.

Inherited from

ValhallaRequestParams.costing_options

Defined in

packages/valhalla/parameters.ts:86


date_time

Optional date_time: ValhallaDateTime

This is the local date and time at the location.

Defined in

packages/valhalla/parameters.ts:37


directions_options

Optional directions_options: ValhallaDirectionsOptions

Additional options specific to the /route endpoint

Defined in

packages/valhalla/parameters.ts:26


exclude_locations

Optional exclude_locations: [number, number][]

A set of locations to exclude or avoid within a route can be specified using a JSON array +of avoid_locations. The avoid_locations have the same format as the locations list. At a +minimum each avoid location must include latitude and longitude. The avoid_locations are +mapped to the closest road or roads and these roads are excluded from the route path computation.

Inherited from

ValhallaRequestParams.exclude_locations

Defined in

packages/valhalla/parameters.ts:97


exclude_polygons

Optional exclude_polygons: [number, number][][] | [number, number][][][]

One or multiple exterior rings of polygons in the form of nested JSON arrays, e.g. +[[[lon1, lat1], [lon2,lat2]],[[lon1,lat1],[lon2,lat2]]]. Roads intersecting these rings +will be avoided during path finding. If you only need to avoid a few specific roads, +it's much more efficient to use exclude_locations. Valhalla will close open rings (i.e. +copy the first coordingate to the last position).

Inherited from

ValhallaRequestParams.exclude_polygons

Defined in

packages/valhalla/parameters.ts:105


id

Optional id: string

Name your route request. If id is specified, the naming will be sent thru to the response.

Inherited from

ValhallaRequestParams.id

Defined in

packages/valhalla/parameters.ts:90


linear_references

Optional linear_references: boolean

When present and true, the successful route response will include a key linear_references. +Its value is an array of base64-encoded OpenLR location references, one for each graph edge +of the road network matched by the input trace.

Defined in

packages/valhalla/parameters.ts:43


locations

locations: ValhallaLocation[]

A location must include a latitude and longitude in decimal degrees. The coordinates can +come from many input sources, such as a GPS location, a point or a click on a map, +a geocoding service, and so on.

Remarks

Note that the Valhalla cannot search for names or addresses or perform geocoding or +reverse geocoding.

Defined in

packages/valhalla/parameters.ts:17


narrative

Optional narrative: boolean

Whether or not narrative instructions should be returned for the route

Default Value

Defaults to false.

Defined in

packages/valhalla/parameters.ts:24

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaRouteResponse.html b/docs/api/interfaces/valhalla.ValhallaRouteResponse.html new file mode 100644 index 0000000..fe8b98c --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaRouteResponse.html @@ -0,0 +1,18 @@ + + + + + +Interface: ValhallaRouteResponse | RoutingJS Documentation + + + + +
+

Interface: ValhallaRouteResponse

valhalla.ValhallaRouteResponse

Properties

alternates

Optional alternates: ValhallaRouteResponse[]

Alternate routes, if alternates was set in the request.

Defined in

packages/valhalla/parameters.ts:189


id

Optional id: string

If specified, the input ID.

Defined in

packages/valhalla/parameters.ts:179


trip

Optional trip: ValhallaTrip

The route results are returned as a trip. This is a JSON object that contains +details about the trip, including locations, a summary with basic information about +the entire trip, and a list of legs.

Defined in

packages/valhalla/parameters.ts:185

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts.html b/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts.html new file mode 100644 index 0000000..6f98e59 --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaTraceRouteOpts.html @@ -0,0 +1,33 @@ + + + + + +Interface: ValhallaTraceRouteOpts | RoutingJS Documentation + + + + +
+

Interface: ValhallaTraceRouteOpts

valhalla.ValhallaTraceRouteOpts

Hierarchy

  • Omit<ValhallaBaseOpts, "avoidLocations" | "avoidPolygons">

    ValhallaTraceRouteOpts

Properties

beginTime

Optional beginTime: string

Begin timestamp for the trace.

Remarks

This is used along with the durations so that timestamps can be specified for a +trace that is specified using an encoded polyline.

Defined in

packages/valhalla/index.ts:231


costingOpts

Optional costingOpts: ValhallaCostingOptsAuto | ValhallaCostingOptsTruck | ValhallaCostingOptsBicycle | ValhallaCostingOptsMotorcycle | ValhallaCostingOptsPedestrian

Profiles can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path. Only specify the actual options dict, the profile +will be filled automatically. For more information, visit: +https://github.com/valhalla/valhalla/blob/master/docs/api/turn-by-turn/api-reference.md#costing-options

Inherited from

Omit.costingOpts

Defined in

packages/valhalla/index.ts:83


dateTime

Optional dateTime: ValhallaDateTime

This is the local date and time at the location. Field type: 0: Current departure time, +1: Specified departure time. Field value: the date and time is specified +in ISO 8601 format (YYYY-MM-DDThh:mm), local time.

Example

   date_time = {type: 0, value: 2021-03-03T08:06:23}

Inherited from

Omit.dateTime

Defined in

packages/valhalla/index.ts:110


directionsOptions

Optional directionsOptions: ValhallaDirectionOpts

Defined in

packages/valhalla/index.ts:254


durations

Optional durations: number[]

List of durations (seconds) between each successive pair of input trace points.

Remarks

This allows trace points to be supplied as an encoded polyline and timestamps to be +created by using this list of "delta" times along with the begin_time of the trace.

Defined in

packages/valhalla/index.ts:239


id

Optional id: string

A request ID that will be returned in the response

Inherited from

Omit.id

Defined in

packages/valhalla/index.ts:70


preference

Optional preference: "shortest" | "fastest"

Convenience argument to set the cost metric, one of ['shortest', 'fastest']. Note, +that shortest is not guaranteed to be absolute shortest for motor vehicle profiles. It's called preference +to be in line with the already existing parameter in the ORS adapter.

Inherited from

Omit.preference

Defined in

packages/valhalla/index.ts:76


shapeMatch

Optional shapeMatch: ValhallaShapeMatch

shape_match is an optional string input parameter. It allows some control +of the matching algorithm based on the type of input.

Remarks

edge_walk: Indicates an edge walking algorithm can be used. This algorithm +requires nearly exact shape matching, so it should only be used +when the shape is from a prior Valhalla route.

map_snap: Indicates that a map-matching algorithm should be used because +the input shape might not closely match Valhalla edges. This +algorithm is more expensive.

walk_or_snap: Also the default option. This will try edge walking and if this +does not succeed, it will fall back and use map matching.

Default Value

walk_or_snap

Defined in

packages/valhalla/index.ts:223


traceOptions

Optional traceOptions: ValhallaAdditionalTraceOpts

Additional Options

Defined in

packages/valhalla/index.ts:253


useTimestamps

Optional useTimestamps: boolean

A boolean value indicating whether the input timestamps or durations should be used +when computing elapsed time at each edge along the matched path.

Remarks

If true, timestamps are used. If false (default), internal costing is applied to +compute elapsed times.

Default Value

false

Defined in

packages/valhalla/index.ts:251

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaTraceRouteParams.html b/docs/api/interfaces/valhalla.ValhallaTraceRouteParams.html new file mode 100644 index 0000000..89199db --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaTraceRouteParams.html @@ -0,0 +1,34 @@ + + + + + +Interface: ValhallaTraceRouteParams | RoutingJS Documentation + + + + +
+

Interface: ValhallaTraceRouteParams

valhalla.ValhallaTraceRouteParams

Hierarchy

  • Omit<ValhallaRequestParams, "exclude_locations" | "exclude_polygons">

  • ValhallaDirectionsOptions

    ValhallaTraceRouteParams

Properties

begin_time

Optional begin_time: string

Begin timestamp for the trace.

Remarks

This is used along with the durations so that timestamps can be specified for a +trace that is specified using an encoded polyline.

Defined in

packages/valhalla/parameters.ts:1366


costing

costing: ValhallaCostingType

Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route +request must include the name of the costing model and can include optional parameters available +for the chosen costing model.

Inherited from

Omit.costing

Defined in

packages/valhalla/parameters.ts:81


costing_options

Optional costing_options: ValhallaCostingOptTypes

Costing methods can have several options that can be adjusted to develop the route path, +as well as for estimating time along the path.

Inherited from

Omit.costing_options

Defined in

packages/valhalla/parameters.ts:86


directions_options

Optional directions_options: ValhallaDirectionsOptions

Defined in

packages/valhalla/parameters.ts:1389


directions_type

Optional directions_type: ValhallaDirectionsType

none indicates no maneuvers or instructions should be returned, +maneuvers indicates that only maneuvers be returned. +instructions indeicates that maneuvers with instructions should be returned

Default Value

Defaults to instructions.

Inherited from

ValhallaDirectionsOptions.directions_type

Defined in

packages/valhalla/parameters.ts:64


durations

Optional durations: number[]

List of durations (seconds) between each successive pair of input trace points.

Remarks

This allows trace points to be supplied as an encoded polyline and timestamps to be +created by using this list of "delta" times along with the begin_time of the trace.

Defined in

packages/valhalla/parameters.ts:1374


id

Optional id: string

Name your route request. If id is specified, the naming will be sent thru to the response.

Inherited from

Omit.id

Defined in

packages/valhalla/parameters.ts:90


language

Optional language: string

The language of the narration instructions based on the IETF BCP 47 language tag string. +If no language is specified or the specified language is unsupported, United States-based +English (en-US) is used.

See

https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#supported-language-tags for full list of supported languages.

Inherited from

ValhallaDirectionsOptions.language

Defined in

packages/valhalla/parameters.ts:72


shape

shape: ValhallaLocation[]

The array of input locations

Defined in

packages/valhalla/parameters.ts:1338


shape_match

Optional shape_match: ValhallaShapeMatch

shape_match is an optional string input parameter. It allows some control +of the matching algorithm based on the type of input.

Remarks

edge_walk: Indicates an edge walking algorithm can be used. This algorithm +requires nearly exact shape matching, so it should only be used +when the shape is from a prior Valhalla route.

map_snap: Indicates that a map-matching algorithm should be used because +the input shape might not closely match Valhalla edges. This +algorithm is more expensive.

walk_or_snap: Also the default option. This will try edge walking and if this +does not succeed, it will fall back and use map matching.

Default Value

walk_or_snap

Defined in

packages/valhalla/parameters.ts:1358


trace_options

Optional trace_options: ValhallaTraceOptions

Additional Options

Defined in

packages/valhalla/parameters.ts:1388


units

Optional units: ValhallaRequestUnit

Distance units for output. Allowable unit types are miles (or mi) and kilometers (or km). +If no unit type is specified, the units default to kilometers.

Default Value

Defaults to "kilometers".

Inherited from

ValhallaDirectionsOptions.units

Defined in

packages/valhalla/parameters.ts:55


use_timestamps

Optional use_timestamps: boolean

A boolean value indicating whether the input timestamps or durations should be used +when computing elapsed time at each edge along the matched path.

Remarks

If true, timestamps are used. If false (default), internal costing is applied to +compute elapsed times.

Default Value

false

Defined in

packages/valhalla/parameters.ts:1386

+ + + + \ No newline at end of file diff --git a/docs/api/interfaces/valhalla.ValhallaTrip.html b/docs/api/interfaces/valhalla.ValhallaTrip.html new file mode 100644 index 0000000..2a5aeba --- /dev/null +++ b/docs/api/interfaces/valhalla.ValhallaTrip.html @@ -0,0 +1,20 @@ + + + + + +Interface: ValhallaTrip | RoutingJS Documentation + + + + +
+

Interface: ValhallaTrip

valhalla.ValhallaTrip

Properties

language

language: string

The language of the narration instructions. If the user specified a language in the +directions options and the specified language was supported - this returned value will +be equal to the specified value. Otherwise, this value will be the default (en-US) language.

Defined in

packages/valhalla/parameters.ts:219


legs

legs: ValhallaLeg[]

A trip contains one or more legs. For n number of break locations, there are n-1 legs. +Through locations do not create separate legs.

Defined in

packages/valhalla/parameters.ts:203


locations

Optional locations: ValhallaReturnLocation[]

Location information is returned in the same form as it is entered with additional fields +to indicate the side of the street.

Defined in

packages/valhalla/parameters.ts:197


status

status: number

Status code.

See

https://valhalla.readthedocs.io/en/latest/api/turn-by-turn/api-reference/#internal-error-codes-and-conditions for the full list of possible status codes.

Defined in

packages/valhalla/parameters.ts:211


status_message

status_message: string

Defined in

packages/valhalla/parameters.ts:205


summary

summary: ValhallaRouteSummary

Defined in

packages/valhalla/parameters.ts:204


units

units: string

The specified units of length are returned, either kilometers or miles.

Defined in

packages/valhalla/parameters.ts:213


warnings

Optional warnings: any

This array may contain warning objects informing about deprecated request parameters, clamped values etc.

Defined in

packages/valhalla/parameters.ts:223

+ + + + \ No newline at end of file diff --git a/docs/api/modules.html b/docs/api/modules.html new file mode 100644 index 0000000..cf17530 --- /dev/null +++ b/docs/api/modules.html @@ -0,0 +1,16 @@ + + + + + +routingjs | RoutingJS Documentation + + + + + + + + + \ No newline at end of file diff --git a/docs/api/modules/core.html b/docs/api/modules/core.html new file mode 100644 index 0000000..e336efb --- /dev/null +++ b/docs/api/modules/core.html @@ -0,0 +1,16 @@ + + + + + +Module: core | RoutingJS Documentation + + + + + + + + + \ No newline at end of file diff --git a/docs/api/modules/graphhopper.html b/docs/api/modules/graphhopper.html new file mode 100644 index 0000000..85c9d92 --- /dev/null +++ b/docs/api/modules/graphhopper.html @@ -0,0 +1,19 @@ + + + + + +Module: graphhopper | RoutingJS Documentation + + + + +
+

Module: graphhopper

Classes

Interfaces

Type Aliases

GraphHopperAPIError

Ƭ GraphHopperAPIError: RoutingJSAPIError<GraphHopperErrorProps>

Defined in

packages/graphhopper/index.ts:49


GraphHopperClient

Ƭ GraphHopperClient: Client<GraphHopperRouteResponse | GraphHopperIsochroneResponse | GraphHopperMatrixResponse, { [k in keyof GraphHopperIsochroneGetParams]: GraphHopperIsochroneGetParams[k] } | { key?: string }, GraphHopperRouteParams | GraphHopperMatrixParams>

Defined in

packages/graphhopper/index.ts:105


GraphHopperDirections

Ƭ GraphHopperDirections: Directions<GraphHopperRouteResponse, GraphHopperRoutePath>

Defined in

packages/graphhopper/index.ts:93


GraphHopperDirectionsOpts

Ƭ GraphHopperDirectionsOpts: Omit<GraphHopperRouteParams, "points" | "profile">

points and profile properties are passed using the directions() method's top level args for +consistency.

Defined in

packages/graphhopper/index.ts:68


GraphHopperIsochroneGetParams

Ƭ GraphHopperIsochroneGetParams: { [K in keyof GraphHopperIsochroneParams]: string }

Since the /isochrone endpoint only accepts GET requests, +all parameters need to be stringified.

Defined in

packages/graphhopper/parameters.ts:254


GraphHopperIsochroneProps

Ƭ GraphHopperIsochroneProps: Object

Properties of the returned Features.

Type declaration

NameType
bucketnumber

Defined in

packages/graphhopper/parameters.ts:543


GraphHopperIsochrones

Ƭ GraphHopperIsochrones: Isochrones<GraphHopperIsochroneResponse, GraphHopperIsochroneProps>

Defined in

packages/graphhopper/index.ts:98


GraphHopperMatrix

Ƭ GraphHopperMatrix: Matrix<GraphHopperMatrixResponse>

Defined in

packages/graphhopper/index.ts:103


GraphHopperProfile

Ƭ GraphHopperProfile: "car" | "car_delivery" | "car_avoid_ferry" | "car_avoid_motorway" | "car_avoid_toll" | "small_truck" | "small_truck_delivery" | "truck" | "scooter" | "scooter_delivery" | "foot" | "hike" | "bike" | "mtb" | "racingbike"

The profile is used to determine the network, speed and other physical attributes to use +for routing the vehicle or pedestrian.

See

https://docs.graphhopper.com/#section/Map-Data-and-Routing-Profiles for full documentation.

Defined in

packages/graphhopper/parameters.ts:385

+ + + + \ No newline at end of file diff --git a/docs/api/modules/ors.html b/docs/api/modules/ors.html new file mode 100644 index 0000000..4882ef1 --- /dev/null +++ b/docs/api/modules/ors.html @@ -0,0 +1,16 @@ + + + + + +Module: ors | RoutingJS Documentation + + + + +
+

Module: ors

Classes

Interfaces

Type Aliases

ORSAPIError

Ƭ ORSAPIError: RoutingJSAPIError<ORSErrorProps>

Defined in

packages/ors/index.ts:51


ORSAttribute

Ƭ ORSAttribute: "avgspeed" | "detourfactor" | "percentage"

Defined in

packages/ors/parameters.ts:207


ORSClient

Ƭ ORSClient: Client<ORSRouteResponse | ORSIsochroneResponse | ORSMatrixResponse, undefined, ORSRouteParams | ORSMatrixParams | ORSIsochroneParams>

Defined in

packages/ors/index.ts:82


ORSDirections

Ƭ ORSDirections: Directions<ORSRouteResponse, ORSRoute>

Defined in

packages/ors/index.ts:76


ORSDirectionsOpts

Ƭ ORSDirectionsOpts: Omit<ORSRouteParams, "coordinates">

Defined in

packages/ors/index.ts:64


ORSExtraInfo

Ƭ ORSExtraInfo: "steepness" | "suitability" | "surface" | "waycategory" | "waytype" | "tollways" | "traildifficulty" | "roadaccessrestrictions"

Defined in

packages/ors/parameters.ts:208


ORSFormat

Ƭ ORSFormat: "geojson" | "json"

Defined in

packages/ors/parameters.ts:218


ORSInstructionFormat

Ƭ ORSInstructionFormat: "html" | "text"

Defined in

packages/ors/parameters.ts:217


ORSIsoAttribute

Ƭ ORSIsoAttribute: "area" | "reachfactor" | "total_pop"

Defined in

packages/ors/parameters.ts:219


ORSIsochroneOpts

Ƭ ORSIsochroneOpts: Omit<ORSIsochroneParams, "locations" | "range" | "interval">

Defined in

packages/ors/index.ts:71


ORSIsochrones

Ƭ ORSIsochrones: Isochrones<ORSIsochroneResponse, any>

Defined in

packages/ors/index.ts:78


ORSMatrix

Ƭ ORSMatrix: Matrix<ORSMatrixResponse>

Defined in

packages/ors/index.ts:80


ORSMatrixOpts

Ƭ ORSMatrixOpts: Pick<ORSMatrixParams, "metrics" | "resolve_locations">

Defined in

packages/ors/index.ts:66


ORSPreference

Ƭ ORSPreference: "fastest" | "shortest" | "recommended"

Defined in

packages/ors/parameters.ts:205


ORSProfile

Ƭ ORSProfile: "driving-car" | "driving-hgv" | "foot-walking" | "foot-hiking" | "cycling-regular" | "cycling-road" | "cycling-mountain" | "cycling-electric"

Specifies the mode of transport.

Defined in

packages/ors/parameters.ts:4


ORSUnit

Ƭ ORSUnit: "m" | "km" | "mi"

Defined in

packages/ors/parameters.ts:206

+ + + + \ No newline at end of file diff --git a/docs/api/modules/osrm.html b/docs/api/modules/osrm.html new file mode 100644 index 0000000..fe90c76 --- /dev/null +++ b/docs/api/modules/osrm.html @@ -0,0 +1,16 @@ + + + + + +Module: osrm | RoutingJS Documentation + + + + + + + + + \ No newline at end of file diff --git a/docs/api/modules/valhalla.html b/docs/api/modules/valhalla.html new file mode 100644 index 0000000..dfe0bfd --- /dev/null +++ b/docs/api/modules/valhalla.html @@ -0,0 +1,18 @@ + + + + + +Module: valhalla | RoutingJS Documentation + + + + +
+

Module: valhalla

Classes

Interfaces

Type Aliases

ValhallaAPIError

Ƭ ValhallaAPIError: RoutingJSAPIError<ValhallaErrorProps>

Defined in

packages/valhalla/index.ts:56


ValhallaClient

Ƭ ValhallaClient: Client<ValhallaRouteResponse | ValhallaMatrixResponse | FeatureCollection, MapboxAuthParams, ValhallaIsochroneParams | ValhallaRouteParams | ValhallaMatrixParams | ValhallaTraceRouteParams>

Defined in

packages/valhalla/index.ts:271


ValhallaCostingType

Ƭ ValhallaCostingType: "auto" | "bicycle" | "motorcycle" | "truck" | "pedestrian"

Valhalla's routing service uses dynamic, run-time costing to generate the route path. The route +request must include the name of the costing model and can include optional parameters available +for the chosen costing model.

Defined in

packages/valhalla/parameters.ts:1276


ValhallaDirections

Ƭ ValhallaDirections: Directions<ValhallaRouteResponse, ValhallaRouteResponse>

Defined in

packages/valhalla/index.ts:257


ValhallaDirectionsType

Ƭ ValhallaDirectionsType: "none" | "maneuvers" | "instructions"

Defined in

packages/valhalla/parameters.ts:422


ValhallaIsochrones

Ƭ ValhallaIsochrones: Isochrones<ValhallaIsochroneResponse, Feature>

Defined in

packages/valhalla/index.ts:262


ValhallaMatrix

Ƭ ValhallaMatrix: Matrix<ValhallaMatrixResponse>

Defined in

packages/valhalla/index.ts:264


ValhallaRequestUnit

Ƭ ValhallaRequestUnit: "mi" | "km" | "miles" | "kilometers"

Defined in

packages/valhalla/parameters.ts:108


ValhallaShapeMatch

Ƭ ValhallaShapeMatch: "edge_walk" | "map_snap" | "walk_or_snap"

Defined in

packages/valhalla/parameters.ts:1308


ValhallaTraceRoute

Ƭ ValhallaTraceRoute: Directions<ValhallaRouteResponse, ValhallaRouteResponse>

Defined in

packages/valhalla/index.ts:266

+ + + + \ No newline at end of file diff --git a/docs/quickstart.html b/docs/quickstart.html new file mode 100644 index 0000000..ede9337 --- /dev/null +++ b/docs/quickstart.html @@ -0,0 +1,16 @@ + + + + + +Quickstart | RoutingJS Documentation + + + + +
+

Quickstart

Installation

Install single client classes:

npm i @routingjs/valhalla @routingjs/osrm @routingjs/ors @routingjs/graphhopper

Directions

All clients support the .directions() method:

import { Valhalla } from "@routingjs/valhalla"

const v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de
v.directions(
[
[8.512516, 47.380742],
[8.557835, 47.359467],
],
"auto"
).then((d) => {
// do stuff with the directions response
d.directions.forEach((direction) => {
console.log(direction.feature)
})
})

The result's directions property is an array of at least one route as GeoJSON LineString feature, and more if alternatives have been requested.

If you want to access the response as sent by the routing server, you can always access it using the raw property.

Matrix

Hint: GraphHopper only supports the /matrix endpoint in their own hosted version.

import { Valhalla } from "@routingjs/valhalla"

const v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de

v.matrix(
[
[1.51886, 42.5063],
[1.53789, 42.51007],
],
"auto"
).then((m) => {
console.log(m.durations)
})

The returned Matrix has durations and distances properties, and you can access the response via its raw property.

Reachability

The .reachability() method is analogous to isochrone/isodistance analyses.

Note: OSRM does not support this method.

import { Valhalla } from "@routingjs/valhalla"

const v = new Valhalla() // URL defaults to http://valhalla1.openstreetmap.de

v.reachability([[1.51886, 42.5063]], "auto").then((i) => {
i.isochrones.forEach((isochrone) => console.log(isochrone.feature))
})
+ + + + \ No newline at end of file diff --git a/img/braces.svg b/img/braces.svg new file mode 100644 index 0000000..71c8027 --- /dev/null +++ b/img/braces.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/img/docusaurus.png b/img/docusaurus.png new file mode 100644 index 0000000000000000000000000000000000000000..f458149e3c8f53335f28fbc162ae67f55575c881 GIT binary patch literal 5142 zcma)=cTf{R(}xj7f`AaDml%oxrAm_`5IRVc-jPtHML-0kDIiip57LWD@4bW~(nB|) z34|^sbOZqj<;8ct`Tl-)=Jw`pZtiw=e$UR_Mn2b8rM$y@hlq%XQe90+?|Mf68-Ux_ zzTBiDn~3P%oVt>{f$z+YC7A)8ak`PktoIXDkpXod+*gQW4fxTWh!EyR9`L|fi4YlH z{IyM;2-~t3s~J-KF~r-Z)FWquQCfG*TQy6w*9#k2zUWV-+tCNvjrtl9(o}V>-)N!) ziZgEgV>EG+b(j@ex!dx5@@nGZim*UfFe<+e;(xL|j-Pxg(PCsTL~f^br)4{n5?OU@ z*pjt{4tG{qBcDSa3;yKlopENd6Yth=+h9)*lkjQ0NwgOOP+5Xf?SEh$x6@l@ZoHoYGc5~d2>pO43s3R|*yZw9yX^kEyUV2Zw1%J4o`X!BX>CwJ zI8rh1-NLH^x1LnaPGki_t#4PEz$ad+hO^$MZ2 ziwt&AR}7_yq-9Pfn}k3`k~dKCbOsHjvWjnLsP1{)rzE8ERxayy?~{Qz zHneZ2gWT3P|H)fmp>vA78a{0&2kk3H1j|n59y{z@$?jmk9yptqCO%* zD2!3GHNEgPX=&Ibw?oU1>RSxw3;hhbOV77-BiL%qQb1(4J|k=Y{dani#g>=Mr?Uyd z)1v~ZXO_LT-*RcG%;i|Wy)MvnBrshlQoPxoO*82pKnFSGNKWrb?$S$4x+24tUdpb= zr$c3K25wQNUku5VG@A=`$K7%?N*K+NUJ(%%)m0Vhwis*iokN#atyu(BbK?+J+=H z!kaHkFGk+qz`uVgAc600d#i}WSs|mtlkuwPvFp) z1{Z%nt|NwDEKj1(dhQ}GRvIj4W?ipD76jZI!PGjd&~AXwLK*98QMwN&+dQN1ML(6< z@+{1`=aIc z9Buqm97vy3RML|NsM@A>Nw2=sY_3Ckk|s;tdn>rf-@Ke1m!%F(9(3>V%L?w#O&>yn z(*VIm;%bgezYB;xRq4?rY})aTRm>+RL&*%2-B%m; zLtxLTBS=G!bC$q;FQ|K3{nrj1fUp`43Qs&V!b%rTVfxlDGsIt3}n4p;1%Llj5ePpI^R} zl$Jhx@E}aetLO!;q+JH@hmelqg-f}8U=XnQ+~$9RHGUDOoR*fR{io*)KtYig%OR|08ygwX%UqtW81b@z0*`csGluzh_lBP=ls#1bwW4^BTl)hd|IIfa zhg|*M%$yt@AP{JD8y!7kCtTmu{`YWw7T1}Xlr;YJTU1mOdaAMD172T8Mw#UaJa1>V zQ6CD0wy9NEwUsor-+y)yc|Vv|H^WENyoa^fWWX zwJz@xTHtfdhF5>*T70(VFGX#8DU<^Z4Gez7vn&4E<1=rdNb_pj@0?Qz?}k;I6qz@| zYdWfcA4tmI@bL5JcXuoOWp?ROVe*&o-T!><4Ie9@ypDc!^X&41u(dFc$K$;Tv$c*o zT1#8mGWI8xj|Hq+)#h5JToW#jXJ73cpG-UE^tsRf4gKw>&%Z9A>q8eFGC zG@Iv(?40^HFuC_-%@u`HLx@*ReU5KC9NZ)bkS|ZWVy|_{BOnlK)(Gc+eYiFpMX>!# zG08xle)tntYZ9b!J8|4H&jaV3oO(-iFqB=d}hGKk0 z%j)johTZhTBE|B-xdinS&8MD=XE2ktMUX8z#eaqyU?jL~PXEKv!^) zeJ~h#R{@O93#A4KC`8@k8N$T3H8EV^E2 z+FWxb6opZnX-av5ojt@`l3TvSZtYLQqjps{v;ig5fDo^}{VP=L0|uiRB@4ww$Eh!CC;75L%7|4}xN+E)3K&^qwJizphcnn=#f<&Np$`Ny%S)1*YJ`#@b_n4q zi%3iZw8(I)Dzp0yY}&?<-`CzYM5Rp+@AZg?cn00DGhf=4|dBF8BO~2`M_My>pGtJwNt4OuQm+dkEVP4 z_f*)ZaG6@t4-!}fViGNd%E|2%ylnzr#x@C!CrZSitkHQ}?_;BKAIk|uW4Zv?_npjk z*f)ztC$Cj6O<_{K=dPwO)Z{I=o9z*lp?~wmeTTP^DMP*=<-CS z2FjPA5KC!wh2A)UzD-^v95}^^tT<4DG17#wa^C^Q`@f@=jLL_c3y8@>vXDJd6~KP( zurtqU1^(rnc=f5s($#IxlkpnU=ATr0jW`)TBlF5$sEwHLR_5VPTGiO?rSW9*ND`bYN*OX&?=>!@61{Z4)@E;VI9 zvz%NmR*tl>p-`xSPx$}4YcdRc{_9k)>4Jh&*TSISYu+Y!so!0JaFENVY3l1n*Fe3_ zRyPJ(CaQ-cNP^!3u-X6j&W5|vC1KU!-*8qCcT_rQN^&yqJ{C(T*`(!A=))=n%*-zp_ewRvYQoJBS7b~ zQlpFPqZXKCXUY3RT{%UFB`I-nJcW0M>1^*+v)AxD13~5#kfSkpWys^#*hu)tcd|VW zEbVTi`dbaM&U485c)8QG#2I#E#h)4Dz8zy8CLaq^W#kXdo0LH=ALhK{m_8N@Bj=Um zTmQOO*ID(;Xm}0kk`5nCInvbW9rs0pEw>zlO`ZzIGkB7e1Afs9<0Z(uS2g*BUMhp> z?XdMh^k}k<72>}p`Gxal3y7-QX&L{&Gf6-TKsE35Pv%1 z;bJcxPO+A9rPGsUs=rX(9^vydg2q`rU~otOJ37zb{Z{|)bAS!v3PQ5?l$+LkpGNJq zzXDLcS$vMy|9sIidXq$NE6A-^v@)Gs_x_3wYxF%y*_e{B6FvN-enGst&nq0z8Hl0< z*p6ZXC*su`M{y|Fv(Vih_F|83=)A6ay-v_&ph1Fqqcro{oeu99Y0*FVvRFmbFa@gs zJ*g%Gik{Sb+_zNNf?Qy7PTf@S*dTGt#O%a9WN1KVNj`q$1Qoiwd|y&_v?}bR#>fdP zSlMy2#KzRq4%?ywXh1w;U&=gKH%L~*m-l%D4Cl?*riF2~r*}ic9_{JYMAwcczTE`!Z z^KfriRf|_YcQ4b8NKi?9N7<4;PvvQQ}*4YxemKK3U-7i}ap8{T7=7`e>PN7BG-Ej;Uti2$o=4T#VPb zm1kISgGzj*b?Q^MSiLxj26ypcLY#RmTPp+1>9zDth7O?w9)onA%xqpXoKA-`Jh8cZ zGE(7763S3qHTKNOtXAUA$H;uhGv75UuBkyyD;eZxzIn6;Ye7JpRQ{-6>)ioiXj4Mr zUzfB1KxvI{ZsNj&UA`+|)~n}96q%_xKV~rs?k=#*r*7%Xs^Hm*0~x>VhuOJh<2tcb zKbO9e-w3zbekha5!N@JhQm7;_X+J!|P?WhssrMv5fnQh$v*986uWGGtS}^szWaJ*W z6fLVt?OpPMD+-_(3x8Ra^sX~PT1t5S6bfk@Jb~f-V)jHRul#Hqu;0(+ER7Z(Z4MTR z+iG>bu+BW2SNh|RAGR2-mN5D1sTcb-rLTha*@1@>P~u;|#2N{^AC1hxMQ|(sp3gTa zDO-E8Yn@S7u=a?iZ!&&Qf2KKKk7IT`HjO`U*j1~Df9Uxz$~@otSCK;)lbLSmBuIj% zPl&YEoRwsk$8~Az>>djrdtp`PX z`Pu#IITS7lw07vx>YE<4pQ!&Z^7L?{Uox`CJnGjYLh1XN^tt#zY*0}tA*a=V)rf=&-kLgD|;t1D|ORVY}8 F{0H{b<4^zq literal 0 HcmV?d00001 diff --git a/img/settings-off.svg b/img/settings-off.svg new file mode 100644 index 0000000..14c3f07 --- /dev/null +++ b/img/settings-off.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/img/switch-3.svg b/img/switch-3.svg new file mode 100644 index 0000000..4a1615b --- /dev/null +++ b/img/switch-3.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..7a1b808 --- /dev/null +++ b/index.html @@ -0,0 +1,16 @@ + + + + + +RoutingJS Documentation | RoutingJS Documentation + + + + +
+

RoutingJS Documentation

Consistent access to Open Source Routing Engines

Quick setup

Hook into public APIs of Valhalla, OSRM, GraphHopper* and OpenRouteService* with no setup.

A unified API

With routing-js it has never been easier to switch between different routing engines.

The Power of TypeScript

Full code completion in your IDE for all API's parameters, thanks to TypeScript, even if you use JavaScript.

* API keys required
+ + + + \ No newline at end of file diff --git a/markdown-page.html b/markdown-page.html new file mode 100644 index 0000000..fa79ea0 --- /dev/null +++ b/markdown-page.html @@ -0,0 +1,16 @@ + + + + + +Markdown page example | RoutingJS Documentation + + + + +
+

Markdown page example

You don't need React to write simple standalone pages.

+ + + + \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..0d17095 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1 @@ +https://gis-ops.github.io/routingjs/markdown-pageweekly0.5https://gis-ops.github.io/routingjs/docs/apiweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.Clientweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.Directionweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.Directionsweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.Isochroneweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.Isochronesweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.Matrixweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/core.RoutingJSAPIErrorweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/graphhopper.GraphHopperweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/ors.ORSweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/osrm.OSRMweekly0.5https://gis-ops.github.io/routingjs/docs/api/classes/valhalla.Valhallaweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/core.BaseRouterweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/core.ClientConstructorArgsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/core.ErrorPropsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/core.JSONObjectweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperErrorPropsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperIsochroneResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperMatrixResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperRoutePathweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/graphhopper.GraphHopperRouteResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSAlternateRouteParamweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSErrorPropsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSIsochroneParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSIsochroneResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSMatrixParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSMatrixResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSRouteweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSRouteParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/ors.ORSRouteResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMDirectionsOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMErrorPropsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMGeometryObjectweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMMatrixOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMRouteweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMRouteParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMRouteResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMTableParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/osrm.OSRMTableResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.MapboxAuthParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaContoursweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsAutoweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsBicycleweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsMotorcycleweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsPedestrianweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaCostingOptsTruckweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaDateTimeweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaDirectionOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaErrorPropsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaIsochroneResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaLegweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaLocationweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaManeuversweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaMatrixResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaRouteParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaRouteResponseweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteOptsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaTraceRouteParamsweekly0.5https://gis-ops.github.io/routingjs/docs/api/interfaces/valhalla.ValhallaTripweekly0.5https://gis-ops.github.io/routingjs/docs/api/modulesweekly0.5https://gis-ops.github.io/routingjs/docs/api/modules/coreweekly0.5https://gis-ops.github.io/routingjs/docs/api/modules/graphhopperweekly0.5https://gis-ops.github.io/routingjs/docs/api/modules/orsweekly0.5https://gis-ops.github.io/routingjs/docs/api/modules/osrmweekly0.5https://gis-ops.github.io/routingjs/docs/api/modules/valhallaweekly0.5https://gis-ops.github.io/routingjs/docs/quickstartweekly0.5https://gis-ops.github.io/routingjs/weekly0.5 \ No newline at end of file