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.

Sign up for GitHub

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

Added ability to specify an interval for gridlines #20

Merged
merged 3 commits into from
Oct 31, 2018
Merged

Added ability to specify an interval for gridlines #20

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5346926
Added new parameter for configuring gridline-intervals.
VeegY Sep 14, 2018
2b9b9fe
Added documentation for the new gridline-interval parameter.
VeegY Sep 14, 2018
06046d0
Re-compiled the library with the new gridline-interval parameter.
VeegY Sep 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added documentation for the new gridline-interval parameter.
  • Loading branch information
@VeegY
VeegY committed Sep 14, 2018
commit 2b9b9fed39cd7e3496a6ceb7891111be865b2c74
84 changes: 44 additions & 40 deletions docs/en/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,33 +151,35 @@ A polar coordinates.

### XAxis - Props

| Name | Description | Required | Type | Default |
| -------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| dashed | Gridline style. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |
| Name | Description | Required | Type | Default |
| ----------------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| gridlineInterval | Display grid-lines base on an interval | - | `Function | Number` | - |
| dashed | Grid dotted line. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |

## YAxis

- Parent: [Cartesian](#cartesian)

### YAxis - Props

| Name | Description | Required | Type | Default |
| -------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| dashed | Gridline style. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |
| Name | Description | Required | Type | Default |
| ----------------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| gridlineInterval | Display grid-lines base on an interval | - | `Function | Number` | - |
| dashed | Grid dotted line. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |

## XAxisInverse

Expand All @@ -187,16 +189,17 @@ Display on the other side of X axis.

### XAxisInverse - Props

| Name | Description | Required | Type | Default |
| -------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| dashed | Gridline style. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |
| Name | Description | Required | Type | Default |
| ----------------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| gridlineInterval | Display grid-lines base on an interval | - | `Function | Number` | - |
| dashed | Grid dotted line. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |

## YAxisInverse

Expand All @@ -206,16 +209,17 @@ Display on the other side of Y axis.

### YAxisInverse - Props

| Name | Description | Required | Type | Default |
| -------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| dashed | Grid dotted line. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |
| Name | Description | Required | Type | Default |
| ----------------- | ----------------------------------------------- | -------- | ------------------- | ------------------------ |
| prop | Field name. | true | `String` | - |
| color | Axis and text color. | - | `String` | `textColor` of cartesian |
| tickSize | The width of tick. | - | `Number` | 5 |
| fontSize | Font size. | - | `Number` | 15 |
| format | Format data, such as append unit. | - | `Function` | - |
| gridline | Display grideline. | - | `Boolean` | false |
| gridlineInterval | Display grid-lines base on an interval | - | `Function | Number` | - |
| dashed | Grid dotted line. | - | `Boolean | String` | false |
| interval | Display tick based on the ticks of the interval | - | `Function | Number` | - |

## YMarker

Expand Down