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.

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

Fix typos #690

Merged
merged 2 commits into from Dec 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -18,7 +18,7 @@ Want to make sure your PR gets a speedy review and a quick merge? Here are some
- Add Tests
- Add documentation about the feature you added
- Make sure you have a clear description of what your PR is about
- Inlcude screenshots
- Include screenshots
- Add Tests

## Releases
Expand Down
2 changes: 1 addition & 1 deletion docs/arc-series.md
Expand Up @@ -37,7 +37,7 @@ const myData = [
]
```

angle0 describes the start of the arc in radians, and angle describes the end of the arc, again in radians. radius0 describes the inner distance from the origin, while radius describes the outer distance to the origin. It is recomended to provide all four of these quantities to format your arcs well.
angle0 describes the start of the arc in radians, and angle describes the end of the arc, again in radians. radius0 describes the inner distance from the origin, while radius describes the outer distance to the origin. It is recommended to provide all four of these quantities to format your arcs well.

#### angle0
Type: `number`
Expand Down
3 changes: 1 addition & 2 deletions docs/area-series.md
Expand Up @@ -2,7 +2,7 @@

<!-- INJECT:"AreaChartWithLink" -->

In addition to the the LineSeries, react-vis offers a similar chart type for area charts.
In addition to the LineSeries, react-vis offers a similar chart type for area charts.
Like LineSeries, AreaSeries:
- are styled at the series level, not at the mark level.
- can have a curve property for a different interpolation between points.
Expand Down Expand Up @@ -161,4 +161,3 @@ This handler fires when the user mouses over an AreaSeries, and provides the cor
// you can access the value of the event
}}
```

2 changes: 1 addition & 1 deletion docs/decorative-axis.md
Expand Up @@ -24,7 +24,7 @@ In the above example we start be setting our domain on the XYPlot (though this w

**WHAT IS THIS FOR** Labeling sections of XY space when we wish the viewer to interpret space in a different way. This could be as part of a Radar chart or radial chart! Or even, the inherently bad Dual Y Axis chart.

**WHAT IS NOT THIS FOR** Using in place of XAxis or YAxis, which should cover most of use cases in which space is being used normally.This type of axis allows for a lot of freedom in it's usage, however that can be dangerous. Most of the time, if you can't get XAxis and YAxis to do what you want, you maybe don't need axes. Be careful!
**WHAT IS NOT THIS FOR** Using in place of XAxis or YAxis, which should cover most of use cases in which space is being used normally. This type of axis allows for a lot of freedom in it's usage, however that can be dangerous. Most of the time, if you can't get XAxis and YAxis to do what you want, you maybe don't need axes. Be careful!

## API Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/flexible-plots.md
Expand Up @@ -21,7 +21,7 @@ import {

`FlexibleWidthXYPlot` modifies `XYPlot` so that it no longer requires a width, since it will take all the with in its container div.
Likewise, `FlexibleHeightXYPlot` modifies `XYPlot` so that is no longer requires a height, and its height will be that of its container div.
Finally, `FlexibleXYPlot` modifies `XYPlot` so that it no longer requires eiter a width and a height, its dimensions will be that of its container.
Finally, `FlexibleXYPlot` modifies `XYPlot` so that it no longer requires either a width and a height, its dimensions will be that of its container.

These components can be used exactly as `XYPlot`:

Expand Down
2 changes: 1 addition & 1 deletion docs/parallel-coordinates.md
Expand Up @@ -55,7 +55,7 @@ Let's looks at each member of the object
- name: generates a member of a labelSeries that shows at the end of the corresponding axis
- getValue: an accessor function that grabs a value from the row being accessed, if this is not provided a default one that uses the name property is used.
- domain: a pair of numbers that are interpolated between. Setting these values correctly is essential for making your graphic legible! Because it is often the case that there will only be one or two data rows in a parallel coordinates, react-vis requires the user to specify the exact domain for each variable. Without which we would be unable to plot the variables well.
- tickFormat: allows the user to provide a formatting function for prettifiying the the way that axis interpolates between the domain values.
- tickFormat: allows the user to provide a formatting function for prettifying the way that axis interpolates between the domain values.

#### width
Type: `number`
Expand Down
2 changes: 1 addition & 1 deletion docs/polygon-series.md
Expand Up @@ -62,7 +62,7 @@ Array of data for the series. See above data format reference.

#### style
Type: `object`
Paths accept a ton of different styles, so rather than prescribe every single one we just accept a general grab bag pf the styles. check out the [w3](https://www.w3schools.com/graphics/svg_path.asp) page for more details and the [style] documnetation (style.md).
Paths accept a ton of different styles, so rather than prescribe every single one we just accept a general grab bag pf the styles. check out the [w3](https://www.w3schools.com/graphics/svg_path.asp) page for more details and the [style] documentation (style.md).

## Interaction handlers

Expand Down
2 changes: 1 addition & 1 deletion docs/radar-chart.md
Expand Up @@ -57,7 +57,7 @@ Let's looks at each member of the object
- name: generates a member of a labelSeries that shows at the end of the corresponding axis
- getValue: an accessor function that grabs a value from the row being accessed, if this is not provided a default one that uses the name property is used.
- domain: a pair of numbers that are interpolated between. Setting these values correctly is essential for making your graphic legible! Because it is often the case that there will only be one or two data rows in a radar chart, react-vis requires the user to specify the exact domain for each variable. Without which we would be unable to plot the variables well.
- tickFormat: allows the user to provide a formatting function for prettifiying the the way that axis interpolates between the domain values.
- tickFormat: allows the user to provide a formatting function for prettifying the way that axis interpolates between the domain values.

#### width
Type: `number`
Expand Down
4 changes: 2 additions & 2 deletions docs/scales-and-data.md
Expand Up @@ -87,15 +87,15 @@ For Heatmap series, while you can pass a colorDomain and a colorRange, you canno

If am attribute is not available as a scale for a given series, all values passed in the corresponding property will be ignored. For instance, if you use a dataset that has fill properties, it will be ignored for LineSeries.

This table is also meant to be used for derived series. Canvas series have the same interface as SVG series. HorizontalRectSeries and VerticalRectSeries take the same attribute as RectSeries. And LineMarkSeries take the same atttribute as Line and Mark series.
This table is also meant to be used for derived series. Canvas series have the same interface as SVG series. HorizontalRectSeries and VerticalRectSeries take the same attribute as RectSeries. And LineMarkSeries take the same attribute as Line and Mark series.

### Scale properties

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`
A accessir 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`.
A 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`
Array of values to visualize from. If domain is not passed, it will be calculated from the values which are passed to component.
Expand Down
6 changes: 3 additions & 3 deletions docs/sunburst.md
Expand Up @@ -5,7 +5,7 @@ at a glance understanding of deeply nested systems. This could be useful for und

<!-- INJECT:"BasicSunburstWithLink" -->

The `Sunburst` is a thin data processing wrapper on an XYPlotted [ArcSeries](arc-series.md), it generates highly re-stylable SVG! Any props that are available in the arc series are also available here. Additionally it copies the data format of the treemap, so if you have data prepped to drop into the tree map, you can use that same data to get a sunbrust.
The `Sunburst` is a thin data processing wrapper on an XYPlotted [ArcSeries](arc-series.md), it generates highly re-stylable SVG! Any props that are available in the arc series are also available here. Additionally it copies the data format of the treemap, so if you have data prepped to drop into the tree map, you can use that same data to get a sunburst.

## Usage

Expand Down Expand Up @@ -115,7 +115,7 @@ Each point consists of following properties:
The style of the attached label. Example `{labelStyle: {fontSize: 15}, ...}`
* `dontRotateLabel` (optional)
Type: `boolean`
Dont rotate this label
Don't rotate this label
* `children` (optional)
Type: `Array`
The children for the leaf.
Expand All @@ -128,7 +128,7 @@ Simple boolean on whether or not to show the root node of the tree.

#### children (optional)
Type: `react components`
Sunburst can accept react components as children if you wish to to annotate your diagram.
Sunburst can accept react components as children if you wish to annotate your diagram.

#### animation (optional)
Type: `boolean|Object`
Expand Down
4 changes: 2 additions & 2 deletions docs/treemap.md
@@ -1,7 +1,7 @@
# Treemap

Treemaps are a splendid way to represent data that has a nested aspect to it. They allow for the easy display of complicated
relative information, such as nested-part-to-whole relationships in a easy to grock fashion. Checkout [the wikipedia page](https://en.wikipedia.org/wiki/Treemapping) or Ben Shneiderman's excellent [History of treemaps](http://www.cs.umd.edu/hcil/treemap-history/index.shtml) for more information.
relative information, such as nested-part-to-whole relationships in a easy to grok fashion. Checkout [the wikipedia page](https://en.wikipedia.org/wiki/Treemapping) or Ben Shneiderman's excellent [History of treemaps](http://www.cs.umd.edu/hcil/treemap-history/index.shtml) for more information.

<!-- INJECT:"SimpleTreemapWithLink" -->

Expand Down Expand Up @@ -73,7 +73,7 @@ the "cluster" node has 3938 + 3812 + 6714 + 743 = 15207 size units.
over all of the nodes.

- It can useful to encode opacity to indicate tree depth, however because each tree leaf is a nested div this gets a little
tricky. One technique is to to compute the effective RGBA to hex value, check out [this link](viget.com/inspire/equating-color-and-transparency)
tricky. One technique is to compute the effective RGBA to hex value, check out [this link](viget.com/inspire/equating-color-and-transparency)
for more details.

- If your not sure when to use a treemap, remember they provide an easy drop in relationship for pie charts.
Expand Down
4 changes: 2 additions & 2 deletions docs/whisker-series.md
Expand Up @@ -20,7 +20,7 @@ render() {
```

Just like other series, WhiskerSeries expects its data to be formatted as an array of
objects. These data points may incude an `xVariance` property, a `yVariance` property,
objects. These data points may include an `xVariance` property, a `yVariance` property,
or both:

```javascript
Expand All @@ -34,7 +34,7 @@ const myData = [
```

WhiskerSeries also accepts a `size` value that specifies an empty "buffer" region.
This is especially useful if you are combinging the whiskers with another series, and
This is especially useful if you are combining the whiskers with another series, and
the marks of that series include transparent regions. The buffer region prevents
whisker lines from being drawn behind that other mark.

Expand Down
2 changes: 1 addition & 1 deletion docs/xy-plot.md
Expand Up @@ -227,7 +227,7 @@ The function that is triggered each time a wheel button is rotated on the compon
#### animation (optional)
Type: `{duration: number}|boolean`
Default: `false`
Animation config, which is automatically passed to all children, but can be overrided for the each child.
Animation config, which is automatically passed to all children, but can be overridden for the each child.
If `false` is passed, then the child components *will not be* animated.
If `true` is passed then the child components *will be* animated with the default settings.
If an object is passed, then the child components *will be* animated with the given settings.
4 changes: 2 additions & 2 deletions src/plot/axis/decorative-axis-ticks.js
Expand Up @@ -27,9 +27,9 @@ import {generatePoints, getAxisAngle} from 'utils/axis-utils';
- props.animation {Boolean}
- props.axisDomain {Array} a pair of values specifying the domain of the axis
- props.numberOfTicks{Number} the number of ticks on the axis
- props.axisStart {Object} a object specify in cartesian space the the start of the axis
- props.axisStart {Object} a object specify in cartesian space the start of the axis
example: {x: 0, y: 0}
- props.axisEnd {Object} a object specify in cartesian space the the start of the axis
- props.axisEnd {Object} a object specify in cartesian space the start of the axis
- props.tickValue {Func} a formatting function for the tick values
- props.tickSize {Number} a pixel size of the axis
- props.style {Object} The style object for the axis
Expand Down