Text View

class TextView(text, width, height, font=None, font_size=None)

Bases: IViewObject

Initialize a TextView used for rendering text annotations inside a layout cell.

Parameters:

• text (str) – The text content of the annotation.

• width (int) – The width of the text view in pixels.

• height (int) – The height of the text view in pixels.

• font (str) – The font used for the text annotation. Defaults to "Arial". Other options include "Courier" and "Times".

• font_size (int) – The font size used for rendering the text. Defaults to 18.

Returns:

None

delete_view()

Delete the underlying render view.

This method removes the associated ParaView render view from the visualization pipeline and logs that the view should no longer be used.

Returns:

None

get_case()

Return the loaded case this view is based on.

Returns:

The loaded case of the view object.

Return type:

Case

get_height()

Return the height of the view in pixels.

If the internally stored height is less than or equal to zero, a warning is logged and the height is set to a failsafe value of 10 to prevent division-by-zero issues during rendering.

Returns:

The height of the view in pixels.

Return type:

int

get_render_object()

Return the underlying render object.

This base implementation does not define a render object and logs an error indicating that subclasses should override this method.

Returns:

Always returns None in the base class.

get_render_view()

Return the underlying ParaView render view.

This method provides access to the internal _render_view attribute, which represents the ParaView RenderView used by the view for visualization.

Returns:

The associated ParaView render view.

get_width()

Return the width of the view in pixels.

If the internally stored width is less than or equal to zero, a warning is logged and the width is set to a failsafe value of 10 to prevent division-by-zero issues during rendering.

Returns:

The width of the view in pixels.

Return type:

int

render(layout, row=0, col=0)

Render the view into the given layout and apply modifiers.

This method performs the following steps in order: 1. Validates that layout is a Layout instance. 2. Renders the view’s own content via _render_inside at the specified grid position (row, col). 3. Toggles the orientation axes visibility on the underlying render view, if available. 4. Applies all attached render modifiers via _render_modifiers. 5. If both a display and block selectors are present, applies the block selection to the display.

Parameters:

• layout (Layout) – The layout grid where the view should be placed.

• row (int) – Target row index in the layout grid. Defaults to 0.

• col (int) – Target column index in the layout grid. Defaults to 0.

Raises:

TypeError – If layout is not an instance of Layout.

Returns:

None

set_blocks(blocks)

Set the list of blocks to be displayed in the view.

This method assigns the provided list of block identifiers to the internal _blocks attribute, determining which blocks are shown in the rendered output.

Parameters:

blocks (List[str]) – A list of block names or identifiers.

Returns:

None