Component:FeedIndicatorInterface

Component image 

Feed Indicator Interface`1 component as seen in the Scene Inspector

The FeedIndicatorInterface component is used as a template type item in data feed mappers in the Data Feeds system. This works as a value viewing module for Feed items, as well as providing the wanted format for the item.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
HasData	Bool	The field to set when this interface is templated by a data feed for whether it has data or not.
ItemName	IField`1<String>	The field to fill with the name of the interface item when it is templated via a data feed. For settings toggles, this would be the toggle name.
ItemKey	IField`1<String>	The field to fill with the interfaces key if it is a dictionary type item.
ItemDescription	IField`1<String>	The field to fill with the template description when template via a data feed.
HasDescription	IField`1<Bool>	Whether the item when templated via a data feed has a description.
DescriptionCleanup	Slot	If this interface doesn't have a description during templating via a data feed, then delete the slot specified.
ItemIcon	IField`1<Uri>	The resource URL to fill with an image link/URI if the data feed item has an icon.
HasIcon	IField`1<Bool>	Whether this template has an icon. This is set during duplication as a template via a data feed.
IconCleanup	Slot	The slot to delete when this interface item doesn't have an icon when being duplicated as a template item by a data feed.
View	SyncRef`1<IDataFeedView>	The data feed view that this template was instantiated by. Like a SingleFeedView.
ParentContainer	FeedItemInterface	This template's parent container. If that template also has a parent and a child, then it recursively goes up the containers till it finds the root interface with a parent and a child interface, then instantiates that interfaces child interface and it's Nested items instead of just this interface.
ChildContainer	Slot	This template's child template which it instanciates if it's part of a parent child structure of interfaces.
NestedItems	list of FeedItemInterface.NestedItem	A list of extra data feed items to instantiate the same as this one with the same arguments, except each one can be Nested under this item.
EnabledState	IField`1<Bool>	The enabled state of this feed interface item UI element.
Value	IField`1<T>	The value field to fill and update from the data feed with.
Format	IField`1<String>	The field to fill with the format string the source data feed has specified should be used with this value when displaying it.

Usage

This article or section is a stub. You can help the Resonite wiki by expanding it.

See Also

• Data Feeds