Struct WidgetLayout

#[non_exhaustive]
pub struct WidgetLayout {
    pub height: i64,
    pub is_column_break: Option<bool>,
    pub width: i64,
    pub x: i64,
    pub y: i64,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

The layout for a widget on a free or new dashboard layout dashboard.

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.

height: i64

The height of the widget. Should be a non-negative integer.

is_column_break: Option<bool>

Whether the widget should be the first one on the second column in high density or not. Note: Only for the new dashboard layout and only one widget in the dashboard should have this property set to true.

width: i64

The width of the widget. Should be a non-negative integer.

x: i64

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

y: i64

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

additional_properties: BTreeMap<String, Value>

Implementations

impl WidgetLayout

pub fn new(height: i64, width: i64, x: i64, y: i64) -> WidgetLayout

Examples found in repository

examples/v1_dashboards_CreateDashboard_417992286.rs (line 20)

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());
    }
}

examples/v1_dashboards_CreateDashboard_913313564.rs (line 24)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![
            Widget::new(WidgetDefinition::IFrameWidgetDefinition(Box::new(
                IFrameWidgetDefinition::new(
                    IFrameWidgetDefinitionType::IFRAME,
                    "https://docs.datadoghq.com/api/latest/".to_string(),
                ),
            )))
            .layout(WidgetLayout::new(12, 12, 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());
    }
}

examples/v1_dashboards_CreateDashboard_651038379.rs (line 26)

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()))
    .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());
    }
}

examples/v1_dashboards_CreateDashboard_1738608750.rs (line 28)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![
            Widget::new(WidgetDefinition::FreeTextWidgetDefinition(Box::new(
                FreeTextWidgetDefinition::new(
                    "Example free text".to_string(),
                    FreeTextWidgetDefinitionType::FREE_TEXT,
                )
                .color("#4d4d4d".to_string())
                .font_size("auto".to_string())
                .text_align(WidgetTextAlign::LEFT),
            )))
            .layout(WidgetLayout::new(6, 24, 0, 0)),
        ],
    )
    .description(None)
    .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());
    }
}

examples/v1_dashboards_CreateDashboard_2607944105.rs (line 30)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![
            Widget::new(WidgetDefinition::CheckStatusWidgetDefinition(Box::new(
                CheckStatusWidgetDefinition::new(
                    "datadog.agent.up".to_string(),
                    WidgetGrouping::CHECK,
                    CheckStatusWidgetDefinitionType::CHECK_STATUS,
                )
                .tags(vec!["*".to_string()])
                .title_align(WidgetTextAlign::LEFT)
                .title_size("16".to_string()),
            )))
            .layout(WidgetLayout::new(8, 15, 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());
    }
}

examples/v1_dashboards_CreateDashboard_3250131584.rs (line 29)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::FREE,
        "Example-Dashboard".to_string(),
        vec![
            Widget::new(WidgetDefinition::EventTimelineWidgetDefinition(Box::new(
                EventTimelineWidgetDefinition::new(
                    "status:error priority:all".to_string(),
                    EventTimelineWidgetDefinitionType::EVENT_TIMELINE,
                )
                .tags_execution("and".to_string())
                .title("".to_string())
                .title_align(WidgetTextAlign::LEFT)
                .title_size("16".to_string()),
            )))
            .layout(WidgetLayout::new(9, 47, 0, 0)),
        ],
    )
    .description(None)
    .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());
    }
}

Additional examples can be found in:

• examples/v1_dashboards_CreateDashboard_2034634967.rs
• examples/v1_dashboards_CreateDashboard_2634813877.rs
• examples/v1_dashboards_CreateDashboard_2316374332.rs
• examples/v1_dashboards_CreateDashboard_1423904722.rs
• examples/v1_dashboards_CreateDashboard_2308247857.rs
• examples/v1_dashboards_CreateDashboard_2917274132.rs
• examples/v1_dashboards_CreateDashboard_1177423752.rs
• examples/v1_dashboards_CreateDashboard_173805046.rs
• examples/v1_dashboards_CreateDashboard_803346562.rs
• examples/v1_dashboards_CreateDashboard_1094917386.rs
• examples/v1_dashboards_CreateDashboard_2610827685.rs
• examples/v1_dashboards_CreateDashboard_109450134.rs
• examples/v1_dashboards_CreateDashboard_2652180930.rs
• examples/v1_dashboards_CreateDashboard_2029850837.rs
• examples/v1_dashboards_CreateDashboard_1200099236.rs
• examples/v1_dashboards_CreateDashboard_1754992756.rs
• examples/v1_dashboards_CreateDashboard_2921337351.rs
• examples/v1_dashboards_CreateDashboard_2705593938.rs
• examples/v1_dashboards_CreateDashboard_3562282606.rs
• examples/v1_dashboards_CreateDashboard_3777304439.rs
• examples/v1_dashboards_CreateDashboard_2349863258.rs
• examples/v1_dashboards_CreateDashboard_2644712913.rs
• examples/v1_dashboards_CreateDashboard_3513586382.rs
• examples/v1_dashboards_CreateDashboard_2490110261.rs
• examples/v1_dashboards_CreateDashboard_145494973.rs
• examples/v1_dashboards_CreateDashboard_765140092.rs
• examples/v1_dashboards_CreateDashboard_798168180.rs
• examples/v1_dashboards_CreateDashboard_1024858348.rs
• examples/v1_dashboards_CreateDashboard_252716965.rs
• examples/v1_dashboards_CreateDashboard_3882428227.rs
• examples/v1_dashboards_CreateDashboard_578885732.rs
• examples/v1_dashboards_CreateDashboard_1442588603.rs
• examples/v1_dashboards_CreateDashboard_2064651578.rs
• examples/v1_dashboards_CreateDashboard_2104498738.rs
• examples/v1_dashboards_CreateDashboard_2336428357.rs
• examples/v1_dashboards_CreateDashboard_1413226400.rs
• examples/v1_dashboards_CreateDashboard_1213075383.rs
• examples/v1_dashboards_CreateDashboard_2563642929.rs
• examples/v1_dashboards_CreateDashboard_3520534424.rs
• examples/v1_dashboards_CreateDashboard_1490099434.rs
• examples/v1_dashboards_CreateDashboard_2278756614.rs
• examples/v1_dashboards_CreateDashboard_2342457693.rs
• examples/v1_dashboards_CreateDashboard_915214113.rs
• examples/v1_dashboards_CreateDashboard_794302680.rs

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

Examples found in repository

examples/v1_dashboards_CreateDashboard_1754992756.rs (line 37)

async fn main() {
    // there is a valid "powerpack" in the system
    let powerpack_data_id = std::env::var("POWERPACK_DATA_ID").unwrap();
    let body = Dashboard::new(
        DashboardLayoutType::ORDERED,
        "Example-Dashboard with powerpack widget".to_string(),
        vec![
            Widget::new(WidgetDefinition::PowerpackWidgetDefinition(Box::new(
                PowerpackWidgetDefinition::new(
                    powerpack_data_id.clone(),
                    PowerpackWidgetDefinitionType::POWERPACK,
                )
                .template_variables(
                    PowerpackTemplateVariables::new()
                        .controlled_by_powerpack(vec![PowerpackTemplateVariableContents::new(
                            "foo".to_string(),
                            vec!["baz".to_string(), "qux".to_string(), "quuz".to_string()],
                        )
                        .prefix("bar".to_string())])
                        .controlled_externally(vec![]),
                ),
            )))
            .layout(WidgetLayout::new(2, 2, 1, 1).is_column_break(false)),
        ],
    )
    .description(Some("description".to_string()));
    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 additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for WidgetLayout

fn clone(&self) -> WidgetLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetLayout

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WidgetLayout

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WidgetLayout

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

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 WidgetLayout