Skip to content

Commit

Permalink
satisfy md-linter
Browse files Browse the repository at this point in the history
minor language improvements
  • Loading branch information
rpietzsch committed Nov 2, 2023
1 parent be8001a commit 9568a0a
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions docs/explore-and-author/charts-catalog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,57 +12,57 @@ The **Charts Catalog** is a module suitable to visualize your data in a chart.

## Charts Management

You can open the Charts Catalog from the left main menu.
You will see a list of existing chart or the information **Your charts catalog is empty**.
From here you can create a new chart or edit an existing chart.
You can open the Charts Catalog from the main menu on the left.
You will see a list of existing charts or the information **Your charts catalog is empty**.
Here you can create a new chart or edit an existing one.

![](23-03-ChartCreation.gif){ class="bordered" }

After selecting **Create Chart** or an existing Chart you will see the Chart editor which is organized into four components:
After selecting **Create Chart** or an existing Chart, you will see the Chart Editor, which is divided into four components:

### Metadata

You can give your charts a name and a description.

### Query selection

Select a query from the :eccenca-application-queries: [Query Catalog](../query-module/index.md) in order to fetch the data which you want to visualize.
Select a query from the :eccenca-application-queries: [Query Catalog](../query-module/index.md) to retrieve the data you want to visualize.

The following activities can be done in this component:
The following activities can be performed in this component:

- **Select a query** — select a query to visualize by clicking on a :material-plus-circle-outline: button. The Assisted chart form (see below) supports a sinble query, while the Advanced chart form can use multiple queries.
- From the dropdown menu:
- **Parameters** — Some queries have parameters which have to be filled with real values here.
- **Preview** — see a preview of the data that is retrieved.
- **View in query catalog** — open the query in the query catalog.
- **Select a query** — Select a query to visualize by clicking on a :material-plus-circle-outline: button.
The Assisted chart form (see below) supports a single query, while the Advanced chart form can use multiple queries.
- From the dropdown menu:
- **Parameters** — Some queries have parameters that need to be filled with real values.
- **Preview** — View a preview of the retrieved data.
- **View in query catalog** — Opens the query in the query catalog.

### Chart forms

There are two types of forms: __Assisted__ and __Advanced__.
There are two types of forms: **Assisted** and **Advanced**.

The assisted form can be used for the creation of simple chart types such as line, bar, bar-line and pie.
It consists of fields that assist you in visualizing your data.
The assisted form can be used to create simple chart types such as line, bar, bar-line and pie charts.
It consists of fields that help you visualize your data.

The advanced form is totally flexible when it comes to the chart configuration.
The advanced form is completely flexible when it comes to chart configuration.
It consists of a JSON editor that allows you to configure the chart yourself.

For more information about chart configuration and examples, visit the [echarts.apache.org](https://echarts.apache.org/examples/en/index.html).

### Preview

The main content on the right side consists of the preview, where you can see the visual results of your changes in the configuration.
The main content on the right side is the preview, where you can see the visual results of your changes in the configuration.

When using an advanced chart, you will also see a tab with the datasets that were created from the selected queries.

## Charts Integration

You can integrate your charts into existing Node or Property shapes in order to show a charts in the context of a resource.
To do so, add :material-plus-circle-outline: the **Chart Visualization** property to the shape and select the wanted Chart.
You can integrate your charts into existing Node or Property shapes in order to show a chart in the context of a resource.
To do so, add :material-plus-circle-outline: the **Chart Visualization** property to the shape and select the desired Chart.

!!! Note

This means your Chart need to be accessible by the Shape Catalog.
This can be achieved either by copying the chart and query resources to the graph or by import the query catalog graph into the shape catalog.

In order to adapt the Chart in the context of each shown resource, you need to use the placeholder `{{shuiResource}}` in your queries.
This means that your Chart must be accessible from the Shape Catalog.
This can be achieved either by copying the chart and query resources into the Shape Catalog graph or by importing the query catalog graph in the Shape Catalog graph.

To customize the chart in the context of each resource shown, you need to use the placeholder `{{shuiResource}}` in your queries.

0 comments on commit 9568a0a

Please sign in to comment.