@nebula.js/sn-grid-chart
Version:
A grid from two dimensions with symbols of varying size based on a measure.
123 lines (79 loc) • 4.62 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>
- [.X](#pluginArguments.keys.SCALE.X) : <code>string</code>
- [.Y](#pluginArguments.keys.SCALE.Y) : <code>string</code>
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.X_AXIS](#pluginArguments.keys.COMPONENT.X_AXIS) : <code>string</code>
- [.Y_AXIS](#pluginArguments.keys.COMPONENT.Y_AXIS) : <code>string</code>
- [.POINT](#pluginArguments.keys.COMPONENT.POINT) : <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>
- [.X](#pluginArguments.keys.SCALE.X) : <code>string</code>
- [.Y](#pluginArguments.keys.SCALE.Y) : <code>string</code>
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.X_AXIS](#pluginArguments.keys.COMPONENT.X_AXIS) : <code>string</code>
- [.Y_AXIS](#pluginArguments.keys.COMPONENT.Y_AXIS) : <code>string</code>
- [.POINT](#pluginArguments.keys.COMPONENT.POINT) : <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 measures.
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>
- [.X](#pluginArguments.keys.SCALE.X) : <code>string</code>
- [.Y](#pluginArguments.keys.SCALE.Y) : <code>string</code>
<a name="pluginArguments.keys.SCALE.X"></a>
##### SCALE.X : <code>string</code>
The scale used for positioning items along the x axis
**Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
<a name="pluginArguments.keys.SCALE.Y"></a>
##### SCALE.Y : <code>string</code>
The scale used for positioning items along the y axis
**Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
<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>
- [.X_AXIS](#pluginArguments.keys.COMPONENT.X_AXIS) : <code>string</code>
- [.Y_AXIS](#pluginArguments.keys.COMPONENT.Y_AXIS) : <code>string</code>
- [.POINT](#pluginArguments.keys.COMPONENT.POINT) : <code>string</code>
<a name="pluginArguments.keys.COMPONENT.X_AXIS"></a>
##### COMPONENT.X_AXIS : <code>string</code>
The x-axis component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.Y_AXIS"></a>
##### COMPONENT.Y_AXIS : <code>string</code>
The y-axis component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.POINT"></a>
##### COMPONENT.POINT : <code>string</code>
The point 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