@nebula.js/sn-pie-chart
Version:
Pie chart supernova
91 lines (58 loc) • 3.48 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>
- [.FILL](#pluginArguments.keys.SCALE.FILL) : <code>string</code>
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
- [.SLICES](#pluginArguments.keys.COMPONENT.SLICES) : <code>string</code>
- [.PIE_LABELS](#pluginArguments.keys.COMPONENT.PIE_LABELS) : <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>
- [.FILL](#pluginArguments.keys.SCALE.FILL) : <code>string</code>
- [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
- [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
- [.SLICES](#pluginArguments.keys.COMPONENT.SLICES) : <code>string</code>
- [.PIE_LABELS](#pluginArguments.keys.COMPONENT.PIE_LABELS) : <code>string</code>
<a name="pluginArguments.keys.SCALE"></a>
#### keys.SCALE : <code>object</code>
The scales associated with the pie 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)
<a name="pluginArguments.keys.SCALE.FILL"></a>
##### SCALE.FILL : <code>string</code>
The scale used for coloring the slices
**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 pie 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>
- [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
- [.SLICES](#pluginArguments.keys.COMPONENT.SLICES) : <code>string</code>
- [.PIE_LABELS](#pluginArguments.keys.COMPONENT.PIE_LABELS) : <code>string</code>
<a name="pluginArguments.keys.COMPONENT.DIMENSION_TITLE"></a>
##### COMPONENT.DIMENSION_TITLE : <code>string</code>
The dimension title component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.SLICES"></a>
##### COMPONENT.SLICES : <code>string</code>
The slices component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
<a name="pluginArguments.keys.COMPONENT.PIE_LABELS"></a>
##### COMPONENT.PIE_LABELS : <code>string</code>
The pie labels component
**Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
# Definitions