Skip to content
Our basic webmap template
JavaScript CSS HTML
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
config
data
dist
images
sassdoc
src
tasks/gulp
templates
.eslintrc.full.js
.eslintrc.js
.gitignore
.prettierignore
README.md
favicon.ico
gulpfile.js
package-lock.json
package.json
prettier.config.js

README.md

GitHub Repository Template

About

This is our Webmap template, which should be used to create webmaps for Hackney.

Prerequisites

You will need to have git installed. You will also need node and npm installed.

Setting Up

Open terminal / bash and run the following:

git clone `https://github.com/LBHackney-IT/lbh-webmap-template.git`

You will need to create a file called mapbox.js in src/js/helpers, and a file called .npmrc in the root of the project. Sandrine Balley (sandrine.balley@hackney.gov.uk) or Marta Villalobos (marta.villalobos@hackney.gov.uk) can give you the file contents for both files.

Create your data file, name it map-definition.json and add it to data/YOUR_MAP_NAME_GOES_HERE/.

Go back to terminal and run the following commands:

cd lbh-webmap-template
npm install
npm start

When you see the text "Listening on port 9000..." (this could take a minute or so), open your web browser and go to http://localhost:9000/YOUR_MAP_NAME_GOES_HERE/index.html for the whole page version (with header), or http://localhost:9000/YOUR_MAP_NAME_GOES_HERE/embed.html for the embed version.

Data file options

The options for the data file are as follows:

Option Type Required Description
title String optional Title of the map that displays in the title box and the metadata box
summary String optional Summary of the map. If title and summary are present, an information icon will appear next to the title and the text added in summary will appear as a tooltip when you hover on the icon (desktop only)
showGeoServerMetadata Boolean optional If true the code will try to read the metadata (from metadata.public_metadata) via geoserver and add it to the infoBox that appears when you click on "About the data of this map" on desktop or on the information icon on mobile. This is a view on Earthlight metadata. This includes the name of the layer, the abstract, source and last update date of each layer of the map.
aboutTheData Boolean optional If showGeoServerMetadata is set to false, aboutTheData can be used to populate the text in the infoBox described above.
baseStyle String optional Mapbox style to use for the base map. Possible values:
streets: the closest style to Google. Amended to remove commercial points of interest at small scale.
light: light grey style we used for the regeneration map.
dark: black style
any other value, empty or omitted: the classical beige style we used for the initial leaflet maps
zoomToMasterMap Boolean optional If true the top 3 levels of zoom show Ordnance Survey masterMap outdoor style.
showLocateButton Boolean optional If true a button with geolocation function will be added to the map.
showResetZoomButton Boolean optional If true a button resetting the zoom to show the full extent of Hackney will be added to the map. (Non mobile devices only)
showHackneyMask Boolean optional If true a semi-opaque white mask will be added to all areas that fall outside of Hackney.
showHackneyBoundary Boolean optional If true the Hackney boundary will be added to the map
showLegend Boolean optional If true a legend will show on the map.
controlsText Object optional If showLegend is true, you can optionally set custom values for the text that will get displayed to show and hide the legend and to clear the map, otherwise defaults will display. Options:
showLegendText: Default is "Show list"
hideLegendText: Default is "Hide list"
clearMapText: Default is "Clear map"
personas Array optional An array of objects that defines any "personas" to be added to the map. Each object will produce a button at the top of the map, which when clicked will turn on a group of layers. Persona options defined below
filters Object optional An object with one or more keys, where the key is the name of the property in the GeoServer database, and the value is an object with a heading (the heading text that will appear at the top of the filter), and options (an array of possible values for that filter).
layers Array required An array of layers to be added to the map. Layer options defined below.

Persona Options

Object properties:

Option Type Required Description
id String required Id of the persona, used as a key in layers to specify whether a layer belongs to the persona.
icon String required Relative url of the default icon for the persona button.
iconActive String required Relative url of the active state icon for the persona button.
text String required (User-friendly) text for the persona button.

Layer Options

Option Type Required Description
title String required Title of the layer. This is how it will be shown on the legend (if there is a legend on the map). It may also be used as a header in popups depending on how the popups are configured.
geoserverLayerName String required Name (not title) of the layer in geoserver which usually follows the following structure [Schema_name]:[table_name] (e.g. planning:conversation_area). The geoserver name does not need to be the same as the table name in the database, but will be by default.
personas Array optional An array of persona ids for the personas that should turn this layer on.
sortOrder Number optional This value is used to order layers in the legend (if there is a legend). If empty, the legend will be sorted alphabetically.
highlightFeatureOnHover Boolean optional If true, polygon features will be highlighted on mouse hover.
zoomToFeatureOnClick Boolean optional If true, clicking on a polygon features will zoom to its extent.
pointStyle Object optional Configures marker style in point layers. Leave empty if the layer is not a point layer. See Point Style Options for details
linePolygonStyle Object optional Used to configure style for lines or polygons. Leave empty if the layer is a point layer. See Line Polygon Options for details
popup Object optional Used to configure the popups for the layer. See Popup Options for details

Point Style Options

Option Type Required Description
markerType String optional Possible values:
"AwesomeMarker": uses font awesome and the icon element below,
"CircleMarker": 6m circle with semi-transparent fill,
Empty or anything else: the default Leaflet blue marker.
icon String optional FontAwesome icon name of the marker when markerType is set to "AwesomeMarker".
markerColor String optional Colour of the marker when markerType is set to "AwesomeMarker" or "CircleMarker". See variable MARKER_COLORS in src/js/map/consts.js to get the list of colours.
cluster Boolean optional If true, Leaflet will use the ClusterMarker plugin up to zoom 17. Beyond zoom 17 the individual markers will be used as defined above. We use a purple cluster style with a level of transparency depending on the size of the cluster.

Line Polygon Options

Option Type Required Description
styleName String Required The styleName will be used to identify the style of the layer. The following options are available:
"default" - The default style can be used with lines and polygons. In this style, you choose the colour and properties of the fill and stroke (see other style properties for more details).
"random polygons" - This option can be chosen for lines and polygons which need to be styled with one colour per object. We do not need to specify the fillcolor since this is done by the function.
stroke Boolean Required Indicates whether polygons have borders.
strokeColor Text Required Color of the stroke. See variable MARKER_COLORS in src/js/map/consts.js to get the list of colours, or enter a hex code string.
opacity Number Required A number between 0 and 1 defining the layer opacity.
fillColor String Required Fill color for polygons. MARKER_COLORS in src/js/map/consts.js to get the list of colours.
fillOpacity Number Required Opacity of the fill between 0 and 1.
weight Number Required Weight of the stroke in pixels.

Popup Options

Option Type Required Description
noPopup Boolean optional If true, no popup will be shown.
title String optional The name of the field to use as the title of the popup window for each record on the map. If omitted the name of the layer will be added (e.g. Parking zones). To remove all titles enter "notitle".
afterTitle String optional An optional string to appear beneath the title in the popup.
fields Array optional A list of field objects to show in the popup with the following properties:
label (String): a label shown in bold before the field value
name (String): geoserver field name (matches the table column name)
afterFields String optional Text to display after the final field.

Troubleshooting

If you have a javascript error and you require more information than what is available in the console, you should set isDist = false in tasks/gulp/compile-assets.js (line 34) and then stop (CTRL+C) and re-run npm start. Please remember to set this back to true when you are ready to build and deploy to production.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

You can’t perform that action at this time.