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

Some restructuring of documentation

Browse source
This commit is contained in:
Pieter Vander Vennet 2022-06-19 13:53:24 +02:00
parent 04e3dc5623
commit 806c20ecb4
2 changed files with 30 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

4
UI/Base/Title.ts
View file

@ -26,9 +26,7 @@ export default class Title extends BaseUIElement {
} else if (embedded instanceof FixedUiElement) { } else if (embedded instanceof FixedUiElement) {
innerText = embedded.content innerText = embedded.content
} else { } else {
if (Utils.runningFromConsole) { if (!Utils.runningFromConsole) {
console.log("Not constructing an anchor for title with embedded content of " + embedded)
} else {
innerText = embedded.ConstructElement()?.innerText innerText = embedded.ConstructElement()?.innerText
} }
} }

52
UI/SpecialVisualizations.ts
View file

@ -207,10 +207,12 @@ class NearbyImageVis implements SpecialVisualization {
const nearby = new Lazy(() => { const nearby = new Lazy(() => {
const towardsCenter = new CheckBox(t.onlyTowards, false) const towardsCenter = new CheckBox(t.onlyTowards, false)
const radiusValue= state?.osmConnection?.GetPreference("nearby-images-radius","300").map(s => Number(s), [], i => ""+i) ?? new UIEventSource(300); const radiusValue = state?.osmConnection?.GetPreference("nearby-images-radius", "300").map(s => Number(s), [], i => "" + i) ?? new UIEventSource(300);
const radius = new Slider(25, 500, {value: const radius = new Slider(25, 500, {
radiusValue, step: 25}) value:
radiusValue, step: 25
})
const alreadyInTheImage = AllImageProviders.LoadImagesFor(tagSource) const alreadyInTheImage = AllImageProviders.LoadImagesFor(tagSource)
const options: NearbyImageOptions & { value } = { const options: NearbyImageOptions & { value } = {
lon, lat, lon, lat,
@ -283,29 +285,31 @@ export default class SpecialVisualizations {
public static specialVisualizations: SpecialVisualization[] = SpecialVisualizations.init() public static specialVisualizations: SpecialVisualization[] = SpecialVisualizations.init()
public static DocumentationFor(viz: SpecialVisualization): BaseUIElement {
return new Combine(
[
new Title(viz.funcName, 3),
viz.docs,
viz.args.length > 0 ? new Table(["name", "default", "description"],
viz.args.map(arg => {
let defaultArg = arg.defaultValue ?? "_undefined_"
if (defaultArg == "") {
defaultArg = "_empty string_"
}
return [arg.name, defaultArg, arg.doc];
})
) : undefined,
new Title("Example usage of " + viz.funcName, 4),
new FixedUiElement(
viz.example ?? "`{" + viz.funcName + "(" + viz.args.map(arg => arg.defaultValue).join(",") + ")}`"
).SetClass("literal-code"),
])
}
public static HelpMessage() { public static HelpMessage() {
const helpTexts = const helpTexts = SpecialVisualizations.specialVisualizations.map(viz => SpecialVisualizations.DocumentationFor(viz));
SpecialVisualizations.specialVisualizations.map(viz => new Combine(
[
new Title(viz.funcName, 3),
viz.docs,
viz.args.length > 0 ? new Table(["name", "default", "description"],
viz.args.map(arg => {
let defaultArg = arg.defaultValue ?? "_undefined_"
if (defaultArg == "") {
defaultArg = "_empty string_"
}
return [arg.name, defaultArg, arg.doc];
})
) : undefined,
new Title("Example usage of " + viz.funcName, 4),
new FixedUiElement(
viz.example ?? "`{" + viz.funcName + "(" + viz.args.map(arg => arg.defaultValue).join(",") + ")}`"
).SetClass("literal-code"),
]
));
return new Combine([ return new Combine([
new Combine([ new Combine([