Commit Graph

8 Commits

Author SHA1 Message Date
Tom Wanzek
59ff802dab [types-2.0] d3-selection and d3-transition JSDoc comments and fixes (#11497)
* d3-selection
* [Chore]: Completed JSDoc comments
* [Chore]: Removed outdated comments
* [Enhancement]: Added some explicit setter signatures, where using the setter with `null` as a value clears the set attribute, style, property
* [Enhancement]: Added explicit possible `null` return value for `touch(...)` if touch cannot, be found for the fiven identifier

* d3-transition and d3-selection
* **[chore](d3-selection)**: Added JSDoc comments for Selection<...> interface and param priority to style(...)
* **[enhancement](d3-selection)**: Started adding some `| null` for strict null checking.  In ValueFn passed into `attr`, `style`, `text`, `html`. Clarifying the ability to clear the respective property when `null` is returned. Also added `| null` to `node()` return type.
* **[chore](d3-transition)**: Added JSDoc comments.
* **[enhancement/fix](d3-transition)**: Updated signatures for `attrTween(...)` and `styleTween(...)` to align them with curent API doc. Added getter, remover and reduced permissible return type for interpolator to `string`. Added getter signature for `tween(...)`
* **[enhancement](d3-transition)**: Added ``| null` in preparation of strict null checking support to ValueFn return types for `attr`, `style`, and `text`. Same with return type for `node()`.
* [BREAKING](d3-transition): Return type of interpolators returned by tween factories in `attr` and `style` has been reduced to `string` as per API doc. (One test was adjusted accordingly)

* d3-transition
* [BREAKING](d3-transition): Fixed signatures for top-level `transition` method. The generics have been updated, as only the datum type in the returned transition needs to be typed. The rest is pre-determined based on a document root selection.
* **[Fix](d3-transition)**: When using an existing transition as an argument, the transition type is not constrained for the argument.
* Adjusted affected tests.

* d3-transition
* [chore](d3-transition): Updated patch version of reference module to 1.0.2
2016-10-03 07:49:43 -07:00
Tom Wanzek
f3cc8644d9 d3-transition
* Relaxed type constraint on existing transition which can be used to create a new transition on a selection. This allows a more general pattern for inheriting /synchronizing e.g. transition timing across multiple different  selections. Updated corresponding  tests.
2016-08-23 11:07:04 -04:00
Tom Wanzek
86baab4f54 d3-selection and version numbers.
* d3-selection: Templated `Local` to allow generic parameter for datum type. Added additonal signatures to `Selection.property(...)` to accept `Local` as first argument. (Thanks to @gustavderdrache for catching these enhancements)
* Updated version numbers header comments to be current.
2016-08-20 13:06:14 -04:00
Tom Wanzek
61e748a7c0 Chores Fixes Enhancements Additions:
* d3-array: Changed name of import alias in test file for consistency with other test files. Deleted excess line at end of definition.
* d3-axis: Enhanced Axis.scale() getter to use generic for refined return type casting. Return type can now be more specific than AxisScale minimal interface compliance. Used `this` as return type for chainable setter methods on Axis.
* d3-brush: Use ValueFn type alias from d3-selection for harmonization of callbacks. Use `this` as return type of chainable setter methods. Fixed return type of BrushBehavior.move(...) to be void
* d3-chord: Use `this` as return type of chainable setter methods.
* d3-collection: Use `this` as return type of chainable setter methods.
* d3-color: Use `this` as return type of chainable setter methods. Added helper interface ColorCommonInstance as a fallback to allow extensibility of color spaces e.g. as through d3-hsv
* d3-dispatch: Use `this` as return type of chainable setter methods.
* d3-drag:  Use ValueFn type alias from d3-selection for harmonization of callbacks. Use `this` as return type of chainable setter methods.
* d3-ease: Removed excess space.
* d3-force: Use `this` as return type of chainable setter methods. Fixed return type of Simulation.tick() to be void. Fixed Force.initialize(...) to be optional when defining a custom force. Enhanced Simulation.force(...) getter to use generic to to cast return type to specific force type, when details are know. Updated related tests.
* d3-hsv: New definitions and tests added
* d3-interpolate: Use ColorCommonInstance to allow more general color spaces than the color space objects defined in d3-color, e.g. d3-hsv. Added related tests.
* d3-quadtree: Use `this` as return type of chainable setter methods.
* d3-scale: Fixed missing support of coercible numeric value as input to ScaleSequential. Use `this` as return type of chainable setter methods.
* d3-selection: Added type alias ValueFn which is used to harmonize callback functions. Use `this` as return type of chainable setter methods, where no new selection is returned. Removed outdated comments.
* d3-selection-multi: Added new definitions with tests.
* d3-shape: Use `this` as return type of chainable setter methods. Removed spurious `?` from callback signatures.
* d3-time: Use `this` as return type of chainable setter methods.
* d3-transition: Added type alias ValueFn which is used to harmonize callback functions. Use `this` as return type of chainable setter methods, where no new transition is returned.
* d3-voronoi: Use `this` as return type of chainable setter methods.
* d3-zoom:  Use `this` as return type of chainable setter methods. Note that ZoomTransform.scale(...) and ZoomTransform.translate(...) return new ZoomTranform objects. Use ValueFn to harmonize callbacks.

Updates the prime for the newly developed D3 version 4 definitions on a file-by-file basis.
2016-08-17 18:20:41 -04:00
Tom Wanzek
e511e4819e Chore + Typo Correction:
* New Line at end.
* No trailing whitespaces (including within commentes.)
* Indenting in accordance with editorconfig.
* Corrected typo in comment in d3-random
2016-07-28 18:32:00 -04:00
Tom Wanzek
4f2dd7b5e5 d3-selection and d3-transition:
* Changes to relax BaseType and remove  unnecessary constraints implied by NodeListOf<...> use. Replaced with new ArrayLike<...> interface were appropriate.
2016-07-21 00:15:06 -04:00
Tom Wanzek
efcf66eb65 Added module versions to the headers.
* Comments for DefinitelyTyped headers now carry reference to D3 module version as of time of drafting.
* Module definitions and tests correspond to the **completed** modules as of release 1.12.0 of repo https://github.com/tomwanzek/d3-v4-definitelytyped
2016-07-20 19:06:02 -04:00
Tom Wanzek
020b196481 Initial commit.
* Based on d3-module definitions and tests for modules completed with tests  as of release v1.11.0 of repo https://github.com/tomwanzek/d3-v4-definitelytyped
* Includes drafts in progress for d3-array, d3-collection, and d3-force. These will be updated before  creating a pull-request for DefinitelyTyped/types-2.0 branch.
2016-07-17 14:16:52 -04:00