Configuration

SampleDataset

SampleDataset dataclass

SampleDataset(name, path, thumbnail=None)

Dataset offered as a shortcut on the application's landing page.

Parameters:

Name	Type	Description	Default
name	str	Label displayed on the dataset card.	required
path	Union[str, Path]	Local dataset file loaded when the card is selected.	required
thumbnail	Optional[Union[str, Path]]	Optional local preview image. When omitted, the card displays the dataset name in its center.	None

BrandingConfig

BrandingConfig dataclass

BrandingConfig(
    logo=None,
    favicon=None,
    landing_page_title=None,
    landing_page_message=None,
)

Application branding shown in the browser client.

Logo and favicon paths may be absolute or relative to the process working directory. They are served by the application rather than copied into the package's static files.

InfoConfig

InfoConfig dataclass

InfoConfig(content, title='About', button_label='About')

Generic information dialog shown from the application header.

Content is rendered as Markdown by the browser client.

to_dict

to_dict()

Convert to browser configuration.

ThemeConfig

ThemeConfig dataclass

ThemeConfig(
    preset=ThemePreset.DARK,
    primary=None,
    primary_hover=None,
    secondary=None,
    background=None,
    surface=None,
    surface_raised=None,
    surface_high=None,
    text=None,
    text_muted=None,
    text_subtle=None,
    on_primary=None,
    border=None,
    success=None,
    danger=None,
    warning=None,
    info=None,
    font_family=None,
)

Visual theme preset with optional semantic token overrides.

to_dict

to_dict()

Convert to browser configuration.

ThemePreset

ThemePreset

Bases: str, Enum

Built-in application theme.

LayoutConfig

LayoutConfig dataclass

LayoutConfig(
    header_title_position=TitlePosition.LEFT,
    header_logo_position=SidePosition.LEFT,
    sidebar_position=SidePosition.LEFT,
    sidebar_width=320,
    sidebar_resizable=True,
    workflow_panel_position=SidePosition.LEFT,
    workflow_panel_width=320,
    workflow_panel_resizable=True,
    show_status_bar=True,
    initial_view_layout=None,
    initial_visible_views=None,
)

Page layout and initial viewer arrangement.

When a panel is resizable, its configured width is the initial width only: the panel edge can be dragged in the browser to resize it within the same 180 to 640 pixel range.

to_dict

to_dict()

Convert to browser configuration.

TitlePosition

TitlePosition

Bases: str, Enum

Horizontal position of the application title.

SidePosition

SidePosition

Bases: str, Enum

Side of the application occupied by a panel or logo.

ViewLayout

ViewLayout

Bases: str, Enum

Initial Web SDK viewer arrangement.

ViewType

ViewType

Bases: str, Enum

Web SDK view that can be shown initially.

SidebarConfig

SidebarConfig dataclass

SidebarConfig(
    show_datamodel=True,
    show_views=True,
    show_display_options=True,
    show_annotations=False,
    collapsed=False,
)

Configuration for sidebar panel visibility.

Attributes:

Name	Type	Description
show_datamodel	bool	Whether to show the Data Model panel. Defaults to True.
show_views	bool	Whether to show the Views panel. Defaults to True.
show_display_options	bool	Whether to show the Display Options panel. Defaults to True.
show_annotations	bool	Whether to show the Annotations panel, which lets the user place and delete annotations on the selected dataset. Defaults to False, since most applications drive annotations from a workflow step or an action parameter instead.
collapsed	bool	Whether the sidebar is collapsed by default. Defaults to False.

Note

Configure the Algorithms panel with ImFusionWebApp(algorithm_selector=...).

to_dict

to_dict()

Convert to dictionary for JSON serialization.

ExportFormat

Accepted by the application's export_formats option and by ExportStep. Plain strings such as "imf", "nii.gz", and "dicom" are normalized to these members, as are the "nii", "nifti", and "dcm" aliases.

ExportFormat

Bases: str, Enum

Browser-download export format for session data.