Skip to content

options.md

Latest commit

 

History

History
87 lines (72 loc) · 4.07 KB

options.md

File metadata and controls

87 lines (72 loc) · 4.07 KB
Raw

Plugin options

Pass options to the geo plugin via Yasgui's standard plugin-config slot:

const yasgui = new Yasgui(document.getElementById('yasgui'), {
  yasr: {
    pluginOrder: ['table', 'response', 'geo'],
    defaultPlugin: 'geo',
    plugins: {
      geo: {
        defaultColor: '#ff5722',
        defaultBasemap: 'CartoDB Voyager',
        initialView: { center: [48.8566, 2.3522], zoom: 11 },
        maxZoom: 18,
        minHeight: 600,
        latLonAutoDetect: true,
        // Replace the bundled basemaps entirely:
        basemaps: {
          'My tiles': L.tileLayer('https://my.tiles/{z}/{x}/{y}.png'),
        },
      },
    },
  },
});

Available options

Option Type Default Description
defaultColor string (CSS color) #3388ff Color used for features without a ?wktColor binding.
defaultBasemap string 'openStreetMap' Name of the basemap to activate at startup. Must be a key of basemaps.
initialView { center: [lat, lon], zoom: number } Belgium @ 5 Map center and zoom when no features are present.
maxZoom number 14 Upper bound applied when auto-fitting bounds to features.
minHeight number (px) 500 Minimum height of the map container.
latLonAutoDetect boolean true Auto-detect numeric lat/lon column pairs and synthesize a WKT POINT column.
basemaps { [name]: L.TileLayer } built-in Replace the bundled basemap dictionary.
styleControl boolean true Show the compact style control for default color, opacity, fill, stroke width and marker radius.
styleStorageKey string | null query hash Override the localStorage key used to persist style-control values.
simplifyTolerance number 0 Initial turf-simplify tolerance in degrees.
simplifyControl boolean true Show a live simplification tolerance slider.
simplifyMaxTolerance number 0.05 Maximum tolerance exposed by the slider.
simplifyStep number 0.0001 Slider step size.
timeSlider boolean true Show a temporal slider when result rows contain time/date-like bindings.
timeBindingNames string[] | null common names Override temporal binding names (time, date, datetime, timestamp, start, startDate).
timeMode 'cumulative' | 'instant' 'cumulative' Show all features up to the selected time, or only features at the exact selected time.
permalink boolean false Persist center, zoom, basemap and visible geometry columns in the URL hash.

Styling

The style control persists default visual settings in localStorage, keyed by the current endpoint/query when YASQE is available. A per-row ?wktColor binding still overrides the selected default color for that feature.

Simplification

The simplification slider adjusts turf-simplify tolerance for line and polygon features. Points are never simplified. A value of 0 disables simplification.

Time Slider

When result rows contain a ?time, ?date, ?datetime, ?timestamp, ?start, or ?startDate binding, the plugin displays a time slider. The default cumulative mode shows all dated features up to the selected value; undated features remain visible.

Convention-based per-feature controls

Bindings the plugin recognizes when present in result rows:

Binding Effect
?wktColor Override fill/stroke color for that feature.
?wktLabel Plain-text popup content (replaces the default key/value table).
?wktTooltip Hover tooltip text.

Supported geometry literal datatypes

Datatype Parsed as
http://www.opengis.net/ont/geosparql#wktLiteral WKT / CRS-prefixed WKT
http://www.openlinksw.com/schemas/virtrdf#Geometry WKT
http://www.w3.org/2003/01/geo/wgs84_pos#geometry WKT (common DBpedia style)
http://www.opengis.net/ont/geosparql#geoJSONLiteral GeoJSON geometry
http://www.opengis.net/ont/geosparql#gmlLiteral GML geometry
http://www.opengis.net/ont/geosparql#geoHashLiteral GeoHash center point