Struct grafana_plugin_sdk::data::FieldConfig

#[non_exhaustive]
pub struct FieldConfig {

    pub display_name: Option<String>,
    pub display_name_from_ds: Option<String>,
    pub path: Option<String>,
    pub description: Option<String>,
    pub writeable: Option<bool>,
    pub filterable: Option<bool>,
    pub unit: Option<String>,
    pub decimals: Option<u16>,
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub mappings: Vec<ValueMapping>,
    pub thresholds: Option<ThresholdsConfig>,
    pub links: Vec<DataLink>,
    pub no_value: Option<String>,
    pub custom: HashMap<String, Value>,
}

The display properties for a Field.

These are used by the Grafana frontend to modify how the field is displayed.

Note that this struct, like most structs in this crate, is marked #[non_exhaustive] and therefore cannot be constructed using a struct expression. Instead, create a default value using FieldConfig::default() and modify any fields necessary.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

display_name: Option<String>

Overrides Grafana default naming.

This should not be used from a datasource.

display_name_from_ds: Option<String>

Overrides Grafana default naming in a better way that allows users to further override it easily.

This should be used instead of display_name when used from a datasource.

path: Option<String>

An explicit path to the field in the datasource.

When the frame meta includes a path, this will default to `${frame.meta.path}/${field.name}.

When defined, this value can be used as an identifier within the datasource scope, and may be used as an identifier to update values in a subsequent request.

description: Option<String>

Human readable field metadata.

writeable: Option<bool>

Indicates that the datasource knows how to update this value.

filterable: Option<bool>

Indicates if the field’s data can be filtered by additional calls.

unit: Option<String>

The string to display to represent this field’s unit, such as “Requests/sec”.

decimals: Option<u16>

The number of decimal places to display.

min: Option<f64>

The minimum value of fields in the column.

When present the frontend can skip the calculation.

max: Option<f64>

The maximum value of fields in the column.

When present the frontend can skip the calculation.

mappings: Vec<ValueMapping>

Mappings from input value to display string.

thresholds: Option<ThresholdsConfig>

Mappings from numeric values to states.

links: Vec<DataLink>

Links to use when clicking on a result.

no_value: Option<String>

An alternative string to use when no value is present.

The default is an empty string.

custom: HashMap<String, Value>

Panel-specific values.

Trait Implementations

impl Clone for FieldConfig

fn clone(&self) -> FieldConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldConfig

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

Formats the value using the given formatter.

impl Default for FieldConfig

fn default() -> FieldConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FieldConfig

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 FieldConfig