Struct FunnelWidgetDefinition

#[non_exhaustive]
pub struct FunnelWidgetDefinition {
    pub requests: Vec<FunnelWidgetRequest>,
    pub time: Option<WidgetTime>,
    pub title: Option<String>,
    pub title_align: Option<WidgetTextAlign>,
    pub title_size: Option<String>,
    pub type_: FunnelWidgetDefinitionType,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.

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.

requests: Vec<FunnelWidgetRequest>

Request payload used to query items.

time: Option<WidgetTime>

Time setting for the widget.

title: Option<String>

The title of the widget.

title_align: Option<WidgetTextAlign>

How to align the text on the widget.

title_size: Option<String>

The size of the title.

type_: FunnelWidgetDefinitionType

Type of funnel widget.

additional_properties: BTreeMap<String, Value>

Implementations

impl FunnelWidgetDefinition

pub fn new( requests: Vec<FunnelWidgetRequest>, type_: FunnelWidgetDefinitionType, ) -> FunnelWidgetDefinition

Examples found in repository

examples/v1_dashboards_CreateDashboard_927141680.rs (lines 21-27)

async fn main() {
    let body = Dashboard::new(
        DashboardLayoutType::ORDERED,
        "Example-Dashboard with funnel widget".to_string(),
        vec![Widget::new(WidgetDefinition::FunnelWidgetDefinition(
            Box::new(FunnelWidgetDefinition::new(
                vec![FunnelWidgetRequest::new(
                    FunnelQuery::new(FunnelSource::RUM, "".to_string(), vec![]),
                    FunnelRequestType::FUNNEL,
                )],
                FunnelWidgetDefinitionType::FUNNEL,
            )),
        ))],
    );
    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 time(self, value: WidgetTime) -> Self

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

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

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

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

Trait Implementations

impl Clone for FunnelWidgetDefinition

fn clone(&self) -> FunnelWidgetDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunnelWidgetDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunnelWidgetDefinition

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunnelWidgetDefinition

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

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 FunnelWidgetDefinition