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.
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 @@ + + +
+ + +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.
{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 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 {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 {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 {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 {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 {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["'])(?