Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Common interface for tooltip settings #476

Open
artemipanchuk opened this issue May 8, 2024 · 2 comments
Open

Common interface for tooltip settings #476

artemipanchuk opened this issue May 8, 2024 · 2 comments

Comments

@artemipanchuk
Copy link
Contributor

We have an idea to create common tooltip settings interface.

Currently, tooltip settings is somehow declared as part of existing widgets:
https://github.com/gravity-ui/chartkit/blob/main/src/plugins/highcharts/types/widget.ts#L52
image

This means, that we need to prepare these settings according to widget plugin we are using.

It would be better to use common interface, independent on type of widget or plugin we are going to use.

In the meantime we should limit number of places, where tooltip settings can be set.

Currently, we can set tooltip settings in each series and globally for widget for Highcharts:
https://github.com/gravity-ui/chartkit/blob/main/src/plugins/highcharts/types/widget.ts#L52

Places where tooltip settings can be set must be same for each widget type and plugin.

@kuzmadom
Copy link
Contributor

kuzmadom commented May 8, 2024

It should be possible to specify formatting settings such as:

    numberFormat?: 'number' | 'percent';
    postfix?: string;
    prefix?: string;
    precision?: number | 'auto';
    showRankDelimiter?: boolean;
    unit?: 'auto' | 'k' | 'm' | 'b' | 't' | null;

@korvin89
Copy link
Collaborator

korvin89 commented May 8, 2024

@artemipanchuk @kuzmadom What do you think about using this interface?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants