Skip to main content

ControlSpec

Enum ControlSpec 

Source
pub enum ControlSpec {
Show 14 variants Enum { key: String, variants: Vec<EnumVariant>, default: String, }, Bool { key: String, default: bool, }, Number { key: String, default: f64, include: Option<bool>, min: Option<f64>, max: Option<f64>, step: Option<f64>, }, String { key: String, default: String, placeholder: Option<String>, }, Color { key: String, default: String, }, Palette { key: String, default: String, max: Option<usize>, }, GradientStops { key: String, default: String, discrete: bool, }, DatetimeFormat { default: Option<DatetimeFormatType>, }, StringFormat, NumberSeriesStyle { default: NumberSeriesStyleDefaultConfig, }, Symbols { default: KeyValueOpts, }, NumberFormat { default: Option<CustomNumberFormatConfig>, }, AggregateDepth, Group { key: String, fields: Vec<ControlSpec>, },
}
Expand description

Discriminated union of widget kinds the viewer can render. Composite variants wrap an existing rich Yew component and carry only the component’s *DefaultConfig. Primitive variants render generic scalar widgets and carry their own key inline; the visible label is resolved at CSS time via --psp-label--<key>--content.

Variants§

§

Enum

Fields

§variants: Vec<EnumVariant>
§default: String
§

Bool

Fields

§default: bool
§

Number

Fields

§default: f64
§include: Option<bool>

If true, always serialize this values even if it is the default.

§step: Option<f64>
§

String

Fields

§default: String
§placeholder: Option<String>
§

Color

Fields

§default: String
§

Palette

Fields

§default: String
§

GradientStops

Fields

§default: String
§discrete: bool
§

DatetimeFormat

Fields

§default: Option<DatetimeFormatType>

Plugin-declared default date_format, shown by the editor in unedited fields and elided from serialized configs.

§

StringFormat

§

NumberSeriesStyle

§

Symbols

Fields

§

NumberFormat

Fields

§default: Option<CustomNumberFormatConfig>

Plugin-declared default format, keyed like number_format itself.

§

AggregateDepth

§

Group

Fields

Implementations§

Source§

impl ControlSpec

Source

pub fn serialized_keys(&self) -> Vec<&str>

Top-level JSON keys this control owns when its value is serialized into a column’s config map. For primitives this is just [key]; for composites it’s the set of fields the wrapped sub-struct flattens. Used by ColumnConfigSchema::active_keys to filter the columns_config blob passed to plugin.restore().

Trait Implementations§

Source§

impl Clone for ControlSpec

Source§

fn clone(&self) -> ControlSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ControlSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ControlSpec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ControlSpec

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromQuery for T

Source§

type Target = T

Target type after parsing.
Source§

type Error = HistoryError

Error that can occur while parsing.
Source§

fn from_query( query: &str, ) -> Result<<T as FromQuery>::Target, <T as FromQuery>::Error>

Decode this query string into the target type.
Source§

impl<T> HasAllProps<(), T> for T

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToQuery for T
where T: Serialize,

Source§

type Error = HistoryError

Error that can be returned from the conversion.
Source§

fn to_query(&self) -> Result<Cow<'_, str>, <T as ToQuery>::Error>

Method to encode the query into a string.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more