Struct datadog_api_client::datadogV1::model::model_image_widget_definition::ImageWidgetDefinition

#[non_exhaustive]
pub struct ImageWidgetDefinition {
    pub has_background: Option<bool>,
    pub has_border: Option<bool>,
    pub horizontal_align: Option<WidgetHorizontalAlign>,
    pub margin: Option<WidgetMargin>,
    pub sizing: Option<WidgetImageSizing>,
    pub type_: ImageWidgetDefinitionType,
    pub url: String,
    pub url_dark_theme: Option<String>,
    pub vertical_align: Option<WidgetVerticalAlign>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.

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.

has_background: Option<bool>

Whether to display a background or not.

has_border: Option<bool>

Whether to display a border or not.

horizontal_align: Option<WidgetHorizontalAlign>

Horizontal alignment.

margin: Option<WidgetMargin>

Size of the margins around the image. Note: small and large values are deprecated.

sizing: Option<WidgetImageSizing>

How to size the image on the widget. The values are based on the image object-fit CSS properties. Note: zoom, fit and center values are deprecated.

type_: ImageWidgetDefinitionType

Type of the image widget.

url: String

URL of the image.

url_dark_theme: Option<String>

URL of the image in dark mode.

vertical_align: Option<WidgetVerticalAlign>

Vertical alignment.

additional_properties: BTreeMap<String, Value>

Implementations

impl ImageWidgetDefinition

pub fn new( type_: ImageWidgetDefinitionType, url: String, ) -> ImageWidgetDefinition

Examples found in repository

examples/v1_dashboards_CreateDashboard_651038379.rs (lines 20-23)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![
            Widget::new(WidgetDefinition::ImageWidgetDefinition(Box::new(
                ImageWidgetDefinition::new(
                    ImageWidgetDefinitionType::IMAGE,
                    "https://example.com/image.png".to_string(),
                )
                .sizing(WidgetImageSizing::COVER),
            )))
            .layout(WidgetLayout::new(12, 12, 0, 0)),
        ],
    )
    .description(Some("".to_string()))
    .is_read_only(false)
    .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 has_background(self, value: bool) -> Self

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

pub fn horizontal_align(self, value: WidgetHorizontalAlign) -> Self

pub fn margin(self, value: WidgetMargin) -> Self

pub fn sizing(self, value: WidgetImageSizing) -> Self

Examples found in repository

examples/v1_dashboards_CreateDashboard_651038379.rs (line 24)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![
            Widget::new(WidgetDefinition::ImageWidgetDefinition(Box::new(
                ImageWidgetDefinition::new(
                    ImageWidgetDefinitionType::IMAGE,
                    "https://example.com/image.png".to_string(),
                )
                .sizing(WidgetImageSizing::COVER),
            )))
            .layout(WidgetLayout::new(12, 12, 0, 0)),
        ],
    )
    .description(Some("".to_string()))
    .is_read_only(false)
    .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 url_dark_theme(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 ImageWidgetDefinition

fn clone(&self) -> ImageWidgetDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageWidgetDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageWidgetDefinition

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImageWidgetDefinition

fn eq(&self, other: &ImageWidgetDefinition) -> 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 ImageWidgetDefinition

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 ImageWidgetDefinition