Skip to content

SectionalElement

Source code in docs_src/capo_amplifyuibuilder/types/sectional_element.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class SectionalElement(TypedDict, closed=True):
    type: "str"
    """<p>The type of sectional element. Valid values are <code>Heading</code>, <code>Text</code>, and <code>Divider</code>.</p>"""
    position: NotRequired["capo_amplifyuibuilder.types.field_position.FieldPosition"]
    """<p>Specifies the position of the text in a field for a <code>Text</code> sectional element.</p>"""
    text: NotRequired["str"]
    """<p>The text for a <code>Text</code> sectional element.</p>"""
    level: NotRequired["int"]
    """<p>Specifies the size of the font for a <code>Heading</code> sectional element. Valid values are <code>1 | 2 | 3 | 4 | 5 | 6</code>.</p>"""
    orientation: NotRequired["str"]
    """<p>Specifies the orientation for a <code>Divider</code> sectional element. Valid values are <code>horizontal</code> or <code>vertical</code>.</p>"""
    excluded: NotRequired["bool"]
    """<p>Excludes a sectional element that was generated by default for a specified data model.</p>"""

excluded instance-attribute 

excluded: NotRequired[bool]

Excludes a sectional element that was generated by default for a specified data model.

level instance-attribute 

level: NotRequired[int]

Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

orientation instance-attribute 

orientation: NotRequired[str]

Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

position instance-attribute 

position: NotRequired[FieldPosition]

Specifies the position of the text in a field for a Text sectional element.

text instance-attribute 

text: NotRequired[str]

The text for a Text sectional element.

type instance-attribute 

type: str

The type of sectional element. Valid values are Heading, Text, and Divider.