PlotAllText

class PlotAllText(text_getter: GetText | None = None, color_rgba: tuple[int, int, int, int]=(255, 255, 255, 255), text_move: Point = <appwindows.appwindows.geometry.Point object>)[source]

Bases: OCRInstruction

Render detected text boxes on a screenshot.

property id: int

Return the unique OCR instruction identifier.

Returns:

OCR instruction identifier.

Return type:

int

perform(ui: BaseUi, text_reader: BaseTextReader, *args, **kwargs)[source]

Execute the instruction with a text reader.

Parameters:

  • ui (BaseUi) – UI instance used during execution.

  • text_reader (BaseTextReader) – Text reader used to detect text.

  • args – Additional positional arguments for the execution flow.

  • kwargs – Additional keyword arguments for the execution flow.

Returns:

Updated UI state when the implementation returns it.

Return type:

BaseUi