Struct RenderSpec 

pub struct RenderSpec {
    pub kind: RenderKind,
    pub columns: Option<Vec<String>>,
    pub labels: Option<BTreeMap<String, String>>,
    pub value: Option<String>,
    pub label: Option<String>,
    pub limit: Option<u32>,
    pub donut: Option<bool>,
    pub num: Option<String>,
    pub den: Option<String>,
}

How a SqlWidget’s SQL result columns map onto a visual. A kind names the chart; the channel fields (value, label, columns, …) name which result columns feed it. Only the channels a kind uses are read; the backend validates the named columns exist in the result. New chart types are “one renderer + the same mapping”, so this stays a flat, additive shape.

Fields

kind: RenderKind

Which visual to render the result as.

columns: Option<Vec<String>>

table only: the columns to show, in order. Absent ⇒ every result column (the universal default).

labels: Option<BTreeMap<String, String>>

table only: optional per-column header relabelling (result column → display name). Columns not listed keep their SQL name.

value: Option<String>

stat / bar / pie / gauge: the result column holding the numeric value (stat/gauge read the first row; bar/pie read every row).

label: Option<String>

bar / pie: the result column holding each row’s category label.

limit: Option<u32>

bar / pie: keep only the top-N rows (by value). Absent ⇒ all rows.

donut: Option<bool>

pie only: render as a donut (a hole with the total in the centre).

num: Option<String>

gauge only: the numerator column (paired with den). Alternative to a precomputed value ratio.

den: Option<String>

gauge only: the denominator column (paired with num).

Trait Implementations

impl Clone for RenderSpec

fn clone(&self) -> RenderSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RenderSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RenderSpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for RenderSpec

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 RenderSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.