From eeb8fdf8f890daeed907a6d0591ea6fae8421860 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 6 Mar 2019 13:53:58 +0100 Subject: API documentation for KVision 0.0.28 --- .../-native-image/-init-.html | 14 ++ .../-native-image/add-representation.html | 14 ++ .../-native-image/create-empty.html | 14 ++ .../-native-image/create-from-buffer.html | 14 ++ .../-native-image/create-from-data-u-r-l.html | 14 ++ .../-native-image/create-from-named-image.html | 14 ++ .../-native-image/create-from-path.html | 14 ++ .../-native-image/crop.html | 14 ++ .../-native-image/get-aspect-ratio.html | 14 ++ .../-native-image/get-bitmap.html | 14 ++ .../-native-image/get-native-handle.html | 14 ++ .../-native-image/get-size.html | 14 ++ .../-native-image/index.html | 182 +++++++++++++++++++++ .../-native-image/is-empty.html | 14 ++ .../-native-image/is-template-image.html | 14 ++ .../-native-image/resize.html | 14 ++ .../-native-image/set-template-image.html | 14 ++ .../-native-image/to-bitmap.html | 14 ++ .../-native-image/to-data-u-r-l.html | 14 ++ .../-native-image/to-j-p-e-g.html | 14 ++ .../-native-image/to-p-n-g.html | 14 ++ 21 files changed, 462 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-native-image/-init-.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/add-representation.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/create-empty.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/create-from-buffer.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/create-from-data-u-r-l.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/create-from-named-image.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/create-from-path.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/crop.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/get-aspect-ratio.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/get-bitmap.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/get-native-handle.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/get-size.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/index.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/is-empty.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/is-template-image.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/resize.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/set-template-image.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/to-bitmap.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/to-data-u-r-l.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/to-j-p-e-g.html create mode 100644 api/pl.treksoft.kvision.electron/-native-image/to-p-n-g.html (limited to 'api/pl.treksoft.kvision.electron/-native-image') diff --git a/api/pl.treksoft.kvision.electron/-native-image/-init-.html b/api/pl.treksoft.kvision.electron/-native-image/-init-.html new file mode 100644 index 00000000..6252dd44 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/-init-.html @@ -0,0 +1,14 @@ + + + +NativeImage.<init> - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / <init>
+
+

<init>

+ +NativeImage() + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/add-representation.html b/api/pl.treksoft.kvision.electron/-native-image/add-representation.html new file mode 100644 index 00000000..dce38e8a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/add-representation.html @@ -0,0 +1,14 @@ + + + +NativeImage.addRepresentation - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / addRepresentation
+
+

addRepresentation

+ +open fun addRepresentation(options: AddRepresentationOptions): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/create-empty.html b/api/pl.treksoft.kvision.electron/-native-image/create-empty.html new file mode 100644 index 00000000..55b5bee4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/create-empty.html @@ -0,0 +1,14 @@ + + + +NativeImage.createEmpty - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / createEmpty
+
+

createEmpty

+ +fun createEmpty(): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/create-from-buffer.html b/api/pl.treksoft.kvision.electron/-native-image/create-from-buffer.html new file mode 100644 index 00000000..787d3f7b --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/create-from-buffer.html @@ -0,0 +1,14 @@ + + + +NativeImage.createFromBuffer - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / createFromBuffer
+
+

createFromBuffer

+ +fun createFromBuffer(buffer: <ERROR CLASS>, options: CreateFromBufferOptions? = definedExternally): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/create-from-data-u-r-l.html b/api/pl.treksoft.kvision.electron/-native-image/create-from-data-u-r-l.html new file mode 100644 index 00000000..a7791b8c --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/create-from-data-u-r-l.html @@ -0,0 +1,14 @@ + + + +NativeImage.createFromDataURL - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / createFromDataURL
+
+

createFromDataURL

+ +fun createFromDataURL(dataURL: String): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/create-from-named-image.html b/api/pl.treksoft.kvision.electron/-native-image/create-from-named-image.html new file mode 100644 index 00000000..65890903 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/create-from-named-image.html @@ -0,0 +1,14 @@ + + + +NativeImage.createFromNamedImage - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / createFromNamedImage
+
+

createFromNamedImage

+ +fun createFromNamedImage(imageName: String, hslShift: Array<Number>): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/create-from-path.html b/api/pl.treksoft.kvision.electron/-native-image/create-from-path.html new file mode 100644 index 00000000..12782b91 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/create-from-path.html @@ -0,0 +1,14 @@ + + + +NativeImage.createFromPath - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / createFromPath
+
+

createFromPath

+ +fun createFromPath(path: String): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/crop.html b/api/pl.treksoft.kvision.electron/-native-image/crop.html new file mode 100644 index 00000000..4dc0bf90 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/crop.html @@ -0,0 +1,14 @@ + + + +NativeImage.crop - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / crop
+
+

crop

+ +open fun crop(rect: Rectangle): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/get-aspect-ratio.html b/api/pl.treksoft.kvision.electron/-native-image/get-aspect-ratio.html new file mode 100644 index 00000000..624e19e4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/get-aspect-ratio.html @@ -0,0 +1,14 @@ + + + +NativeImage.getAspectRatio - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / getAspectRatio
+
+

getAspectRatio

+ +open fun getAspectRatio(): Number + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/get-bitmap.html b/api/pl.treksoft.kvision.electron/-native-image/get-bitmap.html new file mode 100644 index 00000000..1ba796f2 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/get-bitmap.html @@ -0,0 +1,14 @@ + + + +NativeImage.getBitmap - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / getBitmap
+
+

getBitmap

+ +open fun getBitmap(options: BitmapOptions? = definedExternally): <ERROR CLASS> + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/get-native-handle.html b/api/pl.treksoft.kvision.electron/-native-image/get-native-handle.html new file mode 100644 index 00000000..0f83f4cc --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/get-native-handle.html @@ -0,0 +1,14 @@ + + + +NativeImage.getNativeHandle - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / getNativeHandle
+
+

getNativeHandle

+ +open fun getNativeHandle(): <ERROR CLASS> + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/get-size.html b/api/pl.treksoft.kvision.electron/-native-image/get-size.html new file mode 100644 index 00000000..971848ea --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/get-size.html @@ -0,0 +1,14 @@ + + + +NativeImage.getSize - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / getSize
+
+

getSize

+ +open fun getSize(): Size + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/index.html b/api/pl.treksoft.kvision.electron/-native-image/index.html new file mode 100644 index 00000000..0394d34d --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/index.html @@ -0,0 +1,182 @@ + + + +NativeImage - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage
+
+

NativeImage

+open external class NativeImage +

Constructors

+ + + + + + + +

<init>

+NativeImage()

Functions

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

+ addRepresentation +	+`open fun addRepresentation(options: AddRepresentationOptions): Unit`
+ crop +	+`open fun crop(rect: Rectangle): NativeImage`
+ getAspectRatio +	+`open fun getAspectRatio(): Number`
+ getBitmap +	+`open fun getBitmap(options: BitmapOptions? = definedExternally): <ERROR CLASS>`
+ getNativeHandle +	+`open fun getNativeHandle(): <ERROR CLASS>`
+ getSize +	+`open fun getSize(): Size`
+ isEmpty +	+`open fun isEmpty(): Boolean`
+ isTemplateImage +	+`open fun isTemplateImage(): Boolean`
+ resize +	+`open fun resize(options: ResizeOptions): NativeImage`
+ setTemplateImage +	+`open fun setTemplateImage(option: Boolean): Unit`
+ toBitmap +	+`open fun toBitmap(options: ToBitmapOptions? = definedExternally): <ERROR CLASS>`
+ toDataURL +	+`open fun toDataURL(options: ToDataURLOptions? = definedExternally): String`
+ toJPEG +	+`open fun toJPEG(quality: Number): <ERROR CLASS>`
+ toPNG +	+`open fun toPNG(options: ToPNGOptions? = definedExternally): <ERROR CLASS>`

Companion Object Functions

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

+ createEmpty +	+`fun createEmpty(): NativeImage`
+ createFromBuffer +	+`fun createFromBuffer(buffer: <ERROR CLASS>, options: CreateFromBufferOptions? = definedExternally): NativeImage`
+ createFromDataURL +	+`fun createFromDataURL(dataURL: String): NativeImage`
+ createFromNamedImage +	+`fun createFromNamedImage(imageName: String, hslShift: Array<Number>): NativeImage`
+ createFromPath +	+`fun createFromPath(path: String): NativeImage`

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.electron/-native-image/is-empty.html b/api/pl.treksoft.kvision.electron/-native-image/is-empty.html new file mode 100644 index 00000000..51db5887 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/is-empty.html @@ -0,0 +1,14 @@ + + + +NativeImage.isEmpty - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / isEmpty
+
+

isEmpty

+ +open fun isEmpty(): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/is-template-image.html b/api/pl.treksoft.kvision.electron/-native-image/is-template-image.html new file mode 100644 index 00000000..1baa3c5d --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/is-template-image.html @@ -0,0 +1,14 @@ + + + +NativeImage.isTemplateImage - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / isTemplateImage
+
+

isTemplateImage

+ +open fun isTemplateImage(): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/resize.html b/api/pl.treksoft.kvision.electron/-native-image/resize.html new file mode 100644 index 00000000..a2ded41e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/resize.html @@ -0,0 +1,14 @@ + + + +NativeImage.resize - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / resize
+
+

resize

+ +open fun resize(options: ResizeOptions): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/set-template-image.html b/api/pl.treksoft.kvision.electron/-native-image/set-template-image.html new file mode 100644 index 00000000..5a35bc92 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/set-template-image.html @@ -0,0 +1,14 @@ + + + +NativeImage.setTemplateImage - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / setTemplateImage
+
+

setTemplateImage

+ +open fun setTemplateImage(option: Boolean): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/to-bitmap.html b/api/pl.treksoft.kvision.electron/-native-image/to-bitmap.html new file mode 100644 index 00000000..c131b4e9 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/to-bitmap.html @@ -0,0 +1,14 @@ + + + +NativeImage.toBitmap - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / toBitmap
+
+

toBitmap

+ +open fun toBitmap(options: ToBitmapOptions? = definedExternally): <ERROR CLASS> + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/to-data-u-r-l.html b/api/pl.treksoft.kvision.electron/-native-image/to-data-u-r-l.html new file mode 100644 index 00000000..adea75b4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/to-data-u-r-l.html @@ -0,0 +1,14 @@ + + + +NativeImage.toDataURL - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / toDataURL
+
+

toDataURL

+ +open fun toDataURL(options: ToDataURLOptions? = definedExternally): String + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/to-j-p-e-g.html b/api/pl.treksoft.kvision.electron/-native-image/to-j-p-e-g.html new file mode 100644 index 00000000..1137502a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/to-j-p-e-g.html @@ -0,0 +1,14 @@ + + + +NativeImage.toJPEG - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / toJPEG
+
+

toJPEG

+ +open fun toJPEG(quality: Number): <ERROR CLASS> + + diff --git a/api/pl.treksoft.kvision.electron/-native-image/to-p-n-g.html b/api/pl.treksoft.kvision.electron/-native-image/to-p-n-g.html new file mode 100644 index 00000000..900e827a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-native-image/to-p-n-g.html @@ -0,0 +1,14 @@ + + + +NativeImage.toPNG - kvision + + + +kvision / pl.treksoft.kvision.electron / NativeImage / toPNG
+
+

toPNG

+ +open fun toPNG(options: ToPNGOptions? = definedExternally): <ERROR CLASS> + + -- cgit