Skip to content

Commit

Permalink
update docs to split tables
Browse files Browse the repository at this point in the history
  • Loading branch information
etimberg committed Jan 11, 2019
1 parent 51fccab commit 29fe1f2
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions docs/charts/line.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ var myLineChart = new Chart(ctx, {

The line chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset. For example, the colour of a line is generally set this way.

### Line Properties

The line properties are used to configure the line drawn between points. All these values, if `undefined`, fallback to the associated [`elements.line.*`](../configuration/elements.md#line-configuration).

| Name | Type | [Scriptable](../general/options.md#scriptable-options) | [Indexable](../general/options.md#indexable-options) | Default
| ---- | ---- | :----: | :----: | ----
| [`backgroundColor`](#styling) | [`Color`](../general/colors.md) | - | - | `'rgba(0,0,0,0.1)'`
Expand All @@ -54,22 +58,29 @@ The line chart allows a number of properties to be specified for each dataset. T
| [`fill`](#styling) | `Boolean/String` | - | - | `true`
| [`label`](#general) | `String` | - | - | `''`
| [`lineTension`](#styling) | `Number` | - | - | `0.4`
| [`steppedLine`](#stepped-line) | `Boolean/String` | - | - | `false`
| [`xAxisID`](#general) | `String` | - | - | first x axis
| [`yAxisID`](#general) | `String` | - | - | first y axis
| [`showLine`](#general) | `Boolean` | - | - | `undefined`
| [`spanGaps`](#general) | `Boolean` | - | - | `false`

### Point Properties

The point dataset properties are used to configure how points appear on the line chart. All these values, if `undefined`, fallback to the associated [`'elements.point.*`](../configuration/elements.md#point-configuration) options.

| Name | Type | [Scriptable](../general/options.md#scriptable-options) | [Indexable](../general/options.md#indexable-options) | Default
| ---- | ---- | :----: | :----: | ----
| [`pointBackgroundColor`](#styling) | `Color` | Yes | Yes | `'rgba(0,0,0,0.1)'`
| [`pointBorderColor`](#styling) | `Color` | Yes | Yes | `'rgba(0,0,0,0.1)'`
| [`pointBorderWidth`](#styling) | `Number` | Yes | Yes | `1`
| [`pointRadius`](#styling) | `Number` | Yes | Yes | `3`
| [`pointStyle`](#styling) | `String/Image` | Yes | Yes | `'circle'`
| [`pointRotation`](#styling) | `Number` | Yes | Yes | `1`
| [`pointHitRadius`](#styling) | `Number` | Yes | Yes | `1`
| [`steppedLine`](#stepped-line) | `Boolean/String` | - | - | `false`
| [`xAxisID`](#general) | `String` | - | - | first x axis
| [`yAxisID`](#general) | `String` | - | - | first y axis
| [`pointHoverBackgroundColor`](#interactions) | `Color` | Yes | Yes | `undefined`
| [`pointHoverBorderColor`](#interactions) | `Color` | Yes | Yes | `undefined`
| [`pointHoverBorderWidth`](#interactions) | `Number` | Yes | Yes | `undefined`
| [`pointHoverRadius`](#interactions) | `Number` | Yes | Yes | `undefined`
| [`showLine`](#general) | `Boolean` | - | - | `undefined`
| [`spanGaps`](#general) | `Boolean` | - | - | `false`

### General

Expand Down Expand Up @@ -104,8 +115,6 @@ The style of the line and each point can be controlled with the following proper
| `showLine` | If false, the line is not drawn for this dataset.
| `spanGaps` | If true, lines will be drawn between points with no or null data. If false, points with `NaN` data will create a break in the line.

All these values, if `undefined`, fallback to the associated [`elements.line.*`](../configuration/elements.md#line-configuration) or [`'elements.point.*`](../configuration/elements.md#point-configuration) options.

### Interactions

The interaction with each point can be controlled with the following properties:
Expand All @@ -117,8 +126,6 @@ The interaction with each point can be controlled with the following properties:
| `pointHoverBorderWidth` | Border width of point when hovered.
| `pointHoverRadius` | The radius of the point when hovered.

All these values, if `undefined`, fallback to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options.

### cubicInterpolationMode
The following interpolation modes are supported.
* 'default'
Expand Down

0 comments on commit 29fe1f2

Please sign in to comment.