Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
victory-zoom-container
Advanced tools
victory-zoom-container - npm Package Compare versions
Comparing version 32.1.0 to 32.2.0
| { | ||
| "name": "victory-zoom-container", | ||
| "version": "32.1.0", | ||
| "version": "32.2.0", | ||
| "description": "Interactive Zoom Component for Victory", | ||
@@ -24,3 +24,3 @@ "keywords": [ | ||
| "prop-types": "^15.5.8", | ||
| "victory-core": "^32.1.0" | ||
| "victory-core": "^32.2.0" | ||
| }, | ||
@@ -27,0 +27,0 @@ "scripts": { |
108
README.md
@@ -5,108 +5,4 @@ # VictoryZoomContainer | ||
| View these docs at https://formidable.com/open-source/victory/docs/victory-zoom-container to see live examples. | ||
| To view documentation for `VictoryZoomContainer` please see https://formidable.com/open-source/victory/docs/victory-zoom-container | ||
| `VictoryZoomContainer` provides pan and zoom behavior for any Victory component that works with an | ||
| x, y axis. Zoom events are controlled by scrolling, and panning events are controlled by dragging. | ||
| [See an example of a zoomable chart][] | ||
| `VictoryZoomContainer` may be used with any Victory component that works with an x-y coordinate | ||
| system, and should be added as the `containerComponent` of the top-level component. However, the component that uses it must be standalone | ||
| (`standalone={true}`), which is the default for all top-level Victory components. | ||
| ```playground | ||
| <VictoryChart domainPadding={{ y: 10 }} | ||
| containerComponent={ | ||
| <VictoryZoomContainer/> | ||
| } | ||
| > | ||
| <VictoryScatter | ||
| y={(datum) => Math.sin(2 * Math.PI * datum.x)} | ||
| /> | ||
| </VictoryChart> | ||
| ``` | ||
| ## Props | ||
| `VictoryZoomContainer` uses a superset of props used by [VictoryContainer][]. All props are optional. | ||
| ### allowPan | ||
| `type: boolean` | ||
| The optional `allowPan` prop accepts a boolean that enables the panning functionality. Zooming will still be enabled when the `allowPan` prop is set to false. | ||
| _default:_ `allowPan={true}` | ||
| ### allowZoom | ||
| `type: boolean` | ||
| The optional `allowZoom` prop accepts a boolean that enables the zoom functionality. Panning will still be enabled when the `allowZoom` prop is set to false. | ||
| _default:_ `allowZoom={true}` | ||
| ### clipContainerComponent | ||
| `type: element` | ||
| `VictoryZoomContainer` works by clipping data outside of a given domain. `VictoryZoomContainer` uses `VictoryClipContainer` by default. This prop should not be replaced with a custom component, but you may want to set props on `VictoryClipContainer`, such as `clipPadding` | ||
| _example:_ `clipContainerComponent={<VictoryClipContainer clipPadding={{top: 10, right: 10}}}/>}` | ||
| ### disable | ||
| `type: boolean` | ||
| When the `disable` prop is set to `true`, `VictoryZoomContainer` events will not fire. | ||
| ### downsample | ||
| `type: number || boolean` | ||
| The `downsample` prop limits the number of points that will be displayed. This prop may be given as a boolean or a number corresponding to maximum number of points. When given as a boolean, the maximum number of points that will be plotted is 150. | ||
| ### minimumZoom | ||
| `type: { x: number, y: number }` | ||
| The `minimumZoom` prop sets a minimum domain extent for the zoomed chart. When the difference between | ||
| the maximum and minimum of a zoomed domain is equal to the `minimumZoom` in either dimension, the | ||
| component will stop responding to events that would normally trigger zooming in. Zooming out and | ||
| panning will still be enabled. When this prop is not specified, the default minimum zoom will | ||
| cover 1 / 1000th of the original domain. This prop should be given as an object with numeric values | ||
| for x and y. | ||
| _example:_ `minimumZoom={{x: 1, y: 0.01}}` | ||
| ### onZoomDomainChange | ||
| `type: function` | ||
| The optional `onZoomDomainChange` prop accepts an function to be called on each update to the visible domain. The function accepts the parameters `domain` (the updated domain) and `props` (the props used by `VictoryZoomContainer`). | ||
| _example:_ `onZoomDomainChange={(domain, props) => handleDomainChange(domain, props)}` | ||
| ### zoomDomain | ||
| `type: { x: [low, high], y: [low, high] }` | ||
| The `zoomDomain` prop describes the zoomed state. This prop is an object that | ||
| specifies separate arrays for x and y. Each array is a tuple that describes the minimum and maximum | ||
| values to render. If this prop is not provided initially, the chart will render without an initial | ||
| zoom, displaying the entire dataset. Updates to `zoomDomain` will trigger a re-render of the chart | ||
| with the new domain. | ||
| _example:_ `zoomDomain={{x: [0, 100]}}` | ||
| ### zoomDimension | ||
| `type: "x" || "y"` | ||
| When the `zoomDimension` prop is set, panning and zooming will be restricted to the given dimension | ||
| (either x or y), and the domain of the other dimension will remain static. When this prop is not | ||
| specified, both x and y dimensions will pan and zoom. | ||
| _example:_ `zoomDimension="x"` | ||
| [victorycontainer]: https://formidable.com/open-source/victory/docs/victory-container | ||
| [see an example of a zoomable chart]: https://formidable.com/open-source/victory/guides/brush-and-zoom | ||
| To suggest an addition or correction to this documentation please see https://github.com/FormidableLabs/victory-docs/blob/master/src/content/docs/victory-zoom-container.md |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.32%
1242806
- Number of lines in readme file
- decreased by-93.75%
7
Dependency changes
Updatedvictory-core@^32.2.0