SMK Usage Guide

A versatile and lightweight toolkit for building a simple web map.

This project is maintained by bcgov

SMK

Configuration

SMK’s behaviour is completely determined by the configuration object that is loaded into it at initialization. The configuration is expected to be in JSON format.

This is a complete reference to SMK’s configuration. Click on a property name for more information. The "layers" and "tools" collections can contain a variety of possible object types, and each of the possible types is listed under the collection name.

{
    "name":         "SMK Demo App",
    "version":      "1.0.0",
    "createdBy":    "smk",
    "createdDate":  "2020-07-23T19:18:25.876Z",

    "viewer": {
        "type":     "leaflet",
        "device":   "auto",
        "baseMap":  "Topographic",
        "location": { ... }
    },

    "layers": [
        { "type": "esri-dynamic"  },
        { "type": "wms"           },
        { "type": "vector"        },
    ],

    "tools": [
        { "type": "about"         },
        { "type": "baseMaps"      },
        { "type": "bespoke"       },
        { "type": "coordinate"    },
        { "type": "directions"    },
        { "type": "geomark"       },
        { "type": "identify"      },
        { "type": "layers"        },
        { "type": "legend"        },
        { "type": "list-menu"     },
        { "type": "location"      },
        { "type": "markup"        },
        { "type": "measure"       },
        { "type": "minimap"       },
        { "type": "pan"           },
        { "type": "query"         },
        { "type": "scale"         },
        { "type": "search"        },
        { "type": "select"        },
        { "type": "shortcut-menu" },
        { "type": "toolbar"       },
        { "type": "version"       },
        { "type": "zoom"          }
    ]
}