@nebula.js/sn-bar-chart 2.0.2 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,157 +0,0 @@
1
- # Plugins Arguments
2
-
3
- - [pluginArguments](#pluginArguments) : <code>object</code>
4
- - [.layout](#pluginArguments.layout) : <code>object</code>
5
- - [.keys](#pluginArguments.keys) : <code>object</code>
6
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
7
- - [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
8
- - [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
9
- - [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
10
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
11
- - [.BAR](#pluginArguments.keys.COMPONENT.BAR) : <code>string</code>
12
- - [.BAR_AXIS](#pluginArguments.keys.COMPONENT.BAR_AXIS) : <code>string</code>
13
- - [.Y_AXIS](#pluginArguments.keys.COMPONENT.Y_AXIS) : <code>string</code>
14
- - [.MEASURE_TITLE](#pluginArguments.keys.COMPONENT.MEASURE_TITLE) : <code>string</code>
15
- - [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
16
- - [.COLLECTION](#pluginArguments.keys.COLLECTION) : <code>object</code>
17
- - [.MAIN](#pluginArguments.keys.COLLECTION.MAIN) : <code>string</code>
18
-
19
- ---
20
-
21
- <a name="pluginArguments.layout"></a>
22
-
23
- ### pluginArguments.layout : <code>object</code>
24
-
25
- The layout from the enigma model.
26
-
27
- **Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
28
- <a name="pluginArguments.keys"></a>
29
-
30
- ### pluginArguments.keys : <code>object</code>
31
-
32
- The keys (references) to different types of chart internals
33
-
34
- **Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
35
-
36
- - [.keys](#pluginArguments.keys) : <code>object</code>
37
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
38
- - [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
39
- - [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
40
- - [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
41
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
42
- - [.BAR](#pluginArguments.keys.COMPONENT.BAR) : <code>string</code>
43
- - [.BAR_AXIS](#pluginArguments.keys.COMPONENT.BAR_AXIS) : <code>string</code>
44
- - [.Y_AXIS](#pluginArguments.keys.COMPONENT.Y_AXIS) : <code>string</code>
45
- - [.MEASURE_TITLE](#pluginArguments.keys.COMPONENT.MEASURE_TITLE) : <code>string</code>
46
- - [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
47
- - [.COLLECTION](#pluginArguments.keys.COLLECTION) : <code>object</code>
48
- - [.MAIN](#pluginArguments.keys.COLLECTION.MAIN) : <code>string</code>
49
-
50
- <a name="pluginArguments.keys.SCALE"></a>
51
-
52
- #### keys.SCALE : <code>object</code>
53
-
54
- The scales associated with the bar chart
55
- They are useful if you want to, via plugin, add a new component that
56
- uses the same scale as one of the measures.
57
-
58
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
59
-
60
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
61
- - [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
62
- - [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
63
- - [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
64
-
65
- <a name="pluginArguments.keys.SCALE.MAIN"></a>
66
-
67
- ##### SCALE.MAIN : <code>object</code>
68
-
69
- The main scales
70
-
71
- **Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
72
-
73
- - [.MAIN](#pluginArguments.keys.SCALE.MAIN) : <code>object</code>
74
- - [.MINOR](#pluginArguments.keys.SCALE.MAIN.MINOR) : <code>string</code>
75
- - [.MAJOR](#pluginArguments.keys.SCALE.MAIN.MAJOR) : <code>string</code>
76
-
77
- <a name="pluginArguments.keys.SCALE.MAIN.MINOR"></a>
78
-
79
- ###### MAIN.MINOR : <code>string</code>
80
-
81
- The main minor scale
82
-
83
- **Kind**: static property of [<code>MAIN</code>](#pluginArguments.keys.SCALE.MAIN)
84
- <a name="pluginArguments.keys.SCALE.MAIN.MAJOR"></a>
85
-
86
- ###### MAIN.MAJOR : <code>string</code>
87
-
88
- The main major scale
89
-
90
- **Kind**: static property of [<code>MAIN</code>](#pluginArguments.keys.SCALE.MAIN)
91
- <a name="pluginArguments.keys.COMPONENT"></a>
92
-
93
- #### keys.COMPONENT : <code>object</code>
94
-
95
- The unique keys of the existing components available in the chart.
96
- They are useful if you want to extend or override the existing components.
97
-
98
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
99
-
100
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
101
- - [.BAR](#pluginArguments.keys.COMPONENT.BAR) : <code>string</code>
102
- - [.BAR_AXIS](#pluginArguments.keys.COMPONENT.BAR_AXIS) : <code>string</code>
103
- - [.Y_AXIS](#pluginArguments.keys.COMPONENT.Y_AXIS) : <code>string</code>
104
- - [.MEASURE_TITLE](#pluginArguments.keys.COMPONENT.MEASURE_TITLE) : <code>string</code>
105
- - [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
106
-
107
- <a name="pluginArguments.keys.COMPONENT.BAR"></a>
108
-
109
- ##### COMPONENT.BAR : <code>string</code>
110
-
111
- The bar component
112
-
113
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
114
- <a name="pluginArguments.keys.COMPONENT.BAR_AXIS"></a>
115
-
116
- ##### COMPONENT.BAR_AXIS : <code>string</code>
117
-
118
- The bar axis component
119
-
120
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
121
- <a name="pluginArguments.keys.COMPONENT.Y_AXIS"></a>
122
-
123
- ##### COMPONENT.Y_AXIS : <code>string</code>
124
-
125
- The y axis component
126
-
127
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
128
- <a name="pluginArguments.keys.COMPONENT.MEASURE_TITLE"></a>
129
-
130
- ##### COMPONENT.MEASURE_TITLE : <code>string</code>
131
-
132
- The measure title component
133
-
134
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
135
- <a name="pluginArguments.keys.COMPONENT.DIMENSION_TITLE"></a>
136
-
137
- ##### COMPONENT.DIMENSION_TITLE : <code>string</code>
138
-
139
- The dimension title component
140
-
141
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
142
- <a name="pluginArguments.keys.COLLECTION"></a>
143
-
144
- #### keys.COLLECTION : <code>object</code>
145
-
146
- The data collections the users can use to get data from
147
-
148
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
149
- <a name="pluginArguments.keys.COLLECTION.MAIN"></a>
150
-
151
- ##### COLLECTION.MAIN : <code>string</code>
152
-
153
- The main data collection
154
-
155
- **Kind**: static property of [<code>COLLECTION</code>](#pluginArguments.keys.COLLECTION)
156
-
157
- # Definitions