Rute
Beregn ruten mellem to punkter i kortet ved at klikke i kortet eller søge et punkt via søgefeltet.
I toppen af ruteplanlæggeren er der altid en menu (⋮) ved siden af luk-knappen. Menuen folder opad og indeholder:
- Ruteprofilerne fra
legProfileselect(hvis sat). - "Del rute" (hvis
shareButtoner sat). - "Hent rute som GPX" (hvis
downloadButtoner sat). Vises når ruten har mindst to punkter. - "Slet sidste punkt", som fjerner det sidste punkt på ruten.
- "Gentag", som gendanner en fortrudt ændring. Vises kun, når der er noget at gentage.
- "Fortryd", som fortryder den seneste ændring af destinationerne: tilføjelse, flytning (også ved at trække i kortet), sletning eller ændret rækkefølge. Vises kun, når der er noget at fortryde, og står altid nederst.
Options
Herunder findes en beskrivelse af de enkelte egenskaber, der kan sættes på funktionen.
disable
- Type:
boolean - Default:
false
Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
detach
- Type:
string
Angiv en reference til et alternativ html-element, som denne kontrol skal vises i. Det kan benyttes til at placere indholdet af en kontrol et andet sted på sin side. Hvis detach har værdien "abc", så skal der tilføjes et element til HTML'en på denne form: <div data-widget-detach="abc"/>. Hvis elementet ikke findes, så fungerer kontrollen, som hvis detach ikke var angivet.
css
- Type:
string | string[]
Angiv en sti til en css-fil, der skal loades efter denne kontrol. Herved vil det være muligt at lave en brugertilpasset style af kontrollen.
Indlæs én eller flere CSS filer på denne måde:
json
"css": [
"https://septima.dk/widget/custom.css"
]className
- Type:
string
Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
keepInFullscreen
- Type:
boolean - Default:
false
Benyttes når funktionen er "detached" og funktionen "fullscreen" er inkluderet i konfigurationen. Hvis "keepInFullscreen" sættes til true, så er funktionen tilgængelig når kortet vises i fullscreen.
apikey
- Type:
string
En API-nøgle, som er gyldig til Septimas rutewebservice.
header
- Type:
string
Angiver den html-template, der anvendes til at præsentere i overskriften på boksen. Hvis ikke angivet, så vises der en default tekst. Teksten behandles som en template, hvor der er adgang til "profile", "dist" og "time". For denne template er følgende attributter tilgængelige; <%= profile %>, <%= time.s %>, <%= time.m %>, <%= time.h %>, <%= dist.distance %> og <%= dist.unit %>. De kan alle benyttes til at fortælle brugeren hvorlang ruten er og hvor lang tid det tager med den pågældende ruteprofil.
subheader
- Type:
string
Angiver den html-template, der anvendes til at præsentere sammen med listen af punkter. Hvis ikke angivet, så vises der ikke nogen tekst. Med "subheader" kan man styre teksten under listen. Teksten behandles som en template, hvor der er adgang til "points". Herved kan teksten være afhængig af antallet af punkter. Læs mere om templates generelt her.. For denne template er der to tilgængelige attributter; <%= title %> og <%= content %>, hvor <%= title %> benyttes til at skrive, hvor ruten starter, mens <%= content %> er dér, hvor listen indsættes. De enkelte rækker i listen styres af template_route på laget.
profile
- Type:
string - Default:
car
Angiver den ruteprofil, der anvendes fra ruteservicen. "car" beregner bilruter, "bicycle" beregener cykelruter, "foot" beregner for gående, mens "bus" beregner for kørsel med større køretøjer. Derudover er det muligt at benytte "air", som beregner luftlinjeafstanden mellem punkterne.
profileselect
- Type:
array
Giver brugeren mulighed for at skifte mellem forskelige ruteprofiler. Hvert element i arrayet er et objekt med name (vist label), value (profilnavn til ruteservicen) og valgfrit icon (Google Material Icons-symbolnavn).
json
"profileselect": [
{"name": "Bil", "value": "car", "icon": "car"},
{"name": "Cykel", "value": "bicycle", "icon": "bike"},
{"name": "Gang", "value": "foot", "icon": "walk"},
{"name": "Lastbil", "value": "bus", "icon": "truck"},
{"name": "Luftlinjeafstand", "value": "air", "icon": "airplane"}
]legProfileselect
- Type:
array
Gør det muligt at vælge ruteprofil for hver strækning i ruten, f.eks. gang på første strækning, luftlinje på den næste og gang igen på den tredje. Der vises en liste med profilerne øverst i menuen i toppen af ruteplanlæggeren. Den valgte profil bruges til strækningen hen til den næste destination, der tilføjes. Strækninger, der allerede er beregnet, beholder deres profil.
Elementerne har samme format som i profileselect (name, value og evt. apikey/servicehost). Når legProfileselect er sat, vises profileselect ikke, og man kan ikke skifte profil for hele ruten.
Strækningerne samles til én sammenhængende rutelinje, så afstandsmarkeringer (f.eks. fixedInterval) regnes for hele ruten. Linjen har egenskaben profiles med profilen for hver strækning.
json
"legProfileselect": [
{"name": "Gang", "value": "foot"},
{"name": "Cykel", "value": "bicycle"},
{"name": "Luftlinje", "value": "air"}
]limit
- Type:
integer
Antallet af destinationer, der skal vises i listen.
elevationProfile
- Type:
object
Viser en lille graf med terrænets højdeprofil (DHM, terrænmodel) for hele ruten under overskriften. Grafen viser også laveste og højeste punkt. Kræver en API-nøgle, som er gyldig til Septimas højdeservice. host kan sættes, hvis en anden service skal bruges.
json
"routing": {
"elevationProfile": {
"apikey": "..."
}
}downloadButton
- Type:
boolean - Default:
false
Tilføjer "Hent rute som GPX" til menuen. GPX-filen indeholder ruten som et spor og destinationerne som waypoints.
json
"routing": {
"downloadButton": true
}shareButton
- Type:
boolean - Default:
false
Tilføjer "Del rute" til menuen. Der dannes en URL til den aktuelle side med destinationerne (og profilen) i parametrene route og routeprofile. Browserens indbyggede deling bruges, hvor det er muligt (typisk mobil). Ellers kopieres linket til udklipsholderen.
Når siden åbnes med et delt link, vises ruten, og den vinder over en rute gemt med useStore. Parametrene fjernes derefter fra adresselinjen.
json
"routing": {
"shareButton": true
}useStore
- Type:
boolean | object
Gem destinationerne i browserens localStorage, så brugeren kan fortsætte, hvor de slap, når siden indlæses igen. Ruten beregnes og vises igen ud fra de gemte destinationer. Når alle destinationer er fjernet, slettes det gemte.
Sæt useStore til true eller angiv et objekt med følgende muligheder:
- expire Hvor længe ruten huskes i millisekunder. Default er
never, så ruten huskes, indtil den slettes. - ignoreURLParams En eller flere URL-parametre, der ikke skal indgå, når det afgøres, om det er den samme side.
- id Et fast id for det gemte. Kan bruges til at dele den samme rute på tværs af sider.
json
"routing": {
"useStore": {
"expire": 86400000
}
}zoomOptions
- Type:
object
Hvis angivet, så zoomes der til objektet når det er valgt. Det er muligt at angive, hvordan der skal zoomes til objektet i kortet. Læs mere om zoomOptions her.
activateButton
- Type:
object
Aktivér denne funktion med en knap i kortet. Læs mere om activateButton her.
Eksempler
Eksempler, der bruger denne komponent:
Løberute rute
Tegn en løberute i kortet
Ruteberegning rutesøg
Beregn ruten mellem to punkter i kortet ved at klikke i kortet eller søge et punkt via søgefeltet.
Ruteberegning med knap rutesøg
Aktiver ruteberegningen med en knap og beregn derefter ruten mellem to eller flere punkter i kortet
Ruteberegning med luftlinjeafstand rutesøg
Beregn ruten mellem to punkter i kortet ved at klikke i kortet eller søge et punkt via søgefeltet. Brugeren kan skifte ruteprofil.
Ruteberegning med transportform rutesøg
Beregn ruten mellem to punkter i kortet ved at klikke i kortet eller søge et punkt via søgefeltet. Brugeren kan vælge om ruten skal foretages via gående, på cykel eller i bil.