Struct SheetImage

#[non_exhaustive]
pub struct SheetImage {
    pub sheet_image_id: String,
    pub source: Option<SheetImageSource>,
    pub scaling: Option<SheetImageScalingConfiguration>,
    pub tooltip: Option<SheetImageTooltipConfiguration>,
    pub image_content_alt_text: Option<String>,
    pub interactions: Option<ImageInteractionOptions>,
    pub actions: Option<Vec<ImageCustomAction>>,
}

An image that is located on a sheet.

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.

sheet_image_id: String

The ID of the sheet image.

source: Option<SheetImageSource>

The source of the image.

scaling: Option<SheetImageScalingConfiguration>

Determines how the image is scaled.

tooltip: Option<SheetImageTooltipConfiguration>

The tooltip to be shown when hovering over the image.

image_content_alt_text: Option<String>

The alt text for the image.

interactions: Option<ImageInteractionOptions>

The general image interactions setup for an image.

actions: Option<Vec<ImageCustomAction>>

A list of custom actions that are configured for an image.

Implementations

impl SheetImage

pub fn sheet_image_id(&self) -> &str

The ID of the sheet image.

pub fn source(&self) -> Option<&SheetImageSource>

The source of the image.

pub fn scaling(&self) -> Option<&SheetImageScalingConfiguration>

Determines how the image is scaled.

pub fn tooltip(&self) -> Option<&SheetImageTooltipConfiguration>

The tooltip to be shown when hovering over the image.

pub fn image_content_alt_text(&self) -> Option<&str>

The alt text for the image.

pub fn interactions(&self) -> Option<&ImageInteractionOptions>

The general image interactions setup for an image.

pub fn actions(&self) -> &[ImageCustomAction]

A list of custom actions that are configured for an image.

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

impl SheetImage

pub fn builder() -> SheetImageBuilder

Creates a new builder-style object to manufacture SheetImage.

Trait Implementations

impl Clone for SheetImage

fn clone(&self) -> SheetImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SheetImage

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

Formats the value using the given formatter.

impl PartialEq for SheetImage

fn eq(&self, other: &SheetImage) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 SheetImage