Skip to content

Latest commit

 

History

History
283 lines (147 loc) · 10.7 KB

config.md

File metadata and controls

283 lines (147 loc) · 10.7 KB

WFRC App Type

object (WFRC App)

WFRC App Properties

Property Type Required Nullable Defined by
mapInfos object Required cannot be null WFRC App
sherlock object Required cannot be null WFRC App
layerSelector object Required cannot be null WFRC App
defaultExtent object Required cannot be null WFRC App
links object Required cannot be null WFRC App
openOnLoad object Required cannot be null WFRC App
translations object Required cannot be null WFRC App
maxTabsAllowed integer Required cannot be null WFRC App
projectInformation object Required cannot be null WFRC App
defaultTabsNum integer Required cannot be null WFRC App
$schema string Optional cannot be null WFRC App

mapInfos

An object that describes each map available in the application. The property name is the id for the map and should not change since it's used as a URL parameter.

mapInfos

mapInfos Type

object (Map Infos)

sherlock

Configuration options for the map search widget

sherlock

sherlock Type

object (Details)

layerSelector

Configuration options for the base map selector widget

layerSelector

layerSelector Type

object (Details)

defaultExtent

defaultExtent

defaultExtent Type

object (Details)

links

links

links Type

object (Details)

openOnLoad

Controls whether specific map widgets default to be open on page load

openOnLoad

openOnLoad Type

object (Details)

translations

Contains the translated strings used in the app. Falls back to en if there is no other translation. Most strings in the other configs can be translated by using this format: trans:<key>. For example: trans:visionMapTitle.

translations

translations Type

object (Translations)

maxTabsAllowed

Restricts the number of tabs that a user is allowed to add.

maxTabsAllowed

maxTabsAllowed Type

integer (Max Tabs Allowed)

projectInformation

projectInformation

projectInformation Type

object (Project Information widget configuration)

defaultTabsNum

The number of tabs that are open by default

defaultTabsNum

defaultTabsNum Type

integer (Default Tabs Number)

$schema

This should be set to https://wfrc.org/wasatch-choice-map/config.schema.json

$schema

  • is optional

  • Type: string

  • cannot be null

  • defined in: WFRC App

$schema Type

string

$schema Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"https://wfrc.org/wasatch-choice-map/config.schema.json"
"./config.schema.json"

WFRC App Definitions

Definitions group translation

Reference this group by using

{"$ref":"https://wfrc.org/wasatch-choice-map/config.schema.json#/definitions/translation"}
Property Type Required Nullable Defined by
mapTabsDialog object Optional cannot be null WFRC App
Additional Properties Merged Optional cannot be null WFRC App

mapTabsDialog

mapTabsDialog

mapTabsDialog Type

object (Details)

Additional Properties

Additional properties are allowed, as long as they follow this schema:

  • is optional

  • Type: merged type (Details)

  • cannot be null

  • defined in: WFRC App

additionalProperties Type

merged type (Details)

one (and only one) of