siemens / ix

Siemens Industrial Experience is a design system for designers and developers, to consistently create the perfect digital experience for industrial software products.
https://ix.siemens.io/
MIT License
210 stars 67 forks source link

documentation of echarts #1364

Open IngoSternberg opened 5 months ago

IngoSternberg commented 5 months ago

Prerequisites

Suggestion / feature request

This is regarding the echarts page.

I know you only provide theming for the apache echarts. Still the documentation could be improved to make it easier for us to work with echarts.

For Angular: describe more detailed how to add NgxEcharts in your module file or add a link to such documentation. Also for standalone components tell us that we need to add provideEcharts() to our providers in app.config.ts.

Another thing you could add is an example with real time data. So explain how to use dates as timesteps on the x-axis and how the series items for lines on the y-axis should look. Using the echarts dataset for this would be nice too.

Again, of course that would be duplicate to some apache documentation but I think they did not make this very clear. So it would still be immensely helpful and make Siemens iX easier to use for everyone working with it.

IngoSternberg commented 4 months ago

Another thing I just noticed is that in the Angular example for the echarts the theme switching does not work. If I just do it like it is suggested so in the ts

    theme = convertThemeName(themeSwitcher.getCurrentTheme());

    ngOnInit() {
        registerTheme(echarts);
        themeSwitcher.themeChanged.on((theme: string) => {
            this.theme = theme;
        });
    }

and in the html

   <div echarts [options]="pumpChart" [theme]="theme"></div>

the changing theme is not noticed.

I had to use observables/signals/... to make it work

github-actions[bot] commented 4 months ago

🤖 Hello @IngoSternberg

Your issue will be analyzed and is part of our internal workflow. To get informed about our workflow please checkout the Contributing Guidelines

JIRA: IX-1450