Map JSON file format

        
            {
    "Id": "",
    "Properties": {},
    "Document": "{}",
    "Resources": "{}",
    "Categories": "{}",
    "ViewSettings": "{}",
    "Plugins": ""
}
            

Minimum

Two things are required to present a barebones map: a document and a plugin.

  • Document
  • Plugin
            
            
                A JSON object in a stringified notation that contains the pieces of a map.
            
            
                A string that identifies the name of a map view that will
                parse the document and present it in a section of a web page.
                The map view will commonly consist of at least JavaScript file
                that will do the work to parse the map file and a CSS file that
                will apply layout and basic styling of the map.
            
                

Everything else in the map's JSON file format (i.e. Id, Properties, Resources, Categories, ViewSettings) exist to enhance the presentation, rendering, localization, data connectivity and storage of a map.

Properties

Any information that describes a map. Often, this information is referred to as metadata.

Document

The layout, layers, slides and shapes of a map. These are the pieces that make up the base presentation of a map. It describes what the pieces that make up the map. It's similar to a building without any interior styling. A map can be presented without any of the other members of the map object.

Resources

Text and ID strings that can be localized to different languages or data sources changes.

Categories

Text and colors that apply to shapes and HTML elements used in the presentation of a map.

ViewSettings

Information that applies to a specific instance of a map presentation. The view settings are specific to an instance of map and are separate from the general layout presentation information stored in the Document property.

Plugins

A comma-separated list of plugins required in parsing and presenting a map file.

Changelog

v0.5

December 15, 2018
  • Map file format updated
  • Settings updated to ViewSettings to clarify its purpose
  • Categories extracted from Document to allow for easier updates and customizations map categories