Collapsible

CollapsibleSection

CollapsibleSection(
    *,
    content: Union[LayoutItem, List[LayoutItem]],
    header: Optional[
        Union[TemplatedStringItem, CollapsibleSectionHeader]
    ] = None,
    expanded: bool = True
)

Organize and group content with expandable/collapsible sections.

The CollapsibleSection class is used to create collapsible sections within a dashboard layout, providing a way to organize and group content that can be expanded or collapsed.

Constructor for CollapsibleSection.

Parameters:

Name	Type	Description	Default
content	Union[LayoutItem, List[LayoutItem]]	content within the Section. One of Widget, Card, Grid, SelectableSection.	required
header	Optional[Union[TemplatedStringItem, CollapsibleSectionHeader]]	Header specifications. By default the CollapsibleSection does not have title	None
expanded	bool	Whether the section is expanded or not.	True

Examples:

Create a Collapsible Section layout and add a widget

import pandas as pd
from engineai.sdk.dashboard import layout
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import maps

data = pd.DataFrame(
    data=[{"region": "PT", "value": 10}, {"region": "GB", "value": 100}]
)

Dashboard(
    app_slug="engineai-docs-steps",
    workspace_slug="engineai-docs-steps",
    content=layout.CollapsibleSection(content=maps.Geo(data=data)),
)

Create a Collapsible Section layout with multiple Widgets

import pandas as pd
from engineai.sdk.dashboard import layout
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import maps

data = pd.DataFrame(
    data=[{"region": "PT", "value": 10}, {"region": "GB", "value": 100}]
)

Dashboard(
    app_slug="engineai-docs-steps",
    workspace_slug="engineai-docs-steps",
    content=layout.CollapsibleSection(
        content=[maps.Geo(data=data), maps.Geo(data=data)]
    ),
)

CollapsibleSectionHeader

CollapsibleSectionHeader(
    *chips: CollapsibleSectionChip,
    title: Optional[TemplatedStringItem] = None
)

Provides title and chips for collapsible section headers.

The CollapsibleSectionHeader class represents the header of a collapsible section, providing additional information such as title and chips.

Constructor for CollapsibleSectionHeader.

Parameters:

Name	Type	Description	Default
chips	CollapsibleSectionChip	chips to be added to the collapsible section header.	()
title	Optional[TemplatedStringItem]	Collapsible Section title.	None

Examples:

Create a Collapsible Section layout with a title

import pandas as pd
from engineai.sdk.dashboard import layout
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import pie

data = pd.DataFrame(
    {
        "category": ["A", "B"],
        "value": [1, 2],
    },
)

Dashboard(
    app_slug="engineai-docs-steps",
    workspace_slug="engineai-docs-steps",
    content=layout.CollapsibleSection(
        content=pie.Pie(data=data),
        header=layout.CollapsibleSectionHeader(title="Header Title"),
    ),
)

CollapsibleSectionChip

CollapsibleSectionChip(
    *,
    label: Union[str, GenericLink],
    tooltip_text: Optional[
        List[TemplatedStringItem]
    ] = None,
    prefix: str = "",
    suffix: str = ""
)

Labels or links within collapsible section headers for extra context.

The CollapsibleSectionChip class represents individual chips within a collapsible section header, providing additional labels or links.

Constructor for CollapsibleSectionChip.

Parameters:

Name	Type	Description	Default
label	Union[str, GenericLink]	Collapsible Section Header label value. Can assume a static label.	required
tooltip_text	Optional[List[TemplatedStringItem]]	informational pop up text. Each element of list is displayed as a separate paragraph. Can only use this option if the label is set.	None
prefix	str	prefix value to use in before each label.	''
suffix	str	suffix value to use in after each label.	''

Examples:

Create a Collapsible Section with multiple chips.

import pandas as pd
from engineai.sdk.dashboard import layout
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import maps
from engineai.sdk.dashboard.widgets import toggle

data = pd.DataFrame(
    data=[{"id": 1, "label": "Option 1"}, {"id": 2, "label": "Option 2"}]
)
toggle_widget = toggle.Toggle(data=data)

chip = layout.CollapsibleSectionChip(label="Chip 1")
linked_chip = layout.CollapsibleSectionChip(label=toggle_widget.selected.label)

map_data = pd.DataFrame(
    data=[{"region": "PT", "value": 10}, {"region": "GB", "value": 100}]
)
Dashboard(
    app_slug="engineai-docs-steps",
    workspace_slug="engineai-docs-steps",
    content=[
        toggle_widget,
        layout.CollapsibleSection(
            content=maps.Geo(data=map_data),
            header=layout.CollapsibleSectionHeader(chip, linked_chip),
        ),
    ],
)