Skip to content

Commit

Permalink
Merge pull request #149 from eccenca/feature/ChartsCatalog
Browse files Browse the repository at this point in the history
add initial charts catalog documentation
  • Loading branch information
rpietzsch authored Nov 2, 2023
2 parents a2c6218 + 9568a0a commit 7f743e8
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 7 deletions.
5 changes: 3 additions & 2 deletions docs/explore-and-author/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ nav:
- Explore and Author: index.md
- Workspace Selection and Configuration: workspace-configuration
- Graph Exploration: graph-exploration
- Vocabulary Catalog: vocabulary-catalog
- Thesauri Management: thesauri-management
- EasyNav Module: easynav-module
- Query Module: query-module
- Thesauri Management: thesauri-management
- Vocabulary Catalog: vocabulary-catalog
- Charts Catalog: charts-catalog
- Embedding Services via the Integrations Module: embedding-services-via-the-integrations-module

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 68 additions & 0 deletions docs/explore-and-author/charts-catalog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
icon: eccenca/module-charts
status: new
tags:
- KnowledgeGraph
- Dashboards
---

# Charts Catalog and Charts Integration

The **Charts Catalog** is a module suitable to visualize your data in a chart.

## Charts Management

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 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) to retrieve the data you want to visualize.

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 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**.

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 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 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 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 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.
5 changes: 0 additions & 5 deletions docs/explore-and-author/easynav-module/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ tags:

# EasyNav Module

!!! Info

EasyNav is a preview feature, which is disabled by default.
Preview features can be unstable.

## Introduction

This feature allows for the visual exploration of Knowledge Graphs.
Expand Down
1 change: 1 addition & 0 deletions overrides/.icons/eccenca/module-charts.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7f743e8

Please sign in to comment.