import {UIElement} from "./UIElement"; import {UIEventSource} from "../Logic/UIEventSource"; import {VariableUiElement} from "./Base/VariableUIElement"; import LiveQueryHandler from "../Logic/Web/LiveQueryHandler"; import {ImageCarousel} from "./Image/ImageCarousel"; import Combine from "./Base/Combine"; import {FixedUiElement} from "./Base/FixedUiElement"; import {ImageUploadFlow} from "./Image/ImageUploadFlow"; import ShareButton from "./BigComponents/ShareButton"; import Svg from "../Svg"; import ReviewElement from "./Reviews/ReviewElement"; import MangroveReviews from "../Logic/Web/MangroveReviews"; import Translations from "./i18n/Translations"; import ReviewForm from "./Reviews/ReviewForm"; import OpeningHoursVisualization from "./OpeningHours/OhVisualization"; import State from "../State"; import {ImageSearcher} from "../Logic/Actors/ImageSearcher"; export default class SpecialVisualizations { public static specialVisualizations: { funcName: string, constr: ((state: State,tagSource: UIEventSource, argument: string[]) => UIElement), docs: string, example?: string, args: { name: string, defaultValue?: string, doc: string }[] }[] = [{ funcName: "all_tags", docs: "Prints all key-value pairs of the object - used for debugging", args: [], constr: ((state: State,tags: UIEventSource) => { return new VariableUiElement(tags.map(tags => { const parts = []; for (const key in tags) { parts.push(key + "=" + tags[key]); } return parts.join("
") })).SetStyle("border: 1px solid black; border-radius: 1em;padding:1em;display:block;") }) }, { funcName: "image_carousel", docs: "Creates an image carousel for the given sources. An attempt will be made to guess what source is used. Supported: Wikidata identifiers, Wikipedia pages, Wikimedia categories, IMGUR (with attribution, direct links)", args: [{ name: "image key/prefix", defaultValue: "image", doc: "The keys given to the images, e.g. if image is given, the first picture URL will be added as image, the second as image:0, the third as image:1, etc... " }, { name: "smart search", defaultValue: "true", doc: "Also include images given via 'Wikidata', 'wikimedia_commons' and 'mapillary" }], constr: (state: State,tags, args) => { const imagePrefix = args[0]; const loadSpecial = args[1].toLowerCase() === "true"; const searcher : UIEventSource<{ key: string, url: string }[]> = new ImageSearcher(tags, imagePrefix, loadSpecial); return new ImageCarousel(searcher, tags); } }, { funcName: "image_upload", docs: "Creates a button where a user can upload an image to IMGUR", args: [{ name: "image-key", doc: "Image tag to add the URL to (or image-tag:0, image-tag:1 when multiple images are added)", defaultValue: "image" }], constr: (state: State,tags, args) => { return new ImageUploadFlow(tags, args[0]) } }, { funcName: "reviews", docs: "Adds an overview of the mangrove-reviews of this object. IMPORTANT: the _name_ of the object should be defined for this to work!", args: [{ name: "subject", doc: "The identifier used for this value; by default the name of the reviewed object" }], constr: (state: State,tags, args) => { const tgs = tags.data; let subject = tgs.name ?? ""; if (args[0] !== undefined && args[0] !== "") { subject = args[0]; } if (subject === "") { return Translations.t.reviews.name_required; } const mangrove = MangroveReviews.Get(Number(tgs._lon), Number(tgs._lat), encodeURIComponent(subject), state.mangroveIdentity, state.osmConnection._dryRun ); const form = new ReviewForm((r, whenDone) => mangrove.AddReview(r, whenDone), state.osmConnection.userDetails); return new ReviewElement(mangrove.GetSubjectUri(), mangrove.GetReviews(), form); } }, { funcName: "opening_hours_table", docs: "Creates an opening-hours table. Usage: {opening_hours_table(opening_hours)} to create a table of the tag 'opening_hours'.", args: [{ name: "key", defaultValue: "opening_hours", doc: "The tagkey from which the table is constructed." }], constr: (state: State,tagSource: UIEventSource, args) => { let keyname = args[0]; if (keyname === undefined || keyname === "") { keyname = keyname ?? "opening_hours" } return new OpeningHoursVisualization(tagSource, keyname) } }, { funcName: "live", docs: "Downloads a JSON from the given URL, e.g. '{live(example.org/data.json, shorthand:x.y.z, other:a.b.c, shorthand)}' will download the given file, will create an object {shorthand: json[x][y][z], other: json[a][b][c] out of it and will return 'other' or 'json[a][b][c]. This is made to use in combination with tags, e.g. {live({url}, {url:format}, needed_value)}", example: "{live({url},{url:format},hour)} {live(https://data.mobility.brussels/bike/api/counts/?request=live&featureID=CB2105,hour:data.hour_cnt;day:data.day_cnt;year:data.year_cnt,hour)}", args: [{ name: "Url", doc: "The URL to load" }, { name: "Shorthands", doc: "A list of shorthands, of the format 'shorthandname:path.path.path'. Seperated by ;" }, { name: "path", doc: "The path (or shorthand) that should be returned" }], constr: (state: State,tagSource: UIEventSource, args) => { const url = args[0]; const shorthands = args[1]; const neededValue = args[2]; const source = LiveQueryHandler.FetchLiveData(url, shorthands.split(";")); return new VariableUiElement(source.map(data => data[neededValue] ?? "Loading...")); } }, { funcName: "share_link", docs: "Creates a link that (attempts to) open the native 'share'-screen", example: "{share_link()} to share the current page, {share_link()} to share the given url", args: [ { name: "url", doc: "The url to share (defualt: current URL)", } ], constr: (state: State,tagSource: UIEventSource, args) => { if (window.navigator.share) { const title = state.layoutToUse.data.title.txt; let name = tagSource.data.name; if (name) { name = `${name} (${title})` } else { name = title; } let url = args[0] ?? "" if (url === "") { url = window.location.href } return new ShareButton(Svg.share_ui(), { title: name, url: url, text: state.layoutToUse.data.shortDescription.txt }) } else { return new FixedUiElement("") } } } ] static HelpMessage: UIElement = SpecialVisualizations.GenHelpMessage(); private static GenHelpMessage() { const helpTexts = SpecialVisualizations.specialVisualizations.map(viz => new Combine( [ `

${viz.funcName}

`, viz.docs, "
    ", ...viz.args.map(arg => new Combine([ "
  1. ", "" + arg.name + ": ", arg.doc, arg.defaultValue === undefined ? "" : (" Default: " + arg.defaultValue + ""), "
  2. " ])), "
", "Example usage: ", new FixedUiElement( viz.example ?? "{" + viz.funcName + "(" + viz.args.map(arg => arg.defaultValue).join(",") + ")}" ).SetClass("literal-code"), ] )); return new Combine([ "In a tagrendering, some special values are substituted by an advanced UI-element. This allows advanced features and visualizations to be reused by custom themes or even to query third-party API's.", ...helpTexts ] ); } }