Konfiguration

For at bruge Septima Widget skal du blot indsætte følgende to linjer på din hjemmeside:

<div data-widget-url="http://www.septima.dk/widget/config/info4.json"></div>
<script src="http://widgetconfig.septima.dk/widgetconfig.js"></script>

Kort (map)

Elementet "map" definerer en widgets overordnede kortegenskaber

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css string/array Angiv en sti til en css fil, der skal loades efter komponenten. Herved vil det være muligt at lave en brugertilpasset style af elementerne. Ved at angive et array af stier eller en liste adskilt af et komma er det muligt at loade flere filer.
crs string EPSG:25832 Kortets koordinatreferencesystem defineret i EPSG, eksempelvis: EPSG:25832
maxZoomLevel number 0

Angiver, hvor langt brugeren må zoome ud i kortet. Jo lavere tal, der angives, jo længere ud kan brugeren zoome. Den lavest mulige værdi er "0".

minZoomLevel number 11 Angiver, hvor langt brugeren må zoome ind i kortet. Jo højere tal, der angives, jo længere ind kan brugeren zoome. Den højeste værdi, der kan angives, bestemmes af det anvendte kort.
view object

Elementet view definerer et korts opstartstilstand. Det vil sige, centerpunkt defineret ved x og y koordinater i kortet samt zoomlevel:

"view": {
    "zoomLevel": 6,
    "x": 724406,
    "y": 6175994
}

Alternativt er det muligt at angive extent som en bbox med det udsnit, der skal vises.

"view": {
    "extent": [445058, 6066492, 890702, 6400726]
}

Det er også muligt at angive et maxExtent, der gør, at brugeren ikke kan panorere væk for et givent extent.

"view": {
    "zoomLevel": 0,
    "x": 724406,
    "y": 6175994,
    "maxExtent": [445058, 6066492, 890702, 6400726]
}
layer array En liste af lag, der skal vises i kortet
height number/string

Angiv, hvor højt kortet skal være. Værdien kunne for eksempel være 300 eller 300px, der begge sætter højden på kortet til 300 pixels. Højden kan også angives i procent. For eksempel 100%, der kan benyttes til fuldskærmskort.

Denne egenskab kan ligeledes angives direkte på den div, der definerer widget'en. Det gøres ved at tilføje en attribut, der hedder data-widget-height:

<div data-widget="mapwidget" data-widget-height="100%"></div>
useHash boolean false Skal den aktuelle position gemmes i URL'en, så man kan sende URL'en til en anden og se præcist det samme udsnit. Så sæt useHash til true.
useStore object

Med useStore er det muligt at gemme kortets aktuelle centerpunkt og zoome til, næste gang brugeren ser denne widget. Det er for eksempel relevant, når brugeren forlader siden og kommer tilbage hurtigt efter. Som udløber det gemte efter 30 sekunder (30.000 ms). Denne værdi kan ændres ved at sætte expire til noget andet:

"useStore": {
    "expire": 600000
}

Herved udløber den først efter ti minutter.

Sæt expire til never for aldrig at udløbe:

"useStore": {
    "expire": "never"
}
mapcontrols object

Med mapcontrols er det muligt at styre, hvordan interaktionen i kortet skal være. Det er eksempelvist muligt at disable zoom med musehjulet. Det gøres ved at sætte mouseWheelZoom til false:

"mapcontrols": {
    "mouseWheelZoom": false
}

Denne funktionen har ingen indflydelse på kortet i IE8 og ældre browsere.

Følgende navigationsfunktioner der kan deaktiveres: mouseWheelZoom, dragRotate, doubleClickZoom, dragPan, pinchRotate, keyboardPan, keyboardZoom og scaleline

Følgende funktioner kan aktiveres: scaleline. Eksempelvis:

"mapcontrols": {
    "scaleline": true
}

Datalag (layer)

I layer elementet angives de lag, kortet skal bestå af. Hvert layer har følgende elementer

Name type default description
disable boolean false Skal laget deaktiveres. Herved fungerer det, som om laget ikke var tilføjet. Kan bruges til midlertidig fjerne et lag.
namedlayer string

Angiver navnet på et default baggrundskort. På nuværende tidspunkt findes følgende navngivne lag, der kan benyttes: #gst, #gst_graa, #gst_skaerm, #gst_orto, #gst_kommune, #gst_dhm, #plansystem samt #osm

Der er muligt at overstyre enkelte parametre ved blot også at tilføje de parametre, der ønskes overstyret.

visible boolean true Angiver, om laget skal vises fra start
copyright string Tilføj en copyright tekst i kortet. Hvis der skal være et link, kan det tilføjes ved at skrive det som HTML.
extent array Angiver, om laget kun skal vises inden for et bestemt extent. Alt uden for dette extent vises (og hentes) ikke.
type string

Elementet type angiver typen af laget. Gyldige værdier: "geojson", "esrijson", "djangojson", "datasourcejson", "OSM", "TileJSON", "ArcGISRest", "XYZ", "VectorTiles", "Stamen", "WMS" eller "WMTS"

Ved typen geojson er følgende øvrige elementer tilgængelige: features, features_host, features_dataType, features_type, features_style, template, template_[funktionsnavn], features_callbackparam

Ved typen esrijson er følgende øvrige elementer tilgængelige: features, features_host, features_dataType, features_type, features_style, template, template_[funktionsnavn], features_callbackparam

Ved typen djangojson er følgende øvrige elementer tilgængelige: features, features_host, features_dataType, features_type, features_style, template, template_[funktionsnavn], features_callbackparam, features_geometrycolumn

Ved typen datasourcejson er følgende øvrige elementer tilgængelige: features, features_host, features_dataType, features_type, features_style, template, template_[funktionsnavn]

Ved typen wms er følgende øvrige elementer påkrævet: host, format, layername

Ved typen wmts er følgende øvrige elementer påkrævet: host, format, layername, resolutions, matrixIds, matrixSet

Ved typen OSM skal ingen andre elementer angives

Ved typen Stamen skal ingen andre elementer angives, men det er muligt at angive layer_name (default er "watercolor")

Ved typen TileJSON er følgende element påkrævet: host

Ved typen VectorTiles er følgende element påkrævet: host

Ved typen ArcGISRest er følgende øvrige elementer påkrævet: host, extent. For at vælge et specifikt lag, tilføj da layername ("show:0" hvis det er det første lag).

Ved typen XYZ er følgende element påkrævet: host

crs string EPSG:25832 Kortets koordinatreferencesystem defineret i EPSG, eksempelvis: EPSG:25832
features boolean false Angiver, om laget anvender vektor data for dynamisk visning og interaktion. Vektordata skal være i formatet GeoJSON. Ved at angive denne parameter er det muligt både at hente data som WMS, WMTS eller andet rasterlag samtidig med, at man henter vektordata til bedre interaktion for brugeren
data object Indsæt data (GeoJSON) direkte i konfigurationen. Dette kan bruges som et alternativ til at hente vektordata fra en service med "feature_host". Det er også velegenet til at vise enkelte objekter i kortet, såsom adresse eller mødested. Indholdet skal overholde fra GeoJSON-specifikationen - læs mere her
features_host string Internetadressen, hvor vektordata hentes fra, angiver, hvor kortet skal hente vektordata. Det kan eksempelvist være en statisk GeoJSON fil på samme domæne eller fra en ekstern webservice. Hvis data hentes fra en webservice eller en statisk fil på et andet domæne, skal data leveres med JSONP. Elementet "features_dataType" skal i dette tilfælde angives til værdien "jsonp"
features_template string

Her angives en skabelon for, hvorledes JSON fra service skal transformeres til GeoJSON. Attributter fra data kan angives i skabelonen med følgende notation <%= attributnavn %> - læs mere om templates her.

features_infohost string Internetadressen, hvor vektordata kan hentes fra, når der klikkes i kortet. Det kan eksemplevis være en WFS-service eller en anden service, der kan returnere en række ud fra et punkt (x, y). I denne internetadresse vil <%= x %> blive erstattet med x-værdien for det punkt, der søges på. <%= y %> vil blive erstattet med y-værdien for det punkt, der søges på. Derudover erstattes <%= buffer %> af det aktuelle opløsning (resolution) ganget med 3. Dette kan bruges til at finde et objekt uden at skulle ramme præcist. Data skal leveres med JSONP. Det er kun den første række, der bliver vist information for.
features_infohost string/object

Hvis "features_infohost" er en streng, er det en URL til den service, hvor vektordata kan hentes fra, når der klikkes i kortet Når "features_infohost" er en streng, skal servicen returnere GeoJSON. Det kan eksemplevis være en WFS-service eller en anden service, der kan returnere en række ud fra et punkt (x, y). I denne internetadresse vil <%= x %> blive erstattet med x-værdien for det punkt, der søges på. <%= y %> vil blive erstattet med y-værdien for det punkt, der søges på. Derudover erstattes <%= buffer %> af det aktuelle opløsning (resolution) ganget med 3. Dette kan bruges til at finde et objekt uden at skulle ramme præcist. Data skal leveres med JSONP. Det er kun den første række, der bliver vist information for.

Hvis servicen returnere noget andet end GeoJSON (f.eks. ESRIJSON), skal "features_infohost" være et objekt, der indeholder "host" samt "type" i stil med dette:

{
    "host": "//myservice.dk/gis/rest/.../query?...&where=wkt=POINT(%20)",
    "type": "esrijson"
}

Bemærk at "eventtype" skal sættes til "mapclick" (eller ["click", "mapclick"]) for at "features_infohost" kaldes.

features_dataType string Gyldige værdier: "json" eller "jsonp". Hvis data hentes fra en webservice eller en statisk fil på et andet domæne, skal data leveres med JSONP. Se også features_host.
features_callbackparam string callback Hvis servicen leveres med JSONP, men parameteren med navnet på funktionen ikke hedder "callback", angives denne paramtere.
features_type string Typen af geometrier. Gyldige værdier: "Point", "Polygon" eller "Line". Hvis data er multigeometri, bliver det automatisk detekteret. Bemærk at GeometryCollection IKKE er understøttet.
features_geometrycolumn string Hvis servicen leveres med DjangoJSON, ligger geometrien i en navngiven kolonne, der skal angives her for at kunne vise det i kortet.
features_style object

Hvordan skal objekterne styles i kortet. Det er muligt både at angive sti til ikoner, farver og gennemsigtighed, samt hvordan et objekt skal se ud, når det er valgt i kortet

Angiv et array af features_style og gør det muligt at lave avancerede styles, ved at kombibere to styles. Det kan f.eks. beuges til at lave linjer med flere farver eller til at have forskellig markering afhængigt af om objektet er valgt eller ej.

template eller template_[funktionsnavn] string ""

Her angives en html-skabelon for, hvorledes infoboksen skal præsenteres, når brugeren enten klikker eller holder musen over et objekt i kortet. Attributter fra data kan angives i html-skabelonen med følgende notation <%= attributnavn %> - læs mere om templates her.

For at benytte templates til specifikke funktioner, som eksempelvis "Find nærmeste" angives "route" som en del af template-navnet ("template_route"). Tilsvarende for template_table

userfilter object Hvilke objekter skal vises i kortet. Kan benyttes alene eller sammen med filter.
cluster object Vis punkter i kortet som en samling af punkter. Herved er det nemmere at overskue mange punkter for brugeren. Bemærk, at cluster ikke er understøttet i IE8 eller ældre browsere.
heatmap object Vis punkter i kortet som et heatmap. Herved er det nemmere at overskue mange punkter for brugeren. Bemærk, at heatmap ikke er understøttet i IE8 eller ældre browsere.
host string Ved "WMS" eller "WMTS". URL til service
crossOrigin string undefined Hvis der er brug for at få fat i billeder som data, er det nødvendigt at servicen, der levere billederne har CORS header på. Derudover skal crossOrigin sættes til: "crossOrigin": "anonymous". Det er f.eks. i forbindelse med "print" i klienten eller "WEBGL".
layername string Ved "WMS" eller "WMTS". Navnet på laget fra servicen
format string image/png Ved "WMS" eller "WMTS". Formatet af det billede, som servicen skal levere
params object En liste med parametre, der tilføjes til URL'en. Kan kun benyttes til VectorTiles og kan f.eks. bruges til at angive access_token
opacity number 1 Sæt lagets opacity. Kan antage værdier mellem 0.001 og 1. Kan benyttes til billedlag (såsom WMS og WMTS). På vektorlag benyttes features_style
minResolution number Herved kan man styre, hvornår laget skal vises i kortet. Resolution er antallet af meter pr. pixel
maxResolution number Herved kan man styre, hvornår laget skal vises i kortet. Resolution er antallet af meter pr. pixel
singleTile boolean false Ved "WMS". Hent ét billedet i stedet for tiles. Er specielt anvendeligt ved WMS-lag, der indeholder labels eller ikoner
resolutions array Ved "WMTS". Resolutions denne WMTS service leverer i
matrixIds array Ved "WMTS". MatrixIds denne WMTS service leverer
matrixSet array Ved "WMTS". MatrixSet denne WMTS service leverer
relation string/object Det er muligt at angive en relation mellem laget og en eller flere andre lag. Hvis der angives en streng, så refereres der til et andet lag layer_name, der har strengens værdi. Hvis man i stedet angiver et objekt, så er det muligt at angive et match på egenskaber. Herved kan relationen for eksempel være mellem dette lag og alle lag med type="WMS"
delay number 0 Features tilføjes til kortet med en forsinkelse angivet i milisekunder
featureDelay number/string 0 De enkelte features tilføjes til kortet med en individuel forsinkelse i millisekunder. Herved bliver de synlige én ad gangen. Værdien kan angives som millisekunder eller som en template. Læs mere om templates generelt her
animate object Tilføj features til kortet med en animation. Det kunne være, at linjer tegnes som en rute i kortet
lazyload boolean false Hent først vektordata når laget vises i kortet. Kræver at visible er sat til false, så laget ikke er vist fra start.
reloadInterval number Genindlæs data med et fast interval. Intervallet angives i milisekunder og kan f.eks. bruges til at vise "live" data på kortet.
paramNames object

Det er muligt at angive en eller flere nøgler, der skal bruges til at kalde den service, man bruger, med. Det kan bruges til kun at vise bestemte features i kortet eller bestemte lag:

"paramNames": {
    "key": "planid"
}

Herved kigges der først på om URL-parameteren planid er angivet. Hvis ikke, kigges der efter data-widget-planid på div-elementet.

Værdien benyttes til at estatte teksten <%= key %>, der eventuelt er angivet i host eller features_host. Det er også muligt at bruge de andre muligheder, der er med templates. Læs mere om templates generelt her

Style (features_style)

Styling af objekter i kortet.

Det er muligt at anvende værdien fra en kolonne i data til at styre de enkelte style-egenskaber. Det gøres ved at indsætte <%= KOLONNENAVN %> i stedet for en style. Det kunne eksempelvis gøres på denne måde:

"icon": "http://www.septima.dk/widget/img/icon_<%=type%>.png"

eller

"strokecolor": "<%=farvekolonne%>"

Når man angiver sin style, har man ud over værdierne fra kolonnerne, også adgang til geometritypen via <%= _geometryType %> samt oplysninger om det aktuelle kort. Kortets oplysninger findes f.eks. med <%= _currentMap.resolution %>, men der er også adgang _currentMap.center, der er et array og _currentMap.zoom. Det kan f.eks. bruges til:

"strokewidth": "<% if(_currentMap.resolution > 10) { print(1) } else { print(4) } %>"

Læs mere om templates her.

Hver af de nedenstående style-egenskaber har en tilsvarende egenskab med suffix "_selected". Disse angiver, hvordan style skal være for et valgt objekt i kortet. Det valgte objektikon bestemmes således af egenskaben "icon_selected".

Name type default description
namedstyle string

Der findes en række forskellige foruddefinerede styles, der kan benyttes. Lige nu findes der #001, #002, ... , #010 samt #011

Der er muligt at overstyre enkelte parametre ved blot også at tilføje de parametre, der ønskes overstyret

icon string Sti til ikon (gælder for punktdata). Stien kan være relativ i forholde til den side, hvor kortet er, eller absolut
imgSize array Benyttes KUN i forbindelse med SVG ikoner. Angiv den originale størrelsen på SVG ikoner med f.eks. [65,73] hvis ikonet er 65 pixel bredt og 73 pixel højt. Det virker fint uden i alle browsere, med undtagelse af IE.
symbol string none Brug et symbol i stedet for et ikon. Lige nu findes der følgende symboler: circle, square, triangle, star, cross og x.
fillcolor string #FFFFFF Udfyldningsfarve for flader
fillopacity number 0 Udfyldningsgraden for flader. 0 betyder gennemsigtig, 1 betyder helt udfyldt. Med fillopacity = 0 kan man benytte WMS eller WMTS til styling, mens vektordata benyttes til at give brugeren en oplevelse af interaktion
strokecolor string #FFFFFF Udfyldningsfarve for linier og outline på flader
strokeopacity number 0 Udfyldningsgraden for linier og outline på flader. 0 betyder gennemsigtig, 1 betyder helt udfyldt. Med strokeopacity = 0 kan man benytte WMS eller WMTS til styling, mens vektordata benyttes til at give brugeren en oplevelse af interaktion
strokewidth number 1 Breden på linier og outline på flader.
rotation number 0 Rotér symbol eller ikon.
xOffset number 0.5 Forskyd et ikon i x-retningen. Kan antage værdier mellem 0 og 1, hvor 0 er ved ikonets venstre kant, mens 1 er ved ikonets højre kant. Det betyder, at 0.5 er i midten af ikonet.
yOffset number 0 Forskyd et ikon i y-retningen. Angivet i et antal pixels ikonet skal forskydes i y-retningen, hvor 0 er ved ikonets nederste kant. Kan antage både positive og negative værdier.
radius number 10 Størrelsen på et symbol. Anvendes kun, når symbol er angives.
radius2 number 5 Anvendes kun, når symbol er star eller cross.
text string Vis en label på hvert objekt i kortet. Brug for eksempel <%= navn %> til at vise teksten for feltet "navn". Læs mere om templates her.
textAlign string center Placeringen af label. Brug værdierne "center", "end", "left", "right" eller "start"
textBaseline string middle Placeringen af label. Brug værdierne "alphabetic", "bottom", "hanging", "ideographic", "middle" eller "top"
textFont string normal 10px Verdana Angiv "normal" eller "bold", teksten størrelse samt fonttype.
textFillcolor string #333333 Tekstens farve.
textOutlinecolor string #fff Tekstens baggrundsfarve/outlinefarve
textOutlinewidth number 3 Tekstens outline bredde.
textXOffset number 0 Forskydning af teksten i X-retningen.
textYOffset number 0 Forskydning af teksten i Y-retningen.
textRotation number 0 Tekstens rotation angivet i radianer (0.785398164 = 45 grader).
textMinResolution number Herved kan man styre, hvornår labelen skal vises i kortet. Resolution er antallet af meter pr. pixel
textMaxResolution number Herved kan man styre, hvornår labelen skal vises i kortet. Resolution er antallet af meter pr. pixel
textExceedLength boolean false Skal teksten fylde mere end den underliggende geometri (gælder kun for polygoner)?
jsonUrl string En URL til en JSON-fil, der indeholder style til laget. Kan kun benyttes til VectorTiles og kan f.eks. bruges til at få stylen fra en JSON konfiguration
source string composite Navnet på den "source" fra JSON-filen, der definere stylen. Kan kun benyttes sammen med jsonUrl i forbindelse med VectorTiles
geometryOptions objekt

Det er muligt at få tegnet en alternativ geometri i kortet. Det kan være startpunkt, slutpunktet eller alle knudepunkter for en linje/polygon, centroide eller interior point for en polygon, geometriens convex hull eller envelope eller tilføje en buffer til geometrien.

geometryOptions angives hvilken type man vil vælge. Mulige værdier for type er: interiorPoint, centroide, lastPoint, firstPoint, vertices, envelope, convexHull, buffer og wkt. Eksempel:

"geometryOptions": {
    "type": "interiorPoint"
}

Ved buffer angives en ekstra parameter, der definere hvilken buffer, der skal tilføjes. buffer kan angives som et tal eller som en template, der kan bruge oplysningerne fra data:

"geometryOptions": {
    "type": "buffer",
    "buffer": 27
}

Ved wkt angives en ekstra parameter, der definere hvilken wkt, der skal bruges som geometri. wkt kan angives som en fuld tekststreng eller som en template, der kan bruge oplysningerne fra data:

"geometryOptions": {
    "type": "wkt",
    "wkt": "POINT(550800 6293000)"
}

Bemærk Hvis der er mange data, kan disse operationer med fordel gøres på den server, der levere data, ellers er der risiko for at det kan gå langsomt at tegne kortet.

Filter (userfilter)

Styring af hvilke objekter, der vises i kortet.

Herunder er et eksempel på inholdet af userfilter. Man angiver navnet på kolonnen samt hvilke egenskaber, der skal knyttes til dette filter. Der findes følgende typer: range, daterange, boolean, text, selectlist og multiselect. I eksemplet er der angivet to kolonner; "antal" og "belægning". For kolonnen "antal" vises kun objekter, der har værdier mellem 0 og 50 (begge inklusive). For kolonnen "belægning" vises kun de objekter, der har værdier under 100. Begge ranges skal opfyldes for at objektet vises.

{
    "antal": {
        "type": "range",
        "min": 0,
        "max": 50,
        "limit": [0,110],
        "template": "Antal børn: <%= min %>-<%= max %> børn"
        "label": "Antal børn:",
        "unit": " børn"
    },
    "belægning": {
        "max": 100,
    }
}

Herunder findes en beskrivelse af de enkelte egenskaber, et enkelt userfilter kan have.

Name type default description
type string range Hvilken type filter er det. Angiv "range", "boolean", "selectlist", "text", "daterange" eller "multiselect"
label string Benyttes blandt andet af filter funktionen til at vise en overskrift eller teksten på en boolean knap
template string

Ved type:"range": Benyttes af filter funktionen til at vise det valgte interval. Herved er det muligt at lave et beregnet felt afhændigt af det valgte. Det kunne være at man gerne vil vise navnet på måneden i stedet for tallet. Læs mere om templates generelt her

Bemærk at hvis template angives, benyttes label og unit ikke.

min number/string

Ved type:"range" og type:"daterange": Den værdi som kolonnen mindst skal have. Ved type:"daterange" er det en dato i samme format som angivet i "format". Alternativt kan syntaksen "today", der så er dags dato. Det er muligt at angive "today-3d" for at vælge tre dage før i dag. Eller "today+1M" for en måned fra i dag eller "today+2y" for om to år.

max number/string

Ved type:"range" og type:"daterange": Den værdi som kolonnen højst skal have. Ved type:"daterange" er det en dato i samme format som angivet i "format". Alternativt kan syntaksen "today", der så er dags dato. Det er muligt at angive "today-3d" for at vælge tre dage før i dag. Eller "today+1M" for en måned fra i dag eller "today+2y" for om to år.

startDate string

Ved type:"daterange": Den dato, der tidligst kan vælges. En dato i samme format som angivet i "format". Alternativt kan syntaksen "today", der så er dags dato. Det er muligt at angive "today-3d" for at vælge tre dage før i dag. Eller "today+1M" for en måned fra i dag eller "today+2y" for om to år.

endDate string

Ved og type:"daterange": Den dato, der senest kan vælges. En dato i samme format som angivet i "format". Alternativt kan syntaksen "today", der så er dags dato. Det er muligt at angive "today-3d" for at vælge tre dage før i dag. Eller "today+1M" for en måned fra i dag eller "today+2y" for om to år.

limit array Ved type:"range": Benyttes blandt andet af filter funktionen til at angive, hvad udfaldsrummet maksimalt kan have
unit string Ved type:"range": Benyttes blandt andet af filter funktionen til at vise det aktuelle valg med en enhed
sliderType string double Ved type:"range": Brug single hvis man ønsker at have en slider med kun én værdi. Bemærk at min og max skal sættes til samme værdi for at få kortet til at vise det, der er valgt i slideren.
values array Ved type:"multiselect" og type:"selectlist": Hvilken værdier fra denne kolonne skal en feature have for at blive vist i kortet. Ved type:"text": En liste af værdier, der skal filtreres på fra starten
buttontype check Ved type:"selectlist": Skal listen fungere som checkbuttons eller radiobuttons. Ved "buttontype":"check" kan flere værdier fra listen være valgt på én gang. Ved "buttontype":"radio" kan kun én af værdierne i listen være valgt.
allDefaultSelected boolean Ved type:"multiselect": Alle værdier valgt fra starten. Et alternativ til at angive alle eksplicit
value boolean Ved type:"boolean": Skal de features, der overholder de bolske udtryk, vises
eq boolean, number, string Ved type:"boolean": Værdien som en feature skal have for, at den er true
regexp string Ved type:"boolean": Et regulært udtryk som en feature skal matche for, at den er true
regexpTrue string .* Ved type:"boolean": Et regulært udtryk som en feature skal matche for, at den er true. Herved er det muligt, at "true" og "false" ikke er komplementære. Benyttes sammen med "regexpFalse".
regexpFalse string .* Ved type:"boolean": Et regulært udtryk som en feature skal matche for, at den er false. Herved er det muligt, at "true" og "false" ikke er komplementære. Benyttes sammen med "regexpTrue".
format string "DD.MM.YYYY" Ved type:"daterange": Den måde hvorpå datoen vises, når den er valgt.
urlParamNames object Ved type:"daterange": URL-parametre, der indeholder startværdier for henholdsvis min- og max-værdierne. Angiv eksempelvis {"min": "startdato","max": "slutdato"}. Herved er det muligt at kalde siden med &startdato=16.12.2015&slutdato=18.12.2015 hvor de to værdier bliver indsat som min og max. Bemærk, at formatet på datoen er det format, der er angivet under format.

Animation (animate)

Styring af hvordan objekter, der tilføjes i kortet.

{
    "type": "route",
    "duration": 2000
}

Herunder findes en beskrivelse af de enkelte egenskaber, et enkelt animation kan have.

Name type default description
type string Hvilken type animation er det. Angiv "route"
duration number/string Hvor lang tid skal det tage, før featuren er tegnet i kortet. Værdien kan angives som millisekunder eller som en template. Læs mere om templates generelt her

Cluster

Samling af punkter i kortet. Herunder findes en beskrivelse af de enkelte egenskaber, der kan sættes på et cluster. Hvis ingen egenskaber er angivet, vil default-værdier blive brugt. Det er altså ikke nødvendigt at gøre noget. Bemærk, at cluster ikke er understøttet i IE8 eller ældre browsere.

Name type default description
distance number 40 Afstanden mellem punkter, der skal samles
spiral object

Når der klikkes på et cluster, vil de underliggende punkter blive spredt ud som en spiral fra centrum af clusteret. Det er muligt at angive sølgende parametre til spiralen:

"spiral": {
    "pxArc": 35,
    "pxSep": 35
}

hvor pxArc er antallet af pixels, der skal være mellem to punkter, der ligger ved siden af hinanden i spiralen, mens pxSep er antallet af pixels mellem to rækker i spiralen.

features_style object fillcolor:'rgba(43,107,181,0.6)' Hvordan skal cluster punkterne markeres i kortet. Kun fillcolor er supporteret pt. Specielt for cluster er det også muligt at angive en radius. Default er radius dynamisk afhængig af antallet af punkter. Men det er muligt at angive en specifik radius her.
minResolution number 0 Hvor langt skal der zoomes ind, før et cluster vises som punkter i stedet for cluster. Dette tal angives som antallet af meter, hver pixel er i dette zoomniveau.

Heatmap

Samling af punkter i kortet. Herunder findes en beskrivelse af de enkelte egenskaber, der kan sættes på et heatmap. Hvis ingen egenskaber er angivet, vil default-værdier blive brugt. Det er altså ikke nødvendigt at gøre noget. Bemærk, at heatmap ikke er understøttet i IE8 eller ældre browsere.

Name type default description
radius number 5 Afstanden mellem punkter, der skal samles

Data (data)

Elementet "data" definerer et kommunikations lag som erstatning for for eksempel et map. Herved er det muligt at få adgang til data uden at få vist et kort. Indholdet er defineret som lag på samme måde som på map. Bemærk, at kun vektorlag bliver anvendt

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig fjerne en kontrol.
css string/array Angiv en sti til en css-fil, der skal loades efter komponenten. Herved vil det være muligt at lave en brugertilpasset style af elementerne. Ved at angive et array af stier eller en liste adskilt af et komma, er det muligt at loade flere filer.
layer array En liste af lag, hvor data skal hentes fra. Læs mere under Lag.

Funktioner (controls)

Angiver et array af "controls" på kortet. En "control" kan være en adressesøgeboks eller en find nærmeste boks. Navnet på den enkelte "control" er angivet i parentes ud for hver overskrift

Informationsvisning (info)

Kontrol, der styrer, om der skal være info på data, og om det skal vises, når musen føres over data eller ved at klikke på data

minResolution: Hvilken opløsning der skal zoomes til. Tallet er antallet af meter pr. pixel.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
eventtype string/array Typen af interaktionen. Gyldige værdier: "hover", "click" eller "mapclick". Ved "mapclick", søges der også via en service, hvis der er angivet en "features_infohost" på laget.
type string cloud Hvordan skal info vises. Gyldige værdier: "popup" og "cloud".
autoPan boolean true Kan benyttes ved "type": "cloud". Skal kortet automatisk panorere så infoboksen er inden for kortets udsnit?
multifeature integer 1 Hvis der ligger flere vektorfeatures i samme punkt, er det som default kun den øverste features, der rammes. Ved at angive "multifeature", er det muligt at bestemme hvor mange features, der skal vises info på. Hvis der er flere features, listes de over hinanden i infoboksen. Det er en god idé at begrænse antallet ved at sætte denne parameter til eksempelvis 5. Herved er det kun de 5 øverste features, der vises information for.
offset array [0,0] Kan benyttes ved "type": "cloud". Hvordan skal infoboksen placeres i forhold til den feature, man har klikket på. Default [0,0] er lidt over featuren. Det første tal er i x-aksens retning, mens det andet tal er i y-aksens retning.
service object/array Et objekt, der indeholder "url" og "type" med henholdsvis url'en, der skal kaldes ved "mapclick", og hvilken type servicen er. Typen kan pt være "spatialsuite", men på sigt kunne det være andet såsom "WFS".
zoomOptions 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.

"zoomOptions": {
    "zoomStyle": "slow",
    "minResolution": 0.8
}

zoomStyle: Ved none vises kortet blot. Ved slow zoomes der langsomt hen til objektet (ca. 2 sekunder), fast zoomer hurtigt (ca. 1 sekund), mens faster zoomer meget hurtigt (ca 0,5 sekunder).

Listevisning (table)

Få vist data i en liste. Stylen fra objektet bruges til markeringen i kortet.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
detach 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 tlfø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.
showheader boolean false Skal der vises en overskrift for listen. Hvis der er flere lister, kommer der en overskrift for hver liste.
zoomOnClick boolean true Skal der zoomes i kortet, når man klikker i listen (kun aktuel, når kortet er vist).
mapFilter boolean false Skal listen kun vise de features, der er synlige i kortet (kun aktuel, når kortet er vist).
scroolToMap boolean false Når man klikke på et element i listen, så scrolles der til kortet, så man kan se, hvad der er klikket på. Dette er specielt anvendeligt, når listen ligger under eller over kortet.
zoomOptions object

Det er muligt at angive, hvordan der skal zoomes til objektet i kortet.

"zoomOptions": {
    "zoomStyle": "none",
    "minResolution": 0.8
}

Hvad, der skal søges i

Opsætningen til hver enkelt søgning

Name type default description
type string Søg i adresser (address), CVR (cvr), Plansystem (plan), S4 index (s4), GeoSearch fra Kortforsyningen (geosearch) eller i objekter i kortet (local)
minResolution number 3.2 Hvor langt skal der maksimalt zoomes ind til. Dette tal angives som antallet af meter, hver pixel er i dette zoomniveau.
options object

Afhængig af hvad der søges i, skal der angives en række parametre:

Til "type":"dawa" angives de parametre, som er angivet i dokumentationen på https://dawa.aws.dk/autocompletedok

Til "type":"address" angives de parametre, som er angivet i dokumentationen på https://www.kortforsyningen.dk/indhold/geonoegler-geosearch

Til "type":"geosearch" kan der angives parameteren "area" på samme måde som i "address". Derudover kan der angives "targets", der er et array af, hvad der skal søges i:

"targets": ["adresser","matrikelnumre","stednavne"]
Den fulde liste af targets kan ses på Kortforsyningens hjemmeside

Til "type":"local" angives parametrene "singular", "plural", "displaynameProperty" samt "descriptionProperty"

Til "type":"s4" angives parametrene "host", samt "datasources"

Til "type":"cvr" kan der angives parameteren "filter" på denne måde:

"filter": { "komnr" : "101" }

Til "type":"plan" kan der angives parameteren "filter" på denne måde:

"filter": { "kom_id_officiel" : "101" }

Til "type":"arcgis" angives parametrene "catalogUrl" samt "serviceName"

crs string EPSG:25832 Servicens koordinatreferencesystem defineret i EPSG, eksempelvis: EPSG:25832
geometryProxy object

Brug det fundet objekt (adresse) til at finde den geometri, der rent faktisk skal benyttes til f.eks. at markere i kortet. Både geometrien fra det fundet objekt samt oplysnignerne fra objektet, kan bruges i forbindelse med "host".

"geometryProxy" skal være et objekt, der indeholder "host" samt "type" i stil med dette:

"geometryProxy": {
    "host": "//myservice.dk/gis/rest/.../query?...&where=wkt=POINT(%20)",
    "type": "esrijson"
}
Vigtigt! Hvis du vil søge i lokale data, men bruge templates og styles fra data i stedet for at angive dem under søgefunktionen, er det muligt. Tilføj blot template_search_title og template_search_description til laget samt fjern "displaynameProperty" fra konfigurationen til funktionen.

Find nærmeste (route)

Beregn ruter mellem for eksempel en adresse og punkter i kortet. De nærmeste vises i en liste, og det er muligt at få vist ruten i kortet.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
apikey string En apinøgle, som er gyldig til Septimas rutewebservice
profile string 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.
profileselect objekt

Giver brugeren mulighed for at skifte mellem forskelige ruteprofiler

"profileselect": [
    {"name": "Bil", "value": "car", "icon": "car"},
    {"name": "Cykel", "value": "bicycle", "icon": "bike"},
    {"name": "Gang", "value": "foot", "icon": "walk"},
    {"name": "Bus", "value": "bus", "icon": "bus"}
]
limit integer 3 Antallet af nærmeste, der skal vises i listen
template string Angiver den html-template, der anvendes til at præsentere 'find nærmeste' resultater. Hvis ikke angivet, så vises listen uden overskrift og formatering. Med template kan man styre det, der ligger uden om listen. Det kunne være en overskrift samt en forklarende tekst. Læs mere om templates generelt her. For denne template er der to tilgængelige attributter; <%= title %> og <%= ontent %>, 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
zoomOptions object

Det er muligt at angive, hvordan der skal zoomes til objektet i kortet.

"zoomOptions": {
    "zoomStyle": "none",
    "minResolution": 0.8
}
prioritizeWithinGeometry object

Brug den valgte geometri til at finde én polygon med via en service. Alle punkter inden for denne polygon, bliver prioriteret højere end andre, og vises øverst i listen.

"prioritizeWithinGeometry" skal være et objekt, der indeholder "host" samt "type" i stil med dette:

"prioritizeWithinGeometry": {
    "host": "//myservice.dk/gis/rest/.../query?...&where=wkt=POINT(%20)",
    "type": "esrijson"
}

Rute (routing)

Beregn ruter mellem to punkter i kortet. Det er muligt at klikke i kortet eller søge et punkt via søgefeltet.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
apikey string En apinøgle, som er gyldig til Septimas rutewebservice
subheader 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 <%= ontent %>, 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 string 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.
profileselect objekt

Giver brugeren mulighed for at skifte mellem forskelige ruteprofiler

"profileselect": [
    {"name": "Bil", "value": "car", "icon": "car"},
    {"name": "Cykel", "value": "bicycle", "icon": "bike"},
    {"name": "Gang", "value": "foot", "icon": "walk"},
    {"name": "Bus", "value": "bus", "icon": "bus"}
]
limit integer Antallet af destinationer, der skal vises i listen
zoomOptions object

Det er muligt at angive, hvordan der skal zoomes til objektet i kortet.

"zoomOptions": {
    "zoomStyle": "none",
    "minResolution": 0.8
}

Konfliktsøgning (conflict)

Foretag en konfliktsøgning på for eksempel en adresse. Konfliktsøgnigen sker ved, at der kaldes en service, der returnerer resultatet. Resultatet vises i en liste.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
template string Angiver den html-template, der anvendes til at præsentere 'find nærmeste' resultater. Hvis ikke angivet, så vises listen uden overskrift og formatering. Med template kan man styre det, der ligger uden om listen. Det kunne være en overskrift samt en forklarende tekst. Læs mere om templates generelt her. For denne template er der to tilgængelige attributter; <%= title %> og <%= ontent %>, 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
target array Angiver en liste af services, der skal kaldes.
highlight boolean false Skal det fundne markeres i kortet? Dette er specielt hensigtsmæssigt, når eventtype er "mapclick", men kan også bruges i andre situationer. Denne mulighed er ikke optimal, når der bruges flere targets.
features_style object Bruges kun, når "highlight" er sat til true. Her er det muligt at angive, hvordan markeringen skal styles i kortet.
eventtype string/array featureadded Typen af interaktionen. Gyldige værdier: "featureadded", "click" eller "mapclick". Ved "featureadded" aktiveres konfliktsøgningen, når andre funktioner tilføjer noget til kortet. Det kan for eksempel være søgefunktionen. Ved "click" aktiveres konfliktsøgningen, når der klikkes på en vektorfeature i kortet. Ved "mapclick" bruges aktiveres konfliktsøgningen, når brugeren klikket et sted i kortet.
simplifyInputToPoint boolean false Når der søges, bruges en geometri som input. Nogle services har en begrænsning på, hvordan de kan kaldes. Det kan for eksempel være, at URL'en kan blive for lang, hvis den geometri, der søges med, er stor. Derfor er det muligt at angive "simplifyInputToPoint", der gør, at inputgeometrien konverteres til et punkt, inden det sendes afsted til servicen.

Hvad, der skal søges i

Opsætningen til hver enkelt søgning

Name type default description
type string

Elementet 'type' angiver typen af servicen. Gyldige værdier: spatialsuite, geojson, djangojson og esrijson. Derudover er det muligt at have værdien text, der blot sætter værdien af "template" ind. Dette kan f.eks. bruges til at indsætte en fast overskrift eller et "Læs mere" link.

url string

En URL til den service, der skal kaldes. I URL'en vil <%= wkt %> blive erstattet med en WKT-streng for det, der laves konfliktsøgning med. Tilsvarende vil <%= x %> og <%= y %> blive erstattet med centroiden for objektet.

Mulige paramtre er: <%= wkt %>, <%= x %>, <%= y %>, <%= buffer %>, <%= minx %>, <%= maxx %>, <%= miny %> og <%= maxy %>

template string ""

Her angives en html-skabelon for, hvorledes en eventuel tilhørende tekst skal præsenteres. Attributter fra data kan angives i html-skabelonen med følgende notation <%= attributnavn %> - Læs mere om templates her.

nohitmessage string Den viste tekst, der vises, hvis servicen returnerer en tom liste
errormessage string Den viste tekst, der vises, hvis servicen fejler

Kommuneplan (kommuneplan)

Hent oplysninger om en kpmmuneplanramme direkte fra Plansystem.dk og få vist både tekst og kort.

For at benytte denne kontrol skal der på div-elementet tilføjes en attribut, der fortæller hvilket planid, der ønskes vist. Angiv div-elementet på denne måde: <div data-widget="..." data-widget-key="2277350"></div>, hvor data-widget-key indeholder planid.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
detach 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 tlfø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.
filter string Angiv et alternativt CQL filter, der benyttes til at hente den enkelte kommuneplanramme. Default filter er: planid=<%= key %>, hvor <%= key %> bliver erstattet af det valgte planid
layer string Navnet på laget, der indeholder kommuneplanrammen. Default er theme_pdk_kommuneplanramme_vedtaget_v
key string Alternativ måde at angive hvilken kommuneplanramme, der skal vises. Angiv et planid her, og det vil blive benyttet, hvis der ikke er angivet data-widget-key på på div-elementet
features_style object Hvordan skal objekterne styles i kortet, når de er fundet
urlParamNames object

Det er altid muligt at angive hvilken kommuneplanramme, der skal vises, ved at kalde med URL-parameteren widget-key med planid som værdi. Hvis URL-parameteren skal hedde noget andet, er det muligt at angive det i konfigurationen via urlParamNames. På denne egenskab kan man angive hvilken URL-parameter, der skal benyttes i stedet for widget-key:

"urlParamNames": {
    "key": "planid",
    "layer": "kommuneplanlag"
}

Hvis parameteren ikke findes, benyttes værdien fra data-widget-key på på div-elementet eller key i konfigurationen.

På samme måde er det muligt at angive hvilket lag fra Plansystem, der skal hentes data fra. Dette gøres tilsvarende med widget-layer.

Hvis parameteren ikke findes, benyttes værdien fra data-widget-layer på på div-elementet

Lagvælger (layerswitch)

Kontrol, der gør at brugeren kan tænde og slukke for de enkelte lag. Derudover vises signaturen for vektorlagene

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
layers string/array Angiv, hvad der skal vises i lagvælgeren. Ved at angive "all" vises alle lag. Ved at angive "vectors" vises kun vektorlagene. Ved at angive "images" vises billedlagene (WMS og WMTS). Derudover er det muligt at angive et array af id'er på udvalgte lag. Dette kræver, at der er angivet et id på lagene. For at få vist to specifikke lag angives det på denne måde: ["lag1","lag2"].
excludeLayers array Fravælg hvilke lag, der ikke skal vises i lagvælgeren. Det muligt at angive et array af id'er på udvalgte lag, der ikke skal vises. Dette kræver, at der er angivet et id på lagene. For at ekskludere to specifikke lag angives det på denne måde: ["lag1","lag2"]. Dette er specielt hensigtmæssigt, hvis layers er sat til all.
showbuttons boolean true Ved at sætte "showbuttons": false deaktiveres muligheden for at tænde og slukke for lagene.
showlegend boolean true Ved at sætte "showlegend": false vises signaturen ikke for lagene.
selectAll boolean false Ved at sætte "selectAll": true vises der en knap, der gør det muligt at tænde/slukke for alle lag i lagkontrollen på en gang.
type string list Angiver, hvordan lagvælgeren skal vises. Gyldige værdier: "list" eller "dropdown". Ved list bliver lagvælgeren vist som en liste, hvor man kan klikke på de enkelte rækker i listen og herved vise/skjule det pågældende lag. Ved dropdown er listen skjult, og brugeren kan trykke på en "knap" for at få vist listen.
expand string up Ved "type": "dropdown". Skal dropdown folde op eller ned. Gyldige værdier: "up" eller "down".
dropdownlimit number 3 Ved "type": "dropdown". Hvor mange lag må der højst blive vist, før der kun vises, hvor mange der er.
dropdowntext string Ved "type": "dropdown". Angiv en statisk tekst i dropdown menuen. Hvis "dropdowntext" ikke er angivet, vises der en tekst, der er afhængig af hvor mange lag, der er valgt.
activateButton object

Skjul lagvælgeren fra start men gør det muligt for brugeren vise lagvælgeren vha. en knap i kortet. "activateButton" kan indeholde "title", "className" og "html", der alle er optionelle. De har alle en brugbar default værdi. "title" bruges til at angive en tekst, der vises når musen holdes over knappen. "className" tilføjer en CSS-klasse til selve knappen. "html" erstatter indholdet af kanppen med det, der er angivet her. På denne måde er det muligt f.eks. at skifte ikon på knappen. Her er et eksemple på hvordan "activateButton" kan angives:

"activateButton": {
    "title": "Vis signaturforklaring",
    "className": "my-style",
    "html": ""
}
layerOrder boolean false Brug rækkefølgen i layers i lagvælgeren og ikke den rækkefølge, som lagene i kortet har.
groups array

Opret grupper i lagvælgeren. Konfigurationen er en liste (array) af objekter, der hver definere title, type, expanded og layers. Der er dermed muligt at vælge ud hvilke lag, der skal være i hver gruppe. Her er et eksemple på hvordan groups kan angives:

"groups": [
    {
        "title": "Baggrundskort",
        "type": "radio",
        "expanded": false,
        "layers": ["lag1","ortofoto"]
    },
    {
        "title": "Børn og unge",
        "type": "check",
        "expanded": true,
        "layers": ["kommunegraense","skoledistrikter","boernehaver","skoler"]
    }
]

Med denne opsætning lagene med id "lag1" og "ortofoto" blive vist i den første gruppe mens de fire andre lag vil blive vist i den anden gruppe. Den første gruppe vil være klappet sammen fra start, mens den anden gruppe vil være foldet ud. Den første gruppe har typen "radio", hvilket betyder at et klik på et lag i denne gruppe, medfører at de andre lag slukkes.

Bemærk For at få vist signaturen for vektorlag, skal laget indeholder features_type. Se hvilke typer det kan være under layer

Skift mellem baggrundskort (layertoggle)

Knap, der gør, at brugeren kan skifte (toggle) mellem forskellige baggrundskort, der er angivet i konfigurationen. For at et lag kommer med i denne knap, skal der på laget tilføjes en ekstra parameter, der hedder "icon": "url/til/billede/ikon.png". Bemærk: Sæt alle lag, der ikke skal vises fra starten til "visible": false.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
layers array all Vælg hvilke lag, der skal vises i lagvælgeren. Det muligt at angive et array af id'er på udvalgte lag, der skal vises. Dette kræver, at der er angivet et id på lagene. For at vælge to specifikke lag angives det på denne måde: ["lag1","lag2"]. Som default vises alle lag, der har et id samt et icon.
excludeLayers array Fravælg hvilke lag, der ikke skal vises i lagvælgeren. Det muligt at angive et array af id'er på udvalgte lag, der ikke skal vises. Dette kræver, at der er angivet et id på lagene. For at ekskludere to specifikke lag angives det på denne måde: ["lag1","lag2"]. Som default vises alle lag, der har et icon.

Aktuelle position (location)

Zoomer hen til brugerens aktuelle position, når kortet vises. Hvis denne kontrol anvendes sammen med eksempelvis konfliktsøgning eller rute, så benyttes den aktuelle position som indgangspunkt til de funktioner.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
zoom number Angiver hvor langt, der skal zoomes ind i kortet. Jo lavere tal, der angives, jo længere ud kan brugeren zoome. Den lavest mulige værdi er "0".
resolution number Angiver hvor langt, der skal zoomes ind i kortet (alternativ til zoom). Hvilken opløsning der skal zoomes til. Tallet er antallet af meter pr. pixel.
features_style object Hvordan skal objekterne styles i kortet, når de er fundet
onStart boolean true Skal der zoomes ind til aktuelle position ved opstart af kort.
onClick boolean false Skal der tilføjes en knap, der giver brugeren mulighed for at zoomes ind til aktuelle position, når det passer ham.
className string Bruges sammen med "onClick" til at styre hvilket ikon, der skal vises på knappen.
Bemærk De fleste nye browsere har en begrænsning, der gør at de kun tillader brugerens aktuelle position, hvis sitet benytter HTTPS. Derfor vil denne funktion ofte ikke virker, med mindre dette er tilfældet.

Filter (filter)

Vis en eller flere slidere, der kan filtrere hvilke data, der vises i kortet. Filter kontrollen benyttes sammen med userfilter på et vektorlag.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
combine boolean false Hvis to datasæt filtreres på samme kolonnenavn, så vil det første lag styre præsentationen af slideren, men brugerens ændring på slideren vil medføre filter på alle lag, der har et userfilter med samme navn.
hideOnLayerChange boolean false Skjul filteret hvis laget slukkes.

Zoom til (locate)

Få kortet til automatisk at vise et bestemt objekt i kortet. Det kan for eksempel bruges i forbindelse med visning af et kort for et bestemt område på en hjemmeside.

For at benytte denne kontrol kan der på div-elementet tilføjes en attribut, der fortæller hvilken nøgle, der skal benyttes for at hente de ønskede objekter, der ønskes vist i kortet. Angiv div-elementet på denne måde: <div data-widget="..." data-widget-key="2277350"></div> hvor data-widget-key indeholder nøglen. Dette foregår på samme måde som for kommuneplan funktionen.

Det er ligeledes muligt at angive URL-parameteren widget-key med nøglen (for eksempel widget-key=2277350)

minResolution: Hvilken opløsning der skal zoomes til. Tallet er antallet af meter pr. pixel.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
host string Angiver den URL, der skal benyttes til at finde et eller flere objekter. I URL'en er det muligt at angive en template, hvor man for eksempel skriver <%= key %>, der substitueres de af værdier fra parameteren key.
type string geojson Hvilket format kommer data i. Kan antage en af følgende værdier: "geojson", "esrijson", "djangojson", "datasourcejson" samt "local". Ved "local" søges der i de features, der allerede er tilføjet til kortet.
dataType string jsonp Hvordan returneres data. Kan antage en af følgende værdier: "jsonp" og "json". Brug "json", hvis servicen ligger på samme domæne eller leveres med CORS-header.
paramNames object

Det er muligt at angive en række parametre til den URL, der er angivet i host. I dette eksempel kan man enten kalde siden med denne widget med URL-parameteren =?planid=1234. Alternativt kan man på DIV elementet angive attributten data-widget-planid="1234":

"paramNames": {
    "key": "planid"
}
template string ""

Her angives en html-skabelon for, hvorledes en eventuel tilhørende tekst skal præsenteres. Attributter fra data kan angives i html-skabelonen med følgende notation <%= attributnavn %> - Læs mere om templates her.

zoomOptions object

Det er muligt at angive, hvordan der skal zoomes til objektet i kortet.

"zoomOptions": {
    "zoomStyle": "none",
    "minResolution": 0.8
}

zoomStyle: Ved none vises kortet blot. Ved slow zoomes der langsomt hen til objektet (ca. 2 sekunder), fast zoomer hurtigt (ca. 1 sekund), mens faster zoomer meget hurtigt (ca 0,5 sekunder).

features_style object Hvordan skal objekterne styles i kortet, når de er fundet

Vis kort i fullscreen (fullscreen)

Få kortet vist, så det fylder hele skrærmen. Kun elementer, der er inden for kortet, vil blive vist. Det vil sige, at infoboksen, søgefelt og lignende vises som normalt, mens for eksempel listevisning ikke bliver vist.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.

Aktivér kort (overlay)

Skal brugeren aktivere kortet inden brug? Dette er specielt hensigtsmæssigt i forbindelse med scroll på mobile enhender, men også når brugeren scroller med musehjulet. Her vil denne funktion forhindre, at der hovedløst zoomes eller panoreres i kortet.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.

Zoom til startudsnit (fullextent)

Knap, der gør, at brugeren kan zoome til startudsnittet for kortet.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.

Zoom til data (zoomtolayer)

Når kortet startes, zoomes der til et kortudsnit, der omkranser de viste data.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
zoomStyle string slow Angiver, hvordan der skal zoomes ind. Ved none vises kortet blot. Ved slow zoomes der langsomt hen til objektet (ca. 2 sekunder), fast zoomer hurtigt (ca. 1 sekund), mens faster zoomer meget hurtigt (ca 0,5 sekunder).
buffer number 1.2 Angiver, hvor meget luft der mindst skal være omkring de features, der zoomes til. Buffer angives som et forhold, det vil sige, at 1.2 lægger 20% til, mens 1.5 lægger 50% til.
minResolution number 3.2 Hvor langt skal der maksimalt zoomes ind til. Dette tal angives som antallet af meter, hver pixel er i dette zoomniveau.
zoom number 1 Zoom ind til et specifikt zoomniveau, hvor 0 er helt ude, mens 16 er meget langt inde. Hvis den ikke er angivet, vil en af ovenstående vinde og zoomniveauer vil ikke automatisk blive 1.

Historie (story)

Præsentér data som en historie i stedet for en liste.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
text string Den tekst, der bliver vist til at starte med
zoomOptions object

Det er muligt at angive, hvordan der skal zoomes til objektet i kortet.

"zoomOptions": {
    "zoomStyle": "none",
    "minResolution": 0.8
}

Tooltip i kortet (hover)

Vis et tooltip i kortet når musen føres over en feature.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.

Vis punkt (showpoint)

Få et simpelt kort med markering af en adresse eller en koordinat.

For at benytte denne kontrol, kan der på div-elementet tilføjes en attribut, der fortæller hvilken adresse eller koordinat, der skal vises i kortet. Angiv div-elementet på denne måde: <div data-widget="..." data-widget-address="frederiksberggade 28, 1459"></div> hvor data-widget-address indeholder en adresse. Der er muligt at angive følgende attributter: data-widget-point="724472,6175908", data-widget-icon="http://septima.dk/icon.png" samt data-widget-namedlayer="#gst" (med en af følgende: "#gst_graa", "#gst_skaerm" eller "#gst_orto")

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
detach 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 tlfø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.
zoom number 10 Hvor langt skal der zoomes ind i kortet
zoomStyle string slow Angiver, hvordan der skal zoomes hen til objektet. Ved none vises kortet blot. Ved slow zoomes der langsomt hen til objektet (ca. 2 sekunder), fast zoomer hurtigt (ca. 1 sekund), mens faster zoomer meget hurtigt (ca 0,5 sekunder).
features_style object Hvordan skal punktet styles i kortet. Det er for eksempel muligt at angive sti til ikon

Google Street View (googlestreetview)

Vis Google Street View for et givent punkt i kortet.

For at benytte denne kontrol kræver det, at man har en API-key fra Google. Dette kan man få ved at gå ind på denne side.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
className string Tilføj en speciel CSS class til elementet. Dette kan bruges til at styre hvordan elementet ser ud eller placeres på siden.
detach 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 tlfø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.
APIKey string PÅKRÆVET - API-key fra Google
showOnLoad boolean false Vis Google Street View fra start, når kortet loades
heading number 0 Hvilken retning skal Street View starte med at kigge. 0 er mod nord
pitch number 0 Hvilken hældning skal Street View starte med at kigge. 0 er vandret
radius number 50 Angiver hvor stor en radius, der skal søges efter et Street View fra det markerede punkt. Hvis ikke der findes et Street View inden for denne radius, bliver brugeren gjort opmærksom på det.
features_style object Hvordan skal punktet styles i kortet. Det er for eksempel muligt at angive sti til ikon

Google Analytics (analytics)

Hvordan anvender brugerne Septima Widget? Med Analytics funktionen, er det muligt at følge med i om brugeren klikker på en feature i kortet, vælger noget i listevisningen, tænder og slukker lag eller filtrere data.

For at benytte denne kontrol kræver det, at man har et trackID fra Google Analytics. Dette kan man få ved at gå ind på denne side.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
trackID string Angiv tracID fra Google Analytics.

HTML (html)

Få kortet til automatisk at vise et bestemt objekt i kortet. Det kan for eksempel bruges i forbindelse med visning af et kort for et bestemt område på en hjemmeside.

For at benytte denne kontrol kan der på div-elementet tilføjes en attribut, der fortæller hvilken nøgle, der skal benyttes for at hente de ønskede objekter, der ønskes vist i kortet. Angiv div-elementet på denne måde: <div data-widget="..." data-widget-key="2277350"></div>, hvor data-widget-key indeholder nøglen. Dette foregår på samme måde som for kommuneplan funktionen.

Det er ligeledes muligt at angive URL-parameteren widget-key med nøglen (for eksempel widget-key=2277350)

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
html string Angiver den URL, der skal benyttes til at finde et eller flere objekter. I URL'en er det muligt at angive <%= key %> eller <%= filter %> substitueres de af værdier fra parameteren key eller keyfilter.
host string Angiver den URL, der skal benyttes til at finde et eller flere objekter. I URL'en er det muligt at angive en template, hvor man eksempelvis skriver <%= key %>, der substitueres de af værdier fra parameteren key.
type string geojson Hvilket format kommer data i. Kan antage en af følgende værdier: "geojson", "esrijson", "djangojson", "datasourcejson" samt "local". Ved "local" søges der i de features, der allerede er tilføjet til kortet.
dataType string jsonp Hvordan returneres data. Kan antage en af følgende værdier: "jsonp" og "json". Brug "json", hvis servicen ligger på samme domæne eller leveres med CORS-header.
paramNames object

Det er muligt at angive en række parametre til den URL, der er angivet i host. I dette eksempel kan man enten kalde siden med denne widget med URL-parameteren =?planid=1234. Alternativt kan man på DIV elementet angivet attributten data-widget-planid="1234":

"paramNames": {
    "key": "planid"
}
template string ""

Her angives en html-skabelon for, hvorledes en eventuel tilhørende tekst skal præsenteres. Attributter fra data kan angives i html-skabelonen med følgende notation <%= attributnavn %> - læs mere om templates her.

template_feature string ""

Her angives en html-skabelon for, hvorledes hver feature, som host returnere, skal præsenteres. Attributter fra hver feature kan angives i html-skabelonen med følgende notation <%= attributnavn %> - læs mere om templates her.

activateButton object

Skjul lagvælgeren fra start men gør det muligt for brugeren vise lagvælgeren vha. en knap i kortet. "activateButton" kan indeholde "title", "className" og "html", der alle er optionelle. De har alle en brugbar default værdi. "title" bruges til at angive en tekst, der vises når musen holdes over knappen. "className" tilføjer en CSS-klasse til selve knappen. "html" erstatter indholdet af kanppen med det, der er angivet her. På denne måde er det muligt f.eks. at skifte ikon på knappen. Her er et eksemple på hvordan "activateButton" kan angives:

"activateButton": {
    "title": "Vis signaturforklaring",
    "className": "my-style",
    "html": ""
}

Custom "control"

Det er muligt tilføje sin egen "control", der kan være udviklet til noget helt specielt. Herved er det muligt at referere til denne "control" i konfigurationen som enhver anden "control". Dog er det et krav at konfigurationen indeholder en egenskab, der hedder path med stien til det sted, hvor der ligger en js-fil, der har det samme navn som kontrollen (med stort begyndelsesbogstav). Ellers kan man benytte de normale egenskaber, som de fleste andre "controls" har samt de egenskaber, som den selv bestemmer.

Name type default description
disable boolean false Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
css 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.
detach 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 tlfø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.
path string Ved at sætte "path": "http://host/controls/" indlæses kontrollen som enhver anden kontrol. Det er vigtigt, at der under denne sti ligger en js-fil med samme navn som kontrollen (dog med stort begyndelsesbogstav). På denne måde kan man have koden til en kontrol liggende et helt andet sted.
??? ??? Det er muligt for at have egne egenskaber, der kan bruges på lige fod med de andre.