Configuration details

Each Mapseed flavor contains a config.yml file that is used to configure application behavior. There are many config options, and this section of the wiki is intended to be a (work in progress) catalog of those options and how to use them.

Map configuration

...

Dynamic form configuration

...

Right-clinging sidebar configuration

...

Leaflet sidebar configuration

...

Layer style rules configuration

...

Story mode configuration

The story section of the config.yml file configures the behavior of a flavor's story mode. You can control which points on your map appear in a story, which zoom level and centerpoint are used for individual story points, whether the spotlight overlay appears when visiting a story point, and so forth.

Below is an example of a typical story configuration, followed by an explanation of all configurations options used:

story:
  budget-priorities:
    tagline: _(Next budget priority)
    default_zoom: 17
    default_basemap: satellite
    default_visible_layers:
      - 2015-budget-priorities
      - city-council-districts
    order: 
      - url: street-paving
        spotlight: false
        visible_layers:
          - streets
        basemap: dark
      - url: report/214
        zoom: 10
        panTo:
          lat: -122.24877834320068
          lng: 47.731328313742345
      - url: park-improvements
        spotlight: false
        sidebar_icon_url: /static/css/images/markers/map-pin-marker.png

Property	Description
tagline	A string that appears in the story control bar at the bottom of a place detail view.
default_zoom	A map zoom level that will be used for all story points unless a story points defines its own zoom level.
default_basemap	The basemap that will be used for all story points unless a story points defines its own basemap.
default_visible_layers	An array of layers names that will be shown for all story points unless a story points defines its own list of visible layers.
order	An array of urls and optional configuration details that defines the content in a story.
url	Required. The url of a story point.
spotlight	Optional. A boolean value indicating whether or not to display the map spotlight overlay. Defaults to true.
visible_layers	Optional. An array of layers names that will be shown for this story point. Completely overrides default_visible_layers.
basemap	Optional. The basemap that will be shown for this story point. Overrides default_basemap.
zoom	Optional. The map zoom level that will be used for this story point. Overrides default_zoom.
panTo	Optional. An object of lat and lng coordinates to use as the map centerpoint for this story item. Overrides the centerpoint of the underlying geometry.
sidebar_icon_url	Optional. The path to an icon image to use for this story point in the sidebar. If not supplied, the sidebar icon used will be derived from the place section of the config.