Skip to content

Commit

Permalink
fix(documentation): adapt echarts page
Browse files Browse the repository at this point in the history
  • Loading branch information
jul-lam committed Apr 3, 2024
1 parent 12d350a commit 8b06292
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions packages/documentation/docs/controls/charts/charts.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
import TabItem from '@theme/TabItem';
import Preview from '@site/src/components/Preview';

import SourceEcharts from './../../auto-generated/previews/web-component/echarts.md'
import Playground from '@site/src/components/PlaygroundV2';

# ECharts

Siemens Industrial Experience provides a theme for the popular chart library [ECharts](https://echarts.apache.org/handbook/en/get-started).
This lets you harness the power of ECharts with seamless integration into the Siemens Industrial Experience styleguide.
Siemens Industrial Experience provides a theme for the populer chart library [ECharts](https://echarts.apache.org/handbook/en/get-started).
This lets you harness the power of ECharts with seemless intergration into the Siemens Industrial Experience styleguide.

<div className="siemens-brand-section">

ECharts is a third party library distributed under [Apache License 2.0](https://www.apache.org/licenses).

</div>

### Installation
## Installation

```sh
npm install --save @siemens/ix-echarts
```

Import the module once in your application.
First, import the `registerTheme` function from our module. Then, invoke this function, passing in your `echarts` instance as an argument. You don't need to provide the `echarts` instance if it is provided globally in your `window` object when using vanilla Javascript. Once this is done, you’ll be able to utilize the `brand-dark`, `brand-light`, `classic-dark`, and `classic-light` themes for your chart.

```typescript
import '@siemens/ix-echarts';
import { registerTheme } from '@siemens/ix-echarts';

registerTheme(echarts);
```

## Usage
## Examples

<Preview name="echarts" height="42rem">
<TabItem value="javascript">
<SourceEcharts />
</TabItem>
</Preview>
<Playground
height="40rem"
name="echarts"
noMargin
examplesByName>
</Playground>

0 comments on commit 8b06292

Please sign in to comment.