Struct Placement 

pub struct Placement {
    pub analytics: Option<AnalyticsPlacement>,
    pub dashboard: Option<DashboardPlacement>,
}

Where a widget surfaces in the SPA — an Analytics tab and/or a pinned Dashboard card. Shared verbatim by both widget kinds: a job’s AggregateWidget and a view’s SqlWidget are authored the same way. (#1257 folded the aggregate side’s flat dashboard: + pin_dashboard: pair into this block; expressing one idea in two shapes meant a width had to be invented twice.)

Fields

analytics: Option<AnalyticsPlacement>

The Analytics tab this widget groups under. Absent ⇒ not shown on the Analytics page.

Written either as a bare tab name or as a block, so the common case stays one line and a width is there when it’s wanted:

analytics: app-usage
# or
analytics: { tab: app-usage, width: half }

dashboard: Option<DashboardPlacement>

Promote to the main Dashboard (reuses #900’s pinned section). Absent ⇒ not pinned.

Implementations

impl Placement

pub fn is_pinned(&self) -> bool

True when the widget is pinned to the main Dashboard.

pub fn tab(&self) -> &str

The Analytics tab name, or a fallback so a dashboard-only widget still carries a group label for the shared widget list.

pub fn width_for(&self, pinned: bool) -> Option<WidgetWidth>

Width to render at on the surface being served. The two surfaces are independent: the Dashboard’s pinned strip is a summary where two full-width widgets push everything else below the fold, while an Analytics tab gives the widget the room and usually wants the per-render default.

Trait Implementations

impl Clone for Placement

fn clone(&self) -> Placement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Placement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Placement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Placement

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Placement

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

where __S: Serializer,

Serialize this value into the given Serde serializer.