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/-chart/-init-.html | 25 ++ api/pl.treksoft.kvision.chart/-chart/chart.html | 16 + .../-chart/clear-chart.html | 15 + .../-chart/configuration.html | 15 + .../-chart/get-native-config.html | 15 + api/pl.treksoft.kvision.chart/-chart/index.html | 475 +++++++++++++++++++++ api/pl.treksoft.kvision.chart/-chart/render.html | 26 ++ api/pl.treksoft.kvision.chart/-chart/reset.html | 15 + .../-chart/resize-chart.html | 15 + api/pl.treksoft.kvision.chart/-chart/stop.html | 15 + .../-chart/to-base64-image.html | 15 + 11 files changed, 647 insertions(+) create mode 100644 api/pl.treksoft.kvision.chart/-chart/-init-.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/chart.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/clear-chart.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/configuration.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/get-native-config.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/index.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/render.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/reset.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/resize-chart.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/stop.html create mode 100644 api/pl.treksoft.kvision.chart/-chart/to-base64-image.html (limited to 'api/pl.treksoft.kvision.chart/-chart') diff --git a/api/pl.treksoft.kvision.chart/-chart/-init-.html b/api/pl.treksoft.kvision.chart/-chart/-init-.html new file mode 100644 index 00000000..ad683cd1 --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/-init-.html @@ -0,0 +1,25 @@ + + + +Chart.<init> - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / <init>
+
+

<init>

+ +

Chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf())

Parameters

+configuration - chart configuration

+chartWidth - chart width in pixels

+chartHeight - chart height in pixels

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/chart.html b/api/pl.treksoft.kvision.chart/-chart/chart.html new file mode 100644 index 00000000..a72bc019 --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/chart.html @@ -0,0 +1,16 @@ + + + +Chart.chart - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / chart
+
+

chart

+ +

fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: Chart.() -> Unit = null): Chart

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/clear-chart.html b/api/pl.treksoft.kvision.chart/-chart/clear-chart.html new file mode 100644 index 00000000..8c7dc941 --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/clear-chart.html @@ -0,0 +1,15 @@ + + + +Chart.clearChart - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / clearChart
+
+

clearChart

+ +open fun clearChart(): Unit +

Clears the chart.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/configuration.html b/api/pl.treksoft.kvision.chart/-chart/configuration.html new file mode 100644 index 00000000..1c74a21e --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/configuration.html @@ -0,0 +1,15 @@ + + + +Chart.configuration - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / configuration
+
+

configuration

+ +var configuration: Configuration +

Chart configuration.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/get-native-config.html b/api/pl.treksoft.kvision.chart/-chart/get-native-config.html new file mode 100644 index 00000000..6d223f66 --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/get-native-config.html @@ -0,0 +1,15 @@ + + + +Chart.getNativeConfig - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / getNativeConfig
+
+

getNativeConfig

+ +open fun getNativeConfig(): ChartConfiguration? +

Returns chart configuration in the form of native JS object.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/index.html b/api/pl.treksoft.kvision.chart/-chart/index.html new file mode 100644 index 00000000..148f9683 --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/index.html @@ -0,0 +1,475 @@ + + + +Chart - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart
+
+

Chart

+open class Chart : Widget +

Chart component.

Constructors

+ + + + + + + +

<init>

Chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf())

Properties

+ + + + + + + +

configuration

+var configuration: Configuration +

Chart configuration.

Inherited Properties

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

+ draggable +	+`var draggable: Boolean?` + Determines if the current widget is draggable. +
+ eventTarget +	+`var eventTarget: Widget?`
+ id +	+`var id: String?` + An ID attribute of generated HTML element. +
+ lastLanguage +	+`var lastLanguage: String?`
+ parent +	+`open var parent: Container?` + Parent of the current component. +
+ role +	+`var role: String?` + A role attribute of generated HTML element. +
+ surroundingSpan +	+`var surroundingSpan: Boolean`
+ title +	+`var title: String?` + A title attribute of generated HTML element. +
+ visible +	+`open var visible: Boolean` + Visibility state of the current component. +

Functions

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

+ clearChart +	+`open fun clearChart(): Unit` + Clears the chart. +
+ getNativeConfig +	+`open fun getNativeConfig(): ChartConfiguration?` + Returns chart configuration in the form of native JS object. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +`open fun render(duration: Int? = null, lazy: Boolean = false): Unit` + Renders the chart. +
+ reset +	+`open fun reset(): Unit` + Resets the chart. +
+ resizeChart +	+`open fun resizeChart(): Unit` + Resizes the chart to the size of the container. +
+ stop +	+`open fun stop(): Unit` + Stops the animation. +
+ toBase64Image +	+`open fun toBase64Image(): String?` + Returns a base64 encoded string of the chart in its current state. +

Inherited Functions

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

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ afterPostpatch +	+`open fun afterPostpatch(node: VNode): Unit` + Method called after updating Snabbdom vnode. +
+ clearDragDropData +	+`open fun clearDragDropData(): Unit` + Clears D&D data for the current widget. It also makes it not draggable. +
+ dispatchEvent +	+`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
+ getElement +	+`open fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`open fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`open fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ getSnHooks +	+`open fun getSnHooks(): Hooks?` + Returns list of hooks in the form of a Snabbdom Hooks object. +
+ getSnOn +	+`open fun getSnOn(): On?` + Returns list of event handlers in the form of a Snabbdom On object. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of parent component. +
+ render +	+`open fun render(elementName: String): VNode` +`open fun render(elementName: String, children: Array<dynamic>): VNode` + Renders current component as a Snabbdom vnode. +
+ setContextMenu +	+`open fun setContextMenu(contextMenu: ContextMenu): Widget` + Sets context menu for the current widget. +
+ setDragDropData +	+`open fun setDragDropData(format: String, data: String): Unit` + Sets D&D data for the current widget. It also makes it draggable. +
+ setDropTarget +	+`open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit` +`open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` + Sets the current widget as a D&D drop target. +
+ setDropTargetData +	+`open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit` + Sets the current widget as a D&D drop target with helper callback accepting String data. +
+ setEventListener +	+`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` + Sets an event listener for current widget, keeping the actual type of component. +`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` + Sets an event listener for current widget. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +
+ translate +	+`fun translate(text: String?): String?`

Companion Object Functions

+ + + + + + + +

chart

fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: Chart.() -> Unit = null): Chart

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/render.html b/api/pl.treksoft.kvision.chart/-chart/render.html new file mode 100644 index 00000000..5b67ba9a --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/render.html @@ -0,0 +1,26 @@ + + + +Chart.render - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ +open fun render(duration: Int? = null, lazy: Boolean = false): Unit +

Renders the chart.

Parameters

+duration - animation duration

+lazy - if true, the animation can be interrupted by other animations

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/reset.html b/api/pl.treksoft.kvision.chart/-chart/reset.html new file mode 100644 index 00000000..acc8455b --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/reset.html @@ -0,0 +1,15 @@ + + + +Chart.reset - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / reset
+
+

reset

+ +open fun reset(): Unit +

Resets the chart.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/resize-chart.html b/api/pl.treksoft.kvision.chart/-chart/resize-chart.html new file mode 100644 index 00000000..1fda8c21 --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/resize-chart.html @@ -0,0 +1,15 @@ + + + +Chart.resizeChart - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / resizeChart
+
+

resizeChart

+ +open fun resizeChart(): Unit +

Resizes the chart to the size of the container.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/stop.html b/api/pl.treksoft.kvision.chart/-chart/stop.html new file mode 100644 index 00000000..494b8a7a --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/stop.html @@ -0,0 +1,15 @@ + + + +Chart.stop - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / stop
+
+

stop

+ +open fun stop(): Unit +

Stops the animation.

+ + diff --git a/api/pl.treksoft.kvision.chart/-chart/to-base64-image.html b/api/pl.treksoft.kvision.chart/-chart/to-base64-image.html new file mode 100644 index 00000000..c0c4577c --- /dev/null +++ b/api/pl.treksoft.kvision.chart/-chart/to-base64-image.html @@ -0,0 +1,15 @@ + + + +Chart.toBase64Image - kvision + + + +kvision / pl.treksoft.kvision.chart / Chart / toBase64Image
+
+

toBase64Image

+ +open fun toBase64Image(): String? +

Returns a base64 encoded string of the chart in its current state.

+ + -- cgit