From bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 23 Jun 2019 14:12:10 +0200 Subject: API documentation for KVision 0.0.37 --- api/index-outline.html | 3193 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 2884 insertions(+), 309 deletions(-) (limited to 'api/index-outline.html') diff --git a/api/index-outline.html b/api/index-outline.html index 5f08a081..f961b984 100644 --- a/api/index-outline.html +++ b/api/index-outline.html @@ -540,6 +540,50 @@ +object Battery
+ +external class BatteryStatus
+ enum class BgAttach
+external class Browser
+ open external class BrowserView : EventEmitter
+object Camera
+ +class CameraException : Exception
+ +data class CameraOptions
+ open class Canvas : Widget
+class CaptureException : Exception
+ open class Cell : Tag
+external class Coordinates
+ +enum class CordovaEvent
+ external interface CPUUsage
+external class Device
+ external interface DevToolsExtensions
open class Dialog<R> : Modal
+external interface DirectoryEntry : Entry
+ +external interface DirectoryEntryCallback
+external interface DirectoryEntrySync : EntrySync
+ +external interface DirectoryReader
+ +external interface DirectoryReaderSync
+ typealias Dispatch<A> = (A) -> <ERROR CLASS>
external interface Display
-external interface Event
+external interface EntriesCallback
+external interface Entry
-open external class EventEmitter
+external interface EntryCallback
+external interface EntrySync
+external interface ErrorCallback
+external interface Event
+ +open external class EventEmitter
+ +object File
+ +external interface FileCallback
+external interface FileEntry : Entry
+ +external interface FileEntryCallback
+external interface FileEntrySync : EntrySync
+ +class FileException : Exception
+ external interface FileFilter
+external interface FileSaver : EventTarget
+ +external interface FileSystem
+ +external interface FileSystemCallback
+external interface FileSystemSync
+ +external interface FileWriter : FileSaver
+ +external interface FileWriterCallback
+external interface FileWriterSync
+ external interface Filter
+external interface Flags
+ enum class FlexAlignContent
+object Geolocation
+ +class GeolocationException : Exception
+ typealias GetState<S> = () -> S
external interface GlobalShortcut : EventEmitter
+object InAppBrowser
+ +external class InAppBrowserEvent
+ external interface InAppPurchase : EventEmitter
+kotlin.String
+ open class KVController
+external object LocalFileSystem
+ +external object LocalFileSystemSync
+ +object Locationservices
+ external interface LoginItemSettings
+external class Media
+ +object MediaCapture
+ +external class MediaError
+ +external class MediaFile
+ +external class MediaFileData
+ external interface MediaFlags
+external interface Metadata
+ +external interface MetadataCallback
external interface MimeTypedBuffer
+object Network
+ external interface NewWindowEvent : Event
+object Notification
+ open external class Notification : EventEmitter
+class Pace
+ +class PaceAjaxOptions
+ +class PaceElementsOptions
+ +class PaceEventLagOptions
+ +class PaceOptions
+ external interface PageFaviconUpdatedEvent : Event
+external class PendingResult
+ external interface PermissionRequestHandlerDetails
+external class Position
+ enum class Position
+enum class PositionError
+ external interface PowerMonitor : EventEmitter
+external class PromptResponse
+ external interface Protocol : EventEmitter
-external interface Result
+sealed class Result<out V : Any, out E>
-open class RichText : AbstractText
+open operator fun component1(): V?
+open operator fun component2(): E?
+fun <E> error(ex: E): Result.Failure<E>
+class Failure<out E> : Result<Nothing, E>
-open class RichTextInput : AbstractTextInput
+inline fun <X> fold(success: (V) -> X, failure: (E) -> X): X
+abstract fun get(): V
+fun <V : Any> of(value: V?, fail: () -> Exception = { Exception() }): Result<V, Exception>
+fun <V : Any, E> of(f: () -> V): Result<V, E>
+class Success<out V : Any> : Result<V, Nothing>
-class Root : SimplePanel
+fun <V : Any> success(v: V): Result.Success<V>
+ + + +external interface Result
+external class ResumeEvent
+ +open class RichText : AbstractText
+ +open class RichTextInput : AbstractTextInput
+ +class Root : SimplePanel
+ @@ -8845,6 +10000,41 @@ +object Screen
+ external interface Screen : EventEmitter
+object Splashscreen
+ open class SplitPanel : SimplePanel
+object StatusBar
+ external interface StreamProtocolResponse
-abstract class StyledComponent : Component
+abstract class StyledComponent
+external class SystemDirs
+ external interface SystemMemoryInfo
+object Vibration
+ +external interface VoidCallback
open class VPanel : FlexPanel
-open class Widget : StyledComponent
+open class Widget : StyledComponent, Component
protected fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
protected fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
+open fun removeAttribute(name: String): Widget
open fun removeCssClass(css: String): Widget
open fun removeCssClass(css: Style): Widget
open fun removeEventListeners(): Widget
@@ -13341,6 +14589,7 @@ protected open fun render(elementName: String): VNode
protected open fun render(elementName: String, children: Array<dynamic>): VNode
var role: String?
+open fun setAttribute(name: String, value: String): Widget
open fun setContextMenu(contextMenu: ContextMenu): Widget
open fun setDragDropData(format: String, data: String): Unit
open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit
@@ -13352,6 +14601,7 @@ open fun showPopover(): Widget
open fun showTooltip(): Widget
protected fun <T> singleRender(block: () -> T): T
+var strictDOM: Boolean
protected var surroundingSpan: Boolean
var title: String?
open fun toggleVisible(): Widget
@@ -14918,11 +16168,1316 @@ -open var ticks: Chart.TickOptions?
+open var ticks: Chart.TickOptions?
+ + + +interface LinearTickOptions : Chart.TickOptions
+ +interface LogarithmicScale : Chart.ChartScales
+ +interface LogarithmicTickOptions : Chart.TickOptions
+interface NestedTickOptions
+ +var plugins: PluginServiceStatic
+var pluginService: PluginServiceStatic
+interface Point
+ +interface PointLabelOptions
+ +interface Positioners
+interface RadialChartOptions : Chart.ChartOptions
+ +interface RadialLinearScale : Chart.LinearScale
+ +open fun render(duration: Any? = definedExternally, lazy: Any? = definedExternally): Any
+open fun reset(): Any
+open fun resize(): Any
+interface ScaleTitleOptions
+ +open fun stop(): Any
+interface TickOptions : Chart.NestedTickOptions
+ +interface TimeDisplayFormat
+ +interface TimeScale : Chart.ChartScales
+ +open fun toBase64Image(): String
+var Tooltip: Chart.ChartTooltipsStaticConfiguration
+open fun update(duration: Any? = definedExternally, lazy: Any? = definedExternally): Any
+ + + +external interface Defaults
+ +inline operator fun Defaults.get(key: String): Any?
+inline operator fun Chart.Positioners.get(mode: String): ((elements: Array<Any>, eventPosition: Chart.Point) -> Chart.Point)?
+inline operator fun Chart.ChartPluginsOptions.get(pluginId: String): Any?
+external interface Meta
+ +external interface MetaData
+ +external interface Model
+ +external interface PluginServiceGlobalRegistration
+ +external interface PluginServiceRegistrationOptions
+ +open external class PluginServiceStatic
+ +inline operator fun Defaults.set(key: String, value: Any): Unit
+inline operator fun Chart.Positioners.set(mode: String, noinline value: (elements: Array<Any>, eventPosition: Chart.Point) -> Chart.Point): Unit
+inline operator fun Chart.ChartPluginsOptions.set(pluginId: String, value: Any): Unit
+ + + +package pl.treksoft.kvision.cordova
+ +object Notification
-interface PointLabelOptions
+infix fun <V : Any, E> Result<V, E>.or(fallback: V): Result.Success<V>
+external class PendingResult
-interface Positioners
-interface RadialChartOptions : Chart.ChartOptions
+external class Position
-interface RadialLinearScale : Chart.LinearScale
+enum class PositionError
-open fun render(duration: Any? = definedExternally, lazy: Any? = definedExternally): Any
-open fun reset(): Any
-open fun resize(): Any
-interface ScaleTitleOptions
+external class PromptResponse
-open fun stop(): Any
-interface TickOptions : Chart.NestedTickOptions
+suspend fun FileEntry.readAsArrayBuffer(): Result<<ERROR CLASS>, FileException>
+suspend fun FileEntry.readAsDataURL(): Result<String, FileException>
+suspend fun FileEntry.readAsText(): Result<String, FileException>
+suspend fun DirectoryReader.readEntries(): Result<List<Entry>, FileException>
+suspend fun DirectoryEntry.readEntries(): Result<List<Entry>, FileException>
+suspend fun Entry.remove(): Result<Entry, FileException>
+suspend fun DirectoryEntry.removeRecursively(): Result<DirectoryEntry, FileException>
+sealed class Result<out V : Any, out E>
-interface TimeDisplayFormat
+open operator fun component1(): V?
+open operator fun component2(): E?
+fun <E> error(ex: E): Result.Failure<E>
+class Failure<out E> : Result<Nothing, E>
-interface TimeScale : Chart.ChartScales
+inline fun <X> fold(success: (V) -> X, failure: (E) -> X): X
+abstract fun get(): V
+fun <V : Any> of(value: V?, fail: () -> Exception = { Exception() }): Result<V, Exception>
+fun <V : Any, E> of(f: () -> V): Result<V, E>
+class Success<out V : Any> : Result<V, Nothing>
-open fun toBase64Image(): String
-var Tooltip: Chart.ChartTooltipsStaticConfiguration
-open fun update(duration: Any? = definedExternally, lazy: Any? = definedExternally): Any
+fun <V : Any> success(v: V): Result.Success<V>
-external interface Defaults
+external class ResumeEvent
-inline operator fun Defaults.get(key: String): Any?
-inline operator fun Chart.Positioners.get(mode: String): ((elements: Array<Any>, eventPosition: Chart.Point) -> Chart.Point)?
-inline operator fun Chart.ChartPluginsOptions.get(pluginId: String): Any?
-external interface Meta
+object Screen
-external interface MetaData
+fun addOrientationChangeListener(listener: (Screen.Orientation) -> Unit): Unit
+fun getOrientation(): Screen.Orientation
+fun lock(orientation: Screen.Orientation): Unit
+enum class Orientation
-external interface Model
+fun unlock(): Unit
+ + + +object Splashscreen
-external interface PluginServiceGlobalRegistration
+object StatusBar
-external interface PluginServiceRegistrationOptions
+inline fun <V : Any> Result<V, *>.success(f: (V) -> Unit): Unit
+external class SystemDirs
-open external class PluginServiceStatic
+fun <ERROR CLASS>.toBlob(): <ERROR CLASS>
+object Vibration
-inline operator fun Defaults.set(key: String, value: Any): Unit
-inline operator fun Chart.Positioners.set(mode: String, noinline value: (elements: Array<Any>, eventPosition: Chart.Point) -> Chart.Point): Unit
-inline operator fun Chart.ChartPluginsOptions.set(pluginId: String, value: Any): Unit
+external interface VoidCallback
+suspend fun FileEntry.write(data: <ERROR CLASS>): Result<FileEntry, FileException>
+suspend fun FileEntry.write(data: String): Result<FileEntry, FileException>
+suspend fun FileEntry.writeDataUrL(dataUrl: String): Result<FileEntry, FileException>
@@ -15639,14 +18143,17 @@ abstract fun addCssClass(css: Style): Component
abstract fun addSurroundingCssClass(css: String): Component
abstract fun addSurroundingCssClass(css: Style): Component
+abstract fun getAttribute(name: String): String?
abstract fun getElement(): Node?
abstract fun getElementJQuery(): JQuery?
abstract fun getElementJQueryD(): dynamic
abstract var parent: Container?
+abstract fun removeAttribute(name: String): Component
abstract fun removeCssClass(css: String): Component
abstract fun removeCssClass(css: Style): Component
abstract fun removeSurroundingCssClass(css: String): Component
abstract fun removeSurroundingCssClass(css: Style): Component
+abstract fun setAttribute(name: String, value: String): Component
abstract var visible: Boolean
@@ -15924,15 +18431,7 @@ Style(className: String? = null, parentStyle: Style? = null, init: (Style.() -> Unit)? = null)
-open fun addCssClass(css: String): Component
-open fun addCssClass(css: Style): Component
-open fun addSurroundingCssClass(css: String): Component
-open fun addSurroundingCssClass(css: Style): Component
var className: String
-open fun getElement(): Node?
-open fun getElementJQuery(): JQuery?
-open fun getElementJQueryD(): dynamic
-open var parent: Container?
protected inner class RefreshDelegate<T>
protected fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Style.RefreshDelegateProvider<T>
protected fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Style.RefreshDelegateProvider<T>
-open fun removeCssClass(css: String): Component
-open fun removeCssClass(css: Style): Component
-open fun removeSurroundingCssClass(css: String): Component
-open fun removeSurroundingCssClass(css: Style): Component
fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style
fun Style.style(className: String? = null, init: (Style.() -> Unit)? = null): Style
-open var visible: Boolean
-abstract class StyledComponent : Component
+abstract class StyledComponent
-open class Widget : StyledComponent
+open class Widget : StyledComponent, Component
protected fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
protected fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
+open fun removeAttribute(name: String): Widget
open fun removeCssClass(css: String): Widget
open fun removeCssClass(css: Style): Widget
open fun removeEventListeners(): Widget
@@ -16372,6 +18868,7 @@ protected open fun render(elementName: String): VNode
protected open fun render(elementName: String, children: Array<dynamic>): VNode
var role: String?
+open fun setAttribute(name: String, value: String): Widget
open fun setContextMenu(contextMenu: ContextMenu): Widget
open fun setDragDropData(format: String, data: String): Unit
open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit
@@ -16383,6 +18880,7 @@ open fun showPopover(): Widget
open fun showTooltip(): Widget
protected fun <T> singleRender(block: () -> T): T
+var strictDOM: Boolean
protected var surroundingSpan: Boolean
var title: String?
open fun toggleVisible(): Widget
@@ -16525,8 +19023,11 @@ -ContextMenu(classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null)
-fun Widget.contextMenu(classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu
+ContextMenu(element: Widget? = null, fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null)
+fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu
+const val DEFAULT_FIXED_POS_X: Int
+const val DEFAULT_FIXED_POS_Y: Int
+protected val fixedPosition: Boolean
open fun positionMenu(mouseEvent: MouseEvent): ContextMenu
@@ -23526,6 +26027,7 @@ H5
H6
HEADER
+HR
I
INPUT
INS
@@ -23566,15 +26068,10 @@ Tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), attributes: Map<String, String> = mapOf(), init: (Tag.() -> Unit)? = null)
var align: Align?
-protected val attributes: MutableMap<String, String>
open var content: String?
-fun getAttribute(name: String): String?
-protected open fun getSnAttrs(): List<StringPair>
protected open fun getSnClass(): List<StringBoolPair>
-fun removeAttribute(name: String): Widget
protected open fun render(): VNode
open var rich: Boolean
-fun setAttribute(name: String, value: String): Widget
fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), attributes: Map<String, String> = mapOf(), init: (Tag.() -> Unit)? = null): Tag
open var template: ((Any?) -> String)?
open var templates: Map<String, (Any?) -> String>
@@ -23993,6 +26490,88 @@ +package pl.treksoft.kvision.pace
+ package pl.treksoft.kvision.panel
fun DownloadConfig.toJs(): Tabulator.DownloadConfig
-fun <T : Any> ColumnDefinition<T>.toJs(i18nTranslator: (String) -> String, dataSerializer: KSerializer<T>? = null): Tabulator.ColumnDefinition
-fun <T : Any> TabulatorOptions<T>.toJs(i18nTranslator: (String) -> String, dataSerializer: KSerializer<T>? = null): Tabulator.Options
+fun <T : Any> ColumnDefinition<T>.toJs(i18nTranslator: (String) -> String): Tabulator.ColumnDefinition
+fun <T : Any> TabulatorOptions<T>.toJs(i18nTranslator: (String) -> String): Tabulator.Options
enum class TooltipGenerationMode