Skip to content

Commit

Permalink
Update vx-grid Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@robinsoncol
robinsoncol committed Oct 20, 2018
1 parent 85554d0 commit 097feeb
Showing 1 changed file with 40 additions and 36 deletions.
76 changes: 40 additions & 36 deletions packages/vx-grid/Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,48 +28,52 @@ const grid = (<Grid

## `<Grid />`

| Name | Default | Type | Description |
|:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------ |
| top | | number | The top margin in pixels. |
| left | | number | The left margin in pixels. |
| xScale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the xs. |
| yScale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the ys. |
| width | | number | The pixel width of the grid. |
| height | | number | The pixel height of the grid. |
| className | | string | The class name for the Group element. |
| stroke | | string | The color for the stroke of the grid. |
| strokeWidth | | number | The width of the lines in the stroke. |
| strokeDasharray | | array | The [pattern of dashes](https://mzl.la/1l7EiTQ) in the stroke. |
| numTicksRows | | number | The number of row lines. |
| numTicksColumns | | number | The number of column lines. |
| Name | Default | Type | Description |
|:--------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------- |
| top | | number | The top margin in pixels. |
| left | | number | The left margin in pixels. |
| xScale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the xs. |
| yScale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the ys. |
| width | | number | The pixel width of the grid. |
| height | | number | The pixel height of the grid. |
| className | | string | The class name for the Group element. |
| stroke | | string | The color for the stroke of the grid. |
| strokeWidth | | number | The width of the lines in the stroke. |
| strokeDasharray | | array | The [pattern of dashes](https://mzl.la/1l7EiTQ) in the stroke. |
| numTicksRows | | number | The number of row lines. |
| numTicksColumns | | number | The number of column lines. |
| rowTickValues | | Array | An array of values that determine the number and values of the ticks. Falls back to scale.ticks() or .domain(). |
| columnTickValues | | Array | An array of values that determine the number and values of the ticks. Falls back to scale.ticks() or .domain(). |

## `<Rows />`

| Name | Default | Type | Description |
|:--------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------- |
| top | | number | The top margin in pixels. |
| left | | number | The left margin in pixels. |
| scale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the rows. |
| width | | number | The pixel width of the grid. |
| stroke | #eaf0f6 | string | The color for the stroke of the lines. |
| strokeWidth | 1 | number | The width of the lines in the stroke. |
| strokeDasharray | | | The [pattern of dashes](https://mzl.la/1l7EiTQ) in the stroke. |
| className | | | The class name for the Group element. |
| numTicks | 10 | number | The number of row lines. |
| Name | Default | Type | Description |
|:--------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------- |
| top | | number | The top margin in pixels. |
| left | | number | The left margin in pixels. |
| scale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the rows. |
| width | | number | The pixel width of the grid. |
| stroke | #eaf0f6 | string | The color for the stroke of the lines. |
| strokeWidth | 1 | number | The width of the lines in the stroke. |
| strokeDasharray | | | The [pattern of dashes](https://mzl.la/1l7EiTQ) in the stroke. |
| className | | | The class name for the Group element. |
| numTicks | 10 | number | The number of row lines. |
| tickValues | | Array | An array of values that determine the number and values of the ticks. Falls back to scale.ticks() or .domain(). |

## `<Columns />`

| Name | Default | Type | Description |
|:--------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------- |
| top | | number | The top margin in pixels. |
| left | | number | The left margin in pixels. |
| scale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the rows. |
| height | | number | The pixel height of the grid. |
| stroke | #eaf0f6 | string | The color for the stroke of the lines. |
| strokeWidth | 1 | number | The width of the lines in the stroke. |
| strokeDasharray | | | The [pattern of dashes](https://mzl.la/1l7EiTQ) in the stroke. |
| className | | | The class name for the Group element. |
| numTicks | 10 | number | The number of row lines. |
| Name | Default | Type | Description |
|:--------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------- |
| top | | number | The top margin in pixels. |
| left | | number | The left margin in pixels. |
| scale | | function | A [scale function](https://github.com/hshoff/vx/tree/master/packages/vx-scale) for the rows. |
| height | | number | The pixel height of the grid. |
| stroke | #eaf0f6 | string | The color for the stroke of the lines. |
| strokeWidth | 1 | number | The width of the lines in the stroke. |
| strokeDasharray | | | The [pattern of dashes](https://mzl.la/1l7EiTQ) in the stroke. |
| className | | | The class name for the Group element. |
| numTicks | 10 | number | The number of row lines. |
| tickValues | | Array | An array of values that determine the number and values of the ticks. Falls back to scale.ticks() or .domain(). |


## Source For Components
Expand Down

0 comments on commit 097feeb

Please sign in to comment.