Text Display¶

The Text Display block renders text on an image with full control over styling and positioning.

Dynamic Text Content¶

Text content can be parameterized with workflow execution outcomes using the same templating syntax as Email and SMS notification blocks:

text = "Detected {{ '{{' }} $parameters.count {{ '}}' }} objects of class {{ '{{' }} $parameters.class_name {{ '}}' }}"

Parameters are provided via the text_parameters field:

text_parameters = {
    "count": "$steps.model.predictions",
    "class_name": "$inputs.target_class"
}

You can apply transformations to parameters using text_parameters_operations:

text_parameters_operations = {
    "count": [{"type": "SequenceLength"}]
}

Styling Options¶

• text_color: Color of the text. Supports:
• Supervision color names (uppercase): "WHITE", "BLACK", "RED", "GREEN", "BLUE", "YELLOW", "ROBOFLOW", etc.
• Hex format: "#RRGGBB" (e.g., "#FF0000" for red)
• RGB format: "rgb(R, G, B)" (e.g., "rgb(255, 0, 0)" for red)
• BGR format: "bgr(B, G, R)" (e.g., "bgr(0, 0, 255)" for red)
• background_color: Background color behind the text. Supports the same color formats as text_color. Use "transparent" for no background.
• background_opacity: Transparency of the background (0.0 = fully transparent, 1.0 = fully opaque)
• font_scale: Scale factor for the font size
• font_thickness: Thickness of the text strokes
• padding: Padding around the text in pixels
• text_align: Horizontal text alignment ("left", "center", "right")
• border_radius: Radius for rounded corners on the background

Positioning Options¶

The block supports both absolute and relative positioning:

Absolute Positioning (position_mode = "absolute"): - position_x: X coordinate in pixels from the left edge - position_y: Y coordinate in pixels from the top edge

Relative Positioning (position_mode = "relative"): - anchor: Where to anchor the text ("center", "top_left", "top_center", "top_right", "bottom_left", "bottom_center", "bottom_right", "center_left", "center_right") - offset_x: Horizontal offset from the anchor point (positive = right) - offset_y: Vertical offset from the anchor point (positive = down)

Type identifier¶

Use the following identifier in step "type" field: roboflow_core/text_display@v1to add the block as as step in your workflow.

Properties¶

The Refs column marks possibility to parametrise the property with dynamic values available in workflow runtime. See Bindings for more info.

Available Connections¶

Input and Output Bindings¶

The available connections depend on its binding kinds. Check what binding kinds Text Display in version v1 has.

{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/text_display@v1",
    "image": "$inputs.image",
    "text": "Detection count: {{ '{{' }} $parameters.count {{ '}}' }}",
    "text_parameters": {
        "class_name": "$inputs.target_class",
        "count": "$steps.model.predictions"
    },
    "text_parameters_operations": {
        "count": [
            {
                "type": "SequenceLength"
            }
        ]
    },
    "text_color": "WHITE",
    "background_color": "BLACK",
    "background_opacity": 1.0,
    "font_scale": 1.0,
    "font_thickness": 1,
    "padding": 5,
    "text_align": "left",
    "border_radius": 0,
    "position_mode": "absolute",
    "position_x": 10,
    "position_y": 10,
    "anchor": "center",
    "offset_x": 0,
    "offset_y": 0,
    "copy_image": true
}