neft
Version:
Universal Platform
131 lines (106 loc) • 12.7 kB
Markdown
> [Wiki](Home) ▸ [[API Reference|API-Reference]] ▸ [[Renderer|Renderer-API]] ▸ [[Item|Renderer-Item-API]] ▸ **Image**
# Image
```javascript
Image {
source: 'http://lorempixel.com/200/140/'
onLoad: function(error){
if (error){
console.error("Can't load this image");
} else {
console.log("Image has been loaded");
}
}
}
```
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee)
## Table of contents
* [Image](#image)
* [**Class** Image](#class-image)
* [New](#new)
* [pixelRatio](#pixelratio)
* [onPixelRatioChange](#onpixelratiochange)
* [width](#width)
* [height](#height)
* [source](#source)
* [onSourceChange](#onsourcechange)
* [resolution](#resolution)
* [sourceWidth](#sourcewidth)
* [onSourceWidthChange](#onsourcewidthchange)
* [sourceHeight](#sourceheight)
* [onSourceHeightChange](#onsourceheightchange)
* [offsetX](#offsetx)
* [onOffsetXChange](#onoffsetxchange)
* [offsetY](#offsety)
* [onOffsetYChange](#onoffsetychange)
* [fillMode](#fillmode)
* [onFillModeChange](#onfillmodechange)
* [loaded](#loaded)
* [onLoadedChange](#onloadedchange)
* [onLoad](#onload)
* [onError](#onerror)
* [Glossary](#glossary)
#**Class** Image
<dl><dt>Syntax</dt><dd><code>**Class** Image : *Item*</code></dd><dt>Extends</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Item-API#class-item">Item</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#class-image--item)
##New
<dl><dt>Syntax</dt><dd><code>*Image* Image.New([*Component* component, *Object* options])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>component — <i>Component</i> — <i>optional</i></li><li>options — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a> — <i>optional</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#image-imagenewcomponent-component-object-options)
##pixelRatio
<dl><dt>Syntax</dt><dd><code>*Float* Image.pixelRatio = `1`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>1</code></dd></dl>
##onPixelRatioChange
<dl><dt>Syntax</dt><dd><code>*Signal* Image.onPixelRatioChange(*Float* oldValue)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#signal-imageonpixelratiochangefloat-oldvalue)
##width
<dl><dt>Syntax</dt><dd><code>*Float* Image::width = `-1`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>-1</code></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#float-imagewidth--1)
##height
<dl><dt>Syntax</dt><dd><code>*Float* Image::height = `-1`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>-1</code></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#float-imageheight--1)
##source
<dl><dt>Syntax</dt><dd><code>*String* Image::source</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><i>String</i></dd></dl>
The image source URL or data URI.
##onSourceChange
<dl><dt>Syntax</dt><dd><code>*Signal* Image::onSourceChange(*String* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <i>String</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#signal-imageonsourcechangestring-oldvalue)
##resolution
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Image::resolution = `1`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>1</code></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#readonly-float-imageresolution--1)
##sourceWidth
<dl><dt>Syntax</dt><dd><code>Hidden *Float* Image::sourceWidth = `0`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>0</code></dd><dt>Not Implemented</dt></dl>
##onSourceWidthChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* Image::onSourceWidthChange(*Float* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#hidden-signal-imageonsourcewidthchangefloat-oldvalue)
##sourceHeight
<dl><dt>Syntax</dt><dd><code>Hidden *Float* Image::sourceHeight = `0`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>0</code></dd><dt>Not Implemented</dt></dl>
##onSourceHeightChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* Image::onSourceHeightChange(*Float* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#hidden-signal-imageonsourceheightchangefloat-oldvalue)
##offsetX
<dl><dt>Syntax</dt><dd><code>Hidden *Float* Image::offsetX = `0`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>0</code></dd><dt>Not Implemented</dt></dl>
##onOffsetXChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* Image::onOffsetXChange(*Float* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#hidden-signal-imageonoffsetxchangefloat-oldvalue)
##offsetY
<dl><dt>Syntax</dt><dd><code>Hidden *Float* Image::offsetY = `0`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>0</code></dd><dt>Not Implemented</dt></dl>
##onOffsetYChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* Image::onOffsetYChange(*Float* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#hidden-signal-imageonoffsetychangefloat-oldvalue)
##fillMode
<dl><dt>Syntax</dt><dd><code>Hidden *Integer* Image::fillMode = `'Stretch'`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isinteger">Integer</a></dd><dt>Default</dt><dd><code>'Stretch'</code></dd><dt>Not Implemented</dt></dl>
##onFillModeChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* Image::onFillModeChange(*Integer* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isinteger">Integer</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#hidden-signal-imageonfillmodechangeinteger-oldvalue)
##loaded
<dl><dt>Syntax</dt><dd><code>ReadOnly *Boolean* Image::loaded = `false`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#readonly-boolean-imageloaded--false)
##onLoadedChange
<dl><dt>Syntax</dt><dd><code>*Signal* Image::onLoadedChange(*Boolean* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <i>Boolean</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#signal-imageonloadedchangeboolean-oldvalue)
##onLoad
<dl><dt>Syntax</dt><dd><code>*Signal* Image::onLoad()</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#signal-imageonload)
##onError
<dl><dt>Syntax</dt><dd><code>*Signal* Image::onError(*Error* error)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Image-API#class-image">Image</a></dd><dt>Parameters</dt><dd><ul><li>error — <i>Error</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/image.litcoffee#signal-imageonerrorerror-error)
# Glossary
- [Image](#class-image)