Struct ViewerConfigInitial 

pub struct ViewerConfigInitial {
    pub table: String,
    pub version: Option<String>,
    pub plugin: Option<String>,
    pub title: Option<String>,
    pub theme: Option<String>,
    pub plugin_config: Option<Map<String, Value>>,
    pub columns_config: Option<HashMap<String, Map<String, Value>>>,
    pub view_config: ViewConfigUpdate,
}

The initial configuration of a NEW panel (addPanel, restore’s panel-creating upsert, restoreWorkspace panels entries). Unlike ViewerConfigUpdate — a patch against existing state — creation has no prior state: table is REQUIRED (a placed panel without a table binding would be permanently blank), absent fields mean “default” rather than “leave unchanged” (so no OptionalUpdate tri-state), and there is no settings field (element-level, not per-panel).

Fields

table: String

Name of the Table the new panel renders, as hosted on the Client. REQUIRED: a placed panel with no table binding would be permanently blank.

version: Option<String>

The @perspective-dev/viewer version a saved config was written by. Omit it when creating a panel.

plugin: Option<String>

Name of the visualization plugin, from the set registered on the page (the list_plugins agent tool, or the plugin picker). Decides 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. Absent uses the default plugin.

title: Option<String>

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

theme: Option<String>

Theme NAME (e.g. "Pro Dark") — not a CSS value. Valid names are the Perspective themes loaded on the page. Absent uses the default.

plugin_config: Option<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; query the valid keys with get_style_schema rather than guessing.

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

Per-column styling — formatting, colors, and other per-column controls — keyed by column name. Plugin-defined like Self::plugin_config; see get_style_schema.

view_config: ViewConfigUpdate

Implementations

impl ViewerConfigInitial

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

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

pub fn new(table: impl Into<String>) -> Self

A default-config panel bound to table (the “New panel” menus). Exhaustive on purpose — same drift alarm as the From impl below.

Trait Implementations

impl Clone for ViewerConfigInitial

fn clone(&self) -> ViewerConfigInitial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewerConfigInitial

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ViewerConfigInitial

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ViewerConfigInitial> for ViewerConfigUpdate

fn from(value: ViewerConfigInitial) -> Self

Converts to this type from the input type.

impl PartialEq for ViewerConfigInitial

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ViewerConfigInitial

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 ViewerConfigInitial

impl TS for ViewerConfigInitial

type WithoutGenerics = ViewerConfigInitial

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

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.