Config

object

• basemapUrlstring

  The deployment default style (override or dark).

• basemapOverrideUrlstringor null

  The deployment basemap override, when set — it pins Auto maps in both themes.

• basemapsarray

  The selectable basemap styles.

  • (each item)object

    • keystring

      One of dark, light, streets, satellite

    • labelstring

    • urlstring

    • kindstring

      Vector styles carry the toggleable content groups (basemapLayers); imagery is a photo — groups don't apply.

      One of vector, imagery

    • attributionBasemapAttribution

• basemapStylesarray

  The styles an admin added to the basemap library and offers, oldest first, chosen by their id; hidden ones are left out.

  • (each item)object

    A style an admin added to the library by its address, offered where a basemap is chosen. A map that takes it keeps its own copy of the name, the address and the credit.

    • idstringrequired

      The style's identity in the library.

    • namestringrequiredmin length 1max length 60

      The name a person choosing a basemap sees.

    • urlstringrequired

      The style's address, public to whoever draws a map on it, as a map's own style address is.

    • attributionBasemapAttributionrequired

    No other keys.

• singleMapStylesboolean

  Whether a map may take a style address the basemap library does not offer (the basemaps.singleMapStyles setting). Off, such an address is refused with basemap_not_offered when a map write or an undo or redo would newly put it on a map; a map that holds one keeps it.

• palettesarray

  The palette catalogue for data-driven fills, grouped for browsing and flagged colorblind-safe where the upstream source designates it.

  • (each item)object

    • namestring

    • labelstring

    • kindstring

      One of sequential, categorical

    • groupstring

      Browsing group; diverging palettes classify as kind "sequential" (same methods, steps, reverse).

      One of sequential, diverging, qualitative

    • colorblindSafeboolean

    • colorsarray of string

    • levelsobject

      Published per-class-count colors (ColorBrewer sets); a k-class fill uses these exact colors when present.

• renderCapFeaturesinteger

• previewRowsinteger

• geocoderConfiguredboolean

  Whether a place-search provider endpoint is configured. The endpoint URL itself never leaves the server.

• defaultsobject

  What new things start with on this instance, keyed and valued as PATCH /api/instance/settings takes them: every key with its effective value. A new map takes the newMap values and a new layer created without a style the newLayer values; the workflow canvas, the SQL console and a fresh image export card take theirs as they open. Admins change them, and nothing that already exists changes with them. A basemap the instance no longer offers reads as auto.

  • newMap.basemapstringrequired

    Basemap. The basemap a new map starts on. Auto follows the theme; a basemap the instance no longer offers starts on Auto.

    One of auto, dark, light, streets, satellite

  • newMap.latitudenumberrequiredminimum -85maximum 85

    Starting latitude. The latitude a new map opens at.

  • newMap.longitudenumberrequiredminimum -180maximum 180

    Starting longitude. The longitude a new map opens at.

  • newMap.zoomnumberrequiredminimum 0maximum 22

    Starting zoom. The zoom a new map opens at.

  • newMap.legendCornerstringrequired

    Legend corner. Where a new map's legend sits.

    One of top-left, top-right, bottom-left, bottom-right

  • newLayer.colorCyclestringrequired

    Color cycle. The palette whose colors new layers take in turn, drawn sketches included.

    One of uber_viz_qualitative, bold, tab10, paired, dark2, set3

  • newLayer.pointOpacityintegerrequiredminimum 10maximum 100

    Point opacity (%). How opaque a new points layer is drawn, unless it is created with a style.

  • newLayer.lineOpacityintegerrequiredminimum 10maximum 100

    Line opacity (%). How opaque a new lines layer is drawn, unless it is created with a style.

  • newLayer.areaOpacityintegerrequiredminimum 10maximum 100

    Area opacity (%). How opaque a new areas layer is drawn, unless it is created with a style.

  • newLayer.lineWidthnumberrequiredminimum 0.5maximum 50

    Line width (px). How wide a new lines layer is drawn, unless it is created with a style.

  • newLayer.pointRadiusnumberrequiredminimum 0.5maximum 100

    Point radius (px). How large a new layer's points are drawn, unless it is created with a style.

  • canvas.opensstringrequired

    Canvas opens. Whether a workflow canvas opens full screen or framed.

    One of full, framed

  • canvas.minimapstringrequired

    Canvas minimap. When a workflow canvas shows its minimap until the person chooses: auto shows it from six nodes.

    One of auto, always, never

  • canvas.resultsBandstringrequired

    Canvas results band. Whether a workflow canvas opens with its results band closed or open until the person chooses.

    One of closed, open

  • sqlConsole.textSizestringrequired

    SQL text size (px). The text size the SQL console's editor opens at.

    One of 11, 12, 13, 14, 16

  • sqlConsole.lineWrapbooleanrequired

    SQL line wrap. Whether the SQL console's editor wraps long lines.

  • imageExport.widthstringrequired

    Image starting width (px). The width a fresh image export card opens at.

    One of 1280, 1920, 2560

  • imageExport.shapestringrequired

    Image starting shape. The shape a fresh image export card opens at.

    One of 16:9, 4:3, 1:1

  No other keys.

• templatesobject

  • cataloguebooleanrequired

    Whether the template catalogue is in use (the templates.catalogue setting). Off, the server reads it for nothing; shipped and downloaded templates still open and copy.

  No other keys.

• rulesobject

  The rules every signed-in account follows, keyed and valued as PATCH /api/instance/settings takes them. Admins change them.

  • tokens.createstringrequired

    Whether every account or only admins may create API tokens. Tokens made earlier keep working.

    One of everyone, admins

  • tokens.expirystringrequired

    The lifetime a new API token takes, from its creation. Tokens made earlier keep their own.

    One of never, 30d, 90d, 1y

  • publishing.publishstringrequired

    Whether every account, only admins or no one may publish a map or change a publication. Published maps stay public and can be unpublished.

    One of everyone, admins, none

  • publishing.embeddingstringrequired

    Which other sites may show a published page in a frame: any site, only the listed sites (at least one), or none.

    One of any, listed, off

  • connections.createstringrequired

    Whether every account or only admins may add a database connection. Connections made earlier keep working.

    One of everyone, admins

  • imports.linksstringrequired

    Whether every account or only admins may import from web addresses and cloud storage. Link datasets keep refreshing.

    One of everyone, admins

  No other keys.

• passwordMinintegerminimum 8maximum 64

  The instance's shortest password: the fewest characters a password set from now may have, from 8 to 64. Admins change it; passwords set earlier keep signing in.