Struct NoteWidgetDefinition

#[non_exhaustive]
pub struct NoteWidgetDefinition {
    pub background_color: Option<String>,
    pub content: String,
    pub font_size: Option<String>,
    pub has_padding: Option<bool>,
    pub show_tick: Option<bool>,
    pub text_align: Option<WidgetTextAlign>,
    pub tick_edge: Option<WidgetTickEdge>,
    pub tick_pos: Option<String>,
    pub type_: NoteWidgetDefinitionType,
    pub vertical_align: Option<WidgetVerticalAlign>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

The notes and links widget is similar to free text widget, but allows for more formatting options.

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.

background_color: Option<String>

Background color of the note.

content: String

Content of the note.

font_size: Option<String>

Size of the text.

has_padding: Option<bool>

Whether to add padding or not.

show_tick: Option<bool>

Whether to show a tick or not.

text_align: Option<WidgetTextAlign>

How to align the text on the widget.

tick_edge: Option<WidgetTickEdge>

Define how you want to align the text on the widget.

tick_pos: Option<String>

Where to position the tick on an edge.

type_: NoteWidgetDefinitionType

Type of the note widget.

vertical_align: Option<WidgetVerticalAlign>

Vertical alignment.

additional_properties: BTreeMap<String, Value>

Implementations

impl NoteWidgetDefinition

pub fn new( content: String, type_: NoteWidgetDefinitionType, ) -> NoteWidgetDefinition

Examples found in repository

examples/v1_dashboards_CreateDashboard_417992286.rs (line 18)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![Widget::new(WidgetDefinition::NoteWidgetDefinition(Box::new(
            NoteWidgetDefinition::new("# Example Note".to_string(), NoteWidgetDefinitionType::NOTE),
        )))
        .layout(WidgetLayout::new(24, 18, 0, 0))],
    )
    .description(Some("".to_string()))
    .notify_list(Some(vec![]))
    .template_variables(Some(vec![]));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn background_color(self, value: String) -> Self

pub fn font_size(self, value: String) -> Self

pub fn has_padding(self, value: bool) -> Self

pub fn show_tick(self, value: bool) -> Self

pub fn text_align(self, value: WidgetTextAlign) -> Self

pub fn tick_edge(self, value: WidgetTickEdge) -> Self

pub fn tick_pos(self, value: String) -> Self

pub fn vertical_align(self, value: WidgetVerticalAlign) -> Self

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for NoteWidgetDefinition

fn clone(&self) -> NoteWidgetDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteWidgetDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NoteWidgetDefinition

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NoteWidgetDefinition

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for NoteWidgetDefinition

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 NoteWidgetDefinition