Struct PluginContext 

pub struct PluginContext { /* private fields */ }

Context provided to plugins for interacting with the host.

Implementations

impl PluginContext

pub fn new(host: PluginHostRef) -> Self

Create a new plugin context with the given host.

pub fn notify(&self, level: &str, message: &str)

Send a notification to the user.

pub fn request_repaint(&self)

Request a UI repaint.

pub fn log(&self, level: LogLevel, message: &str)

Log a message.

pub fn editor_version(&self) -> &'static str

Get the host application version.

pub fn is_wasm(&self) -> bool

Check if running in WASM environment.

pub fn theme(&self) -> Theme

Get the current theme.

pub fn theme_name(&self) -> &'static str

Get the current theme name as a string.

pub fn clipboard_write(&self, text: &str) -> bool

Write text to the system clipboard.

pub fn clipboard_read(&self) -> Option<String>

Read text from the system clipboard.

pub fn spawn<F>(&self, future: F)

where F: Future<Output = ()> + Send + 'static,

Spawn an async task.

pub fn host(&self) -> &PluginHostRef

Get a reference to the underlying host.

pub fn http_get( &self, url: &str, headers: &FxHashMap<String, String>, ) -> Result<HttpResponse, HttpError>

Perform an HTTP GET request.

pub fn http_post( &self, url: &str, body: &str, headers: &FxHashMap<String, String>, ) -> Result<HttpResponse, HttpError>

Perform an HTTP POST request.

pub fn add_query_pane(&self, query: &str, title: Option<&str>)

Add a query pane with the given PromQL query and optional title.

pub fn add_logs_pane(&self)

Add a logs pane.

pub fn add_tracing_pane(&self, trace_id: Option<&str>)

Add a tracing pane, optionally pre-filled with a trace ID.

pub fn add_terminal_pane(&self)

Add a terminal pane (native only, no-op on WASM).

pub fn add_sql_pane(&self)

Add a SQL pane.

pub fn close_focused_pane(&self)

Close the currently focused pane.

pub fn focus_pane(&self, direction: &str)

Focus pane in the given direction (“left”, “right”, “up”, “down”).

pub fn set_time_range_preset(&self, preset: &str)

Set time range to a preset (e.g., “5m”, “15m”, “1h”, “6h”, “24h”, “7d”).

pub fn set_time_range_absolute(&self, start_secs: f64, end_secs: f64)

Set absolute time range (start and end in seconds since Unix epoch).

pub fn get_time_range(&self) -> (f64, f64)

Get the current time range as (start_secs, end_secs).

pub fn register_custom_table_pane(&self, config: CustomTableConfig)

Register a custom table pane type.

pub fn add_custom_table_pane(&self, pane_type: &str)

Add an instance of a custom table pane.

pub fn update_custom_table_data(&self, pane_id: usize, data: CustomTableData)

Update data for a custom table pane.

pub fn update_custom_table_data_by_type( &self, pane_type: &str, data: CustomTableData, )

Update data for all custom table panes of a given type.

pub fn register_custom_chart_pane(&self, config: CustomChartConfig)

Register a custom chart pane type.

pub fn add_custom_chart_pane(&self, pane_type: &str)

Add an instance of a custom chart pane.

pub fn update_custom_chart_data_by_type( &self, pane_type: &str, data: CustomChartData, )

Update data for all custom chart panes of a given type.

pub fn register_stat_pane(&self, config: StatPaneConfig)

Register a custom stat pane type.

pub fn add_stat_pane(&self, pane_type: &str)

Add an instance of a stat pane.

pub fn update_stat_data_by_type(&self, pane_type: &str, data: StatPaneData)

Update data for all stat panes of a given type.

pub fn register_gauge_pane(&self, config: GaugePaneConfig)

Register a custom gauge pane type.

pub fn add_gauge_pane(&self, pane_type: &str)

Add an instance of a gauge pane.

pub fn update_gauge_data_by_type(&self, pane_type: &str, data: GaugePaneData)

Update data for all gauge panes of a given type.

pub fn get_focused_pane_info(&self) -> Option<FocusedPaneInfo>

Get information about the currently focused pane.