1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>LegendOptions - kvision</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.chart</a> / <a href="./index.html">LegendOptions</a><br/>
<br/>
<h1>LegendOptions</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">LegendOptions</span></code>
<p>Chart legend options.</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html"><init></a></p>
</td>
<td>
<code><span class="identifier">LegendOptions</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/display">display</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/position">position</span><span class="symbol">:</span> <a href="../-position/index.html"><span class="identifier">Position</span></a> <span class="symbol">=</span> Position.TOP<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/fullWidth">fullWidth</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/reverse">reverse</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/onClick">onClick</span><span class="symbol">:</span> <span class="symbol">(</span><span class="identifier">event</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><span class="symbol">,</span> <span class="identifier">legendItem</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-legend-label-item/index.html"><span class="identifier">ChartLegendLabelItem</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/onHover">onHover</span><span class="symbol">:</span> <span class="symbol">(</span><span class="identifier">event</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><span class="symbol">,</span> <span class="identifier">legendItem</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-legend-label-item/index.html"><span class="identifier">ChartLegendLabelItem</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendOptions$<init>(kotlin.Boolean, pl.treksoft.kvision.chart.Position, kotlin.Boolean, kotlin.Boolean, kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), kotlin.Function2((org.w3c.dom.events.MouseEvent, pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, kotlin.Unit)), pl.treksoft.kvision.chart.LegendLabelOptions)/labels">labels</span><span class="symbol">:</span> <a href="../-legend-label-options/index.html"><span class="identifier">LegendLabelOptions</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code>
<p>Chart legend options.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="display.html">display</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">display</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="full-width.html">fullWidth</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">fullWidth</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="labels.html">labels</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">labels</span><span class="symbol">: </span><a href="../-legend-label-options/index.html"><span class="identifier">LegendLabelOptions</span></a><span class="symbol">?</span></code></td>
</tr>
<tr>
<td>
<p><a href="on-click.html">onClick</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">onClick</span><span class="symbol">: </span><span class="symbol">(</span><span class="identifier">event</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><span class="symbol">,</span> <span class="identifier">legendItem</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-legend-label-item/index.html"><span class="identifier">ChartLegendLabelItem</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="on-hover.html">onHover</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">onHover</span><span class="symbol">: </span><span class="symbol">(</span><span class="identifier">event</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><span class="symbol">,</span> <span class="identifier">legendItem</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-legend-label-item/index.html"><span class="identifier">ChartLegendLabelItem</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="position.html">position</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">position</span><span class="symbol">: </span><a href="../-position/index.html"><span class="identifier">Position</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="reverse.html">reverse</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">reverse</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Extension Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code>
<p>Helper function for creating JavaScript objects from dynamic constructors.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../to-js.html">toJs</a></p>
</td>
<td>
<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">LegendOptions</span></a><span class="symbol">.</span><span class="identifier">toJs</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="keyword">dynamic</span></code>
<p>An extension function to convert configuration class to JS object.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
|
