Struct ViewInteractive 

pub struct ViewInteractive {
    pub enabled: Option<bool>,
    pub search: Option<bool>,
    pub page_size: Option<usize>,
    pub max_enum: Option<usize>,
    pub filters: BTreeMap<String, String>,
    pub sortable: BTreeMap<String, bool>,
    pub sort_as: BTreeMap<String, String>,
    pub default_sort: Vec<SortKey>,
    pub unknown: BTreeMap<String, Value>,
}

docgen-specific per-view interactive overrides (docgenInteractive: { ... }). Everything is optional and Obsidian-tolerant (unknown keys ignored).

Fields

enabled: Option<bool>

Explicitly enable/disable the island for this view (M3 host gating).

search: Option<bool>

Show the free-text search box (default: true).

page_size: Option<usize>

Rows per page (pageSize). 0 = no pagination.

max_enum: Option<usize>

Enum-vs-text cardinality threshold (maxEnum, default 40).

filters: BTreeMap<String, String>

Per-column filter widget override: col → none|text|enum|date|number|boolean.

sortable: BTreeMap<String, bool>

Per-column sortable override: col → bool.

sort_as: BTreeMap<String, String>

Per-column sort-order override: col → text|semver.

A column whose values all parse as versions sorts as versions automatically; text opts back out to plain string order, and semver forces version order on a column that would not be detected (values that then fail to parse sort last). Unlike the rest of this struct, this also applies to the static build — a view’s sort: is a build-time ordering.

default_sort: Vec<SortKey>

Initial sort override (defaultSort).

unknown: BTreeMap<String, Value>

Any key here docgen does not recognize. Unlike the Obsidian-owned parts of the format — where an unknown property is forgiving by design — this block is docgen’s OWN namespace, so a key in it that docgen ignores is always an author mistake. Captured rather than dropped so the renderer can say so; see ViewInteractive::unknown_key_warning.

Implementations

impl ViewInteractive

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

A human message naming every unrecognized key, or None when clean.

These keys are camelCase, so the overwhelmingly likely typo is a case slip (pagesize, defaultsort) — match case-insensitively to name the intended key. Anything else is reported without a guess rather than with a wrong one.

Trait Implementations

impl Clone for ViewInteractive

fn clone(&self) -> ViewInteractive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewInteractive

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

Formats the value using the given formatter.

impl Default for ViewInteractive

fn default() -> ViewInteractive

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ViewInteractive

where ViewInteractive: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.