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.

Sign up for GitHub

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

Jump to bottom

[highcharts] Implemented changes from v4.2.x => v5.0.10 #17970

Merged
8 commits merged into from
Jul 17, 2017
Merged

[highcharts] Implemented changes from v4.2.x => v5.0.10 #17970

8 commits merged into from
Jul 17, 2017

Conversation

hanssens
Copy link
Contributor

@hanssens hanssens commented Jul 12, 2017 •
edited

Please fill in this template.

  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Test the change in your own code. (Compile and run.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • Increase the version number in the header if appropriate.
  • If you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }.

Author's comments

This implements all changes from Highcharts v4.2.x up until 5.0.10, as documented by the official changelog available at:
https://www.highcharts.com/documentation/changelog

Also note, dtslint breaks locally for me with known issue: "Could not parse version: line is '// TypeScript Version: 2.3'".

Running test/tsc works fine, though. And tests have been updated a lot as well.
Update: dtslint now works fine as well.

Further Remarks:

  • It is a big change, having implemented all Highchart changes of over nearly a year (!). That combined with the pretty large api of Highcharts, there might be a chance I've overlooked something. Despite that I've tried to be as careful as possible.
  • Each version, as described in the changelog, is committed as a seperate commit
  • Version changes without any declaration/definition changes, e.g. 'implementation-only' changes, are omitted
  • Important: please upvote Highcharts issue #4876, which is a request to officially adopt the .d.ts files by the Highcharts team

hanssens and others added 7 commits July 6, 2017 10:38
@hanssens
Merge pull request #1 from DefinitelyTyped/master
01c9c60 
Updated fork with latest from origin
@hanssens
Implemented specs from Highcharts v5.0.0
e478016 
Conform changelog at https://www.highcharts.com/documentation/changelog, implemented the following changes:

	- Added styled mode for optional separation of SVG and CSS.
	- Added responsive option set.
	- Added accessibility option set.
	- Added new function, Chart.update in order to update the chart options after render time.
	- Added new function, Chart.addCredits.
	- Added new function, Chart.title.update.
	- Added new function, Chart.credits.update.
	- Added new function, Legend.update.
	- Added new option, Renderer.definition.
	- Added new option, exporting.error for catching errors in offline exporting.
	- Added new option, exporting.libURL for use with offline exporting.
	- Added new option, pane.background.className.
	- Added new option, xAxis.className.
	- Added new option, xAxis.crosshair.className.
	- Added new option, plotOptions.series.dataLabels.className.
	- Added new option, plotOptions.series.className for styling individual series.
	- Added new option, xAxis.plotBands.className.
	- Added new option, xAxis.plotLines.className.
	- Added new option, plotOptions.series.zones.className.
	- Added new option, chart.colorCount for use in styled mode.
	- Added new option, defs for defining reusable elements in styled mode.
	- Added new option, tooltip.padding.
	- Added new option, series<line>.data.colorIndex for coloring points in styled mode.
	- Added new option, tooltip.split.
	- Added new option, chart.description for use with the accessibility module.
	- Added new option, chart.typeDescription for use with the accessibility module.
	- Added new option, xAxis.description for use with the accessibility module.
	- Added new option, plotOptions.series.description for use with the accessibility module.
	- Refactored build system to use ES6 imports and node-based build script.
	- Changed all default colors (except series data colors) to a simplified color scheme based on just a few shared colors.

Additional improvements (found throughout the documentation):

	- Changed reference from `color?: string` to `color?: Color` throughout the different Options objects (this broke Typescript intellisense before)
	- ChartObject.xAxis now accepts also a single AxisObject, as well as Array<AxisObject>
	- ChartObject.yAxis now accepts also a single AxisObject, as well as Array<AxisObject>
	- Important: a handful changes already implemented by community contributors are left alone
@hanssens
Implemented specs from Highcharts 5.0.1 (2016-10-26)
d80fadd 
Conform changelog at https://www.highcharts.com/documentation/changelog, implemented the following changes:
    - Added new options, axis.softMin and axis.softMax.

No further documentation linked on the following subjects/changes (= ignored):

	- Added Legend keyboard navigation to the accessibility module.
	- Added animation on hovering point markers.
	- Added offline PDF export support.
@hanssens
Implemented Highcharts 5.0.3 (2016-11-18)
75dad45 
- Added new option, lang.numericSymbolMagnitude, to support numeric symbol shortening in Japanese, Korean and certain Chinese locales.
- Added new option, threshold, for solid gauge series.
- Added new CSS custom property, textOutline, and at the same time removed the textShadow shim. Closes DefinitelyTyped#5849.

Ignored due to being implementation-only, or lack of documentation:

- Better implementation of the chart.pinchType option. Allow pinchType and zoomType to be set independently. When tooltip.followTouchMove is true, pinchType only applies to two-finger touches. Closes DefinitelyTyped#5840.
- Changed the Highcharts.addEvent function to return a callback to be used to remove the same event.
- Implemented bubbles in the Boost module.
- Improved alignment of ticks on multiple axes by allowing ticks to be placed at less strict intervals.
- Refactored split tooltip connectors to use common callback shape instead.
@hanssens
Highcharts 5.0.7 (2017-01-17)
4eeb793 
- Added new option, global.timezone, as a convenient shortcut to timezones defined with moment.js.
- Changed the Highcharts.error function to handle strings.

Ignored due to being implementation-only, or lack of documentation:

- Added Legend keyboard navigation to accessibility module.
- Added chart render and predraw events needed by the new Boost module.
- Added optional redraw to drillToNode, related to DefinitelyTyped#6180.
- Added support for marker.symbol setting on bubble charts.
- Changed the Highcharts.addEvent function to return a callback to be used to remove the same event.
@hanssens
Highcharts 5.0.8 (2017-03-08)
a0b0bcc 
Conform changelog at https://www.highcharts.com/documentation/changelog, implemented the following changes:

- Added animation on graph mouse over and mouse out.
- Added new option, solidgauge.rounded.
- Added support for relative chart.height as a percentage of the width. This allows for fixed aspect ratio.

Ignored due to being implementation-only, or lack of documentation:

- Added a refactored Boost module based on WebGL. Details and API to be announced.
- Added hooks so that users can define their own log axis conversion functions, and can advertise that the log axis should allow negative values.
@hanssens
Highcharts 5.0.10 (2017-03-31)
4f4c5ca 
Conform changelog at https://www.highcharts.com/documentation/changelog, implemented the following changes:

- Added new option, plotOptions.column.crisp, to allow disabling crisp columns and subsequent rendering issues with densely packed items. Closes DefinitelyTyped#5755.
- Added new option, findNearestPointBy to declare how the tooltip searches for points. DefinitelyTyped#6231.

Ignored due to being implementation-only, or lack of documentation:

- Added !default statement to SASS variables for easier configuration. Closes DefinitelyTyped#6436.
- Refactored the Pane object to keep track of its own backgrounds, more decoupled from Axis.
@dt-bot
Copy link
Member

dt-bot commented Jul 12, 2017

types/highcharts/index.d.ts

to authors (@damianog @baltie @AlbertOzimek). Could you review this PR?
👍 or 👎?

Checklist

  • pass the Travis CI test?

@hanssens
Fixed dtslint warnings and errors for CI
c36ecea 
This fixes all tslint/dtslint errors, incl. historic errors. #vanity

- Fixed: Array type using 'Array<T>' is forbidden for simple types. Use 'T[]' instead.
- Fixed: Exceeds maximum line length of 200
- Fixed: trailing whitespace
- Fixed: missing semicolon
- Fixed: Consecutive blank lines are forbidden
- Fixed: non-arrow functions are forbidden
- Fixed: missing whitespace
- Fixed: Don't leave a blank line before/after '{' / '}'
- Fixed: Do not use 'var'
@hanssens
Copy link
Contributor Author

^ As can be seen in the (minor) update above, I've also fixed all dtslint errors.
See previous comments for the entire changelog comments.

Would love any feedback!

This was referenced Jul 12, 2017
Closed
Closed
@hanssens hanssens changed the title Implemented Highcharts changes from v4.2.x => v5.0.10 [highcharts] Implemented changes from v4.2.x => v5.0.10 Jul 14, 2017
@typescript-bot
Copy link
Contributor

This PR has been open and unchanged 5 days without signoff or complaint. This will be merged by a maintainer soon if there are no objections.

@typescript-bot typescript-bot added the Unmerged The author did not merge the PR when it was ready. label Jul 17, 2017
@ghost
Copy link

ghost commented Jul 17, 2017

Thanks!

@ghost ghost merged commit fc32c19 into DefinitelyTyped:master Jul 17, 2017
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Unmerged The author did not merge the PR when it was ready.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@hanssens @dt-bot @typescript-bot