forked from MapComplete/MapComplete
		
	
		
			
				
	
	
		
			96 lines
		
	
	
	
		
			3.7 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			96 lines
		
	
	
	
		
			3.7 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
import {LayerDefinition} from "./LayerDefinition";
 | 
						|
import {UIElement} from "../UI/UIElement";
 | 
						|
import Translations from "../UI/i18n/Translations";
 | 
						|
import Combine from "../UI/Base/Combine";
 | 
						|
import {FixedUiElement} from "../UI/Base/FixedUiElement";
 | 
						|
import {State} from "../State";
 | 
						|
 | 
						|
/**
 | 
						|
 * A layout is a collection of settings of the global view (thus: welcome text, title, selection of layers).
 | 
						|
 */
 | 
						|
export class Layout {
 | 
						|
 | 
						|
    public name: string;
 | 
						|
    public icon: string = "./assets/logo.svg";
 | 
						|
    public title: UIElement;
 | 
						|
    public maintainer: string;
 | 
						|
    public version: string;
 | 
						|
    public description: string | UIElement;
 | 
						|
    public changesetMessage: string;
 | 
						|
    public socialImage: string = "";
 | 
						|
    
 | 
						|
    public layers: LayerDefinition[];
 | 
						|
    public welcomeMessage: UIElement;
 | 
						|
    public gettingStartedPlzLogin: UIElement;
 | 
						|
    public welcomeBackMessage: UIElement;
 | 
						|
    public welcomeTail: UIElement;
 | 
						|
 | 
						|
    public startzoom: number;
 | 
						|
    public supportedLanguages: string[];
 | 
						|
    public startLon: number;
 | 
						|
    public startLat: number;
 | 
						|
 | 
						|
    public locationContains: string[];
 | 
						|
 | 
						|
    public enableAdd: boolean = true;
 | 
						|
    public enableUserBadge: boolean = true;
 | 
						|
    public enableSearch: boolean = true;
 | 
						|
    public enableLayers: boolean = true;
 | 
						|
    public enableMoreQuests: boolean = true;
 | 
						|
    public enableShareScreen: boolean = true;
 | 
						|
 | 
						|
    public hideFromOverview: boolean = false;
 | 
						|
 | 
						|
    /**
 | 
						|
     * The BBOX of the currently visible map are widened by this factor, in order to make some panning possible.
 | 
						|
     * This number influences this
 | 
						|
     */
 | 
						|
    public widenFactor: number = 0.07;
 | 
						|
    public defaultBackground: string = "osm";
 | 
						|
    public enableGeolocation: boolean = true;
 | 
						|
 | 
						|
    /**
 | 
						|
     * 
 | 
						|
     * @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,
 | 
						|
        supportedLanguages: string[],
 | 
						|
        title: UIElement | string,
 | 
						|
        layers: LayerDefinition[],
 | 
						|
        startzoom: number,
 | 
						|
        startLat: number,
 | 
						|
        startLon: number,
 | 
						|
        welcomeMessage: UIElement | string,
 | 
						|
        gettingStartedPlzLogin: UIElement | string = new Combine([
 | 
						|
            Translations.t.general.getStartedLogin
 | 
						|
                .SetClass("soft")
 | 
						|
                .onClick(() => {State.state.osmConnection.AttemptLogin()}),
 | 
						|
            Translations.t.general.getStartedNewAccount
 | 
						|
        ]),
 | 
						|
        welcomeBackMessage: UIElement | string = Translations.t.general.welcomeBack,
 | 
						|
        welcomeTail: UIElement | string = ""
 | 
						|
    ) {
 | 
						|
        this.supportedLanguages = supportedLanguages;
 | 
						|
        this.title = Translations.W(title)
 | 
						|
        this.startLon = startLon;
 | 
						|
        this.startLat = startLat;
 | 
						|
        this.startzoom = startzoom;
 | 
						|
        this.name = name;
 | 
						|
        this.layers = layers;
 | 
						|
        this.welcomeMessage = Translations.W(welcomeMessage)
 | 
						|
        this.gettingStartedPlzLogin = Translations.W(gettingStartedPlzLogin);
 | 
						|
        this.welcomeBackMessage = Translations.W(welcomeBackMessage);
 | 
						|
        this.welcomeTail = Translations.W(welcomeTail);
 | 
						|
    }
 | 
						|
}
 | 
						|
 |