diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.chart/-legend-options/index.html | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.chart/-legend-options/index.html')
| -rw-r--r-- | api1/pl.treksoft.kvision.chart/-legend-options/index.html | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.chart/-legend-options/index.html b/api1/pl.treksoft.kvision.chart/-legend-options/index.html new file mode 100644 index 00000000..4f06ab67 --- /dev/null +++ b/api1/pl.treksoft.kvision.chart/-legend-options/index.html @@ -0,0 +1,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="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">Chart.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><span class="symbol">?</span> <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="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">Chart.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><span class="symbol">?</span> <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="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">Chart.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><span class="symbol">?</span></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="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">Chart.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><span class="symbol">?</span></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> |