FAQ?

[c-git]

I was going to ask about creating a FAQ or some kind of lookup are where ppl can go to find how to do things that are hard to discover through the docs. Then I noticed the Readme has quite a few examples. Were you trying to limit the size of the readme or would adding more be something you are open to? I'm trying to freeze some rows at the top of my spreadsheet and having a hard time. AI is leading me around in circles. I'm making progress but it's slow going. For the next person I wanted to document how to do it. Just trying to see if this is something you are open to.

[c-git]

FYI I got it to work. I think i should make it update the view point but once they scroll it fixes so I'm going to move on. Let me know what you think about the readme. I've tried to find this more than once but I don't think I ever created an issue to ask for help.

use anyhow::Context as _;

fn main() -> anyhow::Result<()> {
    let mut workbook = umya_spreadsheet::new_file_empty_worksheet();
    let sheet = workbook.new_sheet("Sheet1")?;
    set_frozen_pane(sheet, Some(2.9), Some(1.5))?;
    umya_spreadsheet::writer::xlsx::write(&workbook, "test.xlsx")?;
    Ok(())
}

/// Sets the any split values set to `Some(_)` and returns an error if neither
/// are set
fn set_frozen_pane(
    sheet: &mut umya_spreadsheet::Worksheet,
    vertical_split_value: Option<f64>,
    horizontal_split_value: Option<f64>,
) -> anyhow::Result<()> {
    if vertical_split_value.is_none() && horizontal_split_value.is_none() {
        anyhow::bail!("Neither vertical nor horizontal spit are set");
    }

    let sheet_views = sheet.sheet_views_mut();

    // If no sheet view exists yet, push a default one onto the list
    if sheet_views.sheet_view_list_mut().is_empty() {
        sheet_views.add_sheet_view_list_mut(umya_spreadsheet::SheetView::default());
    }

    let sheet_view = sheet_views
        .sheet_view_list_mut()
        .get_mut(0)
        .context("failed to get first sheet view")?;

    // Initialize the pane if it is currently None
    if sheet_view.pane().is_none() {
        sheet_view.set_pane(umya_spreadsheet::structs::Pane::default());
    }

    let pane = sheet_view.pane_mut().context("failed to get pane")?;
    if let Some(value) = vertical_split_value {
        pane.set_vertical_split(value);
    }
    if let Some(value) = horizontal_split_value {
        pane.set_horizontal_split(value);
    }
    pane.set_state(umya_spreadsheet::PaneStateValues::Frozen);
    Ok(())
}

[c-git]

PS. I came across the Elixir wrapper. The site looks great https://umya-spreadsheet-ex.hexdocs.pm/readme.html good job

[MathNya]

@c-git
Thank you.
I’m definitely in favor of including plenty of implementation examples.
However, I’m not very familiar with this topic.
I think it would be best to include representative examples in the README and detailed examples in DOCS.RS, but if there’s a better approach, I’d be happy to change it.
The examples in umya-spreadsheet-ex are excellent.
That’s ideal.

[c-git]

I think that's a great idea but docs.rs Seems to lend itself more to documenting functions. Not really "how to" kind of stuff. I wonder if there is a way to create a rusty version of the elixer docs. Are you familiar with the authors of that documentation? Maybe there us a way to translate it into an mdbook.

PS. Oh the example code is incomplete. It needs to update the view on the spreadsheet to not be on the frozen part but it wasn't bad enough for be to spend more time on it. But before we put it in an examples it would need to be completed. It just shows the frozen part twice until you scroll then the spreadsheet application stops you from going back up.

[schungx]

An mdbook based tutorial would be better than simply API docs...

And it is not difficult to create.

[c-git]

It's mostly just the time.