Appearance
Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:
md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>Results
Theme Data
{
"nav": [
{
"text": "Home",
"link": "https://chartlayers.com/",
"target": "_self"
},
{
"text": "Installation",
"link": "/Doku/Start/installation.md"
},
{
"text": "Erste Schritte",
"link": "/Doku/Basics/quick-start.md"
}
],
"sidebar": [
{
"text": "Start",
"items": [
{
"text": "Installation",
"link": "/Doku/Start/installation.md"
}
]
},
{
"text": "Chartlayers Basics",
"items": [
{
"text": "1. Template einfügen",
"link": "/Doku/Basics/quick-start.md"
},
{
"text": "2. Template anpassen",
"link": "/Doku/Basics/make-a-copy.md"
},
{
"text": "3. Template erstellen",
"link": "/Doku/Basics/individual-template.md"
}
]
},
{
"text": "Grundstruktur",
"items": [
{
"text": "Template Explorer",
"link": "/Doku/Overview/template-explorer.md"
},
{
"text": "Bibliotheken",
"link": "/Doku/Overview/understanding-libraries.md"
},
{
"text": "Navigation & Shortcuts",
"link": "/Doku/Overview/navigation&shortcuts.md"
}
]
},
{
"text": "Chartlayers Library",
"items": [
{
"text": "Standardvorlagen",
"link": "/Doku/Chartlayers-Library/standardtemplates.md"
},
{
"text": "Diagramme anpassen",
"link": "/Doku/Chartlayers-Library/template-adjustments/template-adjustments-intro.md",
"collapsed": true,
"items": [
{
"text": "Datenreihen und Struktur",
"link": "/Doku/Chartlayers-Library/template-adjustments/data-structure.md"
},
{
"text": "Farben und Schriften",
"link": "/Doku/Chartlayers-Library/template-adjustments/colours.md"
},
{
"text": "Balken, Linien und Achsen",
"link": "/Doku/Chartlayers-Library/template-adjustments/bars,lines and axis copy.md"
},
{
"text": "Stabilität und Performance",
"link": "/Doku/Chartlayers-Library/template-adjustments/performance.md"
}
]
},
{
"text": "Unsere Templates",
"link": "/Doku/Chartlayers-Library/templates/templates-to-follow.md",
"collapsed": true,
"items": [
{
"text": "Balkendiagramme",
"collapsed": true,
"items": [
{
"text": "Mit Highlights",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/template-bar-chart-highlighted/template-bar-chart-highlighted-uberblick.md",
"collapsed": true,
"items": [
{
"text": "Beispiel und Ergebnis",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/template-bar-chart-highlighted/bar-chart-highlighted-beispiel.md"
},
{
"text": "Datenstruktur und Funktionsweise",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/template-bar-chart-highlighted/bar-chart-highlighted-datenstruktur.md"
},
{
"text": "Layout und Formatierung",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/template-bar-chart-highlighted/bar-chart-highlighted-layout.md"
},
{
"text": "Häufige Fehler und Lösungen",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/template-bar-chart-highlighted/bar-chart-highlighted-fehler.md"
}
]
}
]
},
{
"text": "Säulendiagramme",
"collapsed": true,
"items": [
{
"text": "Act vs. Bud",
"link": "/Doku/Chartlayers-Library/templates/column-charts/template-act-vs-plan/template-act-vs-plan-uberblick.md",
"collapsed": true,
"items": [
{
"text": "Beispiel und Ergebnis",
"link": "/Doku/Chartlayers-Library/templates/column-charts/template-act-vs-plan/actplan-beispiel.md"
},
{
"text": "Datenstruktur und Funktionsweise",
"link": "/Doku/Chartlayers-Library/templates/column-charts/template-act-vs-plan/actplan-datenstruktur.md"
},
{
"text": "Layout und Formatierung",
"link": "/Doku/Chartlayers-Library/templates/column-charts/template-act-vs-plan/actplan-layout.md"
},
{
"text": "Häufige Fehler und Lösungen",
"link": "/Doku/Chartlayers-Library/templates/column-charts/template-act-vs-plan/actplan-fehler.md"
}
]
},
{
"text": "Mit Highlights",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-highlighted/template-column-chart-highlighted-uberblick.md",
"collapsed": true,
"items": [
{
"text": "Beispiel und Ergebnis",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-highlighted/column-chart-highlieghted-beispiel.md"
},
{
"text": "Datenstruktur und Funktionsweise",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-highlighted/column-chart-highlighted-data.md"
},
{
"text": "Layout und Formatierung",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-highlighted/column-chart-highlighted-layout.md"
},
{
"text": "Häufige Fehler und Lösungen",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-highlighted/column-chart-highlighted-fehler.md"
}
]
},
{
"text": "Mit Ziellinien",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-targetlines/column-chart-targetlines-uberblick.md",
"collapsed": true,
"items": [
{
"text": "Beispiel und Ergebnis",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-targetlines/column-chart-targetlines-beispiel.md"
},
{
"text": "Datenstruktur und Funktionsweise",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-targetlines/column-chart-targetlines-data.md"
},
{
"text": "Layout und Formatierung",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-targetlines/column-chart-targetlines-layout.md"
},
{
"text": "Häufige Fehler und Lösungen",
"link": "/Doku/Chartlayers-Library/templates/column-charts/column-chart-targetlines/column-chart-targetlines-fehler.md"
}
]
}
]
},
{
"text": "Wasserfalldiagramme",
"collapsed": true,
"items": [
{
"text": "Horizontal",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/waterfall-charts/waterfall-horizontal-uberblick.md",
"collapsed": true,
"items": [
{
"text": "Beispiel und Ergebnis",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/waterfall-charts/waterfall-horizontal-beispiel.md"
},
{
"text": "Datenstruktur und Funktionsweise",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/waterfall-charts/waterfall-horizontal-datenstruktur.md"
},
{
"text": "Layout und Formatierung",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/waterfall-charts/waterfall-horizontal-layout.md"
},
{
"text": "Häufige Fehler und Lösungen",
"link": "/Doku/Chartlayers-Library/templates/bar-charts/waterfall-charts/waterfall-horizontal-fehler.md"
}
]
}
]
}
]
}
]
},
{
"text": "Private Library",
"items": [
{
"text": "Individuelle Anwendung",
"link": "/Doku/Private-Library/private-library-individual-use.md"
},
{
"text": "Vorlagen & Components",
"link": "/Doku/Private-Library/components.md"
},
{
"text": "Kompletter Workflow",
"link": "/Doku/Private-Library/own-template.md"
}
]
},
{
"text": "Hilfe",
"items": [
{
"text": "Starthilfe",
"link": "/Doku/Support/starthelp.md"
},
{
"text": "Enterprise Installation",
"link": "/Doku/Support/enterprise-installation.md"
}
]
}
]
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md"
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.