Struct FreeFormLayoutElement

#[non_exhaustive]
pub struct FreeFormLayoutElement {
    pub element_id: String,
    pub element_type: LayoutElementType,
    pub x_axis_location: String,
    pub y_axis_location: String,
    pub width: String,
    pub height: String,
    pub visibility: Option<Visibility>,
    pub rendering_rules: Option<Vec<SheetElementRenderingRule>>,
    pub border_style: Option<FreeFormLayoutElementBorderStyle>,
    pub selected_border_style: Option<FreeFormLayoutElementBorderStyle>,
    pub background_style: Option<FreeFormLayoutElementBackgroundStyle>,
    pub loading_animation: Option<LoadingAnimation>,
}

An element within a free-form layout.

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.

element_id: String

A unique identifier for an element within a free-form layout.

element_type: LayoutElementType

The type of element.

x_axis_location: String

The x-axis coordinate of the element.

y_axis_location: String

The y-axis coordinate of the element.

width: String

The width of an element within a free-form layout.

height: String

The height of an element within a free-form layout.

visibility: Option<Visibility>

The visibility of an element within a free-form layout.

rendering_rules: Option<Vec<SheetElementRenderingRule>>

The rendering rules that determine when an element should be displayed within a free-form layout.

border_style: Option<FreeFormLayoutElementBorderStyle>

The border style configuration of a free-form layout element.

selected_border_style: Option<FreeFormLayoutElementBorderStyle>

The border style configuration of a free-form layout element. This border style is used when the element is selected.

background_style: Option<FreeFormLayoutElementBackgroundStyle>

The background style configuration of a free-form layout element.

loading_animation: Option<LoadingAnimation>

The loading animation configuration of a free-form layout element.

Implementations

impl FreeFormLayoutElement

pub fn element_id(&self) -> &str

A unique identifier for an element within a free-form layout.

pub fn element_type(&self) -> &LayoutElementType

The type of element.

pub fn x_axis_location(&self) -> &str

The x-axis coordinate of the element.

pub fn y_axis_location(&self) -> &str

The y-axis coordinate of the element.

pub fn width(&self) -> &str

The width of an element within a free-form layout.

pub fn height(&self) -> &str

The height of an element within a free-form layout.

pub fn visibility(&self) -> Option<&Visibility>

The visibility of an element within a free-form layout.

pub fn rendering_rules(&self) -> &[SheetElementRenderingRule]

The rendering rules that determine when an element should be displayed within a free-form layout.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rendering_rules.is_none().

pub fn border_style(&self) -> Option<&FreeFormLayoutElementBorderStyle>

The border style configuration of a free-form layout element.

pub fn selected_border_style(&self) -> Option<&FreeFormLayoutElementBorderStyle>

The border style configuration of a free-form layout element. This border style is used when the element is selected.

pub fn background_style(&self) -> Option<&FreeFormLayoutElementBackgroundStyle>

The background style configuration of a free-form layout element.

pub fn loading_animation(&self) -> Option<&LoadingAnimation>

The loading animation configuration of a free-form layout element.

impl FreeFormLayoutElement

pub fn builder() -> FreeFormLayoutElementBuilder

Creates a new builder-style object to manufacture FreeFormLayoutElement.

Trait Implementations

impl Clone for FreeFormLayoutElement

fn clone(&self) -> FreeFormLayoutElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FreeFormLayoutElement

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

Formats the value using the given formatter.

impl PartialEq for FreeFormLayoutElement

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