victory-chart 30.6.1 → 31.2.0

package/README.md

@@ -6,7 +6,6 @@ View these docs at https://formidable.com/open-source/victory/docs/victory-chart
 
 `VictoryChart` is a wrapper component that renders a given set of children on a set of Cartesian or polar axes. `VictoryChart` reconciles the domain for all its children, controls the layout of the chart, and coordinates animations and shared events. If no children are provided, `VictoryChart` will render a set of empty default axes.
 
-
 ```playground
 <div>
   <VictoryChart
@@ -51,7 +50,6 @@ animate={{
 
 **Note: polar charts must use `VictoryPolarAxis` rather than `VictoryAxis`**
 
-
 ### containerComponent
 
 `type: element`
@@ -92,7 +90,7 @@ domainPadding={{x: [10, -10], y: 5}}
 
 The `endAngle` props defines the overall end angle of a polar chart in degrees. This prop is used in conjunction with `startAngle` to create polar chart that spans only a segment of a circle, or to change overall rotation of the chart. This prop should be given as a number of degrees. Degrees are defined as starting at the 3 o'clock position, and proceeding counterclockwise.
 
-*default:* `endAngle={360}`
+_default:_ `endAngle={360}`
 
 ```playground
 <div>
@@ -183,6 +181,7 @@ See the [Events Guide][] for more information on defining events.
   </VictoryStack>
 </VictoryChart>
 ```
+
 ### externalEventMutations
 
 `type: array[object]`
@@ -195,7 +194,7 @@ See the [Events Guide][] for more information on defining events.
 
 `VictoryChart` uses the standard `groupComponent` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props/#groupcomponent)
 
-*default:* `<g/>`
+_default:_ `<g/>`
 
 ```jsx
 groupComponent={<g transform="translate(10, 10)" />}
@@ -209,7 +208,7 @@ groupComponent={<g transform="translate(10, 10)" />}
 
 **note: `VictoryChart` controls the `height` prop of its children.**
 
-*default (provided by default theme):* `height={300}`
+_default (provided by default theme):_ `height={300}`
 
 ```jsx
 height={400}
@@ -235,7 +234,6 @@ When the `innerRadius` prop is set, polar charts will be hollow rather than circ
 
 `VictoryChart` uses the standard `maxDomain` prop. [Read about it in detail](https://formidable.com/open-source/victory/docs/common-props#maxDomain)
 
-
 ```playground
 <VictoryChart maxDomain={{ y: 4.5 }}>
   <VictoryLine data={sampleData}/>
@@ -248,7 +246,6 @@ When the `innerRadius` prop is set, polar charts will be hollow rather than circ
 
 `VictoryChart` uses the standard `minDomain` prop. [Read about it in detail](https://formidable.com/open-source/victory/docs/common-props#minDomain)
 
-
 ```playground
 <VictoryChart minDomain={{ y: 0 }}>
   <VictoryLine data={sampleData}/>
@@ -263,7 +260,7 @@ When the `innerRadius` prop is set, polar charts will be hollow rather than circ
 
 **note: `VictoryChart` controls the `padding` prop of its children.**
 
-*default (provided by default theme):* `padding={50}`
+_default (provided by default theme):_ `padding={50}`
 
 ```jsx
 padding={{ top: 20, bottom: 60 }}
@@ -276,8 +273,9 @@ padding={{ top: 20, bottom: 60 }}
 `VictoryChart` uses the standard `polar` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props/#polar)
 
 **Notes:**
-  - `VictoryChart` controls the `polar` prop of its children
-  - Polar charts should use `VictoryPolarAxis` rather than `VictoryAxis`
+
+- `VictoryChart` controls the `polar` prop of its children
+- Polar charts should use `VictoryPolarAxis` rather than `VictoryAxis`
 
 ```playground
 <div>
@@ -313,7 +311,6 @@ padding={{ top: 20, bottom: 60 }}
 
 [Read about the `range` prop in detail](https://formidable.com/open-source/victory/docs/common-props/#range)
 
-
 ### scale
 
 `type: scale || { x: scale, y: scale }`
@@ -323,7 +320,7 @@ Options for scale include "linear", "time", "log", "sqrt" and the `d3-scale` fun
 
 **note: `VictoryChart` controls the `scale` prop of its children.**
 
-*default:* `scale="linear"`
+_default:_ `scale="linear"`
 
 ```jsx
 scale={{x: "linear", y: "log"}}
@@ -347,7 +344,7 @@ scale={{x: "linear", y: "log"}}
 
 **note:** `VictoryChart` sets `standalone={false} for all of its children.
 
-*default:* `standalone={true}`
+_default:_ `standalone={true}`
 
 ```playground
 <svg width={300} height={300}>
@@ -358,13 +355,14 @@ scale={{x: "linear", y: "log"}}
   />
 </svg>
 ```
+
 ### startAngle
 
 `type: number`
 
 The `startAngle` props defines the overall start angle of a polar chart in degrees. This prop is used in conjunction with `endAngle` to create polar chart that spans only a segment of a circle, or to change overall rotation of the chart. This prop should be given as a number of degrees. Degrees are defined as starting at the 3 o'clock position, and proceeding counterclockwise.
 
-*default:* `startAngle={0}`
+_default:_ `startAngle={0}`
 
 ```playground
 <div>
@@ -417,7 +415,7 @@ The `startAngle` props defines the overall start angle of a polar chart in degre
 
 `VictoryChart` uses the standard `style` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props/#style)
 
-*default (provided by default theme):* See [grayscale theme][] for more detail
+_default (provided by default theme):_ See [grayscale theme][] for more detail
 
 ```playground
 <VictoryChart
@@ -437,7 +435,7 @@ The `startAngle` props defines the overall start angle of a polar chart in degre
 
 See the [Themes Guide][] for information about creating custom themes.
 
-*default:* `theme={VictoryTheme.grayscale}`
+_default:_ `theme={VictoryTheme.grayscale}`
 
 ```jsx
 theme={VictoryTheme.material}
@@ -451,24 +449,24 @@ theme={VictoryTheme.material}
 
 **note: `VictoryChart` controls the `width` prop of its children.**
 
-*default (provided by default theme):* `width={450}`
+_default (provided by default theme):_ `width={450}`
 
 ```jsx
 width={400}
 ```
 
-[VictoryArea]: https://formidable.com/open-source/victory/docs/victory-area
-[VictoryAxis]: https://formidable.com/open-source/victory/docs/victory-axis
-[VictoryPolarAxis]: https://formidable.com/open-source/victory/docs/victory-polar-axis
-[VictoryBar]: https://formidable.com/open-source/victory/docs/victory-bar
-[VictoryCandlestick]: https://formidable.com/open-source/victory/docs/victory-candlestick
-[VictoryErrorBar]: https://formidable.com/open-source/victory/docs/victory-errorbar
-[VictoryGroup]: https://formidable.com/open-source/victory/docs/victory-group
-[VictoryLine]: https://formidable.com/open-source/victory/docs/victory-line
-[VictoryScatter]: https://formidable.com/open-source/victory/docs/victory-scatter
-[VictoryStack]: https://formidable.com/open-source/victory/docs/victory-stack
-[VictoryVoronoi]: https://formidable.com/open-source/victory/docs/victory-voronoi
+[victoryarea]: https://formidable.com/open-source/victory/docs/victory-area
+[victoryaxis]: https://formidable.com/open-source/victory/docs/victory-axis
+[victorypolaraxis]: https://formidable.com/open-source/victory/docs/victory-polar-axis
+[victorybar]: https://formidable.com/open-source/victory/docs/victory-bar
+[victorycandlestick]: https://formidable.com/open-source/victory/docs/victory-candlestick
+[victoryerrorbar]: https://formidable.com/open-source/victory/docs/victory-errorbar
+[victorygroup]: https://formidable.com/open-source/victory/docs/victory-group
+[victoryline]: https://formidable.com/open-source/victory/docs/victory-line
+[victoryscatter]: https://formidable.com/open-source/victory/docs/victory-scatter
+[victorystack]: https://formidable.com/open-source/victory/docs/victory-stack
+[victoryvoronoi]: https://formidable.com/open-source/victory/docs/victory-voronoi
 [grayscale theme]: https://github.com/FormidableLabs/victory-core/blob/master/src/victory-theme/grayscale.js
-[Animations Guide]: https://formidable.com/open-source/victory/guides/animations
-[Events Guide]: https://formidable.com/open-source/victory/guides/events
-[Themes Guide]: https://formidable.com/open-source/victory/guides/themes
+[animations guide]: https://formidable.com/open-source/victory/guides/animations
+[events guide]: https://formidable.com/open-source/victory/guides/events
+[themes guide]: https://formidable.com/open-source/victory/guides/themes