Struct PluginStaticConfig 

pub struct PluginStaticConfig {

    pub name: String,
    pub category: Option<String>,
    pub max_columns: Option<usize>,
    pub max_cells: Option<usize>,
    pub select_mode: ColumnSelectMode,
    pub min_config_columns: Option<usize>,
    pub config_column_names: Vec<String>,
    pub group_rollup_modes: Option<Vec<GroupRollupMode>>,
    pub split_rollup_modes: Option<Vec<SplitRollupMode>>,
    pub priority: Option<i32>,
    pub can_render_column_styles: bool,
    pub group_by_role: Option<String>,
    pub split_by_role: Option<String>,
    pub connects_row_order: bool,
}

Static, immutable configuration for a plugin.

Returned once per plugin from get_static_config() at registration time and cached in [crate::renderer::PluginRecord]. Consumers (renderer, session, queries, components) read these fields off the renderer’s active-plugin metadata rather than calling back into JS.

<perspective-viewer> reads this exactly once per plugin (at registerPlugin time) and caches it for the lifetime of the application. The result must be stable; do not mutate any field after registration.

Fields

name: String

The unique key for this plugin. Used as the plugin field in a ViewerConfig and as the display name key in the <perspective-viewer> UI.

category: Option<String>

Category in the plugin picker menu.

max_columns: Option<usize>

Soft limit on the number of columns the plugin will render. Triggers the “Rendering N of M” warning when the view exceeds this value (until dismissed).

max_cells: Option<usize>

Soft limit on the number of cells (rows × columns) the plugin will render. Triggers the “Rendering N of M” warning when the view exceeds this value (until dismissed).

select_mode: ColumnSelectMode

Column add/remove behavior. "select" exclusively selects the added column, removing other columns. "toggle" toggles the column on or off based on its current state, leaving other columns alone.

min_config_columns: Option<usize>

Minimum number of columns the plugin requires to render. Mostly affects drag/drop and column-remove button behavior. undefined is treated identically to 1.

config_column_names: Vec<String>

Named column slots. Named columns have replace/swap behavior in drag/drop rather than insert. The length must be at least min_config_columns.

group_rollup_modes: Option<Vec<GroupRollupMode>>

Group-rollup modes the plugin accepts, in preference order. The first entry that matches a feature flag becomes the default.

split_rollup_modes: Option<Vec<SplitRollupMode>>

Split-rollup modes the plugin accepts, in preference order. The first entry that matches a feature flag becomes the default.

priority: Option<i32>

Plugin load priority. Higher numbers win; ties resolve in registration order. The highest-priority plugin is loaded by default unless restore({ plugin }) overrides it.

can_render_column_styles: bool

Whether this plugin opts into per-column style controls in the settings sidebar. When true, the StyleTab is shown for active columns and the plugin’s column_config_schema is queried for the per-column field set. When false or omitted, no StyleTab is shown.

group_by_role: Option<String>

What group_by MEANS visually for this plugin, e.g. "X Axis" for the Y-series charts or "Hierarchy" for treemap/sunburst. None where the field has no visual role of its own and is a plain aggregation key (the X/Y charts, whose axes both come from columns).

This is the group_by counterpart of Self::config_column_names: the same declaration that names the positional columns slots should say what the other view fields draw, so that consumers — the settings UI’s field labels, and the agent’s list_plugins contract — read one source instead of restating the mapping.

split_by_role: Option<String>

What split_by MEANS visually for this plugin, e.g. "Series". See Self::group_by_role.

connects_row_order: bool

true when this plugin CONNECTS its points in row order, so the View’s row order is visible in the drawing: an unsorted config renders the table’s natural order, which reads as a tangle unless the rows already arrive ordered along the axis. Declared rather than inferred, because “unsorted” is not itself a mistake — a pre-ordered table needs no sort, and the point plugins (scatter, density) do not care at all.

Implementations

impl PluginStaticConfig

pub fn positional_columns(&self) -> usize

The number of leading columns slots that are POSITIONAL: a drop there swaps with the column already present, and the slot’s meaning is fixed by Self::config_column_names. Everything from this index on is the insert TAIL, which repeats the last named role — which is why a Y Line (named slots: ["Y Axis"]) takes any number of columns as additional Y series, while an X/Y Line (["X Axis", "Y Axis", "Tooltip"]) pins its two axes and treats the rest as further tooltips.

The single definition of that rule: Self::is_swap and the agent’s list_plugins contract both derive from it, so the convention cannot be read two different ways.

pub fn tail_column_role(&self) -> Option<&str>

The role that columns past the positional slots repeat, i.e. the last named slot. None when the plugin names no slots.

pub fn is_swap(&self, index: usize) -> bool

true if dropping a column at index should swap with the column already there rather than insert.

pub fn get_group_rollups( &self, rollup_features: &[GroupRollupMode], ) -> Vec<GroupRollupMode>

pub fn get_split_rollups( &self, rollup_features: &[SplitRollupMode], ) -> Vec<SplitRollupMode>

Trait Implementations

impl Clone for PluginStaticConfig

fn clone(&self) -> PluginStaticConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PluginStaticConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PluginStaticConfig

fn default() -> PluginStaticConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginStaticConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PluginStaticConfig

fn eq(&self, other: &PluginStaticConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PluginStaticConfig

impl TS for PluginStaticConfig

type WithoutGenerics = PluginStaticConfig

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = PluginStaticConfig

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.