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

Refactoring: add more types to special visualisations arguments

Browse source
This commit is contained in:
Pieter Vander Vennet 2025-08-14 15:54:33 +02:00
parent 0601a9df6f
commit 6bb33771b4
18 changed files with 81 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/UI/Popup/AutoApplyButtonVis.ts
View file

@ -2,6 +2,7 @@ import { Store, Stores, UIEventSource } from "../../Logic/UIEventSource"
import ThemeConfig from "../../Models/ThemeConfig/ThemeConfig"
import { Changes } from "../../Logic/Osm/Changes"
import {
SpecialVisualisationArg,
SpecialVisualization,
SpecialVisualizationState,
SpecialVisualizationSvelte,
@ -31,12 +32,7 @@ export default class AutoApplyButtonVis extends SpecialVisualizationSvelte {
public readonly funcName: string = "auto_apply"
public readonly needsUrls = []
public readonly group = "data_import"
public readonly args: {
name: string
defaultValue?: string
doc: string
required?: boolean
}[] = [
public readonly args: SpecialVisualisationArg[] = [
{
name: "target_layer",
doc: "The layer that the target features will reside in",
@ -54,6 +50,7 @@ export default class AutoApplyButtonVis extends SpecialVisualizationSvelte {
},
{
name: "text",
type:"translation",
doc: "The text to show on the button",
required: true,
},

1
src/UI/Popup/DataVisualisations.ts
View file

@ -302,6 +302,7 @@ class PointsInTimeVis extends SpecialVisualization {
args = [
{
name: "key",
type:"key",
required: true,
doc: "The key out of which the points_in_time will be parsed",
},

1
src/UI/Popup/HistogramViz.ts
View file

@ -14,6 +14,7 @@ export class HistogramViz extends SpecialVisualization {
args = [
{
name: "key",
type:"key",
doc: "The key to be read and to generate a histogram from",
required: true,
},

10
src/UI/Popup/ImportButtons/ConflateImportButtonViz.ts
View file

@ -1,4 +1,4 @@
import { SpecialVisualization, SpecialVisualizationState } from "../../SpecialVisualization"
import { SpecialVisualisationArg, SpecialVisualization, SpecialVisualizationState } from "../../SpecialVisualization"
import { UIEventSource } from "../../../Logic/UIEventSource"
import { Feature, Geometry, LineString, Polygon } from "geojson"
import BaseUIElement from "../../BaseUIElement"
@ -28,15 +28,11 @@ export default class ConflateImportButtonViz extends SpecialVisualization implem
group = "data_import"
public readonly funcName: string = "conflate_button"
public readonly args: {
name: string
defaultValue?: string
doc: string
required?: boolean
}[] = [
public readonly args: SpecialVisualisationArg[] = [
...ImportFlowUtils.generalArguments,
{
name: "way_to_conflate",
type:"key",
doc: "The key, of which the corresponding value is the id of the OSM-way that must be conflated; typically a calculatedTag",
},
]

13
src/UI/Popup/LanguageElement/LanguageElement.ts
View file

@ -10,37 +10,44 @@ export class LanguageElement extends SpecialVisualization {
funcName: string = "language_chooser"
needsUrls = []
docs: string | BaseUIElement =
docs: string =
"The language element allows to show and pick all known (modern) languages. The key can be set"
args: { name: string; defaultValue?: string; doc: string; required?: boolean }[] = [
args: { name: string; defaultValue?: string; doc: string; required?: boolean; type?: string }[] = [
{
name: "key",
required: true,
type:"key",
doc: "What key to use, e.g. `language`, `tactile_writing:braille:language`, ... If a language is supported, the language code will be appended to this key, resulting in `<key>:nl=yes` if _nl_ is picked ",
},
{
name: "question",
required: true,
type: "translation",
doc: "What to ask if no questions are known",
},
{
name: "render_list_item",
type: "translation",
doc: "How a single language will be shown in the list of languages. Use `{language}` to indicate the language (which it must contain).",
defaultValue: "{language()}",
},
{
name: "render_single_language",
type: "translation",
doc: "What will be shown if the feature only supports a single language",
required: true,
},
{
type: "translation",
name: "render_all",
doc: "The full rendering. Use `{list}` to show where the list of languages must come. Optional if mode=single",
doc: "The full rendering. U0se `{list}` to show where the list of languages must come. Optional if mode=single",
defaultValue: "{list()}",
},
{
name: "no_known_languages",
type: "translation",
doc: "The text that is shown if no languages are known for this key. If this text is omitted, the languages will be prompted instead",
},
]

4
src/UI/Popup/MultiApplyViz.ts
View file

@ -19,7 +19,9 @@ export class MultiApplyViz extends SpecialVisualizationSvelte {
doc: "One key (or multiple keys, seperated by ';') of the attribute that should be copied onto the other features.",
required: true,
},
{ name: "text", doc: "The text to show on the button" },
{ name: "text",
type: "translation",
doc: "The text to show on the button" },
{
name: "autoapply",
doc: "A boolean indicating wether this tagging should be applied automatically if the relevant tags on this object are changed. A visual element indicating the multi_apply is still shown",

1
src/UI/Popup/PlantNetDetectionViz.ts
View file

@ -31,6 +31,7 @@ export class PlantNetDetectionViz extends SpecialVisualizationSvelte {
args = [
{
name: "image_key",
type:"key",
defaultValue: AllImageProviders.defaultKeys.join(","),
doc: "The keys given to the images, e.g. if <span class='literal-code'>image</span> is given, the first picture URL will be added as <span class='literal-code'>image</span>, the second as <span class='literal-code'>image:0</span>, the third as <span class='literal-code'>image:1</span>, etc... Multiple values are allowed if ';'-separated ",
},

1
src/UI/Popup/ShareLinkViz.ts
View file

@ -17,6 +17,7 @@ export class ShareLinkViz extends SpecialVisualizationSvelte {
},
{
name: "text",
type:"translation",
doc: "The text to show on the button. If none is given, will act as a titleIcon",
},
]

6
src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts
View file

@ -47,6 +47,7 @@ class MaprouletteSetStatusVis extends SpecialVisualizationSvelte {
args = [
{
name: "message",
type: "translation",
doc: "A message to show to the user",
},
{
@ -56,6 +57,7 @@ class MaprouletteSetStatusVis extends SpecialVisualizationSvelte {
},
{
name: "message_confirm",
type: "translation",
doc: "What to show when the task is closed, either by the user or was already closed.",
},
{
@ -65,11 +67,13 @@ class MaprouletteSetStatusVis extends SpecialVisualizationSvelte {
},
{
name: "maproulette_id",
type:"key",
doc: "The property name containing the maproulette id",
defaultValue: "mr_taskId",
},
{
name: "ask_feedback",
type: "translation",
doc: "If not an empty string, this will be used as question to ask some additional feedback. A text field will be added",
defaultValue: "",
},
@ -106,6 +110,7 @@ class LinkedDataFromWebsite extends SpecialVisualization {
{
name: "key",
defaultValue: "website",
type:"key",
doc: "Attempt to load ld+json from the specified URL. This can be in an embedded <script type='ld+json'>",
},
{
@ -248,6 +253,7 @@ class CompareData extends SpecialVisualization {
{
name: "url",
required: true,
type:"key",
doc: "The attribute containing the url where to fetch more data",
},
{

3
src/UI/SpecialVisualisations/ImageVisualisations.ts
View file

@ -95,8 +95,8 @@ class ImageUpload extends SpecialVisualizationSvelte {
needsUrls = [Constants.panoramax, Constants.osmAuthConfig]
args = [
{
type: "key",
name: "image_key",
type: "key",
doc: "Image tag to add the URL to (or image-tag:0, image-tag:1 when multiple images are added)",
defaultValue: "panoramax",
required: false,
@ -105,6 +105,7 @@ class ImageUpload extends SpecialVisualizationSvelte {
name: "label",
doc: "The text to show on the button",
required: false,
type: "translation"
},
{
name: "disable_blur",

5
src/UI/SpecialVisualisations/NoteVisualisations.ts
View file

@ -28,6 +28,7 @@ class CloseNoteViz extends SpecialVisualizationSvelte {
{
name: "text",
doc: "Text to show on this button",
type: "translation",
required: true,
},
{
@ -39,6 +40,7 @@ class CloseNoteViz extends SpecialVisualizationSvelte {
name: "idkey",
doc: "The property name where the ID of the note to close can be found",
defaultValue: "id",
type:"key"
},
{
name: "comment",
@ -87,6 +89,7 @@ class AddNoteCommentViz extends SpecialVisualizationSvelte {
name: "Id-key",
doc: "The property name where the ID of the note to close can be found",
defaultValue: "id",
type:"key"
},
]
public readonly group = "notes"
@ -129,6 +132,7 @@ class AddImageToNote extends SpecialVisualizationSvelte {
name: "Id-key",
doc: "The property name where the ID of the note to close can be found",
defaultValue: "id",
type:"key"
},
]
group = "notes"
@ -150,6 +154,7 @@ class VisualiseNoteComment extends SpecialVisualization {
name: "commentsKey",
doc: "The property name of the comments, which should be stringified json",
defaultValue: "comments",
type:"key"
},
{
name: "start",

8
src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts
View file

@ -43,6 +43,7 @@ class CreateReview extends SpecialVisualizationSvelte {
{
name: "subjectKey",
defaultValue: "name",
type:"key",
doc: "The key to use to determine the subject. If specified, the subject will be <b>tags[subjectKey]</b>",
},
{
@ -51,6 +52,8 @@ class CreateReview extends SpecialVisualizationSvelte {
},
{
name: "question",
type: "translation",
doc: "The question to ask during the review",
},
]
@ -91,6 +94,7 @@ class ListReview extends SpecialVisualizationSvelte {
{
name: "subjectKey",
defaultValue: "name",
type: "key",
doc: "The key to use to determine the subject. If specified, the subject will be <b>tags[subjectKey]</b>",
},
{
@ -125,6 +129,7 @@ class Rating extends SpecialVisualizationSvelte {
{
name: "subjectKey",
defaultValue: "name",
type:"key",
doc: "The key to use to determine the subject. If the value is specified, the subject will be <b>tags[subjectKey]</b> and will use this to filter the reviews.",
},
{
@ -161,6 +166,7 @@ class ImportMangroveKey extends SpecialVisualizationSvelte {
args = [
{
name: "text",
type: "translation",
doc: "The text that is shown on the button",
},
]
@ -186,6 +192,7 @@ class Reviews extends SpecialVisualization {
{
name: "subjectKey",
defaultValue: "name",
type:"key",
doc: "The key to use to determine the subject. If specified, the subject will be <b>tags[subjectKey]</b>",
},
{
@ -194,6 +201,7 @@ class Reviews extends SpecialVisualization {
},
{
name: "question",
type: "translation",
doc: "The question to ask in the review form. Optional",
},
]

3
src/UI/SpecialVisualisations/SettingsVisualisations.ts
View file

@ -111,6 +111,7 @@ export class ClearCachesVis extends SpecialVisualizationSvelte {
{
name: "text",
required: true,
type: "translation",
doc: "The text to show on the button",
},
]
@ -136,6 +137,7 @@ class LoginButtonVis extends SpecialVisualizationSvelte {
},
{
name: "message",
type: "translation",
doc: "Message to display on the button",
},
]
@ -160,6 +162,7 @@ class QrLogin extends SpecialVisualizationSvelte {
funcName = "qr_login"
args = [
{
type: "translation",
name: "text",
doc: "Extra text on the side of the QR-code",
},

1
src/UI/SpecialVisualisations/TagApplyViz.ts
View file

@ -26,6 +26,7 @@ export default class TagApplyViz extends SpecialVisualization implements AutoAct
},
{
name: "message",
type:"translation",
doc: "The text to show to the contributor",
},
{

2
src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts
View file

@ -27,6 +27,7 @@ class StealViz extends SpecialVisualization {
args = [
{
name: "featureId",
type:"key",
doc: "The key of the attribute which contains the id of the feature from which to use the tags",
required: true,
},
@ -117,6 +118,7 @@ class Multi extends SpecialVisualization {
args = [
{
name: "key",
type:"key",
doc: "The property to read and to interpret as a list of properties",
required: true,
},

6
src/UI/SpecialVisualisations/UISpecialVisualisations.ts
View file

@ -99,6 +99,7 @@ class Minimap extends SpecialVisualizationSvelte {
doc: "The key of one or more properties of the feature, semi-colon separated. The corresponding value is interpreted as either the id or the a list of ID's. The features with these ID's will be shown on this minimap. ",
name: "idKey",
defaultValue: "id",
type:"key"
},
{
name: "class",
@ -203,7 +204,7 @@ class QrCodeVis extends SpecialVisualizationSvelte {
funcName = "qr_code"
args = [
{
name: "text",
name: "text",type:"translation",
doc: "Extra text on the side of the QR-code",
},
{
@ -238,6 +239,7 @@ class IfNothingKnown extends SpecialVisualizationSvelte {
{
name: "text",
doc: "Text to show",
type:"translation",
required: true,
},
{ name: "cssClasses", doc: "Classes to apply onto the text" },
@ -346,6 +348,7 @@ class BracedVis extends SpecialVisualization {
name: "text",
required: true,
doc: "The value to show",
type:"translation"
},
]
@ -373,7 +376,6 @@ class CreateCopyVis extends SpecialVisualizationSvelte {
layer: LayerConfig
): SvelteUIElement {
try {
console.log(">>> create_copy invoked")
return new SvelteUIElement(CreateCopy, { state, tags, argument, feature, layer })
} catch (e) {
console.error(">>> failed", e)

10
src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts
View file

@ -25,6 +25,7 @@ class FediverseLinkVis extends SpecialVisualization {
args = [
{
name: "key",
type:"key",
doc: "The attribute-name containing the link",
required: true,
},
@ -47,6 +48,7 @@ class WikipediaVis extends SpecialVisualization {
args = [
{
name: "keyToShowWikipediaFor",
type:"key",
doc: "Use the wikidata entry from this key to show the wikipedia article for. Multiple keys can be given (separated by ';'), in which case the first matching value is used",
defaultValue: "wikidata;wikipedia",
},
@ -76,6 +78,7 @@ class WikidatalabelVis extends SpecialVisualization {
args = [
{
name: "keyToShowWikidataFor",
type:"key",
doc: "Use the wikidata entry from this key to show the label",
defaultValue: "wikidata",
},
@ -117,21 +120,25 @@ class SendEmailVis extends SpecialVisualizationSvelte {
{
name: "to",
doc: "Who to send the email to?",
type:"key",
required: true,
},
{
name: "subject",
type: "translation",
doc: "The subject of the email",
required: true,
},
{
name: "body",
type: "translation",
doc: "The text in the email",
required: true,
},
{
name: "button_text",
type: "translation",
doc: "The text shown on the button in the UI",
required: true,
},
@ -151,11 +158,12 @@ class LinkVis extends SpecialVisualizationSvelte {
{
name: "text",
doc: "Text to be shown",
type: "translation",
required: true,
},
{
name: "href",
doc: "The URL to link to. Note that this will be URI-encoded before ",
doc: "The URL to link to. Note that this will be URI-encoded before and (as everything) supports substitutions of attributes",
required: true,
},
{

26
src/UI/SpecialVisualization.ts
View file

@ -28,6 +28,7 @@ import FeaturePropertiesStore from "../Logic/FeatureSource/Actors/FeaturePropert
import SvelteUIElement from "./Base/SvelteUIElement"
import { Utils } from "../Utils"
import { ServerSourceInfo } from "../Models/SourceOverview"
import { Translation } from "./i18n/Translation"
/**
* The state needed to render a special Visualisation.
@ -87,9 +88,24 @@ export interface SpecialVisualizationState {
reportError(message: string | Error | XMLHttpRequest, extramessage?: string): Promise<void>
}
export interface SpecialVisualisationArg {
name: string
defaultValue?: string
doc: string
required?: false | boolean
type?: "key" | "translation" | string
}
export class SpecialVisualizationUtils {
}
export abstract class SpecialVisualization {
readonly funcName: string
readonly docs: string | BaseUIElement
readonly docs: string
/**
* The 'group' is merely what association it has in the docs
*/
@ -107,13 +123,7 @@ export abstract class SpecialVisualization {
/**
* Indicates that this special visualisation will make requests to the 'alLNodesDatabase' and that it thus should be included
*/
readonly args: {
name: string
defaultValue?: string
doc: string
required?: false | boolean
type?: "key" | string
}[]
readonly args: SpecialVisualisationArg[]
readonly getLayerDependencies?: (argument: string[]) => string[]
structuredExamples?(): { feature: Feature<Geometry, Record<string, string>>; args: string[] }[]