From e992f3f13ec46cad15cc7d6982e64ffc7223eb9a Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 10 Mar 2019 14:42:30 +0100 Subject: API documentation for KVision 0.0.29 --- api/pl.treksoft.kvision.chart/-options/index.html | 217 ++++++++++++++++++++++ 1 file changed, 217 insertions(+) create mode 100644 api/pl.treksoft.kvision.chart/-options/index.html (limited to 'api/pl.treksoft.kvision.chart/-options/index.html') diff --git a/api/pl.treksoft.kvision.chart/-options/index.html b/api/pl.treksoft.kvision.chart/-options/index.html new file mode 100644 index 00000000..b438676e --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-options/index.html @@ -0,0 +1,217 @@ + + + +Options - kvision + + + +kvision / pl.treksoft.kvision.chart / Options
+
+

Options

+data class Options +

Chart options.

+

Constructors

+ + + + + + + +
+

<init>

+
+Options(responsive: Boolean = true, responsiveAnimationDuration: Int = 0, aspectRatio: Int = 2, maintainAspectRatio: Boolean = true, onResize: (chart: Chart, newSize: ChartSize) -> Unit = null, devicePixelRatio: Int? = null, hover: HoverOptions? = null, events: List<String>? = null, onHover: (chart: Chart, event: MouseEvent, activeElements: Array<Any>) -> Any = null, onClick: (chart: Chart, event: MouseEvent, activeElements: Array<Any>) -> Any = null, animation: AnimationOptions? = null, layout: LayoutOptions? = null, legend: LegendOptions? = null, legendCallback: (chart: Chart) -> String = null, title: TitleOptions? = null, tooltips: TooltipOptions? = null, elements: ElementsOptions? = null, scales: ChartScales? = null, showLines: Boolean? = null, spanGaps: Boolean? = null, cutoutPercentage: Int? = null, circumference: Double? = null, rotation: Double? = null) +

Chart options.

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

animation

+
+val animation: AnimationOptions?
+

aspectRatio

+
+val aspectRatio: Int
+

circumference

+
+val circumference: Double?
+

cutoutPercentage

+
+val cutoutPercentage: Int?
+

devicePixelRatio

+
+val devicePixelRatio: Int?
+

elements

+
+val elements: ElementsOptions?
+

events

+
+val events: List<String>?
+

hover

+
+val hover: HoverOptions?
+

layout

+
+val layout: LayoutOptions?
+

legend

+
+val legend: LegendOptions?
+

legendCallback

+
+val legendCallback: (chart: Chart) -> String
+

maintainAspectRatio

+
+val maintainAspectRatio: Boolean
+

onClick

+
+val onClick: (chart: Chart, event: MouseEvent, activeElements: Array<Any>) -> Any
+

onHover

+
+val onHover: (chart: Chart, event: MouseEvent, activeElements: Array<Any>) -> Any
+

onResize

+
+val onResize: (chart: Chart, newSize: ChartSize) -> Unit
+

responsive

+
+val responsive: Boolean
+

responsiveAnimationDuration

+
+val responsiveAnimationDuration: Int
+

rotation

+
+val rotation: Double?
+

scales

+
+val scales: ChartScales?
+

showLines

+
+val showLines: Boolean?
+

spanGaps

+
+val spanGaps: Boolean?
+

title

+
+val title: TitleOptions?
+

tooltips

+
+val tooltips: TooltipOptions?
+

Extension Functions

+ + + + + + + + + + + +
+

createInstance

+
+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+

toJs

+
+fun Options.toJs(i18nTranslator: (String) -> String): dynamic +

An extension function to convert configuration class to JS object.

+
+ + -- cgit