contrapunctus/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Adding documentation

Browse source
This commit is contained in:
Pieter Vander Vennet 2020-07-15 11:23:35 +02:00
parent d293429c68
commit 58bcdbe17a
2 changed files with 42 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

19
Customizations/Layout.ts
View file

@ -17,7 +17,20 @@ export class Layout {
public welcomeTail: string;
public locationContains: string[];
/**
*
* @param name: The name used in the query string. If in the query "quests=<name>" is defined, it will select this layout
* @param title: Will be used in the <title> of the page
* @param layers: The layers to show, a list of LayerDefinitions
* @param startzoom: The initial starting zoom of the map
* @param startLat:The initial starting latitude of the map
* @param startLon: the initial starting longitude of the map
* @param welcomeMessage: This message is shown in the collapsable box on the left
* @param gettingStartedPlzLogin: This is shown below the welcomemessage and wrapped in a login link.
* @param welcomeBackMessage: This is shown when the user is logged in
* @param welcomeTail: This text is shown below the login message. It is ideal for extra help
*/
constructor(
name: string,
title: string,
@ -26,8 +39,8 @@ export class Layout {
startLat: number,
startLon: number,
welcomeMessage: string,
gettingStartedPlzLogin: string,
welcomeBackMessage: string,
gettingStartedPlzLogin: string = "Please login to get started",
welcomeBackMessage: string = "You are logged in. Welcome back!",
welcomeTail: string = ""
) {
this.title = title;