Struct SheetPicture 

pub struct SheetPicture {
    pub data: Vec<u8>,
    pub format: PictureFormat,
    pub name: String,
    pub shape_properties: Option<ShapeProperties>,
}

A picture embedded in a sheet’s drawing (<xdr:pic>, CT_Picture — the spreadsheet-drawing flavor, distinct from a:CT_Picture), anchored by its enclosing DrawingAnchor.

Reuses drawing::ShapeProperties/drawing::BlipFill for the picture’s own formatting (fill/line/rotation via spPr), the same DrawingML content model word-ooxml’s own picture support is being generalized toward — this is genuinely shared content, not a parallel reimplementation. Raw image bytes are supplied directly (data/format), same “no separate loader type” posture as word_ooxml::Image.

Not modeled: cropping (a:srcRect), picture-specific effects beyond what ShapeProperties itself carries.

Fields

data: Vec<u8>

format: PictureFormat

name: String

Alt text / non-visual name (<xdr:cNvPr name="..">).

shape_properties: Option<ShapeProperties>

Implementations

impl SheetPicture

pub fn new(data: impl Into<Vec<u8>>, format: PictureFormat) -> SheetPicture

Examples found in repository

examples/xlsx_images_and_charts.rs (line 25)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_images_and_charts.xlsx");
    let image_bytes = std::fs::read(image_fixture_path())?;

    let picture = SheetPicture::new(image_bytes, PictureFormat::Png).with_name("Test image");
    let picture_sheet = Sheet::new("Picture")
        .with_row(Row::new().with_text("The picture is anchored to cell A1:"))
        .with_drawing(SheetDrawing::new().with_anchor(DrawingAnchor::new(
            CellAnchorPoint::new(0, 1),
            CellAnchorPoint::new(2, 6),
            DrawingObject::Picture(Box::new(picture)),
        )));

    let chart = SheetChart::new(sample_chart_space()).with_name("Quarterly revenue");
    let chart_sheet = Sheet::new("Chart")
        .with_row(Row::new().with_text("A bar chart is anchored below:"))
        .with_drawing(SheetDrawing::new().with_anchor(DrawingAnchor::new(
            CellAnchorPoint::new(0, 1),
            CellAnchorPoint::new(6, 16),
            DrawingObject::Chart(Box::new(chart)),
        )));

    let workbook = Workbook::new()
        .with_sheet(picture_sheet)
        .with_sheet(chart_sheet);
    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_name(self, name: impl Into<String>) -> SheetPicture

Examples found in repository

examples/xlsx_images_and_charts.rs (line 25)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_images_and_charts.xlsx");
    let image_bytes = std::fs::read(image_fixture_path())?;

    let picture = SheetPicture::new(image_bytes, PictureFormat::Png).with_name("Test image");
    let picture_sheet = Sheet::new("Picture")
        .with_row(Row::new().with_text("The picture is anchored to cell A1:"))
        .with_drawing(SheetDrawing::new().with_anchor(DrawingAnchor::new(
            CellAnchorPoint::new(0, 1),
            CellAnchorPoint::new(2, 6),
            DrawingObject::Picture(Box::new(picture)),
        )));

    let chart = SheetChart::new(sample_chart_space()).with_name("Quarterly revenue");
    let chart_sheet = Sheet::new("Chart")
        .with_row(Row::new().with_text("A bar chart is anchored below:"))
        .with_drawing(SheetDrawing::new().with_anchor(DrawingAnchor::new(
            CellAnchorPoint::new(0, 1),
            CellAnchorPoint::new(6, 16),
            DrawingObject::Chart(Box::new(chart)),
        )));

    let workbook = Workbook::new()
        .with_sheet(picture_sheet)
        .with_sheet(chart_sheet);
    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_shape_properties(self, properties: ShapeProperties) -> SheetPicture

Trait Implementations

impl Clone for SheetPicture

fn clone(&self) -> SheetPicture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SheetPicture

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

Formats the value using the given formatter.

impl PartialEq for SheetPicture

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SheetPicture