Skip to content

Common interface for tooltip settings #476

Open

Description

@artemipanchuk

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.

Activity

  1. kuzmadom commented on May 8, 2024

    @kuzmadom
    Contributor

    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;
    
  2. korvin89 commented on May 8, 2024

    @korvin89
    Collaborator

    @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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions