Component:FeedOrderedItemInterface: Difference between revisions

From Resonite Wiki
Newer edit →
Visual
Automated: create new component page
 
add info
Line 3: Line 3:
|Name=Feed Ordered Item Interface`1
|Name=Feed Ordered Item Interface`1
}}
}}
{{stub}}
The '''FeedOrderedItemInterface''' component is used as a template type item in data feed mappers in the [[Data Feeds]] system. This acts as an item in a list of items that can be reordered and moved around.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|
|HasData|Bool| {{Template:FeedItemInterface_HasData}}
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true| {{Template:FeedItemInterface_ItemName}}
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true|
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| {{Template:FeedItemInterface_ItemKey}}
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv3=true|
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv3=true| {{Template:FeedItemInterface_ItemDescription}}
|DescriptionCleanup|Slot|
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true| {{Template:FeedItemInterface_HasDescription}}
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv5=true|
|DescriptionCleanup|Slot| {{Template:FeedItemInterface_DescriptionCleanup}}
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv6=true|
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv6=true| {{Template:FeedItemInterface_ItemIcon}}
|IconCleanup|Slot|
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| {{Template:FeedItemInterface_HasIcon}}
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv8=true|
|IconCleanup|Slot| {{Template:FeedItemInterface_IconCleanup}}
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv9=true|
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv9=true| {{Template:FeedItemInterface_View}}
|ChildContainer|Slot|
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv10=true| {{Template:FeedItemInterface_ParentContainer}}
|NestedItems|{{RootFieldType|SyncList`1|[[Type:NestedItem|NestedItem]]}}|TypeAdv11=true|
|ChildContainer|Slot| {{Template:FeedItemInterface_ChildContainer}}
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv12=true|
|NestedItems|{{RootFieldType|SyncList`1|[[Type:NestedItem|NestedItem]]}}|TypeAdv12=true| {{Template:FeedItemInterface_NestedItems}}
|Value|'''[[Type:IField`1|IField`1]]<T>'''|TypeAdv13=true|
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| {{Template:FeedItemInterface_EnabledState}}
|Formatting|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv14=true|
|Value|'''[[Type:IField`1|IField`1]]<T>'''|TypeAdv14=true| The value field of this ordered item. Can write to the original feed valuem
|IsFirst|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv15=true|
|Formatting|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv15=true| How to format the value when it is displayed in text.
|IsLast|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv16=true|
|IsFirst|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv16=true| The field to set to whether this item is currently first
|MoveUpLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv17=true|
|IsLast|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv17=true| The field to set to whether this item is currently last.
|MoveDownLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv18=true|
|MoveUpLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv18=true| The field that represents this item's move up label.
|MakeFirstLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv19=true|
|MoveDownLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv19=true| The field that represents this item's move down label.
|MakeLastLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv20=true|
|MakeFirstLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv20=true| The field that represents this item's make first label.
|MoveUp|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv21=true|
|MakeLastLabel|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv21=true| The field that represents this item's make last label.
|MoveDown|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv22=true|
|MoveUp|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv22=true| This field is populated with the Action that can be called to move the item up.
|MakeFirst|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv23=true|
|MoveDown|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv23=true| This field is populated with the Action that can be called to move the item down.
|MakeLast|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv24=true|
|MakeFirst|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv24=true| This field is populated with the Action that can be called to make the item first.
|HasMoveUp|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv25=true|
|MakeLast|'''[[Type:SyncDelegate`1|SyncDelegate`1]]<[[Type:Action|Action]]>'''|TypeAdv25=true| This field is populated with the Action that can be called to make the item last.
|HasMoveDown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv26=true|
|HasMoveUp|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv26=true| The field to set to whether this item can currently be moved further up.
|HasMakeFirst|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv27=true|
|HasMoveDown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv27=true| The field to set to whether this item can currently be moved down.
|HasMakeLast|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv28=true|
|HasMakeFirst|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv28=true| The field to set to whether this item can currently be made first.
|HasMakeLast|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv29=true| The field to set to whether this item can currently be made last.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==


== See Also ==
== See Also ==
* [[Data Feeds]]


[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Feed Ordered Item Interface`1]]
[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Feed Ordered Item Interface`1]]
[[Category:Components{{#translation:}}|Feed Ordered Item Interface`1]]
[[Category:Components{{#translation:}}|Feed Ordered Item Interface`1]]
[[Category:Generic Components{{#translation:}}|Feed Ordered Item Interface`1]]
[[Category:Generic Components{{#translation:}}|Feed Ordered Item Interface`1]]
[[Category:ComponentStubs]]

Revision as of 23:23, 17 January 2025

Component image 
Feed Ordered Item Interface`1 component as seen in the Scene Inspector

The FeedOrderedItemInterface component is used as a template type item in data feed mappers in the Data Feeds system. This acts as an item in a list of items that can be reordered and moved around.

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 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 of this ordered item. Can write to the original feed valuem
Formatting IField`1<String> How to format the value when it is displayed in text.
IsFirst IField`1<Bool> The field to set to whether this item is currently first
IsLast IField`1<Bool> The field to set to whether this item is currently last.
MoveUpLabel IField`1<String> The field that represents this item's move up label.
MoveDownLabel IField`1<String> The field that represents this item's move down label.
MakeFirstLabel IField`1<String> The field that represents this item's make first label.
MakeLastLabel IField`1<String> The field that represents this item's make last label.
MoveUp SyncDelegate`1<Action> This field is populated with the Action that can be called to move the item up.
MoveDown SyncDelegate`1<Action> This field is populated with the Action that can be called to move the item down.
MakeFirst SyncDelegate`1<Action> This field is populated with the Action that can be called to make the item first.
MakeLast SyncDelegate`1<Action> This field is populated with the Action that can be called to make the item last.
HasMoveUp IField`1<Bool> The field to set to whether this item can currently be moved further up.
HasMoveDown IField`1<Bool> The field to set to whether this item can currently be moved down.
HasMakeFirst IField`1<Bool> The field to set to whether this item can currently be made first.
HasMakeLast IField`1<Bool> The field to set to whether this item can currently be made last.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:FeedOrderedItemInterface&oldid=94673"