ServiceCall¶

class foxglove.layouts.ServiceCallPanel¶

Call a service and view the service call result.

For more information, see the documentation.

Example¶

import foxglove.layouts as fl

layout = fl.Layout(
    content=fl.ServiceCallPanel(
        config=fl.ServiceCallConfig(
            service_name="/set_parameter",
            request_payload='{"name": "param", "value": 42}',
            button_text="Call Service",
        ),
    ),
)

config: ServiceCallConfig¶

title: str | None = None¶: The title of the panel.

class foxglove.layouts.ServiceCallConfig¶

Configuration for the Service Call panel.

button_color: str | None = None¶: Color of the button

button_text: str | None = None¶: Label displayed on the button

button_tooltip: str | None = None¶: Text displayed when hovering over the button

editing_mode: bool | None = None¶: When enabled, editing the request is allowed and the response content is displayed. When disabled, only the button is visible.

layout: Optional[Literal['vertical', 'horizontal']] = None¶: Positioning of request and response inputs

request_payload: str | None = None¶: Request payload as JSON

service_name: str | None = None¶: Name of service to make a request to

timeout_seconds: float | None = None¶: Maximum time to wait for a response