customize forest maps

mapbuilder

MapBuilder


<p>MapBuilder offers several ways to customize an application. Below is information on how to adjust general settings, alternative language settings, data layer and analysis settings, and other settings on your MapBuilder application. This information will enable you to customize the application template by changing specific properties within the application’s code.</p>



<p>Learn how to do more advanced customizations on GitHub <a href="https://github.com/wri/gfw-mapbuilder/wiki" target="_blank" rel="noreferrer noopener">here</a>.</p>



<h2>Adjust general settings</h2>



<p>The general settings allow you to customize items such as the application text, logos, hyperlinks and the web map. These items are the general attributes of the map that you can directly edit using the code. Learn more about these general attributes on GitHub <a href="https://github.com/wri/gfw-mapbuilder/wiki/Plain-Attributes" target="_blank" rel="noreferrer noopener">here</a>.</p>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>Web map</td><td>Web map ID from ArcGIS Online to use in the application.</td><td>String</td><td>“webmap”: “de85e3fcc07948238aa6c1afd2a4eb0”,</td></tr><tr><td>Language</td><td>Identifies the language for the application.</td><td>String</td><td>“language”: “en”,</td></tr><tr><td>Title</td><td>Title for the application.</td><td>String</td><td>“title”: “GFW MapBuilder”,</td></tr><tr><td>Subtitle</td><td>Subtitle for the application.</td><td>String</td><td>“subtitle”: “Make maps that matter”,</td></tr><tr><td>Narrative</td><td>Short description that will be visible in the information tab of the application. Use html tags to edit and customize the formatting of this text.</td><td>String</td><td>“narrative”: “This MapBuilder provides an overview of land use in the DRC”,</td></tr><tr><td>webmapMenuName</td><td>Heading on the menu for a group of data layers that are pulled from the web map.</td><td>String</td><td>“webmapMenuName”: “Land Use”,</td></tr><tr><td>logoURL</td><td>URL for an image of your logo.</td><td>String</td><td>“logoUrl”: “http://my.gfw-mapbuilder.org/img/gfw-logo.png”,</td></tr><tr><td>logolinkURL</td><td>URL for the website your application will link to when your logo is clicked.</td><td>String</td><td>“logoLinkUrl”: “http://globalforestwatch.org/mapbuilder/”,</td></tr><tr><td>aboutLinkUrl (optional)</td><td>Adds an “about” menu item in the header. The link will point to the given URL.</td><td>String</td><td>“aboutLinkUrl”: “http://wri.org”,</td></tr><tr><td>downloadLinkUrl (optional)</td><td>Adds a “download” menu item in the header. Link will point to the given URL. This is useful for linking to an open data portal.</td><td>String</td><td>“aboutLinkUrl”: “http://wri.org”,<br>“downloadLinkUrl”: “http://wri.org”,</td></tr><tr><td>customColorTheme</td><td>Customize the color theme for your application.</td><td>String</td><td>“customColorTheme”: “#F0AB00”,</td></tr></tbody></table></figure>



<h2>Adjust alternative language settings</h2>



<p>Alternative language settings allow you to specify a secondary or alternative language for your MapBuilder application. You can also provide a translated map, title, subtitle, narrative and web map menu name. These settings are only needed if you want to translate your MapBuilder application.</p>



<p>Below are the languages that MapBuilder currently supports.</p>



<ul><li>English (en)</li><li>French (fr)</li><li>Spanish (es)</li><li>Portuguese (pt)</li><li>Indonesian (id)</li><li>Chinese (zh)</li><li>Georgian (ka)</li></ul>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>useAlternativeLanguage (optional)</td><td>If true, then application will be translated into another language.</td><td>Boolean (true or false)</td><td>“useAlternativeLanguage”: false,</td></tr><tr><td>alternativeWebmap (optional)</td><td>Web map ID from ArcGIS Online to use in alternative language.</td><td>Text</td><td>“webmap”: “de85e3fcc0798238aa6c1afd2a4ceb0”,</td></tr><tr><td>alternativeLanguage (optional)</td><td>Identifies alternative language for the application.</td><td>Text</td><td>“language”: “en”,</td></tr><tr><td>alternativeLanguageTitle (optional)</td><td>Title for the application in alternative language.</td><td>Text</td><td>“title”: “GFW MapBuilder”,</td></tr><tr><td>alternativeLanguageSubtitle (optional)</td><td>Subtitle for application in alternative language.</td><td>String</td><td>“subtitle”: “Make maps that matter”,</td></tr><tr><td>alternativeNarrative (optional)</td><td>Short description that will be visible in the information tab of the application in alternative language. Use html tags to edit and customize the formatting of this text.</td><td>String</td><td>“narrative”: “This MapBuilder provides an overview of land use in the DRC”,</td></tr><tr><td>alternativeWebmapMenuName (optional)</td><td>Heading on the menu for a group of data layers that are pulled from the web map in alternative language.</td><td>String</td><td>“webmapMenuName”: “Land Use”,</td></tr></tbody></table></figure>



<h2>Adjust data layer and analysis settings</h2>



<p>Data layer and analysis settings allow you to add and remove data layers from GFW to your MapBuilder application. Some of the data layers from GFW are added to the MapBuilder template by default.</p>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>viirsFires</td><td>If true, then the VIIRS fires data layer from NASA will be included on the map.</td><td>Boolean (true or false)</td><td>“viirsFires”: true,</td></tr><tr><td>modisFires</td><td>If true, then the MODIS fires data layer from NASA will be included on the map.</td><td>Boolean (true or false)</td><td>“modisFires”: true,</td></tr><tr><td>intactForests</td><td>If true, then the Intact Forests Landscapes data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“intactForests”: true,</td></tr><tr><td>aboveGroundBiomass</td><td>If true, then the aboveground biomass data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“aboveGroundBiomass”: true,</td></tr><tr><td>landcover</td><td>If true, then the global land cover data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“landcover”: true,</td></tr><tr><td>mangroves</td><td>If true, then the global mangrove forest data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“mangroves”: true,</td></tr><tr><td>sadAlerts</td><td>If true, then the SAD alerts data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“sadAlerts”: true,</td></tr><tr><td>gladAlerts</td><td>If true, then the GLAD alerts data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“gladAlerts”: true,</td></tr><tr><td>terraIAlerts</td><td>If true, then the Terra-i alerts data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“terraIAlerts”: true,</td></tr></tbody></table></figure>



<h2>Adjust other settings</h2>



<p>Other settings allow for more detailed customization of your MapBuilder application, as well as the ability to connect related MapBuilder applications.</p>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>Iso (optional)</td><td>Three letter ISO code for the country that your application focuses on. Other countries will be masked out.</td><td>Text</td><td>“iso”: “COD”</td></tr><tr><td>hideHeader</td><td>Hide the application header (including logo, title and menu).</td><td>Boolean (true or false)</td><td>“hideHeader”: false,</td></tr><tr><td>hideFooter</td><td>Hide the application footer.</td><td>Boolean (true or false)</td><td>“hideFooter”: false,</td></tr><tr><td>includeDocumentsTab</td><td>Include documents tab on the application.</td><td>Boolean (true or false)</td><td>“includeDocumentsTab”: true,</td></tr><tr><td>mapThemeIds (optional)</td><td>Link several MapBuilder applications together. Copy the ArcGIS Online application ID for another application and paste it into this field to link the applications together. If you want to add multiple IDs, separate them using a semicolon (;) and add a corresponding map theme title for each application in the map themes field.</td><td>String</td><td>“mapThemeIds”: “1c38ba1095fe49e3ba234bf9105c1077;c76d788b7487476bae4d09a4e933be19”,</td></tr><tr><td>mapThemes (optional)</td><td>The map theme field is only necessary if you are connecting several applications together. The map theme indicates the title for your related applications. Make sure the themes are specified in the same order as your map theme IDs. If your application is translated, fill out the “alternativeMapThemes” field with your translated map theme titles.</td><td>String</td><td>“mapThemes”: “Forest Atlas of Cameroon;Forest Atlas of Equatorial Guinea”,</td></tr><tr><td>“alternativeMapThemes” (optional)</td><td>The alternative map themes field is used to indicate the title of your related applications in the application’s secondary language. This is only necessary if you translated your application into a secondary language using the alternative language settings and are using the map themes option to connect related applications.</td><td>String</td><td>“mapThemes”: “Forest Atlas of Cameroon;Forest Atlas of Equatorial Guinea”,</td></tr></tbody></table></figure>


Adjust MapBuilder configuration settings

<p>MapBuilder offers several ways to customize an application. Below is information on how to adjust general settings, alternative language settings, data layer and analysis settings, and other settings on your MapBuilder application. This information will enable you to customize the application template by changing specific properties within the application’s code.</p>



<p>Learn how to do more advanced customizations on GitHub <a href="https://github.com/wri/gfw-mapbuilder/wiki" target="_blank" rel="noreferrer noopener">here</a>.</p>



<h2>Adjust general settings</h2>



<p>The general settings allow you to customize items such as the application text, logos, hyperlinks and the web map. These items are the general attributes of the map that you can directly edit using the code. Learn more about these general attributes on GitHub <a href="https://github.com/wri/gfw-mapbuilder/wiki/Plain-Attributes" target="_blank" rel="noreferrer noopener">here</a>.</p>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>Web map</td><td>Web map ID from ArcGIS Online to use in the application.</td><td>String</td><td>“webmap”: “de85e3fcc07948238aa6c1afd2a4eb0”,</td></tr><tr><td>Language</td><td>Identifies the language for the application.</td><td>String</td><td>“language”: “en”,</td></tr><tr><td>Title</td><td>Title for the application.</td><td>String</td><td>“title”: “GFW MapBuilder”,</td></tr><tr><td>Subtitle</td><td>Subtitle for the application.</td><td>String</td><td>“subtitle”: “Make maps that matter”,</td></tr><tr><td>Narrative</td><td>Short description that will be visible in the information tab of the application. Use html tags to edit and customize the formatting of this text.</td><td>String</td><td>“narrative”: “This MapBuilder provides an overview of land use in the DRC”,</td></tr><tr><td>webmapMenuName</td><td>Heading on the menu for a group of data layers that are pulled from the web map.</td><td>String</td><td>“webmapMenuName”: “Land Use”,</td></tr><tr><td>logoURL</td><td>URL for an image of your logo.</td><td>String</td><td>“logoUrl”: “http://my.gfw-mapbuilder.org/img/gfw-logo.png”,</td></tr><tr><td>logolinkURL</td><td>URL for the website your application will link to when your logo is clicked.</td><td>String</td><td>“logoLinkUrl”: “http://globalforestwatch.org/mapbuilder/”,</td></tr><tr><td>aboutLinkUrl (optional)</td><td>Adds an “about” menu item in the header. The link will point to the given URL.</td><td>String</td><td>“aboutLinkUrl”: “http://wri.org”,</td></tr><tr><td>downloadLinkUrl (optional)</td><td>Adds a “download” menu item in the header. Link will point to the given URL. This is useful for linking to an open data portal.</td><td>String</td><td>“aboutLinkUrl”: “http://wri.org”,<br>“downloadLinkUrl”: “http://wri.org”,</td></tr><tr><td>customColorTheme</td><td>Customize the color theme for your application.</td><td>String</td><td>“customColorTheme”: “#F0AB00”,</td></tr></tbody></table></figure>



<h2>Adjust alternative language settings</h2>



<p>Alternative language settings allow you to specify a secondary or alternative language for your MapBuilder application. You can also provide a translated map, title, subtitle, narrative and web map menu name. These settings are only needed if you want to translate your MapBuilder application.</p>



<p>Below are the languages that MapBuilder currently supports.</p>



<ul><li>English (en)</li><li>French (fr)</li><li>Spanish (es)</li><li>Portuguese (pt)</li><li>Indonesian (id)</li><li>Chinese (zh)</li><li>Georgian (ka)</li></ul>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>useAlternativeLanguage (optional)</td><td>If true, then application will be translated into another language.</td><td>Boolean (true or false)</td><td>“useAlternativeLanguage”: false,</td></tr><tr><td>alternativeWebmap (optional)</td><td>Web map ID from ArcGIS Online to use in alternative language.</td><td>Text</td><td>“webmap”: “de85e3fcc0798238aa6c1afd2a4ceb0”,</td></tr><tr><td>alternativeLanguage (optional)</td><td>Identifies alternative language for the application.</td><td>Text</td><td>“language”: “en”,</td></tr><tr><td>alternativeLanguageTitle (optional)</td><td>Title for the application in alternative language.</td><td>Text</td><td>“title”: “GFW MapBuilder”,</td></tr><tr><td>alternativeLanguageSubtitle (optional)</td><td>Subtitle for application in alternative language.</td><td>String</td><td>“subtitle”: “Make maps that matter”,</td></tr><tr><td>alternativeNarrative (optional)</td><td>Short description that will be visible in the information tab of the application in alternative language. Use html tags to edit and customize the formatting of this text.</td><td>String</td><td>“narrative”: “This MapBuilder provides an overview of land use in the DRC”,</td></tr><tr><td>alternativeWebmapMenuName (optional)</td><td>Heading on the menu for a group of data layers that are pulled from the web map in alternative language.</td><td>String</td><td>“webmapMenuName”: “Land Use”,</td></tr></tbody></table></figure>



<h2>Adjust data layer and analysis settings</h2>



<p>Data layer and analysis settings allow you to add and remove data layers from GFW to your MapBuilder application. Some of the data layers from GFW are added to the MapBuilder template by default.</p>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>viirsFires</td><td>If true, then the VIIRS fires data layer from NASA will be included on the map.</td><td>Boolean (true or false)</td><td>“viirsFires”: true,</td></tr><tr><td>modisFires</td><td>If true, then the MODIS fires data layer from NASA will be included on the map.</td><td>Boolean (true or false)</td><td>“modisFires”: true,</td></tr><tr><td>intactForests</td><td>If true, then the Intact Forests Landscapes data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“intactForests”: true,</td></tr><tr><td>aboveGroundBiomass</td><td>If true, then the aboveground biomass data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“aboveGroundBiomass”: true,</td></tr><tr><td>landcover</td><td>If true, then the global land cover data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“landcover”: true,</td></tr><tr><td>mangroves</td><td>If true, then the global mangrove forest data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“mangroves”: true,</td></tr><tr><td>sadAlerts</td><td>If true, then the SAD alerts data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“sadAlerts”: true,</td></tr><tr><td>gladAlerts</td><td>If true, then the GLAD alerts data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“gladAlerts”: true,</td></tr><tr><td>terraIAlerts</td><td>If true, then the Terra-i alerts data layer will be included on the map.</td><td>Boolean (true or false)</td><td>“terraIAlerts”: true,</td></tr></tbody></table></figure>



<h2>Adjust other settings</h2>



<p>Other settings allow for more detailed customization of your MapBuilder application, as well as the ability to connect related MapBuilder applications.</p>



<figure class="wp-block-table"><table class="has-fixed-layout"><thead><tr><th>Property</th><th>Explanation</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td>Iso (optional)</td><td>Three letter ISO code for the country that your application focuses on. Other countries will be masked out.</td><td>Text</td><td>“iso”: “COD”</td></tr><tr><td>hideHeader</td><td>Hide the application header (including logo, title and menu).</td><td>Boolean (true or false)</td><td>“hideHeader”: false,</td></tr><tr><td>hideFooter</td><td>Hide the application footer.</td><td>Boolean (true or false)</td><td>“hideFooter”: false,</td></tr><tr><td>includeDocumentsTab</td><td>Include documents tab on the application.</td><td>Boolean (true or false)</td><td>“includeDocumentsTab”: true,</td></tr><tr><td>mapThemeIds (optional)</td><td>Link several MapBuilder applications together. Copy the ArcGIS Online application ID for another application and paste it into this field to link the applications together. If you want to add multiple IDs, separate them using a semicolon (;) and add a corresponding map theme title for each application in the map themes field.</td><td>String</td><td>“mapThemeIds”: “1c38ba1095fe49e3ba234bf9105c1077;c76d788b7487476bae4d09a4e933be19”,</td></tr><tr><td>mapThemes (optional)</td><td>The map theme field is only necessary if you are connecting several applications together. The map theme indicates the title for your related applications. Make sure the themes are specified in the same order as your map theme IDs. If your application is translated, fill out the “alternativeMapThemes” field with your translated map theme titles.</td><td>String</td><td>“mapThemes”: “Forest Atlas of Cameroon;Forest Atlas of Equatorial Guinea”,</td></tr><tr><td>“alternativeMapThemes” (optional)</td><td>The alternative map themes field is used to indicate the title of your related applications in the application’s secondary language. This is only necessary if you translated your application into a secondary language using the alternative language settings and are using the map themes option to connect related applications.</td><td>String</td><td>“mapThemes”: “Forest Atlas of Cameroon;Forest Atlas of Equatorial Guinea”,</td></tr></tbody></table></figure>