From b54ab8ab243770e4e04ab04e1161713925c52008 Mon Sep 17 00:00:00 2001 From: Chris Chua Date: Fri, 29 May 2020 05:10:09 -0700 Subject: [PATCH] Revert "docs(readme): add depreaction message (#1302)" (#1334) This reverts commit 0e74ad76d70bc2544e4314971926bbef4edb7e2b. --- DEPRECATED.md | 5 --- README.md | 2 - docs/animation.md | 2 - docs/arc-series.md | 2 - docs/area-series.md | 2 - docs/axes.md | 2 - docs/bar-series.md | 4 +- docs/borders.md | 2 - docs/chart-label.md | 2 - docs/colors.md | 2 - docs/contour-series.md | 2 - docs/crosshair.md | 2 - docs/custom-svg-series.md | 2 - docs/decorative-axis.md | 3 -- docs/flexible-plots.md | 2 - docs/getting-started/getting-started.md | 18 ++++----- docs/getting-started/installing-react-vis.md | 4 +- docs/getting-started/new-react-vis-project.md | 12 +++--- docs/getting-started/react-vis-in-codepen.md | 4 +- docs/getting-started/your-first-chart.md | 4 +- docs/gradients.md | 2 - docs/grids.md | 2 - docs/heatmap-series.md | 2 - docs/hexbin-series.md | 2 - docs/highlight.md | 2 - docs/hint.md | 2 - docs/interaction.md | 2 - docs/label-series.md | 2 - docs/legends.md | 3 -- docs/line-mark-series.md | 2 - docs/line-series.md | 2 - docs/mark-series.md | 2 - docs/parallel-coordinates.md | 2 - docs/polygon-series.md | 3 -- docs/radar-chart.md | 4 +- docs/radial-chart.md | 2 - docs/rect-series.md | 2 - docs/sankey.md | 2 - docs/scales-and-data.md | 38 +++++++++---------- docs/series.md | 2 - docs/style.md | 2 - docs/sunburst.md | 2 - docs/treemap.md | 2 - docs/voronoi.md | 2 - docs/whisker-series.md | 2 - docs/xy-plot.md | 2 - 46 files changed, 36 insertions(+), 134 deletions(-) delete mode 100644 DEPRECATED.md diff --git a/DEPRECATED.md b/DEPRECATED.md deleted file mode 100644 index 06159b9c2..000000000 --- a/DEPRECATED.md +++ /dev/null @@ -1,5 +0,0 @@ -# Deprecated - -Unfortunately, `react-vis` currently has no active maintainers. As such, we have decided to deprecate the library. This deprecation means that `react-vis` won't receive any patches or new features. If you're interested to take on ownership, please discuss on #1303. Anyone is welcome to fork this library. - -We're working on a new charting library that we'll introduce in 2020. We will keep you folks updated on this repo on the new library! diff --git a/README.md b/README.md index 40060029d..837b92c5c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. -

version diff --git a/docs/animation.md b/docs/animation.md index 5d1d067af..2e32fa3c9 100644 --- a/docs/animation.md +++ b/docs/animation.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Animation Animation makes your charts feel physical, it makes them feel alive, shoot it makes them feel l33t. `react-vis` offers a simple portal into the [react-motion](https://github.com/chenglou/react-motion) animation system by exposing a simple animation prop on most components! This prop accepts three types of values: diff --git a/docs/arc-series.md b/docs/arc-series.md index 3ca9cb0b0..55a70f04c 100644 --- a/docs/arc-series.md +++ b/docs/arc-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## ArcSeries: diff --git a/docs/area-series.md b/docs/area-series.md index 98623f97f..cf7335767 100644 --- a/docs/area-series.md +++ b/docs/area-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # AreaSeries diff --git a/docs/axes.md b/docs/axes.md index 5c1109184..9b01df86b 100644 --- a/docs/axes.md +++ b/docs/axes.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Axes diff --git a/docs/bar-series.md b/docs/bar-series.md index d5067b510..3c2ee645d 100644 --- a/docs/bar-series.md +++ b/docs/bar-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Bar Series **TLDR**: use bar series to make bar charts, but not histograms. @@ -130,7 +128,7 @@ A list of CSS properties to style the series outside of the explicitly set prope #### barWidth Type: `Number` -The percentage for which each bar fills the designated bucket. 1.0 means that the bar fills the whole bucket (no padding between bars), while a +The percentage for which each bar fills the designated bucket. 1.0 means that the bar fills the whole bucket (no padding between bars), while a smaller percentage means more whitespace between the bars. ## Interaction handlers diff --git a/docs/borders.md b/docs/borders.md index 12e48311a..0a5c9d0fb 100644 --- a/docs/borders.md +++ b/docs/borders.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Borders Sometimes when modifying the domain of the XYPlot it can be useful to enforce a border, so that some components appear, and others do not. One way to do this is to use the `Borders` component. It is a simple component that creates rectangles the directly correspond to the margins of the plot. diff --git a/docs/chart-label.md b/docs/chart-label.md index 7982196e6..ea1734924 100644 --- a/docs/chart-label.md +++ b/docs/chart-label.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## ChartLabel When you are styling your chart sometimes you just want to take complete control of label placements. Maybe you want to annotate something, or maybe you just want to place your axis labels in a very specific place, ChartLabel allows you to do just that. Let's look at an example: diff --git a/docs/colors.md b/docs/colors.md index 8fd96fe43..9edb51bb6 100644 --- a/docs/colors.md +++ b/docs/colors.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Color Color can be set and affected in many ways in React-vis. diff --git a/docs/contour-series.md b/docs/contour-series.md index d213ea99d..d68fa34fa 100644 --- a/docs/contour-series.md +++ b/docs/contour-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## ContourSeries The contour series allows for the easy creation of contour density plots. These can be more effective for visualizing heat map data than a rectangular heat map! Given a number of points in a space the relative contour lines are computed, so as to simplify the output into a more legible format! diff --git a/docs/crosshair.md b/docs/crosshair.md index e5c7c6969..05f4d9bcc 100644 --- a/docs/crosshair.md +++ b/docs/crosshair.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Crosshair diff --git a/docs/custom-svg-series.md b/docs/custom-svg-series.md index 780f8fc43..294115317 100644 --- a/docs/custom-svg-series.md +++ b/docs/custom-svg-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## CustomSVGSeries When creating visualizations, it is sometimes necessary to get your hands dirty and completely take control over what SVG components will be shown. This could be necessary in situations where you have predefined SVG code that you just want to appear the way you drew it in Sketch (but positioned using coordinates), or maybe you have multiline text annotations that you want to formatted in a particular way, or you just want to use an alternative type of mark instead of the usual scatterplot mark to differentiate series in a set. To serve these and many other tasks, we use the CustomSVGSeries. diff --git a/docs/decorative-axis.md b/docs/decorative-axis.md index d418567f3..96866b50b 100644 --- a/docs/decorative-axis.md +++ b/docs/decorative-axis.md @@ -1,6 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. -> This library is deprecated. Please see `DEPRECATED.md`. - ## DecorativeAxis diff --git a/docs/flexible-plots.md b/docs/flexible-plots.md index 2d1d1ac2c..138aa12a6 100644 --- a/docs/flexible-plots.md +++ b/docs/flexible-plots.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Flexible plots By default, XYPlot requires a width and a height. There are times, however, when you'd like your chart to take all the space it can. diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index 4c3aa05fe..2512b39a9 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -1,10 +1,8 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ### Getting started #### Jump right in on codepen! -You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent). +You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent). Each published version of react-vis is accessible via [unpkg.com](https://unpkg.com). Add react files, and a link to the latest react-vis version - such as https://unpkg.com/react-vis@1.6.7/dist/dist.min.js. @@ -13,7 +11,7 @@ But you can simply just use that [pen](https://codepen.io/ubervisualization/pen/ #### Install the react-vis module -If you want to use react-vis in your project, add it from the command line: +If you want to use react-vis in your project, add it from the command line: ``` npm install react-vis @@ -24,9 +22,9 @@ npm install react-vis #### Create a new project with react-vis Let's create a new vis app from scratch. -To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold. +To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold. -If you haven't installed yet, do so: +If you haven't installed yet, do so: ``` npm install -g create-react-app @@ -39,9 +37,9 @@ cd my-awesome-vis-app npm install react-vis ``` -That's it! you are now ready to create amazing charts. +That's it! you are now ready to create amazing charts. -Let's edit create-react-app's default App.js: +Let's edit create-react-app's default App.js: ```jsx import React, { Component } from 'react'; @@ -82,13 +80,13 @@ and then on the command line interface: npm run start ``` -and your chart is in the browser. +and your chart is in the browser. Note that on line 3, I have imported the react-vis stylesheet. There are many ways to do that, and it is actually optional. But apps made with create-react-app will let you import stylesheets directly, so that's a simple way to do so. #### Your first chart -We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children. +We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children. Every react-vis chart is inside a component called XYPlot, for which a height and a width must be specified: diff --git a/docs/getting-started/installing-react-vis.md b/docs/getting-started/installing-react-vis.md index f638e0ed0..b7a6e48d8 100644 --- a/docs/getting-started/installing-react-vis.md +++ b/docs/getting-started/installing-react-vis.md @@ -1,8 +1,6 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ### Install the react-vis module -If you want to use react-vis in your project, add it from the command line: +If you want to use react-vis in your project, add it from the command line: ``` npm install react-vis diff --git a/docs/getting-started/new-react-vis-project.md b/docs/getting-started/new-react-vis-project.md index 344c83b09..f3a6d5e59 100644 --- a/docs/getting-started/new-react-vis-project.md +++ b/docs/getting-started/new-react-vis-project.md @@ -1,11 +1,9 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ### Create a new project with react-vis Let's create a new vis app from scratch. -To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold. +To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold. -If you haven't installed yet, do so: +If you haven't installed yet, do so: ``` npm install -g create-react-app @@ -18,9 +16,9 @@ cd my-awesome-vis-app npm install react-vis ``` -That's it! you are now ready to create amazing charts. +That's it! you are now ready to create amazing charts. -Let's edit create-react-app's default App.js: +Let's edit create-react-app's default App.js: ```jsx import React, { Component } from 'react'; @@ -61,6 +59,6 @@ and then on the command line interface: npm run start ``` -and your chart is in the browser. +and your chart is in the browser. Note that on line 3, I have imported the react-vis stylesheet. There are many ways to do that, and it is actually optional. But apps made with create-react-app will let you import stylesheets directly, so that's a simple way to do so. diff --git a/docs/getting-started/react-vis-in-codepen.md b/docs/getting-started/react-vis-in-codepen.md index 329dfe452..46fa4ff5a 100644 --- a/docs/getting-started/react-vis-in-codepen.md +++ b/docs/getting-started/react-vis-in-codepen.md @@ -1,8 +1,6 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ### Jump right in on codepen! -You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent). +You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent). Each published version of react-vis is accessible via [unpkg.com](https://unpkg.com). Add react files, and a link to the latest react-vis version - such as https://unpkg.com/react-vis@1.6.7/dist/dist.min.js. diff --git a/docs/getting-started/your-first-chart.md b/docs/getting-started/your-first-chart.md index 2aa1f1820..43cf71715 100644 --- a/docs/getting-started/your-first-chart.md +++ b/docs/getting-started/your-first-chart.md @@ -1,8 +1,6 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ### Your first chart -We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children. +We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children. Every react-vis chart is inside a component called XYPlot, for which a height and a width must be specified: diff --git a/docs/gradients.md b/docs/gradients.md index ac06b4b76..27ef37238 100644 --- a/docs/gradients.md +++ b/docs/gradients.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Gradient Sometimes it is useful to style our svg components using gradients. The way that this is done in React-vis is by making use of the GradientDefs component, which is a simple wrapper on the svg tag. diff --git a/docs/grids.md b/docs/grids.md index 8d716bb30..168820376 100644 --- a/docs/grids.md +++ b/docs/grids.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Cartesian Grids diff --git a/docs/heatmap-series.md b/docs/heatmap-series.md index f0ed2ea99..71b081d4c 100644 --- a/docs/heatmap-series.md +++ b/docs/heatmap-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## HeatmapSeries: diff --git a/docs/hexbin-series.md b/docs/hexbin-series.md index ab76f1faa..ec297a580 100644 --- a/docs/hexbin-series.md +++ b/docs/hexbin-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## HexbinSeries The hexbin series enables the easy creation of aggregated and binned data. This can be useful if you have a lot of overlapping data or if you simply want to provide a courser representation of data to your user. Unlike many other series this one performs the aggregation computation, simply provide a scatterplot like collection of data (points in linear x and y space) and your off! diff --git a/docs/highlight.md b/docs/highlight.md index ffee3f359..77036599b 100644 --- a/docs/highlight.md +++ b/docs/highlight.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Highlight The highlight component enables use interaction via direct manipulation of chart through dragging and brushing. This component is stateful and can maintain a notion of a dragged box. It can be applied either in two directions or in one! diff --git a/docs/hint.md b/docs/hint.md index 8cb1879e1..d9ce62b98 100644 --- a/docs/hint.md +++ b/docs/hint.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Hint diff --git a/docs/interaction.md b/docs/interaction.md index ad37459ea..9586fcc35 100644 --- a/docs/interaction.md +++ b/docs/interaction.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Interaction Interaction in react-vis happens through _event handlers_ which are triggered by certain interactive events, such as mouse movement or clicks. diff --git a/docs/label-series.md b/docs/label-series.md index b6be67875..8430d53e9 100644 --- a/docs/label-series.md +++ b/docs/label-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## LabelSeries: diff --git a/docs/legends.md b/docs/legends.md index 630501ad9..c5ba456ef 100644 --- a/docs/legends.md +++ b/docs/legends.md @@ -1,6 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. -> This library is deprecated. Please see `DEPRECATED.md`. - ## Legends diff --git a/docs/line-mark-series.md b/docs/line-mark-series.md index b27033c5b..8632e60e6 100644 --- a/docs/line-mark-series.md +++ b/docs/line-mark-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # LineMarkSeries The Line Mark series is a combination of a LineSeries and a MarkSeries: under the hood, it creates both a LineSeries and a MarkSeries and passes them all of its properties. diff --git a/docs/line-series.md b/docs/line-series.md index 3db69bf2d..f5ffc945f 100644 --- a/docs/line-series.md +++ b/docs/line-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # LineSeries/LineMarkSeries diff --git a/docs/mark-series.md b/docs/mark-series.md index 95ba5ab14..62b48627e 100644 --- a/docs/mark-series.md +++ b/docs/mark-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## MarkSeries & MarkSeriesCanvas diff --git a/docs/parallel-coordinates.md b/docs/parallel-coordinates.md index 1236d9df8..1b8f74148 100644 --- a/docs/parallel-coordinates.md +++ b/docs/parallel-coordinates.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Parallel Coordinates Parallel Coordinates provide a robust method for displaying many variables simultaneously. It allows for rapid at-a-glance comparisons across a bunch of dimensions. These graphics can effectively be used either with several data rows on a single chart (as below) or as a small multiple. For more information, check out the [Wiki](https://en.wikipedia.org/wiki/Parallel_coordinates), it's got some really neat examples. diff --git a/docs/polygon-series.md b/docs/polygon-series.md index 45e80b652..15c30d3e8 100644 --- a/docs/polygon-series.md +++ b/docs/polygon-series.md @@ -1,6 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. -> This library is deprecated. Please see `DEPRECATED.md`. - ## PolygonSeries: diff --git a/docs/radar-chart.md b/docs/radar-chart.md index fcd3c170a..ba88e5152 100644 --- a/docs/radar-chart.md +++ b/docs/radar-chart.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Radar Charts Radar charts provide a cute method for displaying many variables simultaneously. It allows for rapid at-a-glance comparisons across a bunch of dimensions. These graphics can effectively be used either with several data rows on a single chart (as below) or as a small multiple. For more information, check out the [Wiki](https://en.wikipedia.org/wiki/Radar_chart), it's got some really neat examples. @@ -158,7 +156,7 @@ Type: `function(d, {event})` #### onValueMouseOut (optional) Type: `function(d, {event})` -`mouseout` event handler for the elements corresponding separate data points. First argument received is, `d`, the relevant data point, and second an object with the only `event` property. +`mouseout` event handler for the elements corresponding separate data points. First argument received is, `d`, the relevant data point, and second an object with the only `event` property. #### onSeriesMouseOver (optional) Type: `function(d, {event})` diff --git a/docs/radial-chart.md b/docs/radial-chart.md index a75df2e9e..85691cd40 100644 --- a/docs/radial-chart.md +++ b/docs/radial-chart.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Radial chart `RadialChart` is responsible for creating pie and donut charts. While this kind of chart is easy to overlook as insignificant, intentionally confusing, or almost always replaceable with a treemap; they can be useful for quickly showing small groups. People don't understand angles very well [(such is our biology)](https://www.interaction-design.org/literature/book/the-encyclopedia-of-human-computer-interaction-2nd-ed/data-visualization-for-human-perception), but over the last hundred years we have seen a lot of pie charts! This has caused us to become intimately familiar with them. diff --git a/docs/rect-series.md b/docs/rect-series.md index 0d72b342a..35ab12c07 100644 --- a/docs/rect-series.md +++ b/docs/rect-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Rect Series RectSeries is a generalization of [BarSeries](bar-series.md) which allows users to build a series of rectangles of arbitrary dimensions. Whereas in barSeries, one dimension of the bars is fixed (width for vertical bar series, height for horizontal bar series), in RectSeries, both dimensions can be controlled. diff --git a/docs/sankey.md b/docs/sankey.md index be8621fe6..3bfe0aa79 100644 --- a/docs/sankey.md +++ b/docs/sankey.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Sankey Sankey diagrams are a form of graph that allows for the easy communication of flows and other transferal processes. diff --git a/docs/scales-and-data.md b/docs/scales-and-data.md index 2a6434a06..06f070b94 100644 --- a/docs/scales-and-data.md +++ b/docs/scales-and-data.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Scales and data ### Data @@ -47,7 +45,7 @@ By the way: can you guess what this dataset is? Answer at the end of the documen Scales are what actually transform the values of the properties in the data objects into visual attributes. In the example above, for instance, the third object is {x: 2, y: 4}. But the corresponding rectangle is 39.45px from the left and 105.56px from the top of the top left corner of the chart. How? Scales. -React-vis scales are designed so that as often as possible, you shouldn't have to do anything; yet they give you control to override anything they do. +React-vis scales are designed so that as often as possible, you shouldn't have to do anything; yet they give you control to override anything they do. The notion of scales and the corresponding vocabulary are directly taken from d3js. Scales have a type, a range and a domain. For a given chart, there are multiple scales: there's one scale per attribute. Attributes include x position, y position, color, size, angle etc. Again, not all attributes are applicable in all series. @@ -95,35 +93,35 @@ This table is also meant to be used for derived series. Canvas series have the s To redefine a scale, you must pass a prop to the series that uses that scale. The prop names are based on the name of the attribute: name + Domain, name + Range, name + Type, name + Padding (for instance: yDomain, colorType, xRange). -* `get[name]` (optional) - Type: `function` +* `get[name]` (optional) + Type: `function` An accessor function that gets the value to be compute from the data. For instance if you were keeping your data as rows like {a: 1, b: 2, c: 3}, you could define an x accessor like `getX: d => d.a`. -* `[name]Domain` (optional) - Type: `Array` +* `[name]Domain` (optional) + Type: `Array` Array of values to visualize from. If domain is not passed, it will be calculated from the values which are passed to component. -* `[name]Padding` (optional) - Type: `Number` +* `[name]Padding` (optional) + Type: `Number` A percentage that will pad your `[name]Domain`. If the padding not passed `[name]Domain` will not be padded. Note: if you pass `[name]Domain` and it is not calculated from the values, padding will not be used. * `[name]Range` (optional) - Type: `Array` + Type: `Array` Array of real-world values to visualize to. If range is not passed, the defaults (depend on visualization type) will be applied. -* `[name]Type` (optional) - Type: `('linear'|'ordinal'|'category'|'time'|'time-utc'|'log'|'literal')` - Default: `'linear'` +* `[name]Type` (optional) + Type: `('linear'|'ordinal'|'category'|'time'|'time-utc'|'log'|'literal')` + Default: `'linear'` Type of the scale. Each scale type can be one of following values: - * `'linear'` + * `'linear'` Continuous scale, that works with numbers. Similar to [d3.scaleLinear](https://github.com/d3/d3-scale/blob/master/README.md#scaleLinear). - * `'ordinal'` + * `'ordinal'` Ordinal scale, works with numbers and strings. Similar to [d3.scaleOrdinal](https://github.com/d3/d3-scale/blob/master/README.md#ordinal-scales). - * `'category'` + * `'category'` Categorical scale, each new value gets the next value from the range. Similar to d3.scale.category\[Number\], but works with other values besides colors. - * `'time'` + * `'time'` Time scale. Similar to [d3.scaleTime](https://github.com/d3/d3-scale/blob/master/README.md#time-scales). - * `'time-utc'` + * `'time-utc'` Time UTC scale. Similar to [d3.scaleUtc](https://github.com/d3/d3-scale/blob/master/README.md#scaleUtc) - * `'log'` + * `'log'` Log scale. Similar to [d3.scaleLog](https://github.com/d3/d3-scale/blob/master/README.md#log-scales). - * `'literal'` + * `'literal'` Returns exactly the value that was given to it. Similar to [d3.scaleIdentity](https://github.com/d3/d3-scale#scaleIdentity), except that it does NOT coerce data into numbers. This is useful for precisely specifying properties in the data, eg color can be specified directly on the data. ### Overriding scales diff --git a/docs/series.md b/docs/series.md index b11895291..32a1a8dab 100644 --- a/docs/series.md +++ b/docs/series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Series The library supports several types of series: diff --git a/docs/style.md b/docs/style.md index 61f0bed3c..effe110e1 100644 --- a/docs/style.md +++ b/docs/style.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Style In order to control the look and feel of your React-Vis components, you have four strategies. diff --git a/docs/sunburst.md b/docs/sunburst.md index 3eb1d29f6..c9b51f184 100644 --- a/docs/sunburst.md +++ b/docs/sunburst.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Sunbursts Sunbursts are a powerful way to demonstrate part to whole relationships. While they certainly have the many of easily criticized problems of pie charts, they allow for diff --git a/docs/treemap.md b/docs/treemap.md index 0212de065..64181eac2 100644 --- a/docs/treemap.md +++ b/docs/treemap.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # Treemap Treemaps are a splendid way to represent data that has a nested aspect to it. They allow for the easy display of complicated diff --git a/docs/voronoi.md b/docs/voronoi.md index a6abd0621..7981e7234 100644 --- a/docs/voronoi.md +++ b/docs/voronoi.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## Voronoi Voronoi diagrams are useful for making a chart interactive by creating target areas for events like hover and click. diff --git a/docs/whisker-series.md b/docs/whisker-series.md index 6ad3b8431..2e3d2b764 100644 --- a/docs/whisker-series.md +++ b/docs/whisker-series.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - ## WhiskerSeries diff --git a/docs/xy-plot.md b/docs/xy-plot.md index 3eed1bb44..d01cde116 100644 --- a/docs/xy-plot.md +++ b/docs/xy-plot.md @@ -1,5 +1,3 @@ -> This library is deprecated. Please see `DEPRECATED.md`. - # XYPlot XYPlot allows you to make line charts, area charts, scatterplots, heat maps, etc with animations and different interactions between them.