mitk.mxn.layout.grid

Contents

mitk.mxn.layout.grid#

mitk.mxn.layout.grid(rows, cols, *, view_directions=None, group=Group(name='main', select_all=True), editor_name='mxn', bare_id_stem='widget', start_index=0, display_names=None)#

Build a rows x cols grid of windows.

Outer split is vertical (rows), inner splits are horizontal (cells in each row).

Parameters:

  • rows (int) – Number of rows (>= 1).

  • cols (int) – Number of columns (>= 1).

  • view_directions (Sequence[ViewDirection] | None) – Per-cell view directions, length rows * cols. When omitted, cycles through axial/sagittal/coronal.

  • group (str | Group) – Selection group every cell links to. Accepts a group name string or a Group instance.

  • editor_name (str) – Editor-name segment for synthesised ids; almost all callers leave this at 'mxn'.

  • bare_id_stem (str) – Prefix of the bare-id segment (the index is appended).

  • start_index (int) – Starting index for synthesised ids; lets callers compose multiple grids without id collisions.

  • display_names (Sequence[str | None] | None) – Per-cell display labels, length rows * cols. Entries that are None produce no name field.

Return type:

Split

Contents