From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- api/pl.treksoft.kvision.html/-canvas/-init-.html | 2 +- .../-canvas/canvas-height.html | 2 +- .../-canvas/canvas-width.html | 2 +- .../-canvas/context2-d.html | 4 +- .../-canvas/get-sn-attrs.html | 3 +- api/pl.treksoft.kvision.html/-canvas/index.html | 614 +++------------------ api/pl.treksoft.kvision.html/-canvas/render.html | 3 +- 7 files changed, 69 insertions(+), 561 deletions(-) (limited to 'api/pl.treksoft.kvision.html/-canvas') diff --git a/api/pl.treksoft.kvision.html/-canvas/-init-.html b/api/pl.treksoft.kvision.html/-canvas/-init-.html index 7cae50d1..6b8586f0 100644 --- a/api/pl.treksoft.kvision.html/-canvas/-init-.html +++ b/api/pl.treksoft.kvision.html/-canvas/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Canvas / <init>

<init>

- +(js) Canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf())

Parameters

diff --git a/api/pl.treksoft.kvision.html/-canvas/canvas-height.html b/api/pl.treksoft.kvision.html/-canvas/canvas-height.html index bccfc42d..31bb924b 100644 --- a/api/pl.treksoft.kvision.html/-canvas/canvas-height.html +++ b/api/pl.treksoft.kvision.html/-canvas/canvas-height.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Canvas / canvasHeight

canvasHeight

- +(js) var canvasHeight: Int?

The height of the canvas.

Getter
diff --git a/api/pl.treksoft.kvision.html/-canvas/canvas-width.html b/api/pl.treksoft.kvision.html/-canvas/canvas-width.html index 741c8362..973b95aa 100644 --- a/api/pl.treksoft.kvision.html/-canvas/canvas-width.html +++ b/api/pl.treksoft.kvision.html/-canvas/canvas-width.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Canvas / canvasWidth

canvasWidth

- +(js) var canvasWidth: Int?

The width of the canvas.

Getter
diff --git a/api/pl.treksoft.kvision.html/-canvas/context2-d.html b/api/pl.treksoft.kvision.html/-canvas/context2-d.html index 9d85da89..6de81f63 100644 --- a/api/pl.treksoft.kvision.html/-canvas/context2-d.html +++ b/api/pl.treksoft.kvision.html/-canvas/context2-d.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.html / Canvas / context2D

context2D

- -lateinit var context2D: <ERROR CLASS> +(js) +lateinit var context2D: CanvasRenderingContext2D

The canvas rendering context.

diff --git a/api/pl.treksoft.kvision.html/-canvas/get-sn-attrs.html b/api/pl.treksoft.kvision.html/-canvas/get-sn-attrs.html index f4b23558..a25e562b 100644 --- a/api/pl.treksoft.kvision.html/-canvas/get-sn-attrs.html +++ b/api/pl.treksoft.kvision.html/-canvas/get-sn-attrs.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.html / Canvas / getSnAttrs

getSnAttrs

- +(js) protected open fun getSnAttrs(): List<StringPair> -

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
list of element attributes

diff --git a/api/pl.treksoft.kvision.html/-canvas/index.html b/api/pl.treksoft.kvision.html/-canvas/index.html index a5e07520..8650abe3 100644 --- a/api/pl.treksoft.kvision.html/-canvas/index.html +++ b/api/pl.treksoft.kvision.html/-canvas/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.html / Canvas

Canvas

-open class Canvas : Widget +(js) open class Canvas : Widget

Canvas component.

Constructors

@@ -27,140 +28,30 @@ +var canvasHeight: Int? +var canvasWidth: Int? - - -
-

<init>

+(js) +

<init>

 Canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf())
-

canvasHeight

+(js) +

canvasHeight

 -var canvasHeight: Int?

The height of the canvas.

-
-

canvasWidth

+(js) +

canvasWidth

 -var canvasWidth: Int?

The width of the canvas.

-
-

context2D

+(js) +

context2D

 -lateinit var context2D: <ERROR CLASS>

The canvas rendering context.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +lateinit var context2D: CanvasRenderingContext2D
-

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.

-
-

popoverOptions

-		 -var popoverOptions: PopoverOptions?
-

role

-		 -var role: String? -

A role attribute of generated HTML element.

-
-

surroundingSpan

-		 -var surroundingSpan: Boolean
-

tabindex

-		 -var tabindex: Int? -

A tabindex attribute of generated HTML element.

-
-

title

-		 -var title: String? -

A title attribute of generated HTML element.

-
-

tooltipOptions

-		 -var tooltipOptions: TooltipOptions?
-

visible

-		 -open var visible: Boolean -

Visibility state of the current component.

-
-

vnode

-		 -var vnode: VNode?
@@ -169,408 +60,21 @@ -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

Returns list of element attributes in the form of a List.

- +open fun getSnAttrs(): List<StringPair> -

render

+(js) +

render

-open fun render(): VNode

Renders current component as a Snabbdom vnode.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun render(): VNode
-

addCssClass

-		 -open fun addCssClass(css: String): Widget -

Adds given value to the set of CSS classes generated in html code of current component.

-
-

addCssStyle

-		 -open fun addCssStyle(css: Style): Widget -

Adds given style object 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.

-
-

addSurroundingCssStyle

-		 -open fun addSurroundingCssStyle(css: Style): Widget -

Adds given style object 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.

-
-

clearDragDropData

-		 -open fun clearDragDropData(): Unit -

Clears D&D data for the current widget. It also makes it not draggable.

-
-

disablePopover

-		 -open fun disablePopover(): Widget -

Disables popover for the current widget.

-
-

disableTooltip

-		 -open fun disableTooltip(): Widget -

Disables tooltip for the current widget.

-
-

dispatchEvent

-		 -open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
-

enablePopover

-		 -open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget -

Enables popover for the current widget.

-
-

enableTooltip

-		 -open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget -

Enables tooltip for the current widget.

-
-

getAttribute

-		 -open fun getAttribute(name: String): String? -

Returns the value of an additional attribute.

-
-

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.

-
-

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.

-
-

hidePopover

-		 -open fun hidePopover(): Widget -

Hides popover for the current widget.

-
-

hideTooltip

-		 -open fun hideTooltip(): Widget -

Hides tooltip for the current widget.

-
-

refreshOnUpdate

-		 -fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-

removeAttribute

-		 -open fun removeAttribute(name: String): Widget -

Removes the value of additional attribute.

-
-

removeCssClass

-		 -open fun removeCssClass(css: String): Widget -

Removes given value from the set of CSS classes generated in html code of current component.

-
-

removeCssStyle

-		 -open fun removeCssStyle(css: Style): Widget -

Removes given style object from the set of CSS classes generated in html code of current component.

-
-

removeEventListener

-		 -open fun removeEventListener(id: Int): Widget -

Removes event listener from current widget.

-
-

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.

-
-

removeSurroundingCssStyle

-		 -open fun removeSurroundingCssStyle(css: Style): Widget -

Removes given style object 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.

-
-

setAttribute

-		 -open fun setAttribute(name: String, value: String): Widget -

Sets the value of additional attribute.

-
-

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): Int -

Sets an event listener for current widget, keeping the actual type of component.

-
-

show

-		 -open fun show(): Widget -

Makes current widget visible.

-
-

showPopover

-		 -open fun showPopover(): Widget -

Shows popover for the current widget.

-
-

showTooltip

-		 -open fun showTooltip(): Widget -

Shows tooltip for the current widget.

-
-

singleRender

-		 -fun <T> singleRender(block: () -> T): T
-

toggleVisible

-		 -open fun toggleVisible(): Widget -

Toggles visibility of current widget.

-
-

translate

-		 -fun translate(text: String?): String?
@@ -579,24 +83,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -605,123 +112,126 @@ -

addBsBgColor

+(js) +

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit -

addBsBorder

+(js) +

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit -

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit -

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit -

contextMenu

+(js) +

contextMenu

-fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu

DSL builder extension function.

- - - - -

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

- +fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu -

eventFlow

+(js) +

eventFlow

-fun <T : Widget> T.eventFlow(event: String): <ERROR CLASS><Pair<T, Event>> +fun <T : Widget> T.eventFlow(event: String): Flow<Pair<T, Event>> -

onEvent

+(js) +

onEvent

-fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int +fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int -

removeBsBgColor

+(js) +

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit -

removeBsBorder

+(js) +

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit -

removeBsClearfix

+(js) +

removeBsClearfix

fun Component.removeBsClearfix(): Unit -

removeBsColor

+(js) +

removeBsColor

fun Component.removeBsColor(bsColor: BsColor): Unit -

removeBsRounded

+(js) +

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit -

setContextMenu

+(js) +

setContextMenu

-fun Widget.setContextMenu(contextMenu: ContextMenu): Widget

Sets context menu for the current widget.

- +fun Widget.setContextMenu(contextMenu: ContextMenu): Widget -

style

+(js) +

style

-fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style

DSL builder extension function.

- +fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style diff --git a/api/pl.treksoft.kvision.html/-canvas/render.html b/api/pl.treksoft.kvision.html/-canvas/render.html index 8aea9910..aa9cb6b5 100644 --- a/api/pl.treksoft.kvision.html/-canvas/render.html +++ b/api/pl.treksoft.kvision.html/-canvas/render.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.html / Canvas / render

render

- +(js) protected open fun render(): VNode -

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
Snabbdom vnode

-- cgit