Dokumentation

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".

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]
}

Find et passende view her

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>

Med useStore er det muligt at gemme flere ting omkring kortets aktuelle visning, herunder centerpunkt og zoomniveau til det rette sted, næste gang brugeren ser denne widget, samt hvilke lag, der er vist. Det er for eksempel relevant, når brugeren forlader siden og vender tilbage hurtigt efter. Som udgangspunkt bliver det gemte sted husket i 30 sekunder (30.000 millisekunder). Denne værdi kan ændres ved at sætte expire til et andet antal i millisekunder:

"useStore": {
    "expire": 600000
}

Herved udløber den først efter 600.000 millisekunder, svarende til ti minutter.

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

"useStore": {
    "expire": "never"
}

For at altivere at lag også huskes, tilføjes "layer": true. Herved vil de sidst viste lag være aktive næste gang brugeren kommer ind på siden. Default er "layer": false

Tilsvarende vil "map": false gøre at kortets centerpunkt og zoomniveau ikke gemmes. Default er "map": true

"useStore": {
    "expire": "never",
    "map": true,
    "layer": true
}

For at sikre at det, der gemmes bliver brugt af den samme Widget, benyttes URL'en som identifikation. Men dele af URL'en kan være dynamiske selvom det er den samme Widget, der vises. Derfor er det muligt at angive en liste med URL parametre, der ikke skal tages med som identifikatin. Det gøres ved at angive en liste med en eller flere parametrenavne på denne måde: "ignoreURLParams": ["husnummerid"]

"useStore": {
    "expire": "never",
    "ignoreURLParams": [
        "husnummerid"
    ]
}

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

"mapcontrols": {
    "mouseWheelZoom": false
}

Følgende navigationsfunktioner der kan deaktiveres: mouseWheelZoom, dragRotate, shiftDragZoom, doubleClickZoom, dragPan, pinchZoom, pinchRotate, keyboard og scaleline.

Derudover kan onFocusOnly sættes til true, hvis brugeren skal have kortet i fokus før der kan navigeres i det. Default er false.

Det er ligeledes muligt at styre hvor meget der zoomes ind ved dobbeltklik ved at angive et tal for zoomDelta.

Følgende funktioner kan aktiveres: scaleline og zoom. Eksempelvis:

"mapcontrols": {
    "zoom": true
    "scaleline": true
}

For scaleline er det muligt at angive forskellige parametre i stedet for true. Det kan bruges til at styre hvilket element (angiv ID på elementet) scaleline skal vises i som her:

"mapcontrols": {
    "scaleline": {
        "target": "elementID"
    }
}

Indeholder en læsbar tekst, der bruges af funktioner som f.eks. lagvælger m.fl., hvor der skal vises en tekst for hvert lag.

Angiver navnet på et default baggrundskort. På nuværende tidspunkt findes følgende navngivne lag, der kan benyttes: #dk_standard, #dk_luftfoto, #dk_graa, #dk_skaerm, #dk_forvaltning, #dk_vejkort, #dk_natur, #dk_dagi, #dk_kommune, #dk_topo, #dk_dhm, #dk_dhm_overflade, #dk_mat, #plandata, #plandata_wmts, #osm, #septima_vt_3857, #dk_luftfoto_3857 samt #mapbox_vt

Der er muligt at overstyre enkelte parametre ved blot også at tilføje de parametre, der ønskes overstyret. For #dk_forvaltning, #plandata og #plandata_wmts kan man med fordel vise forskellige lag fra de enkelte service ved at angive layername. For #dk_mat kan man styre farven på jordstykkerne ved at angive styles til f.eks.: "styles": "Jordstykke_Gaeldende_Gul". Derudover er det muligt at angive et ID på at datasæt fra DMPs datakatalog og få vist det pågældende lag i kortet. Dette åbner op for en masse nye lag, som ikke kræver nogen konfiguration.

Elementet type angiver typen af laget. Gyldige værdier: "geojson", "esrijson", "shp", "json", "djangojson", "datasourcejson", "gml", "gpx", "sheet", "OSM", "TileJSON", "GeoTIFF", "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, features_template

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

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

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

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

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, features_template

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

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

Ved typen gpx er følgende øvrige elementer tilgængelige: features, features_host, features_dataType, features_type, features_style, template, template_[funktionsnavn], features_template. Bemærk: Sæt "features_dataType": "text"

Ved typen sheet er følgende øvrige elementer tilgængelige: features, features_host, features_style, template_[funktionsnavn] samt sourceOptions

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 layername (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

Her er det muligt at styre den præcise konfiguration af laget. Dette relevant for typerne "OSM", "TileJSON", "GeoTIFF", "ArcGISRest", "XYZ", "VectorTiles", "Stamen", "WMS" eller "WMTS", men primært "GeoTIFF", der kan indeholde specielle attributter.

Ved typen sheet angives hvilket "ark" der skal læses (defautl er Ark1). Skriv f.eks. "sheet": "deltagere". Det er også muligt at springe de første x antal rækker over, hvis de f.eks. indeholder noget ligegyldigt information. Dette gøres med "skipFirstRows": 2. Første række læses som "header" og hvis den indeholder nogle brugbare navne, kan de bruges som kolonnenavne i data. Men gør det ikke det, er det muligt at angive en liste af navnet i parameteren "header" på denne måde: "header": ["kolonne1","kolonne2","kolonne3"]. Det er også muligt at angive "header": "A". Det gør at kolonnerne hedder "A", "B", osv. som i regnearket. Hvis data indeholder en form for geometri, indsættes det ved at benytte "geometryTemplate": "POINT(<%= D %> <%= E %>)", der er en template, der danner en WKT.

"sourceOptions": {
    "sheet": "Ark1",
    "header": "A",
    "skipFirstRows": 2,
    "geometryTemplate": "POINT(<%= D %> <%= E %>)"
}

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.

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), en wkt eller en bbox. 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å. Tilsvarende kan man skrive <%= wkt %> og <%= bbox %>. 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 returnerer 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.

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.

En features_style kan både styre stylen afhængig af zoom samt af data. Det betyder at hver gang, der sker noget i kortet, så skal stylen gentegnes. Hvis der er mange features i kortet, kan dette tage lidt tid og reducere performance. Men hvis ens style ikke kræver denne dynamik, kan det gøre performance bedre ved at håndtere stylen mere statisk. Dette kan ikke detekteres automatisk og derfor skal man selv fortælle laget hvilken styleType der skal bruges og dermed optimere performance.

Ved at vælge static, er det ikke længere muligt at lade stylen være afhængig af zoom og data. Det betyder at det ikke er muligt at bruge f.eks. labels. Ved at sætte styleType til static, vil der heller ikke komme en "select" style på når brugeren vælger featuren i kortet ved f.eks. info.

Ved at vælge semistatic, er det muligt at lade stylen være afhængig af zoom, men ikke af data. Det betyder at det heller ikke her er muligt at bruge f.eks. labels. Derimod vil semistatic give muligt at have en "select" style på når brugeren vælger featuren i kortet ved f.eks. info.

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

Kontroller den måde vektordata hentes på. Som default er værdien all. Det betyder at alle data hentes fra start. Ved at sætte værdien til bbox hent de vektordata, der er inden for det viste kortudsnit. Hver gang kortudsnittet ændres, hentes der nye data. Benyt en template til at definere features_host eller params og benyt f.eks. parameteren "bbox" på denne måde:

"params": {
    "bbox": "<%= bbox[0] %>,<%= bbox[1] %>,<%= bbox[2] %>,<%= bbox[3] %>"
},

eller via features_host:

"https://geoserver.plandata.dk/geoserver/wfs?...
&bbox=<%= bbox[0] %>,<%= bbox[1] %>,<%= bbox[2] %>,<%= bbox[3] %>",

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

Berig data fra en supplerende datakilde.

"join": {
    "type": "json",
    "host": "https://septima.dk/widget/data/kom_kategori.json",
    "dataType":"json",
    "on": {
        "komnr": "kommunekode"
    }
}

Data kan også angives direkte i konfigurationen:

"join": {
    "data": {
        "type": "FeatureCollection",
        "features": [{
            "type": "Feature",
            "properties": {
                "kommunekode": 730,
                "kategori": 1,
                "info": "Gælder alene for Fælledparken"
            }
        }]
    },
    "on": {
        "komnr": "kommunekode"
    }
}

I on er det muligt at angive én eller flere kolonner, der skal matche før featuren bliver beriget. Det er p.t. kun muligt at supplere data med et eksakt match.

Tilføj supplerende beregnede kolonne til data, der kan benyttes til f.eks. at skabe en nemmere kategorisering. Det er muligt at angive en listen med nye kolonnenavne angivet i name. For hver kolonne angives en template, der kan transformere eksisterende kolonne til nye. For at styre formatet af den nye kolonne, angives det vha. type, der kan antage typerne "string" (default), "number", "date" eller "object".

Herunder ses forskellige eksempeler,der konverterer eksisterende kolonner til noget andet:

"computedProperties": [
    {
        "column": "adresse",
        "template: "<%= vejnavn %> <%= husnummer %>, <%= postnummer %> <%= postdistrikt %>"
        "type": "string"
    },
    {
        "column": "pris",
        "template: "<%= grundpris %>",
        "type": "number"
    },
    {
        "column": "overtagelse",
        "template: "<%= dato %>",
        "type": "date"
    },
    {
        "column": "interval",
        "template: "{from: <%= start %>, to: <%= end %>}",
        "type": "object"
    }
]

Sortering af data når de f.eks. vises i listevisningen. Det er muligt at angive en listen med kolonnenavne angivet i column, der skal sorteres på. For hver kolonne kan man angive sorteringsretningen med desc med værdien true eller false. Hvis værdien i kolonne er et tal, angives datatypen som "number" under type.

Herunder ses et eksempel hvor der først sorteres på "status" og derefter på "grundpris":

"orderBy": [
    {
        "column": "status",
        "desc": true
    },
    {
        "column": "grundpris",
        "desc": false,
        "type": "number"
    }
]

Gruppering af data. Angiv en liste med kolonnenavne, der skal grupperes på. Hvis data indeholder geometri, forudsættes det er geometrien er ens på tværs af rækkerne, der grupperes. Derfor benyttes geometrien fra den første forekomst. informationen for alle rækker, der er grupperet, er gemt i attributten data og kan benyttes i forbindelse med f.eks. infoboksen eller listevisningen.

Herunder ses et eksempel hvor data er grupperet efter kolonnen pladsid:

"groupBy": ["pladsid"]

Der findes en række forskellige foruddefinerede styles, der kan benyttes. Lige nu findes der #000, der bruges når features skal være klikbare men ikke synlige. Det kan f.eks. bruges oven på et WMS lag. Derudover findes #001, #002, ... , #010 samt #011

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

Det er muligt at angive SVG inline i konfigurationen. Dette kan f.eks. bruges til at styre SVG'en individuelt pr. feature ved at benytte værdier fra data, som beskrevet i ovenstående.

Værdien af alle fill="currentColor" attributter i SVG'en, erstattes automatisk af værdien fra fillcolor.

Værdien af alle stroke="currentColor" attributter i SVG'en, erstattes automatisk af værdien fra strokecolor.

Værdien af alle stroke-width="currentWidth" attributter i SVG'en, erstattes automatisk af værdien fra strokewidth.

Værdien af alle stroke-width="currentWidth" attributter i SVG'en, erstattes automatisk af værdien fra -strokewidth.

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.

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

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

Ved buffer angives en ekstra parameter, der definerer 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 offset angives en ekstra parameter, der kan være enten delta eller pixels, hvor delta definerer hvor mange meter objektet skal flyttes og pixels definerer hvor mange pixels objektet skal flyttes. Kun en af de to parametre kan angives. Begge parametre skal angives som et array med to tal, der siger hvor mange hhv meter og pixels objketket skal flyttes i x og y retningen. De to tal kan også hver især angives som en template, der kan bruge oplysningerne fra data:

"geometryOptions": {
    "type": "offset",
    "delta": [10, 10],
    "pixels": [2, -2]
}

Ved wkt angives en ekstra parameter, der definerer 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.

Få udfyldt flader i kortet med en skravering.

På fillpattern angives hvilken form for skravering man vil have. Eksempel:

"fillpattern": {
    "pattern": "hatch",
    "fillcolor": "rgba(200,200,200,0)",
    "strokecolor": "rgba(200,200,200,1)",
    "offset": 0,
    "size": 1,
    "spacing": 5,
    "angle": 60,
    "scale": 2
}

Vælg mellem følgende typer skravering: "hatch", "cross", "dot", "circle", "square", "tile", "woven", "crosses", "caps", "nylon", "hexagon", "cemetry", "sand", "conglomerate", "gravel", "brick", "dolomite", "coal", "breccia", "clay", "flooded", "chaos", "grass", "swamp", "wave", "vine", "forest", "scrub", "tree", "pine", "pines", "rock", "rocks".

Se eksempel på de forskellige typer her.

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.

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.

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.

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.

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.

Ved type:"daterange": Vis genveje til f.eks. "næste uge", "næste måned" og "næste år"

"shortcuts": {
    "prev": ["week", "month", "year"],
    "next": ["week", "month", "year"]
}

Ved type:"daterange": Kan have værdierne some, all og allSelected.

Ved some skal der blot være et overlap mellem det valgte interval og intervallet i data.

Ved all skal det valgte intervalg ligge fuldstndigt inden for intervallet i data.

Ved allSelected skal hele intervallet i data ligge inden for det valgte interval.

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,
    "pxDist": 30
}

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.

pxDist bestemmer hvor langt et punkt skal vises fra centrum når der kun vises få punkter.

Hvordan skal cluster punkterne markeres i kortet. 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.

Her er et eksempel:

"features_style": {
    "strokecolor": "rgba(230, 0, 126, 0.4)",
    "strokewidth": 14,
    "fillcolor": "rgba(230, 0, 126, 1)",
    "textFont": "bold 16px Roboto",
    "radius": 18
}

I stylen er det muligt at bruge teplates til at styre indholdet stylen. Templaten kan bruge parametrene colorratio, opacityratio, radius, ratio> og text>, hvor den sidste er antallet af punkter, der ligger i dette cluster. Læs mere om templates generelt her

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 parametre er: <%= wkt %>, <%= x %>, <%= y %>, <%= buffer %>, <%= zoom %>, <%= resolution %>, <%= minx %>, <%= maxx %>, <%= miny %> og <%= maxy %>.

Derudover er det muligt at tjekke på hvilken eventtype der har aktiveret konfliktsøgningen. Det gøres ved at bruge <%= event %>, der har værdien mapclick, hvis brugeren har klikke i kortet, eller featureadded hvis eventet kommer via en markering fra f.eks. søgefeltet. Dette kan bruges til at differentiere kaldet afhængigt af hvad brugeren har gjort.

Hvis konfliktsøgningen aktiveres via søgefeltet, er der også muligt at benytte oplysinger herfra til at danne URL'en med. Herved kan konfliktsøgningen ske ved en kombination af geometri og/eller attributværdier. Det kan f.eks. være at man vil bruge ejerlavskoden fra "dawa" til at lave konfliktsøgningen med. Dette gøres ved at benytte <%= properties.ejerlav.kode %>. Eller hvis man søger på lokale data i søgefeltet, så kan man få adgang til et id via <%= properties.id %>. Dette kræver altså lidt viden om de data, der søges i samt at den service man benytter, understøtter andet end blot et grometrisk filter.

Elementet 'type' angiver typen af servicen. Gyldige værdier: geojson, esrijson, datasourcejson, spatialqueryjson, json og djangojson. 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.

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"
}

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.

Her angives en html-skabelon for, hvorledes en eventuel tekst skal præsenteres når der ikke er nogen hits. Dette kan bruges til at få fuld kontrol pver hvad der skal vises når konfliktsøgningen ikke finder noget. Hvis angivet, så ignoreres nohitmessage. Attributter fra konfigurationen af dette target, kan angives i html-skabelonen med følgende notation <%= attributnavn %> - Læs mere om templates her.

Angiv id på det lag, som geometrien skal tegnes i.

Laget skal være et helt almindeligt vektorlag. Hvis man blot vil have et tomt lag, kan man med fordel bruge noget i stil med:

{
    "id": "tegnelag",
    "edit": true,
    "features": true,
    "type": "geojson",
    "data": {
        "type": "FeatureCollection",
        "crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:EPSG::25832" } }, 
        "features": []
    },
    "features_dataType": "json",
    "features_style": {
        "namedstyle": "#004"
    }
}

Bemærk at laget har "edit": true </td> </tr>

Hvis brugeren skal kunne skifte mellem hvilken geometritype, der skal tegnes med, er det muligt at angive en liste med knapper, der skal være tilgængelige

Til hver knap angives hvilken geometritype knappen skal vises. Derudover er det muligt at angive en tekst, der vises som tooltip på knappen. Hvis der er behov for at skifte ikoner, så kan det gøres med CSS, ved at angive et className

Det er også muligt at angive en knap af typen Complete, der viser en knap, som brugeren kan afslutte aktuelle tegning med. Knappen vises når brugeren har placeret de to første punkter i en linje eller de tre første funkter i en polygon.

"buttons": [
    {
        "text": "Tegn punkt",
        "type": "Point",
        "className": "mdi mdi-map-marker-plus"
    },
    {
        "text": "Tegn linje",
        "type": "LineString",
        "className": "mdi mdi-vector-line"
    },
    {
        "text": "Tegn polygon",
        "type": "Polygon",
        "className": "mdi mdi-vector-square"
    },
    {
        "text": "Afslut",
        "type": "Complete",
        "className": "mdi mdi-check"
    }
]

Angiv id på det lag, som geometrien skal tegnes i.

Laget skal være et helt almindeligt vektorlag. Hvis man blot vil have et tomt lag, kan man med fordel bruge noget i stil med:

{
    "id": "tegnelag",
    "edit": true,
    "features": true,
    "type": "geojson",
    "data": {
        "type": "FeatureCollection",
        "crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:EPSG::25832" } }, 
        "features": []
    },
    "features_dataType": "json",
    "features_style": {
        "namedstyle": "#004"
    }
}

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"
}

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.

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.

Aktivér HTML'en 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 eksempel på, hvordan "activateButton" kan angives:

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

Aktivér billedet 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 eksempel på, hvordan "activateButton" kan angives:

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

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": {
    "mode": "mode",
    "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

Tilsvarende er det muligt at angive hvilket "mode", data skal vises i. Dette gøres med parameteren widget-mode.

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

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 eksempel på, hvordan "activateButton" kan angives:

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

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

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

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.

title er overskriften i gruppen.

type bestemmer om der kan vælges en eller flere lag i gruppen.

expanded angiver om gruppen skal være foldet ud fra start.

layers relaterer sig til hvilke lag, gruppen skal indeholde. Dette er en liste med id'er på lagene.

showCount sat til true betyder at antallet af lag samt antallet af tændte lag i en gruppe vises. Herved er det muligt at se lidt mere om hvad den pågældende gruppe indeholder. Som default bliver antallet ikke vist.

Det er muligt at angive en række parametre, der styre hvordan lagvælgeren opfører sig.

Pt. er det muligt at angive en liste med ID'er på lag (adskilt af komma), der skal vises. Det er kun lag, der er med i lagvælgeren, det er muligt at styre. I dette eksempel kan man enten kalde siden med denne widget med URL-parameteren =?visiblelayers=lag1,lag4 for at de to lag. Alternativt kan man på DIV elementet angivet attributten data-widget-visiblelayers="lag1,lag4":

Tilsvarende er det muligt at angive hvilke grupper, der skal være foldet ud (expanded). Det gøres som ved "layers" blot med "groups". Hvis parameteren er angivet, vil den styre grupperne, ellers vil værdien angivet i expanded styre det.

"paramNames": {
    "layers": "visiblelayers"
    "groups": "expandedgroups"
}

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"
}

Ved at angive en liste med påkrævede parametre, der skal være angivet for at servicen kaldes, kan man begrænse hvad der bliver kaldt med. Dette er et eksempel, der kræver at "planid" skal være angivet som parameter:

"requiredParams": ["planid"]

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.

Her angives en skabelon for, hvad titlen på siden skal skiftes til. Attributter fra data kan angives i skabelonen med følgende notation <%= attributnavn %> - Læs mere om templates her.

Det er muligt at angive en række parametre, der styre hvordan funktionen konfigureres. Pt. er det muligt at angive værdien for onStart og onClick med URL-parameteren =?location.onStart=true&location.onClick=false. Alternativt kan man på DIV elementet angivet attributten data-widget-location.onStart="true" og data-widget-location.onClick="false". Det kræver at man angiver følgende i konfigurationen:

"paramNames": {
    "onClick": "location.onClick",
    "onStart": "location.onStart"
}

Her angives en html-skabelon for, hvorledes målene skal præsenteres for brugere. Målene kan ses ved at tilføje "debug": true i konfigurationen og kan angives i html-skabelonen med følgende notation <%= formatted.html %> - Læs mere om templates her.

Fælgende parametre kan benyttes i templaten:

{
    "vertices": 4,
    "area": 108178.75732421875,
    "last": 1231.1360836260728,
    "length": 2966.6013881474846,
    "formatted": {
        "distance": "2,97",
        "distanceUnit": "km",
        "area": "108179",
        "areaUnit": "m2",
        "html": "Areal: 108179 m2"
    }
}

Angiv én eller to knapper, der aktivere måleværktøjet. Den ene knap er til at måle afstande med mens den anden er til at måle arealer med.

Til hver knap angives hvilken geometritype knappen skal aktivere. Brug LineString for at måle afstande eller polygon for at måle arealer. Derudover er det muligt at angive en tekst, der vises som tooltip på knappen. Hvis der er behov for at skifte ikoner, så kan det gøres med CSS, ved at angive et className. Hvis className ikke angives benyttes der et default ikon

"buttons": [
    {
        "text": "Mål afstand",
        "type": "LineString",
        "className": "mdi mdi-vector-line"
    },
    {
        "text": "Mål areal",
        "type": "Polygon",
        "className": "mdi mdi-vector-square"
    }
]

Angiv hvordan oversigtskortet skal agere når brugeren navigerer i kortet. Det kan f.eks. være hvilke resolutions, der skal hoppen mellem:

"viewOptions": {
    "resolutions": [1600, 1000]
}

Alle options, der er angivet her kan benyttes.

Aktivér oversigtskortet 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 eksempel på, hvordan "activateButton" kan angives:

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

Her angives hvilke formater, der skal kunne udskrives i. P.t. er det kun muligt at angive ét format.

Som default oprettes der et PDF-dokument med kortet. I templates angives hvor stort kortet skal være samt opløsningen. Bemærk at det kan tage lidt tid at generere dokumentet, hvis opløsningen er høj. Angiv orientation til enten "langscape" (default) eller "portrait". Derudover er det muligt at angive parpirformatet med format til f.eks. "a4" (default).

Angiv filename med navnet på den fil, der bliver dannet. Filnavnet skal inkludere formartet, f.eks. pdf.

Det er også muligt at udskrive som et billede. Dette gøres ved at angive outputformat med værdien image.

"templates": [{
    "name":"Udskriv i A4 liggende",
    "orientation": "landscape",
    "format": "a4",
    "ppi": 150,
    "map_height": 210,
    "map_width": 297
}]

Hvis man har en service, der kan generere en udskrift af kortet, er dette også muligt. Det kan f.eks. være QGIS Server, Geoserver eller Spatial Suite. Det kræver dog, at servicen indeholder alle lag, der skal udskrives:

"templates": [{
    "name": "Udskriv i A4 liggende",
    "map_height": 187,
    "map_width": 277,
    "url": "https://kort.haderslev.dk/spatialmap?page=print.pdf.new&mapheight=&mapwidth=&map_size= &mapext=&layers=&opacities=1&scalebarname=pdf&pageformat=a4&orientation=landscape&map_resolution=200&printscale=8&pdfprintlegend=true&printformats=a4_landscape&map_angle=360&ppi=200&titleblock=true&copyrighttext=&date=&profile=widget_kp17"
}]

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": "Lastbil", "value": "bus", "icon": "truck"},
    {"name": "Luftlinje", "value": "air", "icon": "air"}
]

Indstillinger for animationen af ruten i kortet.

"animate": {
    "duration": 600
}

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"
}

Skal beregningen foregå ved opstart, gøres det ved at tilføje "data" direkte til funktionen. Data bliver ikke vist nogen steder og bruges kun til beregning af de nærmeste.

"data": {
    "type": "FeatureCollection",
    "crs": { "type": "name", "properties": {"name": "urn:ogc:def:crs:EPSG::25832"}},
    "features": [{
        "type": "Feature",
        "properties": {},
        "geometry": {
            "type": "Point",
            "coordinates": [724509,6175921]
        }
    }]
}

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": "Lastbil", "value": "bus", "icon": "truck"},
    {"name": "Luftlinjeafstand", "value": "air", "icon": "airplane"}
]

Det er muligt at angive en række parametre, der styre hvordan søgefeltet opfører sig. Pt. er det muligt at angive hvilken hjælpetekst displaytext, der skal vises samt om søgefeltet skal være i fokus autofocus når siden loades:

"paramNames": {
    "autofocus": "autofocus",
    "displaytext": "displaytext"
}

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

Til alle typer er det muligt at angive parameteren "minimumShowCount": 3 med et antal hits, der altid skal vises selvom der er flere. For adressesøgningen er denne værdi default 3, mens den for alle andre er 0.

Til "type":"dawa" eller "type":"address" kan angives med parameteren "highlightRoad": true, der bestemmer om man vil have markeret vejen i kortet når vejen vælges i listen. Derudover er det muligt at angive "kommunekode" for at begrænse søgningen til bestemte kommuner. Det kan f.eks. gøres med:

"kommunekode": "101"

"kommunekode": "101,161,163"

Til "type":"geosearch" er det muligt at angive "kommunekode" på samme måde som ved "type":"dawa". Derudover kan der angives "targets", der er et array af, hvad der skal søges i:

"targets": ["postdistrikter","matrikelnumre"]

Til "type":"stednavn" kan der angives parameteren "kommunekode" på samme måde som ved "type":"dawa". Med denne type søges der i de officielle danske stednavne.

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

Til "type":"s3" angives parametrene "host", samt "service".

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

Til "type":"cvr" er det muligt at angive "kommunekode" på samme måde som ved "type":"dawa".

Til "type":"plan" er det muligt at angive "kommunekode" på samme måde som ved "type":"dawa".

Til "type":"arcgis" angives parametrene "catalogUrl", "serviceName" samt "layers".

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"
}

Det er muligt at angive "condition": "..." på "geometryProxy". Herved er det muligt at styre hvornår denne proxy skal kaldes. Indholdet i "condition" er en template, der tager inputtet fra den valgte vej, husnummer eller hvad der nu er valgt.

Her angives id'et på det lag, der skal tændes når et objekt af denne type vælges i søgefeltet. Hvis flere lag skal tændes, angives en kommasepareret liste med id'er. Det er også muligt at angive en skabelon, der bruger det valgte objekts attributter til at danne lagnavnet med. Attributter fra data kan angives i skabelonen med følgende notation <%= attributes.kategori %> - læs mere om templates her.

Vis en popup for det markerede objekt.

"popup" skal være et objekt, der kan indeholder "delay", "template" samt "geometryOptions" (som beskrevet under features_style) i stil med dette:

"popup": {
    "delay": 1500,
    "className": "widget-map-popup"
    "template": "
<%= dist %> meter - <%= time %> sekunder
",
    "geometryOptions": {
        "type": "interiorPoint"
    }
}

Skal der vises en overskrift for listen. Hvis der er flere lister, kommer der en overskrift for hver liste. Hvis listen er tom, skjules overskriften.

Som default vises lagets "navn" (der der er angivet i "name"). Hvis man ønsker en alternativ overskrift, kan det styres ved at tilføje template_table_header til laget ellse ved at angive showheaderTemplate her. I denne template kan man skrive en fast tekst/HTML, som vises over listen.

Hvis man ønsker at få vist antallet af rækker i listen i overskriften, skal man blot tilføje et HTML-element med class='widget-table-header-count' til template_table_header/showheaderTemplate. Indholdet af dette element vil blive erstattet af et tal, der siger hvor mange rækker der er vist.

Hvis showheader er angivet, er det her muligt at angive en alternativ måde overskriften skal vises på. Templaten bliver kaldt med alle parametre fra laget. Det betyder at man f.eks. kan agive <h1><%= name %></h1> for at få vist en overskrift med et H1 element. Men det er herved også muligt at indsætte ikoner og meget mere.

Kan bruges når showheader er true. Hvis den er angivet, vil det være muligt for brugeren at folde de enkelte lister sammen. Hvis showheaderCollapsed er true er listerne foldet sammen fra start, mens de er foldet ud hvis showheaderCollapsed er false. Som default er det ikke muligt for brugeren at folde listerne sammen.

Kan bruges når showheader er true og showheader er angivet. Hvis showheaderCollapsedAccordion er true, vil de enkelte lister fungere som en accordion. Det betyder at der kun vises én liste ad gangen. Når brugeren folder en liste ud, så foldes de andre sammen.

Kan bruges når showheader er true og template_table_header er angivet på laget. Hvis updateHeaderOnFilterChange er true, vil templaten blive kaldt hver gang filteret opdateres. Herved kan overskriften på listen være afhænig af det aktuelle filter.

Download funktionen gør det muligt at hente data som CSV eller PDF (tabelform) og konfigureres som et objekt med forskelige parametre. Hvis man blot vil have en knap, der downloader data som CSV, så tilføjes:

"download": {
    "type": "csv",
    "button": true
}

Kanppen tilføjes i overskriften over listen og kræver derfor at showheader er true.

Men det er også muligt at angive:

button - kan have værdien true hvorved der vises en knap med et ikon. Hvis button er en tekst, så vil teksten blive vist på knappen i stedet for det ikon, der default vises.

filename - navnet på den fil, der hentes. Default er det, der er angivet i name på laget, men ellers liste.

type - pt. understøttes csv og pdf. csv er default.

seperator - for "type": "csv", hvilken seperator skal benyttes. Default er ,.

onLoad - Downloader data med det samme. Det bruges typisk hvis en widget tilføjes dynamisk eller hvis en widget er skjult fra start.

format - for "type": "pdf", hvilket format pdf-dokumentet skal have. Det kan f.eks. være a4.

orientation - for "type": "pdf", landscale eller portrait.

"download": {
    "button": true,
    "filename": "liste",
    "format": "csv",
    "seperator": ",",
    "onLoad": false
}

Angiv id på det lag, som geometrien skal tilføjes til.

Laget skal være et helt almindeligt vektorlag. Hvis man blot vil have et tomt lag, kan man med fordel bruge noget i stil med:

{
    "id": "tegnelag",
    "features": true,
    "type": "geojson",
    "data": {
        "type": "FeatureCollection",
        "crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:EPSG::25832" } }, 
        "features": []
    },
    "features_dataType": "json",
    "features_style": {
        "namedstyle": "#004"
    }
}

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).