neft
Version:
Universal Platform
227 lines (97 loc) • 6.59 kB
Markdown
# PropertyAnimation
> **API Reference** ▸ [Renderer](/api/renderer.md) ▸ [Animation](/api/renderer-animation.md) ▸ **PropertyAnimation**
<!-- toc -->
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee)
* * *
### `constructor()`
<dl><dt>Extends</dt><dd><i>Animation</i></dd><dt>Returns</dt><dd><i>PropertyAnimation</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#propertyanimation-propertyanimationconstructor--animation)
* * *
### `property`
<dl><dt>Type</dt><dd><i>String</i></dd></dl>
* * *
### `onPropertyChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>String</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationonpropertychangestring-oldvalue)
* * *
### `duration`
<dl><dt>Type</dt><dd><i>Float</i></dd><dt>Default</dt><dd><code>250</code></dd></dl>
* * *
### `onDurationChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Float</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationondurationchangefloat-oldvalue)
* * *
### `startDelay`
<dl><dt>Type</dt><dd><i>Float</i></dd><dt>Default</dt><dd><code>0</code></dd></dl>
* * *
### `onStartDelayChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Float</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationonstartdelaychangefloat-oldvalue)
* * *
### `loopDelay`
<dl><dt>Type</dt><dd><i>Float</i></dd><dt>Default</dt><dd><code>0</code></dd></dl>
* * *
### `onLoopDelayChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Float</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationonloopdelaychangefloat-oldvalue)
* * *
### `delay`
<dl><dt>Type</dt><dd><i>Float</i></dd><dt>Default</dt><dd><code>0</code></dd></dl>
* * *
### `onDelayChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Float</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationondelaychangefloat-oldvalue)
* * *
### `updateData`
<dl><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd></dl>
* * *
### `onUpdateDataChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Boolean</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationonupdatedatachangeboolean-oldvalue)
* * *
### `updateProperty`
<dl><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd></dl>
* * *
### `onUpdatePropertyChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Boolean</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationonupdatepropertychangeboolean-oldvalue)
* * *
### `from`
<dl><dt>Type</dt><dd><i>Any</i></dd></dl>
* * *
### `onFromChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Any</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationonfromchangeany-oldvalue)
* * *
### `to`
<dl><dt>Type</dt><dd><i>Any</i></dd></dl>
* * *
### `onToChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>Any</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationontochangeany-oldvalue)
* * *
### `progress`
<dl><dt>Type</dt><dd><i>Float</i></dd><dt>Default</dt><dd><code>0</code></dd><dt>Read Only</dt></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#readonly-float-propertyanimationprogress--0)
* * *
### `easing`
<dl><dt>Type</dt><dd><i>Easing</i></dd></dl>
* * *
### `onEasingChange()`
<dl><dt>Parameters</dt><dd><ul><li>value — <i>Easing</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-propertyanimationoneasingchangeeasing-value)
* * *
### `type`
<dl><dt>Type</dt><dd><i>String</i></dd><dt>Default</dt><dd><code>'Linear'</code></dd></dl>
Supported easing functions:
Linear, InQuad, OutQuad, InOutQuad, InCubic, OutCubic,
InOutCubic, InQuart, OutQuart, InOutQuart, InQuint, OutQuint,
InOutQuint, InSine, OutSine, InOutSine, InExpo, OutExpo,
InOutExpo, InCirc, OutCirc, InOutCirc, InElastic, OutElastic,
InOutElastic, InBack, OutBack, InOutBack, InBounce, OutBounce,
InOutBounce.
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#string-easingtype--39linear39)
* * *
### `onTypeChange()`
<dl><dt>Parameters</dt><dd><ul><li>oldValue — <i>String</i></li></ul></dd><dt>Type</dt><dd><i>Signal</i></dd></dl>
> [`Source`](https://github.com/Neft-io/neft/blob/f9c128ccb37aa79380c961e878cd76ec9e79c99e/src/renderer/types/extensions/animation/types/property.litcoffee#signal-easingontypechangestring-oldvalue)