Struct ViewerConfigUpdate 

pub struct ViewerConfigUpdate {
    pub version: VersionUpdate,
    pub plugin: PluginUpdate,
    pub title: TitleUpdate,
    pub table: TableUpdate,
    pub theme: ThemeUpdate,
    pub settings: SettingsUpdate,
    pub plugin_config: PluginConfigUpdate,
    pub columns_config: ColumnConfigUpdate,
    pub view_config: ViewConfigUpdate,
}

Fields

version: VersionUpdate

The @perspective-dev/viewer version a saved config was written by, used to migrate older tokens. Omit it — the viewer stamps the current version on save.

plugin: PluginUpdate

Name of the visualization plugin to switch to, from the set registered on the page (the list_plugins agent tool, or the plugin picker). Changing it changes what the view fields MEAN: columns is positional and every plugin reads the positions differently, and group_by/split_by draw different things per plugin — so read the new plugin’s roles before writing columns for it.

title: TitleUpdate

Panel title, shown in its tab. null restores the default title; omitting the field leaves the current one.

table: TableUpdate

Name of the Table to render, as hosted on this panel’s Client. Rebinding an existing panel to another table keeps the rest of the config, so column names that do not exist in the new table will fail validation.

theme: ThemeUpdate

Theme NAME (e.g. "Pro Dark") — not a CSS value. Valid names are the Perspective themes loaded on the page, re-scanned by resetThemes(). null selects the default.

settings: SettingsUpdate

Whether the settings sidebar is OPEN. Purely cosmetic chrome — it does not affect what the viewer renders, and it is element-level rather than per-panel.

plugin_config: PluginConfigUpdate

Plugin-wide settings (as opposed to the per-column Self::columns_config). The viewer passes these through opaquely — their valid keys are defined by the ACTIVE plugin and vary by plugin and by state, so query them with the get_style_schema agent tool rather than guessing.

columns_config: ColumnConfigUpdate

Per-column styling — formatting, colors, and other per-column controls — keyed by column name. Opaque to the viewer and plugin-defined like Self::plugin_config; get_style_schema reports the valid keys for a given column under the active plugin.

view_config: ViewConfigUpdate

Implementations

impl ViewerConfigUpdate

pub fn decode(update: &JsValue) -> ApiResult<Self>

Decode a JsValue into a ViewerConfigUpdate by auto-detecting format from JavaScript type.

pub fn migrate(&self) -> ApiResult<Self>

Trait Implementations

impl Clone for ViewerConfigUpdate

fn clone(&self) -> ViewerConfigUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewerConfigUpdate

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

Formats the value using the given formatter.

impl Default for ViewerConfigUpdate

fn default() -> ViewerConfigUpdate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ViewerConfigUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ViewerConfigUpdate

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

Formats the value using the given formatter.

impl From<ViewerConfigInitial> for ViewerConfigUpdate

fn from(value: ViewerConfigInitial) -> Self

Converts to this type from the input type.

impl PartialEq for ViewerConfigUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ViewerConfigUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ViewerConfigUpdate

impl TS for ViewerConfigUpdate

type WithoutGenerics = ViewerConfigUpdate

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 = ViewerConfigUpdate

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 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 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 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.