-
Notifications
You must be signed in to change notification settings - Fork 133
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
[WIP] Add migration guide for 2.0 #591
Draft
willingc
wants to merge
1
commit into
nteract:main
Choose a base branch
from
willingc:migration-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Migrate to Semiotic 2.0 | ||
|
||
**What's New in 2.0** This document outlines the high-level differences between 1.x and 2.0 releases. | ||
For detailed information about changes, see Semiotic's [Change Log](CHANGELOG.md). | ||
|
||
## Installing 2.0 | ||
|
||
TODO: Add installation and a usage example; highlight any non-obvious steps | ||
|
||
## 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) | ||
- send it 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 | ||
- Smaller package sizes | ||
- Faster builds using Parcel | ||
- `Areas` in `XYFrame` are now `Summaries` | ||
- Renamed components and files to `Summaries` | ||
- For example, `canvasAreas` has been renamed to `canvasSummaries` | ||
- Removed download data functionality | ||
|
||
## Improvements | ||
|
||
### Canvas | ||
- Canvas progressive rendering is improved | ||
- Progressive rendering can be disabled via the `disableProgressiveRendering` | ||
prop on a frame | ||
|
||
### Frames | ||
- `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. | ||
- `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) | ||
- `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. | ||
|
||
### Charts | ||
|
||
#### Boxplot chart | ||
|
||
- 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. | ||
|
||
#### Trendline chart | ||
|
||
- Trendline can now show the formula as a decoration via `showSlope: true` | ||
in the summary object | ||
|
||
#### Violin chart | ||
|
||
- Multipart Violin via `subsets: fn => { returns filterAppliedOnViolinData }` | ||
on the `summaryType` allows you to draw more than one violin plot overlapping | ||
on the same column | ||
- Add IQR viz to violin via `iqr: true` in the type object | ||
|
||
### Actions and events | ||
|
||
- Clickable Legend Events | ||
- Pass raw event to interaction events |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed support for IE11