Struct PanelViewerConfig 

pub struct PanelViewerConfig<V: TS = String> {
    pub version: V,
    pub columns_config: HashMap<String, Map<String, Value>>,
    pub plugin: String,
    pub plugin_config: Map<String, Value>,
    pub table: String,
    pub theme: Option<String>,
    pub title: Option<String>,
    pub view_config: ViewConfig,
}

The per-panel state of a ViewerConfig — everything except the element-level settings flag. This is the panels entry type of the whole-element config format.

Fields

version: V

The @perspective-dev/viewer version that wrote this config, stamped on save and used to migrate older tokens. Callers do not set it.

columns_config: HashMap<String, Map<String, Value>>

Per-column styling, keyed by column name. The viewer treats the values as opaque — their shape is defined by the ACTIVE plugin, so a config written for one plugin may carry keys another ignores. Query the live shape with the get_style_schema agent tool, or the plugin’s column_config_schema().

plugin: String

Name of the visualization plugin, from the set registered on the page (the list_plugins agent tool, or the plugin picker). This also decides what the view fields MEAN visually: columns is positional and each plugin reads the positions differently, and group_by/split_by draw different things per plugin.

plugin_config: Map<String, Value>

Plugin-wide settings (as opposed to the per-column Self::columns_config). Opaque to the viewer and defined by the active plugin; see get_style_schema.

table: String

Name of the Table this panel renders, as hosted on the panel’s Client. Every placed panel has a table binding (creation requires one by type — ViewerConfigInitial), so the saved config carries it unconditionally.

theme: Option<String>

Selected theme NAME (e.g. "Pro Dark") — not a CSS value. Valid names are the Perspective themes loaded on the page, which resetThemes() re-scans. None selects the first available.

title: Option<String>

Panel title, shown in its tab. None renders the default title.

view_config: ViewConfig

Trait Implementations

impl<V: Debug + TS> Debug for PanelViewerConfig<V>

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

Formats the value using the given formatter.

impl<V: Default + TS> Default for PanelViewerConfig<V>

fn default() -> PanelViewerConfig<V>

Returns the “default value” for a type.

impl<V: PartialEq + TS> PartialEq for PanelViewerConfig<V>

fn eq(&self, other: &PanelViewerConfig<V>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<V> Serialize for PanelViewerConfig<V>

where V: Serialize + TS,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<V: PartialEq + TS> StructuralPartialEq for PanelViewerConfig<V>

impl<V> TS for PanelViewerConfig<V>

where V: TS + TS,

type WithoutGenerics = PanelViewerConfig<Dummy>

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 = PanelViewerConfig<V>

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.