<HTML> <HEAD> <meta charset="UTF-8"> <title>Image - kvision</title> <link rel="stylesheet" href="../../../style.css"> </HEAD> <BODY> <a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="./index.html">Image</a><br/> <br/> <h1>Image</h1> <code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Image</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Image component.</p> <h3>Constructors</h3> <table> <tbody> <tr> <td> <p><a href="-init-.html"><init></a></p> </td> <td> <code><span class="identifier">Image</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Image$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.IMAGESHAPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/src">src</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-res-string.html"><span class="identifier">ResString</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Image$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.IMAGESHAPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/alt">alt</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Image$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.IMAGESHAPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/responsive">responsive</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Image$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.IMAGESHAPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/shape">shape</span><span class="symbol">:</span> <a href="../-i-m-a-g-e-s-h-a-p-e/index.html"><span class="identifier">IMAGESHAPE</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Image$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.IMAGESHAPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/centered">centered</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Image$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.IMAGESHAPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">)</span></code></td> </tr> </tbody> </table> <h3>Properties</h3> <table> <tbody> <tr> <td> <p><a href="alt.html">alt</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">alt</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> <p>The alternative text of the image.</p> </td> </tr> <tr> <td> <p><a href="centered.html">centered</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">centered</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> <p>Determines if the image is rendered as centered.</p> </td> </tr> <tr> <td> <p><a href="responsive.html">responsive</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">responsive</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> <p>Determines if the image is rendered as responsive.</p> </td> </tr> <tr> <td> <p><a href="shape.html">shape</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">shape</span><span class="symbol">: </span><a href="../-i-m-a-g-e-s-h-a-p-e/index.html"><span class="identifier">IMAGESHAPE</span></a><span class="symbol">?</span></code> <p>The shape of the image.</p> </td> </tr> <tr> <td> <p><a href="src.html">src</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">src</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-res-string.html"><span class="identifier">ResString</span></a></code> <p>URL of the image.</p> </td> </tr> </tbody> </table> <h3>Inherited Properties</h3> <table> <tbody> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/id.html">id</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> <p>An ID attribute of generated HTML element.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/parent.html">parent</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">parent</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">?</span></code> <p>Parent of the current component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/role.html">role</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">role</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> <p>A role attribute of generated HTML element.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/title.html">title</a></p> </td> <td> <code><span class="keyword">var </span><span class="identifier">title</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> <p>A title attribute of generated HTML element.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/visible.html">visible</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">visible</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> <p>Visibility state of the current component.</p> </td> </tr> </tbody> </table> <h3>Functions</h3> <table> <tbody> <tr> <td> <p><a href="get-sn-attrs.html">getSnAttrs</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnAttrs</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span></code> <p>Returns list of element attributes in the form of a List.</p> </td> </tr> <tr> <td> <p><a href="get-sn-class.html">getSnClass</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnClass</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">></span></code> <p>Returns list of CSS class names for current widget in the form of a List.</p> </td> </tr> <tr> <td> <p><a href="render.html">render</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code> <p>Renders current component as a Snabbdom vnode.</p> </td> </tr> </tbody> </table> <h3>Inherited Functions</h3> <table> <tbody> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/add-css-class.html">addCssClass</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$addCssClass(kotlin.String)/css">css</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Adds given value to the set of CSS classes generated in html code of current component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html">addSurroundingCssClass</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$addSurroundingCssClass(kotlin.String)/css">css</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Adds given value to the set of CSS classes generated in html code of parent component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/after-create.html">afterCreate</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterCreate</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterCreate(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> <p>Method called after creating Snabbdom vnode.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/after-destroy.html">afterDestroy</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterDestroy</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> <p>Method called after destroying Snabbdom vnode.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/after-insert.html">afterInsert</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterInsert</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterInsert(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> <p>Method called after inserting Snabbdom vnode into the DOM.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/after-postpatch.html">afterPostpatch</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterPostpatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterPostpatch(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> <p>Method called after updating Snabbdom vnode.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/get-element.html">getElement</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElement</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html"><span class="identifier">Node</span></a><span class="symbol">?</span></code> <p>Returns DOM element bound to the current component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/get-element-j-query.html">getElementJQuery</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElementJQuery</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">JQuery</span><span class="symbol">?</span></code> <p>Returns JQuery element bound to the current component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/get-element-j-query-d.html">getElementJQueryD</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElementJQueryD</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="keyword">dynamic</span></code> <p>Returns JQuery element bound to the current component as a <em>dynamic</em> type.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-hooks.html">getSnHooks</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnHooks</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Hooks</span><span class="symbol">?</span></code> <p>Returns list of hooks in the form of a Snabbdom <em>Hooks</em> object.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-on.html">getSnOn</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnOn</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">On</span><span class="symbol">?</span></code> <p>Returns list of event handlers in the form of a Snabbdom <em>On</em> object.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/hide.html">hide</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">hide</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Makes current widget invisible.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/remove-css-class.html">removeCssClass</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$removeCssClass(kotlin.String)/css">css</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Removes given value from the set of CSS classes generated in html code of current component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/remove-event-listeners.html">removeEventListeners</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeEventListeners</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Removes all event listeners from current widget.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html">removeSurroundingCssClass</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$removeSurroundingCssClass(kotlin.String)/css">css</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Removes given value from the set of CSS classes generated in html code of parent component.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/render.html">render</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String)/elementName">elementName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code><br/> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String, kotlin.Array((kotlin.Any)))/elementName">elementName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String, kotlin.Array((kotlin.Any)))/children">children</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol"><</span><span class="keyword">dynamic</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code> <p>Renders current component as a Snabbdom vnode.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/set-event-listener.html">setEventListener</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">></span> <span class="identifier">setEventListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.core.Widget.setEventListener.T)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-widget/set-event-listener.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Sets an event listener for current widget, keeping the actual type of component.</p> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setEventListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.core.Widget)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">></span><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Sets an event listener for current widget.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/show.html">show</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">show</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Makes current widget visible.</p> </td> </tr> <tr> <td> <p><a href="../../pl.treksoft.kvision.core/-widget/toggle-visible.html">toggleVisible</a></p> </td> <td> <code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toggleVisible</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> <p>Toggles visibility of current widget.</p> </td> </tr> </tbody> </table> </BODY> </HTML>