Config Structure

[james-rae]

Guts by @yileifeng

Language

• language: string
  • language used in config file (en, fr)

Version

• version: string
  • schema version used in config file (4.0, ...)

UI (rename/remove?)

• title: string
  • default viewer title
• fullscreen: boolean
• help: { path: string }
  • configures help file/section
• restrictNav: boolean
  • restrict from panning beyond maximum map extent
• openTable: string
  • optional identification to open table panel linked to the id on map load

Fixtures

• appbar: Appbar
  • configures appbar
• geosearch: Geosearch
  • configures geosearch fixture
• identify: Details
  • configures details fixture
• legend: { reorderable: boolean, isOpen: boolean, root: entryGroup }
  • a tree structure with an entryGroup at its root, containing children that specify which layers defined above are displayed inside the legend panel
• navbar: Navbar
  • configures navbar
• northArrow, overviewMap, scalebar, other components as needed

Legend

Entry Group

• name: string (required)
  • title of the legend group
• hidden: boolean
  • hide from UI
• expanded: boolean
  • specifies if group is expanded by default
• children: [entryGroup || entry || infoSection || visibilitySet]
  • array consisting of objects representing various legend elements including - entry group, single entry, visibility set, and info/text sections
• controls: [string]
  • array consisting of strings that specifies controls enabled for group, can include opacity, visibility, symbology, query, reload, delete, settings
• disabledControls: [string]
  • array consisting of strings that specifies controls disabled for group, same options as above

Entry

• layerId: string (required)
  • identification to link to a layer defined in layers section of config
• hidden: boolean
  • hide from UI
• controlledIds: [string]
  • additional layer IDs controlled by this layer
• entryIndex: integer
  • index of sublayer for dynamic layers
• entryId: string
  • identification of sublayer for WFS layers
• coverIcon: string
  • optional icon to represent layer
• description: string
  • optional description displayed when clicking on symbology toggle
• symbologyStack: [object]
  • array of objects containing image-text pairings detailing features of a layer (render with icons or images)
• symbologyExpanded: boolean
  • specifies if symbology is expanded by default

Visibility Set

• exclusiveVisibility: [entryGroup || entry]
  • array of elements making up the set (note: cannot nest visiblity sets)

Info Section

• infoType: string (required)
  • either an image, title, or text
• content: string
  • actual content of the legend element (picture, text, headline, etc.)

Table

Table Node

• title: string
  • title of the datatable
• columns: [ColumnNode]
  • array of objects describing column properties
• globalSearch: { enabled: boolean, value: string }
  • specifies if global search is enabled and optional initial global search filter value
• showFilter: boolean
  • specifies if column filters are displayed when table loads
• filterByExtent: boolean
  • specifies if table data is filtered by map extent on load
• applyMap: boolean
  • specifies if column filters are applied to the map by default

Column Node

• title: string
  • title of column
• data: string (required)
  • field name to link to layer
• visible: boolean
  • specifies if column is visible by default
• width: integer
  • specifies the column width, should be bounded by a max value
• sort: string
  • specifies if column is sorted (ascending or descending) by default
• searchable: boolean
  • specifies if column is able to be filtered
• filter: FilterNode
  • object describing filter properties

Filter Node

• type: string (required)
  • column filter type (string, number, date, selector)
• value: string
  • specifies initial filter value
• static: boolean
  • specifies if filter value can be modified

Appbar

• items: [string || { id: string, options: object } ]
  • array of strings or objects representing buttons that appear on appbar, objects are customizable and should specify an id to link
  • strings can include basemap, geosearch, legend, and more if needed

Navbar

• zoomOptions: string
  • specify between "zoom buttons", "zoom sliders", or both (default to buttons)
• navbarButtons: [string]
  • array of strings containing navigation buttons to be displayed (e.g. fullscreen, help, zoom in/out functionality, home extent, etc.)

Geosearch

• enabled: boolean
  • specifies if geosearch is enabled
• serviceUrls: object
  • various geosearch service URLs (location, names, provinces/types)

Details

• templates: [ { "layerId": custom-vue-component } ]
  • array of objects with key-value pairings with layer ID as the key and a custom user-defined template as its value to render in details panel

Layers

• layers: [any Layer Node]
  • array of objects representing layers to be displayed on the map, added to the map in same order it appears in the array
• no significant changes from RAMP2 for layers (WFS changes required?)
• layer config definitions stored in GeoApi
• layer type shorthands used in RAMP2 config: esriDynamic, esriFeature, esriImage, esriTile, ogcWms, ogcWfs

Layer Node

• properties: id, name, url, refreshInterval, responseTime, metadataUrl, catalogueUrl, layerType, extent, controls, disabledControls, initialLayerSettings, details

Dynamic Layer Node

• extends Layer Node
• additional properties: toggleSymbology, singleEntryCollapse, layerEntries, imageFormat

Feature Layer Node

• extends Layer Node
• additional properties: nameField, tooltipField, outfields, toggleSymbology, customRenderer, tableNode, fieldMetadata (defined in GeoApi)

WMS Layer Node

• extends Layer Node
• additional properties: layerEntries, featureInfoMimeType, legendMimeType

WFS Layer Node

• extends Feature Layer Node
• additional properties: color, xyInAttribs

File Layer Node

• extends Feature Layer Node
• additional properties: color, fileType (CSV, GeoJSON, Shapefile), latField, longField

Map

• tileSchemas: [TileSchemaNode] (required)
  • array of objects specifying combinations of extent sets and zoom scales
• extentSets: [ExtentSetNode]
  • array of objects detailing default and max extents of map (define only if no default hardcoded value exists or it needs to be overriden)
• lodSets: [LodSetNode]
  • array of objects describing levels of detail - zoom scales for map (define only if no default hardcoded value exists or it needs to be overriden)
• initialBasemapId: string
  • initial basemap to load
• basemaps: [BasemapNode] (required)
  • array of objects representing basemaps that can be loaded onto the map, appears in the basemap selector panel

Tile Schema Node

• id: string (required)
• name: string (required)
  • tile schema name
• default: string
  • provide default name that is linked to value containing extent set and lod set hardcoded data
• extentSetId: string
  • only provide if id does not match hardcoded regular value, or want to override default value
• lodSetId: string
  • only provide if id does not match hardcoded regular value, or want to override default value

Lod Set Node

• defined in GeoApi
• id: string (required)
• lods: [object] (required)
  • array of objects describing levels of details for a tile schema

Extent Set Node

• defined in GeoApi
• id: string (required)
• spatialReference: { wkid: integer, wkt: integer } (required)
  • define spatial reference using a well-known ID (WKID) or well-known text (WKT)
• defaultExtent: { xmin: integer, xmax: integer, ymin: integer, ymax: integer } (required)
  • default starting extent
• maximumExtent: { xmin: integer, xmax: integer, ymin: integer, ymax: integer }
  • maximum map extent

Basemap Node

• defined in GeoApi
• id: string (required)
  • unique basemap identifier
• name: string (required)
  • basemap name
• description: string (required)
  • basemap description
• altText: string (required)
  • basemap thumbnail image text
• tileSchemaId: string (required)
  • identifier to associate tile schema linked to this basemap
• layers: [object]
  • array of objects containing a set of URLs to form a basemap entry
• thumbnailUrl: string
  • optional custom image file for basemap thumbnail

Services

• TODO

Export

• TODO

NOTE: Real schema will have default values for most properties

Sample Config Snippet

{
    "language": "en",
    "version": "4.0",
    "ui": {
        "title": "Sample Page",
        "help": "default", 
        ...
    },
    "services": {
        ...
    },
    "fixtures": {
        "legend": {
            "isOpen": true,
            "reorderable": false,
            "root": {
                "name": "root legend element",
                "children" [
                    {
                        "layerId": "HydrometricStations",
                        ...
                    },
                    ...
                ]
            }
        },
        "appbar": {
            "items": ['basemap', 'geosearch', 'legend']
        },
        "navbar": {
            "navbarButtons": ['fullscreen', 'zoomIn', 'zoomOut', help', 'basemap']
        },
        "geosearch": {
            'enabled': true,
            'serviceUrls': {
                ...
            }
        },
        "identify": {
            "templates": {
                "HydrometricStations": "<custom-vue-component>"
            }
        }
    },
    "layers": [
        {
            "id": "HydrometricStations",
            "layerType": "ogcWfs", 
            ...
        }, 
        ...
    ],
    "map": {
        "tileSchemas": [
            {
                "id": ...,
                "default": "reference to hardcoded regular values",
                ...
            },
            {
                "id": ...,
                "default": "reference to hardcoded regular values"
                "lodSetId": "overrideLodSetId",
                ...
            },
            ...
        ],
        "lodSets": [
            {
                "id": "overrideLodSetId",
                ...
            }, 
            ...
        ],
        "basemaps": [
            {
                "id": "esriImagery", 
                "tileSchemaId": ...,
                "layers": [...]
            }, 
            ...
        ], 
        "initialBasemapId": "esriImagery"
    }
}

Questions

• How to process different language configs?
• Where to initialize config object in RAMP4?
• Any component properties that needs to be added/replaced/deleted?
• Missing components?
• Improvement for layers/legend configuration (mostly the same as RAMP2)?
• Export and services sections
• Additional thoughts?

[james-rae]

Feedback from @spencerwahl

Where to initialize config object in RAMP4?

I think the config store should be handling all the config init/defaulting/etc. So RAMP would get its first (or a new) config, the store's 'setConfig' gets called, it fills out the config with defaults and then stores it. Config snippets can come in at a later time and the store will update its info (and anything bound to it will automatically have the new config stuff). If the store is passed another whole config, it will default and overwrite it?

How to process different language configs?

I think I remember talking about making it so that different language configs get loaded when they're needed, and the language in the config can dictate the language of ramp? In this case config switching dictates the language switch.

The other option is the language switch dictating a config switch, where we'd need to store multiple configs.

[the group then decided to make a new design item for languages and configs]

[james-rae]

Feedback from me

For WFS layers, I'm going to dredge up a thing from other discussions that never seemed to get resolved (see ramp4-pcar4/r4design#15 ).

We have our config saying "the layer type is WFS" but in reality the layer type is Feature Layer, and the source is a WFS.

When we load from a file, we specify Feature Layer and provide a fileType. Part of me feels WFS should become a file type, and rename to sourceType or something like that.

[james-rae]

3 Year Update:

The config schema is fairly locked down now, so just consult the schema.json file.

The layer type comments above were resolved here #338 (comment)

Language stuff can be read more on here: #513 , #343 , but I believe one of the primary solutions was to adopt an overarching config structure that could contain sub-configs keyed by a specific language.