Iterator Node

Iterators repeat a template for every element in the source data. This is most useful for displaying lists or grids of items.

Each element within the source data is provided as {{scope.element}}. You can access the current index (0-indexed) as {{scope.i}}.

Properties

Visible

PropiteratorNode.isVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropiteratorNode.isEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

PropiteratorNode.tooltip
Typestring
Defaultundefined

The tooltip text to display when hovered or focused over this node.

Top

PropiteratorNode.top
Typestring
Default1

The position of the node from the top side of the grid (grid-row-start).

Left

PropiteratorNode.left
Typestring
Default1

The position of the node from the left side of the grid (grid-column-start).

Width

PropiteratorNode.width
Typestring
Default320px

The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px or 100%).

Min Width

PropiteratorNode.minWidth
Typestring
Defaultnone

The minimum width of the node. When this node is in a grid layout, this property is ignored.

Max Width

PropiteratorNode.maxWidth
Typestring
Defaultnone

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

PropiteratorNode.height
Typestring
Default128px

The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px or 100%).

Min Height

PropiteratorNode.minHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Max Height

PropiteratorNode.maxHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Overflow

PropiteratorNode.overflow
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.

Overflow X

PropiteratorNode.overflowX
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal axis for content that is larger than its container.

Overflow Y

PropiteratorNode.overflowY
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the vertical axis for content that is larger than its container.

Custom Styles

PropiteratorNode.styles
Typestring
Defaultelement.styles { }

Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.

Data

PropiteratorNode.data
TypeArray<UnknownRecord>
Default{{[]}}

The source data array. For each item in this array, the template will be instantiated.

Template

PropiteratorNode.template
Type(string | null)
Defaultundefined

The template to render for each item in the data array.

Layout Style

PropiteratorNode.layoutStyle
TypeNodeLayoutStyle ('GRID' | 'HORIZONTAL_STACK' | 'VERTICAL_STACK')
DefaultVERTICAL_STACK

The layout style of the individual items in the iterator (horizontal or vertical stack).

Padding

PropiteratorNode.padding
Typestring
Default16

The internal padding of the iterator to place around its children.

Spacing

PropiteratorNode.spacing
Typestring
Default16

The spacing to use between child nodes of the iterator.

Background Color

PropiteratorNode.backgroundColor
Typestring
Defaultsurface.100

Background color

Distribute Content

PropiteratorNode.distributeContent
TypeNodeLayoutDistributeStyle ('start' | 'center' | 'end' | 'around' | 'between' | 'even')
Defaultstart

The distribution of the children nodes within the container. Corresponds to the justify-content CSS Flexbox property.

Align Content

PropiteratorNode.alignContent
TypeNodeLayoutAlignStyle ('start' | 'center' | 'end')
Defaultstart

The alignment of the children nodes within the container. Corresponds to the align-items CSS Flexbox property.

Wrap Content

PropiteratorNode.wrapContent
TypeNodeLayoutWrapStyle ('wrap' | 'nowrap' | 'wrap-reverse')
Defaultnowrap

How the children nodes wrap within the container. Corresponds to the flex-wrap CSS Flexbox property.