@nebula.js/sn-line-chart
Version:
Line chart supernova
168 lines (110 loc) • 7 kB
Markdown
# Plugins Arguments
- [pluginArguments](#pluginArguments) : <code>object</code>
- [.layout](#pluginArguments.layout) : <code>object</code>
- [.keys](#pluginArguments.keys) : <code>object</code>
- [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
- [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
- [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
- [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.LINE](#pluginArguments.keys.COMPONENT.LINE) : <code>string</code>
- [.MAJOR_AXIS](#pluginArguments.keys.COMPONENT.MAJOR_AXIS) : <code>string</code>
- [.MAJOR_AXIS_TIME_INNER](#pluginArguments.keys.COMPONENT.MAJOR_AXIS_TIME_INNER) : <code>string</code>
- [.MAJOR_AXIS_TITLE](#pluginArguments.keys.COMPONENT.MAJOR_AXIS_TITLE) : <code>string</code>
- [.MINOR_AXIS](#pluginArguments.keys.COMPONENT.MINOR_AXIS) : <code>string</code>
- [.MINOR_AXIS_TITLE](#pluginArguments.keys.COMPONENT.MINOR_AXIS_TITLE) : <code>string</code>
- [.COLLECTION](#pluginArguments.keys.COLLECTION) : <code>object</code>
- [.MAIN](#pluginArguments.keys.COLLECTION.MAIN) : <code>string</code>
---
<a name="pluginArguments.layout"></a>
### pluginArguments.layout : <code>object</code>
The layout from the enigma model.
**Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
<a name="pluginArguments.keys"></a>
### pluginArguments.keys : <code>object</code>
The keys (references) to different types of chart internals
**Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
- [.keys](#pluginArguments.keys) : <code>object</code>
- [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
- [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
- [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
- [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.LINE](#pluginArguments.keys.COMPONENT.LINE) : <code>string</code>
- [.MAJOR_AXIS](#pluginArguments.keys.COMPONENT.MAJOR_AXIS) : <code>string</code>
- [.MAJOR_AXIS_TIME_INNER](#pluginArguments.keys.COMPONENT.MAJOR_AXIS_TIME_INNER) : <code>string</code>
- [.MAJOR_AXIS_TITLE](#pluginArguments.keys.COMPONENT.MAJOR_AXIS_TITLE) : <code>string</code>
- [.MINOR_AXIS](#pluginArguments.keys.COMPONENT.MINOR_AXIS) : <code>string</code>
- [.MINOR_AXIS_TITLE](#pluginArguments.keys.COMPONENT.MINOR_AXIS_TITLE) : <code>string</code>
- [.COLLECTION](#pluginArguments.keys.COLLECTION) : <code>object</code>
- [.MAIN](#pluginArguments.keys.COLLECTION.MAIN) : <code>string</code>
<a name="pluginArguments.keys.SCALE"></a>
#### keys.SCALE : <code>object</code>
The scales associated with the line chart
They are useful if you want to, via plugin, add a new component that
uses the same scale as one of the measures.
**Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
- [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
- [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
- [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
- [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
<a name="pluginArguments.keys.SCALE.MAIN"></a>
##### SCALE.MAIN : <code>object</code>
The main scales
**Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
- [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
- [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
- [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
<a name="pluginArguments.keys.SCALE.MAIN.MINOR"></a>
###### MAIN.MINOR : <code>string</code>
The main minor scale
**Kind**: static property of [<code>MAIN</code>](#pluginArguments.keys.SCALE.MAIN)
<a name="pluginArguments.keys.SCALE.MAIN.MAJOR"></a>
###### MAIN.MAJOR : <code>string</code>
The main major scale
**Kind**: static property of [<code>MAIN</code>](#pluginArguments.keys.SCALE.MAIN)
<a name="pluginArguments.keys.COMPONENT"></a>
#### keys.COMPONENT : <code>object</code>
The unique keys of the existing components available in the chart.
They are useful if you want to extend or override the existing components.
**Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.LINE](#pluginArguments.keys.COMPONENT.LINE) : <code>string</code>
- [.MAJOR_AXIS](#pluginArguments.keys.COMPONENT.MAJOR_AXIS) : <code>string</code>
- [.MAJOR_AXIS_TIME_INNER](#pluginArguments.keys.COMPONENT.MAJOR_AXIS_TIME_INNER) : <code>string</code>
- [.MAJOR_AXIS_TITLE](#pluginArguments.keys.COMPONENT.MAJOR_AXIS_TITLE) : <code>string</code>
- [.MINOR_AXIS](#pluginArguments.keys.COMPONENT.MINOR_AXIS) : <code>string</code>
- [.MINOR_AXIS_TITLE](#pluginArguments.keys.COMPONENT.MINOR_AXIS_TITLE) : <code>string</code>
<a name="pluginArguments.keys.COMPONENT.LINE"></a>
##### COMPONENT.LINE : <code>string</code>
The line component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.MAJOR_AXIS"></a>
##### COMPONENT.MAJOR_AXIS : <code>string</code>
The major axis component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.MAJOR_AXIS_TIME_INNER"></a>
##### COMPONENT.MAJOR_AXIS_TIME_INNER : <code>string</code>
The major axis time inner component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.MAJOR_AXIS_TITLE"></a>
##### COMPONENT.MAJOR_AXIS_TITLE : <code>string</code>
The major axis title component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.MINOR_AXIS"></a>
##### COMPONENT.MINOR_AXIS : <code>string</code>
The minor axis component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.MINOR_AXIS_TITLE"></a>
##### COMPONENT.MINOR_AXIS_TITLE : <code>string</code>
The minor axis title component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COLLECTION"></a>
#### keys.COLLECTION : <code>object</code>
The data collections the users can use to get data from
**Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
<a name="pluginArguments.keys.COLLECTION.MAIN"></a>
##### COLLECTION.MAIN : <code>string</code>
The main data collection
**Kind**: static property of [<code>COLLECTION</code>](#pluginArguments.keys.COLLECTION)
# Definitions