Path Transparency Observatory (PTO) web frontend
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css
img
js
json
apikey.html
cachedqueries.html
charts.html
footer.html
index.html
license
navbar.html
obssets.html
raw.html
readme.md

readme.md

pto3-web

This project implements a web front end for visualizing data of the PTO 3.

Configuration

The file config.json is the main configuration file for the pto3-web.

directoryQuery

The URL of the query to be used for the directory matrix.

pages

Holds all chart pages that will be available on the website. Each property defines a page.

Key

If the page corresponds to a feature, it's key should be the id of the feature.

linktitle

The text of the link to be displayed in the navigation bar.

pageConfig

The file name of the page configuration file

Page Configuration

Each page defined in config.json is configured in a separate JSON file.

title

The title to be shown in the header of the feature page.

description

The description displayed underneath the title on the feature page.

charts

An array of chart configurations.

Chart Configuration

query

The encoded query of which provides the data for the chart.

title

The title of the chart to be shown in the above the chart.

description

The description of the chart to be shown in the above the chart.

conditions

The conditions which will be shown in this chart. Usually these are all conditions of one aspect in the PTO.

colors

The color for each condition. The key must match a name of a condition.

descriptions

The descriptions for each condition. The key must match a name of a condition.

Query rerun, cache invalidating

All queries can be found in the configuration. If data behind these queries changes, they must be cleared from the PTO cache. When someone with an API Key loads a page with an uncached query, he is asked if he wants to rerun it.

Dependencies

License

MIT