semiotic icon indicating copy to clipboard operation
semiotic copied to clipboard

Create changelog for 2.0

Open willingc opened this issue 3 years ago • 2 comments

This is issue is for explicitly adding discussion and feedback for the changelog.

Related to #556

willingc avatar Dec 23 '21 11:12 willingc

Didn't know where else to leave it but here's a high-level list of the major changes in 2.0 after looking through the commits:

Major Changes

  • React 17 Compatibility - Remove deprecated lifecycle events, transition most components to functional components using hooks
  • RoughJS is now optional
    • You need to import RoughJS (or anything that follows its pattern) and send that as the sketchyRenderingEngine prop of a frame for it to honor the renderMode options that were honored automatically in 1.0
  • Dramatically Improved Build and Tooling ** "Areas" in XYFrame are now "Summaries" which means areas -> summaries, canvasAreas -> canvasSummaries, etc
  • Removed download data functionality

Moderate changes

  • Canvas progressive rendering is improved
    • Progressive rendering can be disabled via the disableProgressiveRendering prop on a frame
  • Trendline can now show the formula as a decoration via showSlope: true in the summary object
  • Pass raw event to interaction events
  • Add IQR viz to violin via iqr: true in the type object
  • Multipart Violin via subsets: fn => { returns filterAppliedOnViolinData } on the summaryType allows you to draw more than one violin plot overlapping on the same column
  • 1.5IQR Outliers for Boxplot via outliers: true on the summaryType that pulls all points outside of 1.5 IQR and draws them as individual points outside the whiskers.
  • Clickable Legend Events
  • lineBounds summaryType in XYFrame (to create bounding regions around a line) takes boundingAccessor (when bounds above and below are the same), topBoundingAccessor and bottomBoundingAccessor to let you draw asymmetric bounding regions around a line.
  • filterRenderedNodes, filterRenderedLines, filterRenderedPoints, filterRenderedSummaries props on NetworkFrame and XYFrame that take a filter function and will apply the filter on the drawn viz after it's been created (useful for filtering Partition layouts and things like that)
  • frameRenderOrder allows you to change the render order of elements in frames (you can even render them twice if you want them to sandwich another layer of elements) takes an array of any or all (with duplicates) of these values: ["axes-tick-lines", "viz-layer", "matte", "axes-labels", "labels"] which you can rearrange.

Originally posted by @emeeks in https://github.com/nteract/semiotic/issues/556#issuecomment-1000021813

willingc avatar Dec 23 '21 11:12 willingc

It probably makes sense to use conventional-changelog to auto-regenerate CHANGELOG.md and have it be a comprehensive history of changes.

To capture these higher level changes, let's create migrate2.mdx doc to highlight steps to migrate along with key changes in different project areas. #590

willingc avatar Dec 23 '21 12:12 willingc