Struct VisualCustomAction

#[non_exhaustive]
pub struct VisualCustomAction {
    pub custom_action_id: String,
    pub name: String,
    pub status: Option<WidgetStatus>,
    pub trigger: VisualCustomActionTrigger,
    pub action_operations: Vec<VisualCustomActionOperation>,
}

A custom action defined on a visual.

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.

custom_action_id: String

The ID of the VisualCustomAction.

name: String

The name of the VisualCustomAction.

status: Option<WidgetStatus>

The status of the VisualCustomAction.

trigger: VisualCustomActionTrigger

The trigger of the VisualCustomAction.

Valid values are defined as follows:

• DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

• DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

action_operations: Vec<VisualCustomActionOperation>

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Implementations

impl VisualCustomAction

pub fn custom_action_id(&self) -> &str

The ID of the VisualCustomAction.

pub fn name(&self) -> &str

The name of the VisualCustomAction.

pub fn status(&self) -> Option<&WidgetStatus>

The status of the VisualCustomAction.

pub fn trigger(&self) -> &VisualCustomActionTrigger

The trigger of the VisualCustomAction.

Valid values are defined as follows:

• DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

• DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

pub fn action_operations(&self) -> &[VisualCustomActionOperation]

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

impl VisualCustomAction

pub fn builder() -> VisualCustomActionBuilder

Creates a new builder-style object to manufacture VisualCustomAction.

Trait Implementations

impl Clone for VisualCustomAction

fn clone(&self) -> VisualCustomAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VisualCustomAction

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

Formats the value using the given formatter.

impl PartialEq for VisualCustomAction

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