mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-08 16:40:30 +08:00
Matthias Hild
00c2478e98
The signature of Transition.styleTween is currently:
styleTween(name: string, tween: (datum: Datum, index: number, attr: string) => Primitive, priority?: string): Transition<Datum>; (line 833)
Note that the tween is said to return a Primitive. This seems incorrect, both in terms of D3 intent and implementation.
The *correct* version appears to be:
styleTween(name: string, tween: (datum: Datum, index: number, attr: string) => (t: number) => Primitive, priority?: string): Transition<Datum>;
(This is similar to similar to Transition.attrTween.)
First, the documentation states:
>>> The return value of tween must be an interpolator: a function that maps a parametric value t in the domain [0,1]
>>> to a color, number or arbitrary value.
Second, the source code of d3 3.5.5 has:
d3_transitionPrototype.styleTween = function(name, tween, priority) {
if (arguments.length < 3) priority = "";
function styleTween(d, i) {
var f = tween.call(this, d, i, d3_window(this).getComputedStyle(this, null).getPropertyValue(name));
return f && function(t) {
this.style.setProperty(name, f(t), priority);
};
}
return this.tween("style." + name, styleTween);
};
Note the line "this.style.setProperty(name, f(t), priority);" where the result f of applying the tween is passed a parameter t.
The only point of discussion might be the type of the return value of the tween's interpolator output. Is it Primitive or any? The documentation quoted above (incidentally the same for attrTween and styleTween) explicitly allows for an arbitrary value. I don't have enough D3 experience to know if this is a practically relevant possibility.
Many thanks for your great work on d3.d.ts!!! Especially the use of tweens and interpolators perfectly illustrates the benefits of Typescript.
Best wishes,
Matthias
DefinitelyTyped 
The repository for high quality TypeScript type definitions.
For more information see the definitelytyped.org website.
Usage
Include a line like this:
/// <reference path="jquery.d.ts" />
Contributions
DefinitelyTyped only works because of contributions by users like you!
Please see the contribution guide on how to contribute to DefinitelyTyped.
How to get the definitions
- Directly from the Github repos
- NuGet packages
- TypeScript Definition manager
List of definitions
- See CONTRIBUTORS.md
Requested definitions
Here is are the currently requested definitions.
Licence
This project is licensed under the MIT license.
Copyrights on the definition files are respective of each contributor listed at the beginning of each definition file.