Definition
- Namespace:
- Tizen.NUI.BaseComponents
- Assembly:
- Tizen.NUI.dll
- API Level:
- 7
LottieAnimationView renders an animated vector image (Lottie file).
public class LottieAnimationView : ImageView, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
- Inheritance
-
- Derived
-
- Implements
-
Constructors
View Source
LottieAnimationView(Single, Boolean)
LottieAnimationView constructor
Declaration
public LottieAnimationView(float scale = 1F, bool shown = true)
Parameters
| Type |
Name |
Description |
| Single |
scale |
The factor of scaling image, default : 1.0f
|
| Boolean |
shown |
false : not displayed (hidden), true : displayed (shown), default : true
|
Examples
LottieAnimationView myLottie = new LottieAnimationView();
LottieAnimationView myLottie2 = new LottieAnimationView(2.0f);
LottieAnimationView myLottie3 = new LottieAnimationView(1.0f, false);
API Level: 7
Fields
Declaration
public static readonly BindableProperty CurrentFrameProperty
Field Value
Declaration
public static readonly BindableProperty LoopCountProperty
Field Value
Declaration
public static readonly BindableProperty LoopingModeProperty
Field Value
View Source
RedrawInScalingDownProperty
RedrawInScalingDownProperty
Declaration
public static readonly BindableProperty RedrawInScalingDownProperty
Field Value
Declaration
public static readonly BindableProperty StopBehaviorProperty
Field Value
Declaration
public static readonly BindableProperty URLProperty
Field Value
Properties
View Source
CurrentFrame
Set or get the current frame. When setting a specific frame, it is displayed as a still image.
Declaration
public int CurrentFrame { get; set; }
Property Value
Examples
We assume that the animation in myLottie.json file has 100 frames originally. If so, its frame index will be 0 - 99.
LottieAnimationView myLottie = new LottieAnimationView();
myLottie.URL = Tizen.Applications.Application.Current.DirectoryInfo.Resource + "myLottie.json"; //myLottie.json's total frame is 100 (frame: 0~99)
NUIApplication.GetDefaultWindow().GetDefaultLayer().Add(myLottie);
myLottie.CurrentFrame = 200; //display 99 frame
myLottie.SetMinMaxFrame(10, 20);
myLottie.CurrentFrame = 15; //display 15 frame
myLottie.CurrentFrame = 50; //display 20 frame, because the MinMax is set (10,20) above
API Level: 7
View Source
DesiredHeight
Gets or sets the desired image height for LottieAnimationView
Declaration
public int DesiredHeight { get; set; }
Property Value
View Source
DesiredWidth
Gets or sets the desired image width for LottieAnimationView
Declaration
public int DesiredWidth { get; set; }
Property Value
Declaration
public int LoopCount { get; set; }
Property Value
Examples
LottieAnimationView myLottie = new LottieAnimationView();
myLottie.URL = Tizen.Applications.Application.Current.DirectoryInfo.Resource + "myLottie.json"; //myLottie.json's total frame is 100 (frame: 0~99)
NUIApplication.GetDefaultWindow().GetDefaultLayer().Add(myLottie);
myLottie.LoopCount = -1; //infinite loop
myLottie.Play();
myLottie.Stop(); //it plays continuously unless Stop() is called
myLottie.LoopCount = 2;
myLottie.Play(); //it plays only 2 times and stops automatically
API Level: 7
View Source
LoopingMode
Sets or gets the looping mode of Lottie animation.
Declaration
public LottieAnimationView.LoopingModeType LoopingMode { get; set; }
Property Value
API Level: 7
Declaration
public LottieAnimationView.PlayStateType PlayState { get; }
Property Value
API Level: 7
View Source
RedrawInScalingDown
Whether to redraw the image when the visual is scaled down.
Declaration
public bool RedrawInScalingDown { get; set; }
Property Value
View Source
ResourceUrl
Set or Get resource URL of Lottie file.
Declaration
public string ResourceUrl { get; set; }
Property Value
View Source
StopBehavior
Sets or gets the stop behavior.
Declaration
public LottieAnimationView.StopBehaviorType StopBehavior { get; set; }
Property Value
API Level: 7
View Source
SynchronousLoading
Gets or sets the SynchronousLoading for LottieAnimationView
We should set it before setup ResourceUrl, URL property.
Declaration
public bool SynchronousLoading { get; set; }
Property Value
View Source
TotalFrame
Get the number of total frames.
If resouce is still not be loaded, or invalid resource, the value is 0.
Declaration
public int TotalFrame { get; }
Property Value
API Level: 7
View Source
URL
Set or Get resource URL of Lottie file.
Declaration
public string URL { get; set; }
Property Value
API Level: 7
Methods
Declaration
protected override void Dispose(bool disposing)
Parameters
| Type |
Name |
Description |
| Boolean |
disposing |
|
Overrides
View Source
Dispose(DisposeTypes)
Dispose(DisposeTypes type)
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Overrides
View Source
DoActionExtension(LottieAnimationViewDynamicProperty)
Declaration
public void DoActionExtension(LottieAnimationViewDynamicProperty info)
Parameters
View Source
GetContentInfo()
Get the list of layers' information such as the start frame and the end frame in the Lottie file.
Declaration
public List<Tuple<string, int, int>> GetContentInfo()
Returns
| Type |
Description |
| List<Tuple<String, Int32, Int32>> |
List of Tuple (string of layer name, integer of start frame, integer of end frame)
|
API Level: 7
View Source
GetMarkerInfo()
Get the list of markers' information such as the start frame and the end frame in the Lottie file.
Declaration
public List<Tuple<string, int, int>> GetMarkerInfo()
Returns
| Type |
Description |
| List<Tuple<String, Int32, Int32>> |
List of Tuple (string of marker name, integer of start frame, integer of end frame)
|
Declaration
public Tuple<int, int> GetMinMaxFrame()
Returns
| Type |
Description |
| Tuple<Int32, Int32> |
Tuple of Min and Max frames
|
View Source
MergeCachedImageVisualProperty(PropertyMap)
Update NUI cached animated image visual property map by inputed property map.
And call base.MergeCachedImageVisualProperty()
Declaration
protected override void MergeCachedImageVisualProperty(PropertyMap map)
Parameters
Overrides
Declaration
API Level: 7
Declaration
API Level: 7
View Source
SetMinMaxFrame(Int32, Int32)
Set the minimum and the maximum frame.
Declaration
public void SetMinMaxFrame(int minFrame, int maxFrame)
Parameters
| Type |
Name |
Description |
| Int32 |
minFrame |
minimum frame
|
| Int32 |
maxFrame |
maximum frame
|
API Level: 7
View Source
SetMinMaxFrameByMarker(String, String)
A marker has its start frame and end frame.
Animation will play between the start frame and the end frame of the marker if one marker is specified.
Or animation will play between the start frame of the first marker and the end frame of the second marker if two markers are specified.
Declaration
public void SetMinMaxFrameByMarker(string marker1, string marker2 = null)
Parameters
| Type |
Name |
Description |
| String |
marker1 |
First marker
|
| String |
marker2 |
Second marker
|
Declaration
API Level: 7
View Source
UpdateImage()
Update lottie-image-relative properties synchronously.
After call this API, All image properties updated.
Declaration
protected override void UpdateImage()
Overrides
Events
Declaration
public event EventHandler Finished
Event Type
| Type |
Description |
| EventHandler |
|
API Level: 7
Implements
Extension Methods