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

fix(types): Fix the signature of the tick format callback for timeseries #2676

Closed
wants to merge 1 commit into from

Conversation

stof
Copy link
Contributor

@stof stof commented May 7, 2022

Issue

Details

When running typescript in strict modes, it checks the compatibility of callback signatures.
When using a timeseries axis and passing a date formatting callback for the ticks, it currently returns that error:

assets/js/widget/program-evolution-chart.js:76:15 - error TS2322: Type '(arg0: Date) => string' is not assignable to type 'string | ((this: Chart, x: number | Date) => string | number) | ((this: Chart, index: number, categoryName: string) => string) | undefined'.
  Type '(arg0: Date) => string' is not assignable to type '(this: Chart, x: number | Date) => string | number'.
    Types of parameters 'arg0' and 'x' are incompatible.
      Type 'number | Date' is not assignable to type 'Date'.
        Type 'number' is not assignable to type 'Date'.

76       format: formatDate,
                 ~~~~~~~~~~

The documentation explicitly says that timeseries axis are always passing a Date there, so there is no need to require a callback support both dates and numbers:
image

@coveralls
Copy link

Coverage Status

Coverage increased (+0.06%) to 90.526% when pulling cfdf461 on stof:fix_tick_format into 9a87464 on naver:master.

@netil netil closed this in c9c76e5 May 17, 2022
@netil netil added the type.d Type definition related label May 17, 2022
@netil
Copy link
Member

netil commented May 17, 2022

@stof thanks for the contribution!

@stof stof deleted the fix_tick_format branch May 17, 2022 07:44
github-actions bot pushed a commit that referenced this pull request Jun 9, 2022
# [3.5.0-next.1](3.4.1...3.5.0-next.1) (2022-06-09)

### Bug Fixes

* **bar:** fix bar radius for zero value ([9aa7579](9aa7579)), closes [#2642](#2642)
* **build:** Fix this keyword transpile ([b65531a](b65531a)), closes [#2671](#2671) [#2664](#2664) [#2665](#2665) [#2666](#2666) [#2667](#2667)
* **data:** Fix data label position on inverted axis ([b024d83](b024d83)), closes [#2700](#2700)
* **grid:** Fix y grid to show for log axis type ([d0b8cbd](d0b8cbd)), closes [#2710](#2710)
* **plugin:** fix sparkline dimension & tooltip ([79e1ab7](79e1ab7)), closes [#2682](#2682)
* **plugin:** fix stanford tooltip formatting ([9a87464](9a87464)), closes [#2657](#2657)
* **resize:** Fix legend resize ([7df949b](7df949b)), closes [#2650](#2650)
* **scale:** fix getting tickOffset ([3091677](3091677)), closes [#2669](#2669)
* **size.axis:** fix truncated axis when has no data ([40f4b66](40f4b66)), closes [#2675](#2675)
* **types:** Fix `Chart.load({ json })` typing ([1bd4f4a](1bd4f4a)), closes [#2711](#2711)
* **types:** Fix the signature of the tick format callback for timeseries ([c9c76e5](c9c76e5)), closes [#2676](#2676)
* **types:** Fix the type for options.data.names ([e64f6bd](e64f6bd)), closes [#2677](#2677)
* **types:** Fix types for the tooltip contents callback ([a0c0355](a0c0355)), closes [#2693](#2693)
* **zoom:** fix wheel zoom feeling "stuck" when panning past the edge ([50ed640](50ed640)), closes [#2588](#2588) [#2648](#2648)

### Features

* **data:** Intent to ship data.labels.rotate ([7b7ee08](7b7ee08)), closes [#2662](#2662)
* **module:** Support dual CJS/ESM package ([437c007](437c007)), closes [#2202](#2202)
* **plugin:** Intent to ship TableView plugin ([215b611](215b611)), closes [#1873](#1873)
* **resize:** Intent to ship resize.timer ([#2712](#2712)) ([0a07de0](0a07de0)), closes [#2650](#2650)
github-actions bot pushed a commit that referenced this pull request Jun 30, 2022
# [3.5.0](3.4.1...3.5.0) (2022-06-30)

### Bug Fixes

* **bar:** fix bar radius for zero value ([9aa7579](9aa7579)), closes [#2642](#2642)
* **build:** Fix this keyword transpile ([b65531a](b65531a)), closes [#2671](#2671) [#2664](#2664) [#2665](#2665) [#2666](#2666) [#2667](#2667)
* **data:** Fix data label position on inverted axis ([b024d83](b024d83)), closes [#2700](#2700)
* **grid:** Fix y grid to show for log axis type ([d0b8cbd](d0b8cbd)), closes [#2710](#2710)
* **option:** Fix onresize/onresized call context ([3ef9684](3ef9684)), closes [#2726](#2726)
* **plugin, type:** fix TextOverlap type definition ([80cc3b7](80cc3b7))
* **plugin:** fix sparkline dimension & tooltip ([79e1ab7](79e1ab7)), closes [#2682](#2682)
* **plugin:** fix stanford tooltip formatting ([9a87464](9a87464)), closes [#2657](#2657)
* **resize:** Fix legend resize ([7df949b](7df949b)), closes [#2650](#2650)
* **scale:** fix getting tickOffset ([3091677](3091677)), closes [#2669](#2669)
* **size.axis:** fix truncated axis when has no data ([40f4b66](40f4b66)), closes [#2675](#2675)
* **types:** Fix `Chart.load({ json })` typing ([1bd4f4a](1bd4f4a)), closes [#2711](#2711)
* **types:** Fix the signature of the tick format callback for timeseries ([c9c76e5](c9c76e5)), closes [#2676](#2676)
* **types:** Fix the type for options.data.names ([e64f6bd](e64f6bd)), closes [#2677](#2677)
* **types:** Fix types for the tooltip contents callback ([a0c0355](a0c0355)), closes [#2693](#2693)
* **zoom:** fix wheel zoom feeling "stuck" when panning past the edge ([50ed640](50ed640)), closes [#2588](#2588) [#2648](#2648)

### Features

* **area:** add option to render area below line ([cf60291](cf60291)), closes [#2740](#2740) [#2741](#2741)
* **data:** Intent to ship data.labels.rotate ([7b7ee08](7b7ee08)), closes [#2662](#2662)
* **option:** Intent to ship boost.useCssRule ([4a060d6](4a060d6)), closes [#2716](#2716)
* **option:** Intent to ship boost.useWorker ([eeaf8bd](eeaf8bd))
* **resize:** Intent to ship resize.timer ([#2712](#2712)) ([0a07de0](0a07de0)), closes [#2650](#2650)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.d Type definition related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants