mapcomplete/Customizations/Layout.ts
Pieter Vander Vennet 3f8b6e88d3 Fix deploy
2020-11-06 01:58:26 +01:00

131 lines
4.7 KiB
TypeScript

import {UIElement} from "../UI/UIElement";
import Translations from "../UI/i18n/Translations";
import Combine from "../UI/Base/Combine";
import State from "../State";
import LayerConfig from "./JSON/LayerConfig";
import {LayoutConfigJson} from "./JSON/LayoutConfigJson";
import TagRenderingConfig from "./JSON/TagRenderingConfig";
import {FromJSON} from "./JSON/FromJSON";
import {Translation} from "../UI/i18n/Translation";
import Svg from "../Svg";
import {Img} from "../UI/Img";
/**
* A layout is a collection of settings of the global view (thus: welcome text, title, selection of layers).
*/
export class Layout {
public id: string;
public icon: string = Img.AsData(Svg.bug);
public title: UIElement;
public maintainer: string;
public version: string;
public description: string | UIElement;
public changesetMessage: string;
public socialImage: string = "";
/**
* Custom CSS link
*/
public customCss: string = undefined;
public layers: LayerConfig[];
public welcomeMessage: UIElement;
public gettingStartedPlzLogin: UIElement;
public welcomeBackMessage: UIElement;
public welcomeTail: UIElement;
public supportedLanguages: string[];
public startzoom: number;
public startLon: number;
public startLat: number;
public enableAdd: boolean = true;
public enableUserBadge: boolean = true;
public enableSearch: boolean = true;
public enableLayers: boolean = true;
public enableBackgroundLayers: boolean = true;
public enableMoreQuests: boolean = true;
public enableShareScreen: boolean = true;
public enableGeolocation: 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 static LayoutFromJSON(json: LayoutConfigJson, sharedLayers): Layout {
const tr = FromJSON.Translation;
const layers = json.layers.map(jsonLayer => {
if(typeof jsonLayer === "string"){
return sharedLayers[jsonLayer];
}
return new LayerConfig(jsonLayer, "theme."+json.id);
});
const roaming: TagRenderingConfig[] = json.roamingRenderings?.map((tr, i) =>
new TagRenderingConfig(tr, `theme.${json.id}.roamingRendering[${i}]`)) ?? [];
for (const layer of layers) {
layer.tagRenderings.push(...roaming);
}
const layout = new Layout(
json.id,
typeof (json.language) === "string" ? [json.language] : json.language,
tr(json.title ?? "Title not defined"),
layers,
json.startZoom,
json.startLat,
json.startLon,
new Combine(["<h3>", tr(json.title), "</h3>", tr(json.description)]),
undefined,
undefined,
tr(json.descriptionTail)
);
layout.defaultBackground = json.defaultBackgroundId ?? "osm";
layout.widenFactor = json.widenFactor ?? 0.07;
layout.icon = json.icon;
layout.maintainer = json.maintainer;
layout.version = json.version;
layout.socialImage = json.socialImage;
layout.description = tr(json.shortDescription) ?? tr(json.description)?.FirstSentence();
layout.changesetMessage = json.changesetmessage;
return layout;
}
constructor(
id: string,
supportedLanguages: string[],
title: Translation | string,
layers: LayerConfig[],
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.WT(title)
this.startLon = startLon;
this.startLat = startLat;
this.startzoom = startzoom;
this.id = id;
this.layers = layers;
this.welcomeMessage = Translations.W(welcomeMessage)
this.gettingStartedPlzLogin = Translations.W(gettingStartedPlzLogin);
this.welcomeBackMessage = Translations.W(welcomeBackMessage);
this.welcomeTail = Translations.W(welcomeTail);
}
}