Skip to main content

List

This view allows you to display several views in vertical succession, one after the other. It could be thought of as the vertical version of a Composite... without the wrapping behaviour (because it's already vertical!).

JSON Format

{
"type": "list",
"id": ...,
"type": ...,
"margin_left": ...,
"margin_right": ...,
"margin_top": ...,
"margin_bottom": ...,
"is_visible": ...,
"validation_message": ...,
"subviews": ...,
"padding": ...,
"padding_left": ...,
"padding_right": ...,
"padding_top": ...,
"padding_bottom": ...,
"alignment": ...
}

Fields

FieldTypeRequiredDescription
idStringA unique identifier for the view. You can use it to reference view values in stat formulas by doing $view.view_id (where view_id is the id that was assigned to this view by you in the system definition)
typeRPGViewTypeThe type of this view. Note that these are all in camelCase.
margin_leftdoubleOptional. How much margin to add to the left of this view.
margin_rightdoubleOptional. How much margin to add to the right of this view.
margin_topdoubleOptional. How much margin to add to the top of this view.
margin_bottomdoubleOptional. How much margin to add to the bottom of this view.
is_visibleStatFormulaComponentOptional. A formula to specify if the view should be visible or not. Must return a bool.
validation_messageStatFormulaComponentOptional. If this view is an input, you can define this formula to return a message when the input value is invalid. If the input is valid, you should return null. Otherwise, make the formula return the string that should be shown to the user.
subviewsList<RPGView>The views that should be displayed, one after the other, vertically.
paddingdoubleOptional. Defaults to 0. How much space to include to the sides and before and after the items in this list.
padding_leftdoubleOptional. Defaults to 0. How much space to include to the left of the items in the list.
padding_rightdoubleOptional. Defaults to 0. How much space to include to the right of the items in the list.
padding_topdoubleOptional. Defaults to 0. How much space to include before the items in the list.
padding_bottomdoubleOptional. Defaults to 0. How much space to include after the items in the list.
alignmentCompositeRPGViewAlignmentOptional. Defaults to start. How to (horizontally) align the items in the list.