aboutsummaryrefslogtreecommitdiff
path: root/api/pl.treksoft.kvision.chart/-legend-label-options/index.html
blob: 190971267f73c05406e9744120e2276f227fe182 (plain)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>LegendLabelOptions - kvision</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.chart</a>&nbsp;/&nbsp;<a href="./index.html">LegendLabelOptions</a><br/>
<br/>
<h1>LegendLabelOptions</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">LegendLabelOptions</span></code>
<p>Chart legend label options.</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">LegendLabelOptions</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/boxWidth">boxWidth</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a>&nbsp;<span class="symbol">=</span>&nbsp;40<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/fontSize">fontSize</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a>&nbsp;<span class="symbol">=</span>&nbsp;12<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/fontStyle">fontStyle</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.core/-font-style/index.html"><span class="identifier">FontStyle</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/fontColor">fontColor</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.core/-color/index.html"><span class="identifier">Color</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/fontFamily">fontFamily</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/padding">padding</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a>&nbsp;<span class="symbol">=</span>&nbsp;10<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/generateLabels">generateLabels</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">chart</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/filter">filter</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">legendItem</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-legend-label-item/index.html"><span class="identifier">ChartLegendLabelItem</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">data</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-data/index.html"><span class="identifier">ChartData</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.chart.LegendLabelOptions$<init>(kotlin.Int, kotlin.Int, pl.treksoft.kvision.core.FontStyle, pl.treksoft.kvision.core.Color, kotlin.String, kotlin.Int, kotlin.Function1((kotlin.Any, )), kotlin.Function2((pl.treksoft.kvision.chart.js.Chart.ChartLegendLabelItem, pl.treksoft.kvision.chart.js.Chart.ChartData, kotlin.Any)), kotlin.Boolean)/usePointStyle">usePointStyle</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;false<span class="symbol">)</span></code>
<p>Chart legend label options.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="box-width.html">boxWidth</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">boxWidth</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="filter.html">filter</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">filter</span><span class="symbol">: </span><span class="symbol">(</span><span class="identifier">legendItem</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-legend-label-item/index.html"><span class="identifier">ChartLegendLabelItem</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">data</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.chart.js/-chart/-chart-data/index.html"><span class="identifier">ChartData</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="font-color.html">fontColor</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">fontColor</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-color/index.html"><span class="identifier">Color</span></a><span class="symbol">?</span></code></td>
</tr>
<tr>
<td>
<p><a href="font-family.html">fontFamily</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">fontFamily</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code></td>
</tr>
<tr>
<td>
<p><a href="font-size.html">fontSize</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">fontSize</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="font-style.html">fontStyle</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">fontStyle</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-font-style/index.html"><span class="identifier">FontStyle</span></a><span class="symbol">?</span></code></td>
</tr>
<tr>
<td>
<p><a href="generate-labels.html">generateLabels</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">generateLabels</span><span class="symbol">: </span><span class="symbol">(</span><span class="identifier">chart</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="padding.html">padding</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">padding</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="use-point-style.html">usePointStyle</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">usePointStyle</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">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</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>&nbsp;<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">LegendLabelOptions</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>