WorkSheetRow

Trait WorkSheetRow 

Source
pub trait WorkSheetRow: _Row {
    // Provided methods
    fn get_row(&self, row: u32) -> WorkSheetResult<Row> { ... }
    fn get_row_with_format(
        &self,
        row: u32,
    ) -> WorkSheetResult<(Row, Option<Format>)> { ... }
    fn get_row_height(&self, row: u32) -> WorkSheetResult<Option<f64>> { ... }
    fn set_row(&mut self, row_number: u32, row: &Row) -> WorkSheetResult<()> { ... }
    fn set_row_with_format(
        &mut self,
        row_number: u32,
        row: &Row,
        format: &Format,
    ) -> WorkSheetResult<()> { ... }
    fn set_row_height(&mut self, row: u32, height: f64) -> WorkSheetResult<()> { ... }
    fn set_row_height_pixels(
        &mut self,
        row: u32,
        height: f64,
    ) -> WorkSheetResult<()> { ... }
    fn set_row_height_with_format(
        &mut self,
        row: u32,
        height: f64,
        format: &Format,
    ) -> WorkSheetResult<()> { ... }
    fn set_row_height_pixels_with_format(
        &mut self,
        row: u32,
        height: f64,
        format: &Format,
    ) -> WorkSheetResult<()> { ... }
    fn hide_row(&mut self, row: u32) -> WorkSheetResult<()> { ... }
    fn set_row_level(&mut self, row: u32, level: u8) -> WorkSheetResult<()> { ... }
    fn collapse_row(&mut self, row: u32) -> WorkSheetResult<()> { ... }
}
Expand description

WorkSheetRow is a trait for WorkSheets that allowing them working with Rows.

Not only does it support reading and updating rows directly, but it also provides a set of suggested methods for reading and updating rows swiftly.

Provided Methods§

Source

fn get_row(&self, row: u32) -> WorkSheetResult<Row>

Get the Row of a row based on the row number, note that the row number starts with 1.

§Example
use edit_xlsx::{Workbook, WorkSheetRow};
let workbook = Workbook::from_path("./examples/xlsx/accounting.xlsx").unwrap();
let worksheet = workbook.get_worksheet_by_name("worksheet").unwrap();
let first_row = worksheet.get_row(1).unwrap();
// Convert to u32 to reduce error
assert_eq!(first_row.height.unwrap() as u32, 28);
Source

fn get_row_with_format( &self, row: u32, ) -> WorkSheetResult<(Row, Option<Format>)>

Get the Row and Format of a row based on the row number, note that the row number starts with 1.

§Example
use edit_xlsx::{Workbook, WorkSheetRow};
let workbook = Workbook::from_path("./examples/xlsx/accounting.xlsx").unwrap();
let worksheet = workbook.get_worksheet_by_name("worksheet").unwrap();
let (_, third_row_format) = worksheet.get_row_with_format(3).unwrap();
assert_eq!(third_row_format.unwrap().font.bold, true);
Examples found in repository?
examples/read_and_copy.rs (line 33)
7fn main() -> WorkbookResult<()> {
8    // Read an existed workbook
9    let reading_book = Workbook::from_path("./tests/xlsx/accounting.xlsx")?;
10    let reading_sheet = reading_book.get_worksheet_by_name("worksheet")?;
11    // Create a new workbook to write
12    let mut writing_book = Workbook::new();
13    let writing_sheet = writing_book.get_worksheet_mut(1)?;
14
15    // Synchronous column width and format
16    let columns_map = reading_sheet.get_columns_with_format("A:XFD")?;
17    match reading_sheet.get_default_column() {
18        None => writing_sheet.set_default_column_adaptive(),
19        Some(width) => writing_sheet.set_default_column(width),
20    }
21    columns_map.iter().for_each(|(col_range, (column, format))| {
22        if let Some(format) = format {
23            // if col format exists, write it to writing_sheet
24            writing_sheet.set_columns_with_format(col_range, column, format).unwrap()
25        } else {
26            writing_sheet.set_columns(col_range, column).unwrap()
27        }
28    });
29
30    // Synchronous row height and format
31    writing_sheet.set_default_row(reading_sheet.get_default_row());
32    for row_number in 1..=reading_sheet.max_row() {
33        let (row, format) = reading_sheet.get_row_with_format(row_number)?;
34        if let Some(format) = format {
35            // if col format exists, write it to writing_sheet
36            writing_sheet.set_row_with_format(row_number, &row, &format)?;
37        } else {
38            writing_sheet.set_row(row_number, &row)?;
39        }
40    }
41
42    // Read then write text and format
43    for row in 1..=reading_sheet.max_row() {
44        for col in 1..=reading_sheet.max_column() {
45            if let Ok(cell) = reading_sheet.read_cell((row, col)) {
46                writing_sheet.write_cell((row, col), &cell)?;
47            }
48        }
49    }
50
51    writing_book.save_as("./examples/read_and_copy.xlsx")?;
52    Ok(())
53}
Source

fn get_row_height(&self, row: u32) -> WorkSheetResult<Option<f64>>

Get the custom height of a row based on the row number, note that the row number starts with 1. Only rows have custom height can return their height.

§Example
use edit_xlsx::{Workbook, WorkSheetRow};
let workbook = Workbook::from_path("./examples/xlsx/accounting.xlsx").unwrap();
let worksheet = workbook.get_worksheet_by_name("worksheet").unwrap();
let first_height = worksheet.get_row_height(1).unwrap();
let forth_height = worksheet.get_row_height(4).unwrap();
assert_eq!(first_height, Some(28.2));
assert_eq!(forth_height, None);
Source

fn set_row(&mut self, row_number: u32, row: &Row) -> WorkSheetResult<()>

update a row by Row, note that the row number starts with 1.

Only not none fields will be updated.

§Example
use edit_xlsx::{Row, Workbook, WorkSheetRow};
let mut workbook = Workbook::from_path("./examples/xlsx/accounting.xlsx").unwrap();
let mut worksheet = workbook.get_worksheet_mut_by_name("worksheet").unwrap();
let mut row = Row::default();
row.outline_level = Some(1);
row.hidden = Some(1);
worksheet.set_row(1, &row).unwrap();
worksheet.set_row(2, &row).unwrap();
worksheet.set_row(3, &row).unwrap();
workbook.save_as("./examples/row_set_row.xlsx").unwrap()
Examples found in repository?
examples/read_and_copy.rs (line 38)
7fn main() -> WorkbookResult<()> {
8    // Read an existed workbook
9    let reading_book = Workbook::from_path("./tests/xlsx/accounting.xlsx")?;
10    let reading_sheet = reading_book.get_worksheet_by_name("worksheet")?;
11    // Create a new workbook to write
12    let mut writing_book = Workbook::new();
13    let writing_sheet = writing_book.get_worksheet_mut(1)?;
14
15    // Synchronous column width and format
16    let columns_map = reading_sheet.get_columns_with_format("A:XFD")?;
17    match reading_sheet.get_default_column() {
18        None => writing_sheet.set_default_column_adaptive(),
19        Some(width) => writing_sheet.set_default_column(width),
20    }
21    columns_map.iter().for_each(|(col_range, (column, format))| {
22        if let Some(format) = format {
23            // if col format exists, write it to writing_sheet
24            writing_sheet.set_columns_with_format(col_range, column, format).unwrap()
25        } else {
26            writing_sheet.set_columns(col_range, column).unwrap()
27        }
28    });
29
30    // Synchronous row height and format
31    writing_sheet.set_default_row(reading_sheet.get_default_row());
32    for row_number in 1..=reading_sheet.max_row() {
33        let (row, format) = reading_sheet.get_row_with_format(row_number)?;
34        if let Some(format) = format {
35            // if col format exists, write it to writing_sheet
36            writing_sheet.set_row_with_format(row_number, &row, &format)?;
37        } else {
38            writing_sheet.set_row(row_number, &row)?;
39        }
40    }
41
42    // Read then write text and format
43    for row in 1..=reading_sheet.max_row() {
44        for col in 1..=reading_sheet.max_column() {
45            if let Ok(cell) = reading_sheet.read_cell((row, col)) {
46                writing_sheet.write_cell((row, col), &cell)?;
47            }
48        }
49    }
50
51    writing_book.save_as("./examples/read_and_copy.xlsx")?;
52    Ok(())
53}
Source

fn set_row_with_format( &mut self, row_number: u32, row: &Row, format: &Format, ) -> WorkSheetResult<()>

update a row by Row, note that the row number starts with 1.

Only not none fields will be updated.

NOTICE: Changing the Row’s Format does not mean that the effect can be seen directly in Excel, because the style priority is Cell>Row>Column.

§Example
use edit_xlsx::{Format, FormatColor, Row, Workbook, WorkSheetRow};
let mut workbook = Workbook::from_path("./examples/xlsx/accounting.xlsx").unwrap();
let mut worksheet = workbook.get_worksheet_mut_by_name("worksheet").unwrap();
let mut row = Row::default();
row.height = Some(10.0);
let red_font = Format::default().set_background_color(FormatColor::Index(4)).set_color(FormatColor::RGB(255, 0, 0));
worksheet.set_row_with_format(6, &row, &red_font).unwrap();
worksheet.set_row_with_format(7, &row, &red_font).unwrap();
worksheet.set_row_with_format(8, &row, &red_font).unwrap();
workbook.save_as("./examples/row_set_row_with_format.xlsx").unwrap()
Examples found in repository?
examples/read_and_copy.rs (line 36)
7fn main() -> WorkbookResult<()> {
8    // Read an existed workbook
9    let reading_book = Workbook::from_path("./tests/xlsx/accounting.xlsx")?;
10    let reading_sheet = reading_book.get_worksheet_by_name("worksheet")?;
11    // Create a new workbook to write
12    let mut writing_book = Workbook::new();
13    let writing_sheet = writing_book.get_worksheet_mut(1)?;
14
15    // Synchronous column width and format
16    let columns_map = reading_sheet.get_columns_with_format("A:XFD")?;
17    match reading_sheet.get_default_column() {
18        None => writing_sheet.set_default_column_adaptive(),
19        Some(width) => writing_sheet.set_default_column(width),
20    }
21    columns_map.iter().for_each(|(col_range, (column, format))| {
22        if let Some(format) = format {
23            // if col format exists, write it to writing_sheet
24            writing_sheet.set_columns_with_format(col_range, column, format).unwrap()
25        } else {
26            writing_sheet.set_columns(col_range, column).unwrap()
27        }
28    });
29
30    // Synchronous row height and format
31    writing_sheet.set_default_row(reading_sheet.get_default_row());
32    for row_number in 1..=reading_sheet.max_row() {
33        let (row, format) = reading_sheet.get_row_with_format(row_number)?;
34        if let Some(format) = format {
35            // if col format exists, write it to writing_sheet
36            writing_sheet.set_row_with_format(row_number, &row, &format)?;
37        } else {
38            writing_sheet.set_row(row_number, &row)?;
39        }
40    }
41
42    // Read then write text and format
43    for row in 1..=reading_sheet.max_row() {
44        for col in 1..=reading_sheet.max_column() {
45            if let Ok(cell) = reading_sheet.read_cell((row, col)) {
46                writing_sheet.write_cell((row, col), &cell)?;
47            }
48        }
49    }
50
51    writing_book.save_as("./examples/read_and_copy.xlsx")?;
52    Ok(())
53}
Source

fn set_row_height(&mut self, row: u32, height: f64) -> WorkSheetResult<()>

set the height of a row by row number, The effect is the same as

§Basic Example
use edit_xlsx::Row;
let mut row = Row::default();
row.height = Some(15.0);
// worksheet.set_row(1, &row);
Examples found in repository?
examples/hide_row_col.rs (line 19)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6
7    let worksheet = workbook.get_worksheet_mut(1)?;
8
9    // Write some data.
10    worksheet.write("D1", "Some hidden columns.")?;
11    worksheet.write("A8", "Some hidden rows.")?;
12
13    // Hide all rows without data.
14    worksheet.hide_unused_rows(true);
15
16    // Set the height of empty rows that we do want to display even if it is
17    // the default height.
18    for row in 2..=7 {
19        worksheet.set_row_height(row, 15.0)?;
20    }
21
22    // Columns can be hidden explicitly. This doesn't increase the file size..
23    worksheet.hide_columns("G:XFD")?;
24
25    workbook.save_as("examples/hide_row_col.xlsx")?;
26    Ok(())
27}
More examples
Hide additional examples
examples/merge.rs (line 9)
3fn main() -> WorkbookResult<()> {
4    let mut workbook = Workbook::new();
5    let worksheet = workbook.get_worksheet_mut(1)?;
6
7    // Increase the cell size of the merged cells to highlight the formatting.
8    worksheet.set_columns_width("B:D", 18.0)?;
9    worksheet.set_row_height(4, 40.0)?;
10    worksheet.set_row_height(7, 30.0)?;
11    worksheet.set_row_height(8, 30.0)?;
12
13    // Create a format to use in the merged range.
14    let merge_format = Format::default()
15        .set_bold()
16        .set_border(FormatBorderType::Double)
17        .set_align(FormatAlignType::Center)
18        .set_align(FormatAlignType::VerticalCenter)
19        .set_background_color(FormatColor::RGB(255, 255, 0));
20
21    // Merge 3 cells.
22    worksheet.merge_range_with_format("B4:D4", "Merged Range", &merge_format)?;
23    // Merge 3 cells over two rows.
24    worksheet.merge_range_with_format("B7:D8", "Merged Range", &merge_format)?;
25
26    workbook.save_as("examples/merge.xlsx")?;
27    Ok(())
28}
examples/panes.rs (line 22)
3fn main() -> WorkbookResult<()> {
4    let header_format = Format::default()
5        .set_bold()
6        .set_align(FormatAlignType::Center)
7        .set_align(FormatAlignType::VerticalCenter)
8        .set_border(FormatBorderType::Medium)
9        .set_background_color(FormatColor::RGB(126, 75, 12));
10    let center_format = Format::default().set_align(FormatAlignType::Center);
11
12    // Create a new workbook
13    let mut workbook = Workbook::new();
14
15    //
16    // Example 1. Freeze pane on the top row.
17    //
18    let worksheet1 = workbook.add_worksheet_by_name("Panes 1")?;
19    worksheet1.freeze_panes("A2")?;
20    // Other sheet formatting.
21    worksheet1.set_columns_width("A:I", 16.0)?;
22    worksheet1.set_row_height(0, 20.0)?;
23    worksheet1.set_selection("C3:C3")?;
24
25    // Some text to demonstrate scrolling.
26    for col in 1..=9 {
27        worksheet1.write_with_format((1, col), "Scroll down", &header_format)?;
28    }
29
30    for row in 2..100 {
31        for col in 1..=9 {
32            worksheet1.write_with_format((row, col), row, &center_format)?;
33        }
34    }
35
36    //
37    // Example 2. Freeze pane on the left column.
38    //
39    let worksheet2 = workbook.add_worksheet_by_name("Panes 2")?;
40    worksheet2.freeze_panes("B1")?;
41
42    // Other sheet formatting.
43    worksheet2.set_columns_width("A:A", 16.0)?;
44    worksheet2.set_selection("C3:C3")?;
45
46    // Some text to demonstrate scrolling.
47    for row in 1..=50 {
48        worksheet2.write_with_format((row, 1), "Scroll right", &header_format)?;
49        for col in 2..=26 {
50            worksheet2.write_with_format((row, col), col, &center_format)?;
51        }
52    }
53
54    //
55    // Example 3. Freeze pane on the top row and left column.
56    //
57    let worksheet3 = workbook.add_worksheet_by_name("Panes 3")?;
58    worksheet3.freeze_panes((2, 2))?;
59
60    // Other sheet formatting.
61    worksheet3.set_columns_width("A:Z", 16.0)?;
62    worksheet3.set_row_height(1, 20.0)?;
63    worksheet3.set_selection("C3:C3")?;
64    worksheet3.write_with_format((1, 1), "", &header_format)?;
65
66    // Some text to demonstrate scrolling.
67    for col in 2..=26 {
68        worksheet3.write_with_format((1, col), "Scroll down", &header_format)?;
69    }
70
71    for row in 2..=50 {
72        worksheet3.write_with_format((row, 1), "Scroll right", &header_format)?;
73        for col in 2..=26 {
74            worksheet3.write_with_format((row, col), col, &center_format)?;
75        }
76    }
77
78    //
79    // Example 4. Split pane on the top row and left column.
80    //
81    // The divisions must be specified in terms of row and column dimensions.
82    //
83    let worksheet4 = workbook.add_worksheet_by_name("Panes 4")?;
84    // Set the default row height is 17 and set the column width is 13
85    worksheet4.set_columns_width("A:Z", 13.0)?;
86    worksheet4.set_default_row(17.0);
87    worksheet4.split_panes(2.0 * 13.0, 2.0 * 17.0)?;
88    worksheet4.set_selection("C3:C3")?;
89
90    // Some text to demonstrate scrolling.
91    for col in 1..=26 {
92        worksheet4.write_with_format((1, col), "Scroll", &center_format)?;
93    }
94    for row in 1..=50 {
95        worksheet4.write_with_format((row, 1), "Scroll", &center_format)?;
96        for col in 1..=26 {
97            worksheet4.write_with_format((row, col), col, &center_format)?;
98        }
99    }
100
101    workbook.save_as("examples/panes.xlsx")?;
102    Ok(())
103}
Source

fn set_row_height_pixels( &mut self, row: u32, height: f64, ) -> WorkSheetResult<()>

Source

fn set_row_height_with_format( &mut self, row: u32, height: f64, format: &Format, ) -> WorkSheetResult<()>

set the height and format of a row by row number, The effect is the same as

§Basic Example
use edit_xlsx::{Format, Row};
let mut row = Row::default();
row.height = Some(15.0);
let format = Format::default();
// worksheet.set_row_with_format(1, &row, &format);
Examples found in repository?
examples/outline_collapsed.rs (line 127)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    // Add a general format
7    let bold = Format::default().set_bold();
8
9    //
10    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()
11    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
15    worksheet1.set_row_level(2, 2)?;
16    worksheet1.set_row_level(3, 2)?;
17    worksheet1.set_row_level(4, 2)?;
18    worksheet1.set_row_level(5, 2)?;
19    worksheet1.set_row_level(6, 1)?;
20    worksheet1.set_row_level(7, 2)?;
21    worksheet1.set_row_level(8, 2)?;
22    worksheet1.set_row_level(9, 2)?;
23    worksheet1.set_row_level(10, 2)?;
24    worksheet1.set_row_level(11, 1)?;
25    create_sub_totals(worksheet1)?;
26
27    //
28    // Example 2: Create a worksheet with collapsed outlined rows.
29    // This is the same as the example 1  except that the all rows are collapsed.
30    // Note: We need to indicate the rows that contains the collapsed symbol '+'
31    // with the optional parameter, 'collapsed'.
32    //
33    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows 1")?;
34    worksheet2.set_row_level(2, 2)?;
35    worksheet2.hide_row(2)?;
36    worksheet2.set_row_level(3, 2)?;
37    worksheet2.hide_row(3)?;
38    worksheet2.set_row_level(4, 2)?;
39    worksheet2.hide_row(4)?;
40    worksheet2.set_row_level(5, 2)?;
41    worksheet2.hide_row(5)?;
42    worksheet2.set_row_level(6, 1)?;
43    worksheet2.hide_row(6)?;
44    worksheet2.set_row_level(7, 2)?;
45    worksheet2.hide_row(7)?;
46    worksheet2.set_row_level(8, 2)?;
47    worksheet2.hide_row(8)?;
48    worksheet2.set_row_level(9, 2)?;
49    worksheet2.hide_row(9)?;
50    worksheet2.set_row_level(10, 2)?;
51    worksheet2.hide_row(10)?;
52    worksheet2.set_row_level(11, 1)?;
53    worksheet2.hide_row(11)?;
54
55    worksheet2.collapse_row(12)?;
56
57    // Write the sub-total data that is common to the row examples.
58    create_sub_totals(worksheet2)?;
59
60
61    //
62    // Example 3: Create a worksheet with collapsed outlined rows.
63    // Same as the example 1  except that the two sub-totals are collapsed.
64    //
65    let worksheet3 = workbook.add_worksheet_by_name("Collapsed Rows 2")?;
66    worksheet3.set_row_level(2, 2)?;
67    worksheet3.hide_row(2)?;
68    worksheet3.set_row_level(3, 2)?;
69    worksheet3.hide_row(3)?;
70    worksheet3.set_row_level(4, 2)?;
71    worksheet3.hide_row(4)?;
72    worksheet3.set_row_level(5, 2)?;
73    worksheet3.hide_row(5)?;
74    worksheet3.set_row_level(6, 1)?;
75    worksheet3.collapse_row(6)?;
76    worksheet3.set_row_level(7, 2)?;
77    worksheet3.hide_row(7)?;
78    worksheet3.set_row_level(8, 2)?;
79    worksheet3.hide_row(8)?;
80    worksheet3.set_row_level(9, 2)?;
81    worksheet3.hide_row(9)?;
82    worksheet3.set_row_level(10, 2)?;
83    worksheet3.hide_row(10)?;
84    worksheet3.set_row_level(11, 1)?;
85    worksheet3.collapse_row(11)?;
86    // Write the sub-total data that is common to the row examples.
87    create_sub_totals(worksheet3)?;
88
89
90    //
91    // Example 4: Create a worksheet with outlined rows.
92    // Same as the example 1  except that the two sub-totals are collapsed.
93    //
94    let worksheet4 = workbook.add_worksheet_by_name("Collapsed Rows 3")?;
95    worksheet4.set_row_level(2, 2)?;
96    worksheet4.hide_row(2)?;
97    worksheet4.set_row_level(3, 2)?;
98    worksheet4.hide_row(3)?;
99    worksheet4.set_row_level(4, 2)?;
100    worksheet4.hide_row(4)?;
101    worksheet4.set_row_level(5, 2)?;
102    worksheet4.hide_row(5)?;
103    worksheet4.set_row_level(6, 1)?;
104    worksheet4.hide_row(6)?;
105    worksheet4.collapse_row(6)?;
106    worksheet4.set_row_level(7, 2)?;
107    worksheet4.hide_row(7)?;
108    worksheet4.set_row_level(8, 2)?;
109    worksheet4.hide_row(8)?;
110    worksheet4.set_row_level(9, 2)?;
111    worksheet4.hide_row(9)?;
112    worksheet4.set_row_level(10, 2)?;
113    worksheet4.hide_row(10)?;
114    worksheet4.set_row_level(11, 1)?;
115    worksheet4.hide_row(11)?;
116    worksheet4.collapse_row(11)?;
117    worksheet4.collapse_row(12)?;
118    // Write the sub-total data that is common to the row examples.
119    create_sub_totals(worksheet4)?;
120
121
122
123    //
124    // Example 5: Create a worksheet with outlined columns.
125    //
126    let worksheet5 = workbook.add_worksheet_by_name("Outline Columns")?;
127    worksheet5.set_row_height_with_format(1, 15.0, &bold)?;
128    worksheet5.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
129    worksheet5.set_columns_width_with_format("A:A", 10.0, &bold)?;
130    worksheet5.set_columns_width("B:G", 5.0)?;
131    worksheet5.set_columns_level("B:G", 1)?;
132    worksheet5.set_columns_width("H:H", 10.0)?;
133    worksheet5.write_column("A2", &["North", "South", "East", "East"])?;
134    worksheet5.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
135    worksheet5.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
136    worksheet5.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
137    worksheet5.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
138    worksheet5.write_formula("H2", "=SUM(B2:G2)")?;
139    worksheet5.write_formula("H3", "=SUM(B3:G3)")?;
140    worksheet5.write_formula("H4", "=SUM(B4:G4)")?;
141    worksheet5.write_formula("H5", "=SUM(B5:G5)")?;
142    worksheet5.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
143
144
145
146    //
147    // Example 6: Create a worksheet with collapsed outlined columns.
148    // This is the same as the previous example except with collapsed columns.
149    //
150    let worksheet6 = workbook.add_worksheet_by_name("Collapsed Columns")?;
151    worksheet6.set_row_height_with_format(1, 15.0, &bold)?;
152    worksheet6.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
153    worksheet6.set_columns_width_with_format("A:H", 10.0, &bold)?;
154    worksheet6.set_columns_level("B:G", 1)?;
155    worksheet6.set_columns_level("C:F", 2)?;
156    worksheet6.set_columns_level("D:E", 3)?;
157    worksheet6.hide_columns("D:E")?;
158    worksheet6.collapse_columns("D:E")?;
159    worksheet6.write_column("A2", &["North", "South", "East", "East"])?;
160    worksheet6.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
161    worksheet6.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
162    worksheet6.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
163    worksheet6.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
164    worksheet6.write_formula("H2", "=SUM(B2:G2)")?;
165    worksheet6.write_formula("H3", "=SUM(B3:G3)")?;
166    worksheet6.write_formula("H4", "=SUM(B4:G4)")?;
167    worksheet6.write_formula("H5", "=SUM(B5:G5)")?;
168    worksheet6.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
169
170
171    workbook.save_as("examples/outline_collapsed.xlsx")?;
172    Ok(())
173}
More examples
Hide additional examples
examples/outline.rs (line 126)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
7    // Add a general format
8    let bold = Format::default().set_bold();
9
10    //
11    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()?;    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    // For outlines the important parameters are 'level' and 'hidden'. Rows with
15    // the same 'level' are grouped together. The group will be collapsed if
16    // 'hidden' is enabled. The parameters 'height' and 'cell_format' are assigned
17    // default values if they are None.
18    //
19    worksheet1.set_row_level(2, 2)?;
20    worksheet1.set_row_level(3, 2)?;
21    worksheet1.set_row_level(4, 2)?;
22    worksheet1.set_row_level(5, 2)?;
23    worksheet1.set_row_level(6, 1)?;
24    worksheet1.set_row_level(7, 2)?;
25    worksheet1.set_row_level(8, 2)?;
26    worksheet1.set_row_level(9, 2)?;
27    worksheet1.set_row_level(10, 2)?;
28    worksheet1.set_row_level(11, 1)?;
29
30    // Adjust the column width for clarity
31    worksheet1.set_columns_width("A:A", 20.0)?;
32
33    // Add the data, labels and formulas
34    worksheet1.write_with_format("A1", "Region", &bold)?;
35    worksheet1.write("A2", "North")?;
36    worksheet1.write("A3", "North")?;
37    worksheet1.write("A4", "North")?;
38    worksheet1.write("A5", "North")?;
39    worksheet1.write_with_format("A6", "North Total", &bold)?;
40
41    worksheet1.write_with_format("B1", "Sales", &bold)?;
42    worksheet1.write("B2", 1000)?;
43    worksheet1.write("B3", 1200)?;
44    worksheet1.write("B4", 900)?;
45    worksheet1.write("B5", 1200)?;
46    worksheet1.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
47    worksheet1.write("A7", "South")?;
48    worksheet1.write("A8", "South")?;
49    worksheet1.write("A9", "South")?;
50    worksheet1.write("A10", "South")?;
51    worksheet1.write_with_format("A11", "South Total", &bold)?;
52    worksheet1.write("B7", 400)?;
53    worksheet1.write("B8", 600)?;
54    worksheet1.write("B9", 500)?;
55    worksheet1.write("B10", 600)?;
56    worksheet1.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
57    worksheet1.write_with_format("A12", "Grand Total", &bold)?;
58    worksheet1.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
59
60
61    //
62    // Example 2: A worksheet with outlined rows. This is the same as the
63    // previous example except that the rows are collapsed.
64    // Note: We need to indicate the rows that contains the collapsed symbol '+'
65    // with the optional parameter, 'collapsed'. The group will be then be
66    // collapsed if 'hidden' is True.
67    //
68    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows")?;
69    worksheet2.set_row_level(2, 2)?;
70    worksheet2.hide_row(2)?;
71    worksheet2.set_row_level(3, 2)?;
72    worksheet2.hide_row(3)?;
73    worksheet2.set_row_level(4, 2)?;
74    worksheet2.hide_row(4)?;
75    worksheet2.set_row_level(5, 2)?;
76    worksheet2.hide_row(5)?;
77    worksheet2.set_row_level(6, 1)?;
78    worksheet2.hide_row(6)?;
79    worksheet2.set_row_level(7, 2)?;
80    worksheet2.hide_row(7)?;
81    worksheet2.set_row_level(8, 2)?;
82    worksheet2.hide_row(8)?;
83    worksheet2.set_row_level(9, 2)?;
84    worksheet2.hide_row(9)?;
85    worksheet2.set_row_level(10, 2)?;
86    worksheet2.hide_row(10)?;
87    worksheet2.set_row_level(11, 1)?;
88    worksheet2.hide_row(11)?;
89    worksheet2.collapse_row(12)?;
90
91    // Adjust the column width for clarity
92    worksheet2.set_columns_width("A:A", 20.0)?;
93
94    // Add the data, labels and formulas
95    worksheet2.write_with_format("A1", "Region", &bold)?;
96    worksheet2.write("A2", "North")?;
97    worksheet2.write("A3", "North")?;
98    worksheet2.write("A4", "North")?;
99    worksheet2.write("A5", "North")?;
100    worksheet2.write_with_format("A6", "North Total", &bold)?;
101
102    worksheet2.write_with_format("B1", "Sales", &bold)?;
103    worksheet2.write("B2", 1000)?;
104    worksheet2.write("B3", 1200)?;
105    worksheet2.write("B4", 900)?;
106    worksheet2.write("B5", 1200)?;
107    worksheet2.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
108    worksheet2.write("A7", "South")?;
109    worksheet2.write("A8", "South")?;
110    worksheet2.write("A9", "South")?;
111    worksheet2.write("A10", "South")?;
112    worksheet2.write_with_format("A11", "South Total", &bold)?;
113    worksheet2.write("B7", 400)?;
114    worksheet2.write("B8", 600)?;
115    worksheet2.write("B9", 500)?;
116    worksheet2.write("B10", 600)?;
117    worksheet2.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
118    worksheet2.write_with_format("A12", "Grand Total", &bold)?;
119    worksheet2.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
120
121    //
122    // Example 3: Create a worksheet with outlined columns.
123    //
124    let worksheet3 = workbook.add_worksheet_by_name("Outline Columns")?;
125    // Add bold format to the first row.
126    worksheet3.set_row_height_with_format(1, 15.0, &bold)?;
127    worksheet3.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
128    worksheet3.set_columns_width_with_format("A:A", 10.0, &bold)?;
129    worksheet3.set_columns_width("B:G", 10.0)?;
130    worksheet3.set_columns_level("B:G", 1)?;
131    worksheet3.set_columns_width("H:H", 10.0)?;
132    worksheet3.write_column("A2", &["North", "South", "East", "East"])?;
133    worksheet3.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
134    worksheet3.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
135    worksheet3.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
136    worksheet3.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
137    worksheet3.write_formula("H2", "=SUM(B2:G2)")?;
138    worksheet3.write_formula("H3", "=SUM(B3:G3)")?;
139    worksheet3.write_formula("H4", "=SUM(B4:G4)")?;
140    worksheet3.write_formula("H5", "=SUM(B5:G5)")?;
141    worksheet3.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
142
143    //
144    // Example 4: Show all possible outline levels.
145    //
146    let levels = [
147        "Level 1",
148        "Level 2",
149        "Level 3",
150        "Level 4",
151        "Level 5",
152        "Level 6",
153        "Level 7",
154        "Level 6",
155        "Level 5",
156        "Level 4",
157        "Level 3",
158        "Level 2",
159        "Level 1",
160    ];
161    let worksheet4 = workbook.add_worksheet_by_name("Outline levels")?;
162    worksheet4.write_column("A1", &levels)?;
163
164    worksheet4.set_row_level(1, 1)?;
165    worksheet4.set_row_level(2, 2)?;
166    worksheet4.set_row_level(3, 3)?;
167    worksheet4.set_row_level(4, 4)?;
168    worksheet4.set_row_level(5, 5)?;
169    worksheet4.set_row_level(6, 6)?;
170    worksheet4.set_row_level(7, 7)?;
171    worksheet4.set_row_level(8, 6)?;
172    worksheet4.set_row_level(9, 5)?;
173    worksheet4.set_row_level(10, 4)?;
174    worksheet4.set_row_level(11, 3)?;
175    worksheet4.set_row_level(12, 2)?;
176    worksheet4.set_row_level(13, 1)?;
177
178    workbook.save_as("examples/outline.xlsx")?;
179    Ok(())
180}
examples/autofilter.rs (line 27)
4fn main() -> WorkbookResult<()> {
5    // Prepare autofilter data
6    let text = fs::read_to_string("examples/autofilter_data.txt").unwrap();
7    let mut text = text.split("\n");
8    let headers: Vec<&str> = text.next().unwrap().split_whitespace().collect();
9    let mut data: Vec<Vec<&str>> = vec![];
10    for text in text { data.push(text.split_whitespace().collect()) }
11
12    // Create a new workbook
13    let mut workbook = Workbook::new();
14    // Add some worksheets
15    workbook.add_worksheet()?;
16    workbook.add_worksheet()?;
17    workbook.add_worksheet()?;
18    workbook.add_worksheet()?;
19    workbook.add_worksheet()?;
20    workbook.add_worksheet()?;
21
22    // Set up several sheets with the same data.
23    for worksheet in workbook.worksheets_mut() {
24        // Make the columns wider.
25        worksheet.set_columns_width("A:D", 12.0)?;
26        // // Make the header row larger.
27        worksheet.set_row_height_with_format(1, 20.0, &Format::default().set_bold())?;
28        // Make the headers bold.
29        worksheet.write_row("A1", &headers)?;
30    }
31
32    //
33    // Example 1. Autofilter without conditions.
34    //
35
36    let worksheet1 = workbook.get_worksheet_mut(1)?;
37    // Set the autofilter.
38    worksheet1.autofilter("A1:D51");
39    let mut row = 2;
40    for row_data in &data {
41        let mut col = 1;
42        for data in row_data {
43            if let Ok(num) = data.parse::<i32>() {
44                worksheet1.write((row, col), num)?;
45            } else {
46                worksheet1.write((row, col), *data)?;
47            }
48            col += 1;
49        }
50        // Move on to the next worksheet row.
51        row += 1;
52    }
53
54
55    //
56    // Example 2. Autofilter with a filter condition in the first column.
57    //
58    let worksheet2 = workbook.get_worksheet_mut(2)?;
59    // Set the autofilter.
60    worksheet2.autofilter("A1:D51");
61    // Add filter criteria.
62    let mut filters = Filters::new();
63    filters.and(Filter::eq("East"));
64    worksheet2.filter_column("A", &filters);
65    // Hide the rows that don't match the filter criteria.
66    let mut row = 2;
67    for row_data in &data {
68        let mut col = 1;
69        let data = row_data.get(0);
70        // Check for rows that match the filter.
71        if data != Some(&"East") {
72            // We need to hide rows that don't match the filter.
73            worksheet2.hide_row(row)?;
74        }
75        for data in row_data {
76            if let Ok(num) = data.parse::<i32>() {
77                worksheet2.write((row, col), num)?;
78            } else {
79                worksheet2.write((row, col), *data)?;
80            }
81            col += 1;
82        }
83        // Move on to the next worksheet row.
84        row += 1;
85    }
86
87    //
88    // Example 3. Autofilter with a filter condition in the first column.
89    //
90    let worksheet3 = workbook.get_worksheet_mut(3)?;
91    // Set the autofilter.
92    worksheet3.autofilter("A1:D51");
93    // Add filter criteria.
94    let mut filters = Filters::new();
95    filters.and(Filter::eq("East")).or(Filter::eq("South"));
96    worksheet3.filter_column("A", &filters);
97    // Hide the rows that don't match the filter criteria.
98    let mut row = 2;
99    for row_data in &data {
100        let mut col = 1;
101        let data = row_data.get(0);
102        // Check for rows that match the filter.
103        if data != Some(&"East") && data != Some(&"South") {
104            // We need to hide rows that don't match the filter.
105            worksheet3.hide_row(row)?;
106        }
107        for data in row_data {
108            if let Ok(num) = data.parse::<i32>() {
109                worksheet3.write((row, col), num)?;
110            } else {
111                worksheet3.write((row, col), *data)?;
112            }
113            col += 1;
114        }
115        // Move on to the next worksheet row.
116        row += 1;
117    }
118
119
120    //
121    // Example 4. Autofilter with filter conditions in two columns.
122    //
123    let worksheet4 = workbook.get_worksheet_mut(4)?;
124    // Set the autofilter.
125    worksheet4.autofilter("A1:D51");
126    // Add filter criteria.
127    let mut filters_a = Filters::new();
128    filters_a.and(Filter::eq("East"));
129    worksheet4.filter_column("A", &filters_a);
130    let mut filters_c = Filters::new();
131    filters_c.and(Filter::gt("3000")).and(Filter::lt("8000"));
132    worksheet4.filter_column("C", &filters_c);
133    // Hide the rows that don't match the filter criteria.
134    let mut row = 2;
135    for row_data in &data {
136        let mut col = 1;
137        let data = row_data.get(0);
138        // Check for rows that match the filter.
139        if data != Some(&"East") {
140            // We need to hide rows that don't match the filter.
141            worksheet4.hide_row(row)?;
142        }
143        for data in row_data {
144            if let Ok(num) = data.parse::<i32>() {
145                if num <= 3000 || num >= 8000 {
146                    worksheet4.hide_row(row)?;
147                }
148                worksheet4.write((row, col), num)?;
149            } else {
150                worksheet4.write((row, col), *data)?;
151            }
152            col += 1;
153        }
154        // Move on to the next worksheet row.
155        row += 1;
156    }
157
158
159    //
160    // Example 5. Autofilter with a filter list condition in one of the columns.
161    //
162    let worksheet5 = workbook.get_worksheet_mut(5)?;
163    // Set the autofilter.
164    worksheet5.autofilter("A1:D51");
165    // Add filter criteria.
166    let filters_list = Filters::eq(vec!["East", "North", "South"]);
167    worksheet5.filter_column("A", &filters_list);
168    // Hide the rows that don't match the filter criteria.
169    let mut row = 2;
170    for row_data in &data {
171        let mut col = 1;
172        let data = row_data.get(0);
173        // Check for rows that match the filter.
174        if data != Some(&"East") && data != Some(&"North") && data != Some(&"South") {
175            // We need to hide rows that don't match the filter.
176            worksheet5.hide_row(row)?;
177        }
178        for data in row_data {
179            if let Ok(num) = data.parse::<i32>() {
180                worksheet5.write((row, col), num)?;
181            } else {
182                worksheet5.write((row, col), *data)?;
183            }
184            col += 1;
185        }
186        // Move on to the next worksheet row.
187        row += 1;
188    }
189
190    //
191    // Example 6. Autofilter with filter for blanks.
192    //
193    let worksheet6 = workbook.get_worksheet_mut(6)?;
194    // Set the autofilter.
195    worksheet6.autofilter("A1:D51");
196    // Add filter criteria.
197    let filters = Filters::blank();
198    worksheet6.filter_column("A", &filters);
199    // Hide the rows that don't match the filter criteria.
200    let mut row = 2;
201    // Simulate a blank cell in the data.
202    data[5][0] = "";
203
204    for row_data in &data {
205        let mut col = 1;
206        let data = row_data.get(0);
207        // Check for rows that match the filter.
208        if data != Some(&"") {
209            // We need to hide rows that don't match the filter.
210            worksheet6.hide_row(row)?;
211        }
212        for data in row_data {
213            if let Ok(num) = data.parse::<i32>() {
214                worksheet6.write((row, col), num)?;
215            } else {
216                worksheet6.write((row, col), *data)?;
217            }
218            col += 1;
219        }
220        // Move on to the next worksheet row.
221        row += 1;
222    }
223
224    //
225    // Example 7. Autofilter with filter for non-blanks.
226    //
227    let worksheet7 = workbook.get_worksheet_mut(7)?;
228    // Set the autofilter.
229    worksheet7.autofilter("A1:D51");
230    // Add filter criteria.
231    let filters = Filters::not_blank();
232    worksheet7.filter_column("A", &filters);
233    // Hide the rows that don't match the filter criteria.
234    let mut row = 2;
235    // Simulate a blank cell in the data.
236
237    for row_data in &data {
238        let mut col = 1;
239        let data = row_data.get(0);
240        // Check for rows that match the filter.
241        if data == Some(&"") {
242            // We need to hide rows that don't match the filter.
243            worksheet7.hide_row(row)?;
244        }
245        for data in row_data {
246            if let Ok(num) = data.parse::<i32>() {
247                worksheet7.write((row, col), num)?;
248            } else {
249                worksheet7.write((row, col), *data)?;
250            }
251            col += 1;
252        }
253        // Move on to the next worksheet row.
254        row += 1;
255    }
256
257
258    workbook.save_as("examples/autofilter.xlsx")?;
259
260    Ok(())
261}
Source

fn set_row_height_pixels_with_format( &mut self, row: u32, height: f64, format: &Format, ) -> WorkSheetResult<()>

Source

fn hide_row(&mut self, row: u32) -> WorkSheetResult<()>

hide a row by row number, The effect is the same as

§Basic Example
use edit_xlsx::Row;
let mut row = Row::default();
row.hidden = Some(1);
// worksheet.set_row(1, &row);
Examples found in repository?
examples/outline_collapsed.rs (line 35)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    // Add a general format
7    let bold = Format::default().set_bold();
8
9    //
10    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()
11    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
15    worksheet1.set_row_level(2, 2)?;
16    worksheet1.set_row_level(3, 2)?;
17    worksheet1.set_row_level(4, 2)?;
18    worksheet1.set_row_level(5, 2)?;
19    worksheet1.set_row_level(6, 1)?;
20    worksheet1.set_row_level(7, 2)?;
21    worksheet1.set_row_level(8, 2)?;
22    worksheet1.set_row_level(9, 2)?;
23    worksheet1.set_row_level(10, 2)?;
24    worksheet1.set_row_level(11, 1)?;
25    create_sub_totals(worksheet1)?;
26
27    //
28    // Example 2: Create a worksheet with collapsed outlined rows.
29    // This is the same as the example 1  except that the all rows are collapsed.
30    // Note: We need to indicate the rows that contains the collapsed symbol '+'
31    // with the optional parameter, 'collapsed'.
32    //
33    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows 1")?;
34    worksheet2.set_row_level(2, 2)?;
35    worksheet2.hide_row(2)?;
36    worksheet2.set_row_level(3, 2)?;
37    worksheet2.hide_row(3)?;
38    worksheet2.set_row_level(4, 2)?;
39    worksheet2.hide_row(4)?;
40    worksheet2.set_row_level(5, 2)?;
41    worksheet2.hide_row(5)?;
42    worksheet2.set_row_level(6, 1)?;
43    worksheet2.hide_row(6)?;
44    worksheet2.set_row_level(7, 2)?;
45    worksheet2.hide_row(7)?;
46    worksheet2.set_row_level(8, 2)?;
47    worksheet2.hide_row(8)?;
48    worksheet2.set_row_level(9, 2)?;
49    worksheet2.hide_row(9)?;
50    worksheet2.set_row_level(10, 2)?;
51    worksheet2.hide_row(10)?;
52    worksheet2.set_row_level(11, 1)?;
53    worksheet2.hide_row(11)?;
54
55    worksheet2.collapse_row(12)?;
56
57    // Write the sub-total data that is common to the row examples.
58    create_sub_totals(worksheet2)?;
59
60
61    //
62    // Example 3: Create a worksheet with collapsed outlined rows.
63    // Same as the example 1  except that the two sub-totals are collapsed.
64    //
65    let worksheet3 = workbook.add_worksheet_by_name("Collapsed Rows 2")?;
66    worksheet3.set_row_level(2, 2)?;
67    worksheet3.hide_row(2)?;
68    worksheet3.set_row_level(3, 2)?;
69    worksheet3.hide_row(3)?;
70    worksheet3.set_row_level(4, 2)?;
71    worksheet3.hide_row(4)?;
72    worksheet3.set_row_level(5, 2)?;
73    worksheet3.hide_row(5)?;
74    worksheet3.set_row_level(6, 1)?;
75    worksheet3.collapse_row(6)?;
76    worksheet3.set_row_level(7, 2)?;
77    worksheet3.hide_row(7)?;
78    worksheet3.set_row_level(8, 2)?;
79    worksheet3.hide_row(8)?;
80    worksheet3.set_row_level(9, 2)?;
81    worksheet3.hide_row(9)?;
82    worksheet3.set_row_level(10, 2)?;
83    worksheet3.hide_row(10)?;
84    worksheet3.set_row_level(11, 1)?;
85    worksheet3.collapse_row(11)?;
86    // Write the sub-total data that is common to the row examples.
87    create_sub_totals(worksheet3)?;
88
89
90    //
91    // Example 4: Create a worksheet with outlined rows.
92    // Same as the example 1  except that the two sub-totals are collapsed.
93    //
94    let worksheet4 = workbook.add_worksheet_by_name("Collapsed Rows 3")?;
95    worksheet4.set_row_level(2, 2)?;
96    worksheet4.hide_row(2)?;
97    worksheet4.set_row_level(3, 2)?;
98    worksheet4.hide_row(3)?;
99    worksheet4.set_row_level(4, 2)?;
100    worksheet4.hide_row(4)?;
101    worksheet4.set_row_level(5, 2)?;
102    worksheet4.hide_row(5)?;
103    worksheet4.set_row_level(6, 1)?;
104    worksheet4.hide_row(6)?;
105    worksheet4.collapse_row(6)?;
106    worksheet4.set_row_level(7, 2)?;
107    worksheet4.hide_row(7)?;
108    worksheet4.set_row_level(8, 2)?;
109    worksheet4.hide_row(8)?;
110    worksheet4.set_row_level(9, 2)?;
111    worksheet4.hide_row(9)?;
112    worksheet4.set_row_level(10, 2)?;
113    worksheet4.hide_row(10)?;
114    worksheet4.set_row_level(11, 1)?;
115    worksheet4.hide_row(11)?;
116    worksheet4.collapse_row(11)?;
117    worksheet4.collapse_row(12)?;
118    // Write the sub-total data that is common to the row examples.
119    create_sub_totals(worksheet4)?;
120
121
122
123    //
124    // Example 5: Create a worksheet with outlined columns.
125    //
126    let worksheet5 = workbook.add_worksheet_by_name("Outline Columns")?;
127    worksheet5.set_row_height_with_format(1, 15.0, &bold)?;
128    worksheet5.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
129    worksheet5.set_columns_width_with_format("A:A", 10.0, &bold)?;
130    worksheet5.set_columns_width("B:G", 5.0)?;
131    worksheet5.set_columns_level("B:G", 1)?;
132    worksheet5.set_columns_width("H:H", 10.0)?;
133    worksheet5.write_column("A2", &["North", "South", "East", "East"])?;
134    worksheet5.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
135    worksheet5.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
136    worksheet5.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
137    worksheet5.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
138    worksheet5.write_formula("H2", "=SUM(B2:G2)")?;
139    worksheet5.write_formula("H3", "=SUM(B3:G3)")?;
140    worksheet5.write_formula("H4", "=SUM(B4:G4)")?;
141    worksheet5.write_formula("H5", "=SUM(B5:G5)")?;
142    worksheet5.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
143
144
145
146    //
147    // Example 6: Create a worksheet with collapsed outlined columns.
148    // This is the same as the previous example except with collapsed columns.
149    //
150    let worksheet6 = workbook.add_worksheet_by_name("Collapsed Columns")?;
151    worksheet6.set_row_height_with_format(1, 15.0, &bold)?;
152    worksheet6.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
153    worksheet6.set_columns_width_with_format("A:H", 10.0, &bold)?;
154    worksheet6.set_columns_level("B:G", 1)?;
155    worksheet6.set_columns_level("C:F", 2)?;
156    worksheet6.set_columns_level("D:E", 3)?;
157    worksheet6.hide_columns("D:E")?;
158    worksheet6.collapse_columns("D:E")?;
159    worksheet6.write_column("A2", &["North", "South", "East", "East"])?;
160    worksheet6.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
161    worksheet6.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
162    worksheet6.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
163    worksheet6.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
164    worksheet6.write_formula("H2", "=SUM(B2:G2)")?;
165    worksheet6.write_formula("H3", "=SUM(B3:G3)")?;
166    worksheet6.write_formula("H4", "=SUM(B4:G4)")?;
167    worksheet6.write_formula("H5", "=SUM(B5:G5)")?;
168    worksheet6.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
169
170
171    workbook.save_as("examples/outline_collapsed.xlsx")?;
172    Ok(())
173}
More examples
Hide additional examples
examples/outline.rs (line 70)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
7    // Add a general format
8    let bold = Format::default().set_bold();
9
10    //
11    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()?;    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    // For outlines the important parameters are 'level' and 'hidden'. Rows with
15    // the same 'level' are grouped together. The group will be collapsed if
16    // 'hidden' is enabled. The parameters 'height' and 'cell_format' are assigned
17    // default values if they are None.
18    //
19    worksheet1.set_row_level(2, 2)?;
20    worksheet1.set_row_level(3, 2)?;
21    worksheet1.set_row_level(4, 2)?;
22    worksheet1.set_row_level(5, 2)?;
23    worksheet1.set_row_level(6, 1)?;
24    worksheet1.set_row_level(7, 2)?;
25    worksheet1.set_row_level(8, 2)?;
26    worksheet1.set_row_level(9, 2)?;
27    worksheet1.set_row_level(10, 2)?;
28    worksheet1.set_row_level(11, 1)?;
29
30    // Adjust the column width for clarity
31    worksheet1.set_columns_width("A:A", 20.0)?;
32
33    // Add the data, labels and formulas
34    worksheet1.write_with_format("A1", "Region", &bold)?;
35    worksheet1.write("A2", "North")?;
36    worksheet1.write("A3", "North")?;
37    worksheet1.write("A4", "North")?;
38    worksheet1.write("A5", "North")?;
39    worksheet1.write_with_format("A6", "North Total", &bold)?;
40
41    worksheet1.write_with_format("B1", "Sales", &bold)?;
42    worksheet1.write("B2", 1000)?;
43    worksheet1.write("B3", 1200)?;
44    worksheet1.write("B4", 900)?;
45    worksheet1.write("B5", 1200)?;
46    worksheet1.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
47    worksheet1.write("A7", "South")?;
48    worksheet1.write("A8", "South")?;
49    worksheet1.write("A9", "South")?;
50    worksheet1.write("A10", "South")?;
51    worksheet1.write_with_format("A11", "South Total", &bold)?;
52    worksheet1.write("B7", 400)?;
53    worksheet1.write("B8", 600)?;
54    worksheet1.write("B9", 500)?;
55    worksheet1.write("B10", 600)?;
56    worksheet1.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
57    worksheet1.write_with_format("A12", "Grand Total", &bold)?;
58    worksheet1.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
59
60
61    //
62    // Example 2: A worksheet with outlined rows. This is the same as the
63    // previous example except that the rows are collapsed.
64    // Note: We need to indicate the rows that contains the collapsed symbol '+'
65    // with the optional parameter, 'collapsed'. The group will be then be
66    // collapsed if 'hidden' is True.
67    //
68    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows")?;
69    worksheet2.set_row_level(2, 2)?;
70    worksheet2.hide_row(2)?;
71    worksheet2.set_row_level(3, 2)?;
72    worksheet2.hide_row(3)?;
73    worksheet2.set_row_level(4, 2)?;
74    worksheet2.hide_row(4)?;
75    worksheet2.set_row_level(5, 2)?;
76    worksheet2.hide_row(5)?;
77    worksheet2.set_row_level(6, 1)?;
78    worksheet2.hide_row(6)?;
79    worksheet2.set_row_level(7, 2)?;
80    worksheet2.hide_row(7)?;
81    worksheet2.set_row_level(8, 2)?;
82    worksheet2.hide_row(8)?;
83    worksheet2.set_row_level(9, 2)?;
84    worksheet2.hide_row(9)?;
85    worksheet2.set_row_level(10, 2)?;
86    worksheet2.hide_row(10)?;
87    worksheet2.set_row_level(11, 1)?;
88    worksheet2.hide_row(11)?;
89    worksheet2.collapse_row(12)?;
90
91    // Adjust the column width for clarity
92    worksheet2.set_columns_width("A:A", 20.0)?;
93
94    // Add the data, labels and formulas
95    worksheet2.write_with_format("A1", "Region", &bold)?;
96    worksheet2.write("A2", "North")?;
97    worksheet2.write("A3", "North")?;
98    worksheet2.write("A4", "North")?;
99    worksheet2.write("A5", "North")?;
100    worksheet2.write_with_format("A6", "North Total", &bold)?;
101
102    worksheet2.write_with_format("B1", "Sales", &bold)?;
103    worksheet2.write("B2", 1000)?;
104    worksheet2.write("B3", 1200)?;
105    worksheet2.write("B4", 900)?;
106    worksheet2.write("B5", 1200)?;
107    worksheet2.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
108    worksheet2.write("A7", "South")?;
109    worksheet2.write("A8", "South")?;
110    worksheet2.write("A9", "South")?;
111    worksheet2.write("A10", "South")?;
112    worksheet2.write_with_format("A11", "South Total", &bold)?;
113    worksheet2.write("B7", 400)?;
114    worksheet2.write("B8", 600)?;
115    worksheet2.write("B9", 500)?;
116    worksheet2.write("B10", 600)?;
117    worksheet2.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
118    worksheet2.write_with_format("A12", "Grand Total", &bold)?;
119    worksheet2.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
120
121    //
122    // Example 3: Create a worksheet with outlined columns.
123    //
124    let worksheet3 = workbook.add_worksheet_by_name("Outline Columns")?;
125    // Add bold format to the first row.
126    worksheet3.set_row_height_with_format(1, 15.0, &bold)?;
127    worksheet3.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
128    worksheet3.set_columns_width_with_format("A:A", 10.0, &bold)?;
129    worksheet3.set_columns_width("B:G", 10.0)?;
130    worksheet3.set_columns_level("B:G", 1)?;
131    worksheet3.set_columns_width("H:H", 10.0)?;
132    worksheet3.write_column("A2", &["North", "South", "East", "East"])?;
133    worksheet3.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
134    worksheet3.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
135    worksheet3.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
136    worksheet3.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
137    worksheet3.write_formula("H2", "=SUM(B2:G2)")?;
138    worksheet3.write_formula("H3", "=SUM(B3:G3)")?;
139    worksheet3.write_formula("H4", "=SUM(B4:G4)")?;
140    worksheet3.write_formula("H5", "=SUM(B5:G5)")?;
141    worksheet3.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
142
143    //
144    // Example 4: Show all possible outline levels.
145    //
146    let levels = [
147        "Level 1",
148        "Level 2",
149        "Level 3",
150        "Level 4",
151        "Level 5",
152        "Level 6",
153        "Level 7",
154        "Level 6",
155        "Level 5",
156        "Level 4",
157        "Level 3",
158        "Level 2",
159        "Level 1",
160    ];
161    let worksheet4 = workbook.add_worksheet_by_name("Outline levels")?;
162    worksheet4.write_column("A1", &levels)?;
163
164    worksheet4.set_row_level(1, 1)?;
165    worksheet4.set_row_level(2, 2)?;
166    worksheet4.set_row_level(3, 3)?;
167    worksheet4.set_row_level(4, 4)?;
168    worksheet4.set_row_level(5, 5)?;
169    worksheet4.set_row_level(6, 6)?;
170    worksheet4.set_row_level(7, 7)?;
171    worksheet4.set_row_level(8, 6)?;
172    worksheet4.set_row_level(9, 5)?;
173    worksheet4.set_row_level(10, 4)?;
174    worksheet4.set_row_level(11, 3)?;
175    worksheet4.set_row_level(12, 2)?;
176    worksheet4.set_row_level(13, 1)?;
177
178    workbook.save_as("examples/outline.xlsx")?;
179    Ok(())
180}
examples/autofilter.rs (line 73)
4fn main() -> WorkbookResult<()> {
5    // Prepare autofilter data
6    let text = fs::read_to_string("examples/autofilter_data.txt").unwrap();
7    let mut text = text.split("\n");
8    let headers: Vec<&str> = text.next().unwrap().split_whitespace().collect();
9    let mut data: Vec<Vec<&str>> = vec![];
10    for text in text { data.push(text.split_whitespace().collect()) }
11
12    // Create a new workbook
13    let mut workbook = Workbook::new();
14    // Add some worksheets
15    workbook.add_worksheet()?;
16    workbook.add_worksheet()?;
17    workbook.add_worksheet()?;
18    workbook.add_worksheet()?;
19    workbook.add_worksheet()?;
20    workbook.add_worksheet()?;
21
22    // Set up several sheets with the same data.
23    for worksheet in workbook.worksheets_mut() {
24        // Make the columns wider.
25        worksheet.set_columns_width("A:D", 12.0)?;
26        // // Make the header row larger.
27        worksheet.set_row_height_with_format(1, 20.0, &Format::default().set_bold())?;
28        // Make the headers bold.
29        worksheet.write_row("A1", &headers)?;
30    }
31
32    //
33    // Example 1. Autofilter without conditions.
34    //
35
36    let worksheet1 = workbook.get_worksheet_mut(1)?;
37    // Set the autofilter.
38    worksheet1.autofilter("A1:D51");
39    let mut row = 2;
40    for row_data in &data {
41        let mut col = 1;
42        for data in row_data {
43            if let Ok(num) = data.parse::<i32>() {
44                worksheet1.write((row, col), num)?;
45            } else {
46                worksheet1.write((row, col), *data)?;
47            }
48            col += 1;
49        }
50        // Move on to the next worksheet row.
51        row += 1;
52    }
53
54
55    //
56    // Example 2. Autofilter with a filter condition in the first column.
57    //
58    let worksheet2 = workbook.get_worksheet_mut(2)?;
59    // Set the autofilter.
60    worksheet2.autofilter("A1:D51");
61    // Add filter criteria.
62    let mut filters = Filters::new();
63    filters.and(Filter::eq("East"));
64    worksheet2.filter_column("A", &filters);
65    // Hide the rows that don't match the filter criteria.
66    let mut row = 2;
67    for row_data in &data {
68        let mut col = 1;
69        let data = row_data.get(0);
70        // Check for rows that match the filter.
71        if data != Some(&"East") {
72            // We need to hide rows that don't match the filter.
73            worksheet2.hide_row(row)?;
74        }
75        for data in row_data {
76            if let Ok(num) = data.parse::<i32>() {
77                worksheet2.write((row, col), num)?;
78            } else {
79                worksheet2.write((row, col), *data)?;
80            }
81            col += 1;
82        }
83        // Move on to the next worksheet row.
84        row += 1;
85    }
86
87    //
88    // Example 3. Autofilter with a filter condition in the first column.
89    //
90    let worksheet3 = workbook.get_worksheet_mut(3)?;
91    // Set the autofilter.
92    worksheet3.autofilter("A1:D51");
93    // Add filter criteria.
94    let mut filters = Filters::new();
95    filters.and(Filter::eq("East")).or(Filter::eq("South"));
96    worksheet3.filter_column("A", &filters);
97    // Hide the rows that don't match the filter criteria.
98    let mut row = 2;
99    for row_data in &data {
100        let mut col = 1;
101        let data = row_data.get(0);
102        // Check for rows that match the filter.
103        if data != Some(&"East") && data != Some(&"South") {
104            // We need to hide rows that don't match the filter.
105            worksheet3.hide_row(row)?;
106        }
107        for data in row_data {
108            if let Ok(num) = data.parse::<i32>() {
109                worksheet3.write((row, col), num)?;
110            } else {
111                worksheet3.write((row, col), *data)?;
112            }
113            col += 1;
114        }
115        // Move on to the next worksheet row.
116        row += 1;
117    }
118
119
120    //
121    // Example 4. Autofilter with filter conditions in two columns.
122    //
123    let worksheet4 = workbook.get_worksheet_mut(4)?;
124    // Set the autofilter.
125    worksheet4.autofilter("A1:D51");
126    // Add filter criteria.
127    let mut filters_a = Filters::new();
128    filters_a.and(Filter::eq("East"));
129    worksheet4.filter_column("A", &filters_a);
130    let mut filters_c = Filters::new();
131    filters_c.and(Filter::gt("3000")).and(Filter::lt("8000"));
132    worksheet4.filter_column("C", &filters_c);
133    // Hide the rows that don't match the filter criteria.
134    let mut row = 2;
135    for row_data in &data {
136        let mut col = 1;
137        let data = row_data.get(0);
138        // Check for rows that match the filter.
139        if data != Some(&"East") {
140            // We need to hide rows that don't match the filter.
141            worksheet4.hide_row(row)?;
142        }
143        for data in row_data {
144            if let Ok(num) = data.parse::<i32>() {
145                if num <= 3000 || num >= 8000 {
146                    worksheet4.hide_row(row)?;
147                }
148                worksheet4.write((row, col), num)?;
149            } else {
150                worksheet4.write((row, col), *data)?;
151            }
152            col += 1;
153        }
154        // Move on to the next worksheet row.
155        row += 1;
156    }
157
158
159    //
160    // Example 5. Autofilter with a filter list condition in one of the columns.
161    //
162    let worksheet5 = workbook.get_worksheet_mut(5)?;
163    // Set the autofilter.
164    worksheet5.autofilter("A1:D51");
165    // Add filter criteria.
166    let filters_list = Filters::eq(vec!["East", "North", "South"]);
167    worksheet5.filter_column("A", &filters_list);
168    // Hide the rows that don't match the filter criteria.
169    let mut row = 2;
170    for row_data in &data {
171        let mut col = 1;
172        let data = row_data.get(0);
173        // Check for rows that match the filter.
174        if data != Some(&"East") && data != Some(&"North") && data != Some(&"South") {
175            // We need to hide rows that don't match the filter.
176            worksheet5.hide_row(row)?;
177        }
178        for data in row_data {
179            if let Ok(num) = data.parse::<i32>() {
180                worksheet5.write((row, col), num)?;
181            } else {
182                worksheet5.write((row, col), *data)?;
183            }
184            col += 1;
185        }
186        // Move on to the next worksheet row.
187        row += 1;
188    }
189
190    //
191    // Example 6. Autofilter with filter for blanks.
192    //
193    let worksheet6 = workbook.get_worksheet_mut(6)?;
194    // Set the autofilter.
195    worksheet6.autofilter("A1:D51");
196    // Add filter criteria.
197    let filters = Filters::blank();
198    worksheet6.filter_column("A", &filters);
199    // Hide the rows that don't match the filter criteria.
200    let mut row = 2;
201    // Simulate a blank cell in the data.
202    data[5][0] = "";
203
204    for row_data in &data {
205        let mut col = 1;
206        let data = row_data.get(0);
207        // Check for rows that match the filter.
208        if data != Some(&"") {
209            // We need to hide rows that don't match the filter.
210            worksheet6.hide_row(row)?;
211        }
212        for data in row_data {
213            if let Ok(num) = data.parse::<i32>() {
214                worksheet6.write((row, col), num)?;
215            } else {
216                worksheet6.write((row, col), *data)?;
217            }
218            col += 1;
219        }
220        // Move on to the next worksheet row.
221        row += 1;
222    }
223
224    //
225    // Example 7. Autofilter with filter for non-blanks.
226    //
227    let worksheet7 = workbook.get_worksheet_mut(7)?;
228    // Set the autofilter.
229    worksheet7.autofilter("A1:D51");
230    // Add filter criteria.
231    let filters = Filters::not_blank();
232    worksheet7.filter_column("A", &filters);
233    // Hide the rows that don't match the filter criteria.
234    let mut row = 2;
235    // Simulate a blank cell in the data.
236
237    for row_data in &data {
238        let mut col = 1;
239        let data = row_data.get(0);
240        // Check for rows that match the filter.
241        if data == Some(&"") {
242            // We need to hide rows that don't match the filter.
243            worksheet7.hide_row(row)?;
244        }
245        for data in row_data {
246            if let Ok(num) = data.parse::<i32>() {
247                worksheet7.write((row, col), num)?;
248            } else {
249                worksheet7.write((row, col), *data)?;
250            }
251            col += 1;
252        }
253        // Move on to the next worksheet row.
254        row += 1;
255    }
256
257
258    workbook.save_as("examples/autofilter.xlsx")?;
259
260    Ok(())
261}
Source

fn set_row_level(&mut self, row: u32, level: u8) -> WorkSheetResult<()>

set the outline of a row by row number, The effect is the same as

§Basic Example
use edit_xlsx::Row;
let mut row = Row::default();
row.outline_level = Some(1);
// worksheet.set_row(1, &row);
Examples found in repository?
examples/outline_collapsed.rs (line 15)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    // Add a general format
7    let bold = Format::default().set_bold();
8
9    //
10    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()
11    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
15    worksheet1.set_row_level(2, 2)?;
16    worksheet1.set_row_level(3, 2)?;
17    worksheet1.set_row_level(4, 2)?;
18    worksheet1.set_row_level(5, 2)?;
19    worksheet1.set_row_level(6, 1)?;
20    worksheet1.set_row_level(7, 2)?;
21    worksheet1.set_row_level(8, 2)?;
22    worksheet1.set_row_level(9, 2)?;
23    worksheet1.set_row_level(10, 2)?;
24    worksheet1.set_row_level(11, 1)?;
25    create_sub_totals(worksheet1)?;
26
27    //
28    // Example 2: Create a worksheet with collapsed outlined rows.
29    // This is the same as the example 1  except that the all rows are collapsed.
30    // Note: We need to indicate the rows that contains the collapsed symbol '+'
31    // with the optional parameter, 'collapsed'.
32    //
33    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows 1")?;
34    worksheet2.set_row_level(2, 2)?;
35    worksheet2.hide_row(2)?;
36    worksheet2.set_row_level(3, 2)?;
37    worksheet2.hide_row(3)?;
38    worksheet2.set_row_level(4, 2)?;
39    worksheet2.hide_row(4)?;
40    worksheet2.set_row_level(5, 2)?;
41    worksheet2.hide_row(5)?;
42    worksheet2.set_row_level(6, 1)?;
43    worksheet2.hide_row(6)?;
44    worksheet2.set_row_level(7, 2)?;
45    worksheet2.hide_row(7)?;
46    worksheet2.set_row_level(8, 2)?;
47    worksheet2.hide_row(8)?;
48    worksheet2.set_row_level(9, 2)?;
49    worksheet2.hide_row(9)?;
50    worksheet2.set_row_level(10, 2)?;
51    worksheet2.hide_row(10)?;
52    worksheet2.set_row_level(11, 1)?;
53    worksheet2.hide_row(11)?;
54
55    worksheet2.collapse_row(12)?;
56
57    // Write the sub-total data that is common to the row examples.
58    create_sub_totals(worksheet2)?;
59
60
61    //
62    // Example 3: Create a worksheet with collapsed outlined rows.
63    // Same as the example 1  except that the two sub-totals are collapsed.
64    //
65    let worksheet3 = workbook.add_worksheet_by_name("Collapsed Rows 2")?;
66    worksheet3.set_row_level(2, 2)?;
67    worksheet3.hide_row(2)?;
68    worksheet3.set_row_level(3, 2)?;
69    worksheet3.hide_row(3)?;
70    worksheet3.set_row_level(4, 2)?;
71    worksheet3.hide_row(4)?;
72    worksheet3.set_row_level(5, 2)?;
73    worksheet3.hide_row(5)?;
74    worksheet3.set_row_level(6, 1)?;
75    worksheet3.collapse_row(6)?;
76    worksheet3.set_row_level(7, 2)?;
77    worksheet3.hide_row(7)?;
78    worksheet3.set_row_level(8, 2)?;
79    worksheet3.hide_row(8)?;
80    worksheet3.set_row_level(9, 2)?;
81    worksheet3.hide_row(9)?;
82    worksheet3.set_row_level(10, 2)?;
83    worksheet3.hide_row(10)?;
84    worksheet3.set_row_level(11, 1)?;
85    worksheet3.collapse_row(11)?;
86    // Write the sub-total data that is common to the row examples.
87    create_sub_totals(worksheet3)?;
88
89
90    //
91    // Example 4: Create a worksheet with outlined rows.
92    // Same as the example 1  except that the two sub-totals are collapsed.
93    //
94    let worksheet4 = workbook.add_worksheet_by_name("Collapsed Rows 3")?;
95    worksheet4.set_row_level(2, 2)?;
96    worksheet4.hide_row(2)?;
97    worksheet4.set_row_level(3, 2)?;
98    worksheet4.hide_row(3)?;
99    worksheet4.set_row_level(4, 2)?;
100    worksheet4.hide_row(4)?;
101    worksheet4.set_row_level(5, 2)?;
102    worksheet4.hide_row(5)?;
103    worksheet4.set_row_level(6, 1)?;
104    worksheet4.hide_row(6)?;
105    worksheet4.collapse_row(6)?;
106    worksheet4.set_row_level(7, 2)?;
107    worksheet4.hide_row(7)?;
108    worksheet4.set_row_level(8, 2)?;
109    worksheet4.hide_row(8)?;
110    worksheet4.set_row_level(9, 2)?;
111    worksheet4.hide_row(9)?;
112    worksheet4.set_row_level(10, 2)?;
113    worksheet4.hide_row(10)?;
114    worksheet4.set_row_level(11, 1)?;
115    worksheet4.hide_row(11)?;
116    worksheet4.collapse_row(11)?;
117    worksheet4.collapse_row(12)?;
118    // Write the sub-total data that is common to the row examples.
119    create_sub_totals(worksheet4)?;
120
121
122
123    //
124    // Example 5: Create a worksheet with outlined columns.
125    //
126    let worksheet5 = workbook.add_worksheet_by_name("Outline Columns")?;
127    worksheet5.set_row_height_with_format(1, 15.0, &bold)?;
128    worksheet5.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
129    worksheet5.set_columns_width_with_format("A:A", 10.0, &bold)?;
130    worksheet5.set_columns_width("B:G", 5.0)?;
131    worksheet5.set_columns_level("B:G", 1)?;
132    worksheet5.set_columns_width("H:H", 10.0)?;
133    worksheet5.write_column("A2", &["North", "South", "East", "East"])?;
134    worksheet5.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
135    worksheet5.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
136    worksheet5.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
137    worksheet5.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
138    worksheet5.write_formula("H2", "=SUM(B2:G2)")?;
139    worksheet5.write_formula("H3", "=SUM(B3:G3)")?;
140    worksheet5.write_formula("H4", "=SUM(B4:G4)")?;
141    worksheet5.write_formula("H5", "=SUM(B5:G5)")?;
142    worksheet5.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
143
144
145
146    //
147    // Example 6: Create a worksheet with collapsed outlined columns.
148    // This is the same as the previous example except with collapsed columns.
149    //
150    let worksheet6 = workbook.add_worksheet_by_name("Collapsed Columns")?;
151    worksheet6.set_row_height_with_format(1, 15.0, &bold)?;
152    worksheet6.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
153    worksheet6.set_columns_width_with_format("A:H", 10.0, &bold)?;
154    worksheet6.set_columns_level("B:G", 1)?;
155    worksheet6.set_columns_level("C:F", 2)?;
156    worksheet6.set_columns_level("D:E", 3)?;
157    worksheet6.hide_columns("D:E")?;
158    worksheet6.collapse_columns("D:E")?;
159    worksheet6.write_column("A2", &["North", "South", "East", "East"])?;
160    worksheet6.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
161    worksheet6.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
162    worksheet6.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
163    worksheet6.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
164    worksheet6.write_formula("H2", "=SUM(B2:G2)")?;
165    worksheet6.write_formula("H3", "=SUM(B3:G3)")?;
166    worksheet6.write_formula("H4", "=SUM(B4:G4)")?;
167    worksheet6.write_formula("H5", "=SUM(B5:G5)")?;
168    worksheet6.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
169
170
171    workbook.save_as("examples/outline_collapsed.xlsx")?;
172    Ok(())
173}
More examples
Hide additional examples
examples/outline.rs (line 19)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
7    // Add a general format
8    let bold = Format::default().set_bold();
9
10    //
11    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()?;    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    // For outlines the important parameters are 'level' and 'hidden'. Rows with
15    // the same 'level' are grouped together. The group will be collapsed if
16    // 'hidden' is enabled. The parameters 'height' and 'cell_format' are assigned
17    // default values if they are None.
18    //
19    worksheet1.set_row_level(2, 2)?;
20    worksheet1.set_row_level(3, 2)?;
21    worksheet1.set_row_level(4, 2)?;
22    worksheet1.set_row_level(5, 2)?;
23    worksheet1.set_row_level(6, 1)?;
24    worksheet1.set_row_level(7, 2)?;
25    worksheet1.set_row_level(8, 2)?;
26    worksheet1.set_row_level(9, 2)?;
27    worksheet1.set_row_level(10, 2)?;
28    worksheet1.set_row_level(11, 1)?;
29
30    // Adjust the column width for clarity
31    worksheet1.set_columns_width("A:A", 20.0)?;
32
33    // Add the data, labels and formulas
34    worksheet1.write_with_format("A1", "Region", &bold)?;
35    worksheet1.write("A2", "North")?;
36    worksheet1.write("A3", "North")?;
37    worksheet1.write("A4", "North")?;
38    worksheet1.write("A5", "North")?;
39    worksheet1.write_with_format("A6", "North Total", &bold)?;
40
41    worksheet1.write_with_format("B1", "Sales", &bold)?;
42    worksheet1.write("B2", 1000)?;
43    worksheet1.write("B3", 1200)?;
44    worksheet1.write("B4", 900)?;
45    worksheet1.write("B5", 1200)?;
46    worksheet1.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
47    worksheet1.write("A7", "South")?;
48    worksheet1.write("A8", "South")?;
49    worksheet1.write("A9", "South")?;
50    worksheet1.write("A10", "South")?;
51    worksheet1.write_with_format("A11", "South Total", &bold)?;
52    worksheet1.write("B7", 400)?;
53    worksheet1.write("B8", 600)?;
54    worksheet1.write("B9", 500)?;
55    worksheet1.write("B10", 600)?;
56    worksheet1.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
57    worksheet1.write_with_format("A12", "Grand Total", &bold)?;
58    worksheet1.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
59
60
61    //
62    // Example 2: A worksheet with outlined rows. This is the same as the
63    // previous example except that the rows are collapsed.
64    // Note: We need to indicate the rows that contains the collapsed symbol '+'
65    // with the optional parameter, 'collapsed'. The group will be then be
66    // collapsed if 'hidden' is True.
67    //
68    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows")?;
69    worksheet2.set_row_level(2, 2)?;
70    worksheet2.hide_row(2)?;
71    worksheet2.set_row_level(3, 2)?;
72    worksheet2.hide_row(3)?;
73    worksheet2.set_row_level(4, 2)?;
74    worksheet2.hide_row(4)?;
75    worksheet2.set_row_level(5, 2)?;
76    worksheet2.hide_row(5)?;
77    worksheet2.set_row_level(6, 1)?;
78    worksheet2.hide_row(6)?;
79    worksheet2.set_row_level(7, 2)?;
80    worksheet2.hide_row(7)?;
81    worksheet2.set_row_level(8, 2)?;
82    worksheet2.hide_row(8)?;
83    worksheet2.set_row_level(9, 2)?;
84    worksheet2.hide_row(9)?;
85    worksheet2.set_row_level(10, 2)?;
86    worksheet2.hide_row(10)?;
87    worksheet2.set_row_level(11, 1)?;
88    worksheet2.hide_row(11)?;
89    worksheet2.collapse_row(12)?;
90
91    // Adjust the column width for clarity
92    worksheet2.set_columns_width("A:A", 20.0)?;
93
94    // Add the data, labels and formulas
95    worksheet2.write_with_format("A1", "Region", &bold)?;
96    worksheet2.write("A2", "North")?;
97    worksheet2.write("A3", "North")?;
98    worksheet2.write("A4", "North")?;
99    worksheet2.write("A5", "North")?;
100    worksheet2.write_with_format("A6", "North Total", &bold)?;
101
102    worksheet2.write_with_format("B1", "Sales", &bold)?;
103    worksheet2.write("B2", 1000)?;
104    worksheet2.write("B3", 1200)?;
105    worksheet2.write("B4", 900)?;
106    worksheet2.write("B5", 1200)?;
107    worksheet2.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
108    worksheet2.write("A7", "South")?;
109    worksheet2.write("A8", "South")?;
110    worksheet2.write("A9", "South")?;
111    worksheet2.write("A10", "South")?;
112    worksheet2.write_with_format("A11", "South Total", &bold)?;
113    worksheet2.write("B7", 400)?;
114    worksheet2.write("B8", 600)?;
115    worksheet2.write("B9", 500)?;
116    worksheet2.write("B10", 600)?;
117    worksheet2.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
118    worksheet2.write_with_format("A12", "Grand Total", &bold)?;
119    worksheet2.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
120
121    //
122    // Example 3: Create a worksheet with outlined columns.
123    //
124    let worksheet3 = workbook.add_worksheet_by_name("Outline Columns")?;
125    // Add bold format to the first row.
126    worksheet3.set_row_height_with_format(1, 15.0, &bold)?;
127    worksheet3.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
128    worksheet3.set_columns_width_with_format("A:A", 10.0, &bold)?;
129    worksheet3.set_columns_width("B:G", 10.0)?;
130    worksheet3.set_columns_level("B:G", 1)?;
131    worksheet3.set_columns_width("H:H", 10.0)?;
132    worksheet3.write_column("A2", &["North", "South", "East", "East"])?;
133    worksheet3.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
134    worksheet3.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
135    worksheet3.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
136    worksheet3.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
137    worksheet3.write_formula("H2", "=SUM(B2:G2)")?;
138    worksheet3.write_formula("H3", "=SUM(B3:G3)")?;
139    worksheet3.write_formula("H4", "=SUM(B4:G4)")?;
140    worksheet3.write_formula("H5", "=SUM(B5:G5)")?;
141    worksheet3.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
142
143    //
144    // Example 4: Show all possible outline levels.
145    //
146    let levels = [
147        "Level 1",
148        "Level 2",
149        "Level 3",
150        "Level 4",
151        "Level 5",
152        "Level 6",
153        "Level 7",
154        "Level 6",
155        "Level 5",
156        "Level 4",
157        "Level 3",
158        "Level 2",
159        "Level 1",
160    ];
161    let worksheet4 = workbook.add_worksheet_by_name("Outline levels")?;
162    worksheet4.write_column("A1", &levels)?;
163
164    worksheet4.set_row_level(1, 1)?;
165    worksheet4.set_row_level(2, 2)?;
166    worksheet4.set_row_level(3, 3)?;
167    worksheet4.set_row_level(4, 4)?;
168    worksheet4.set_row_level(5, 5)?;
169    worksheet4.set_row_level(6, 6)?;
170    worksheet4.set_row_level(7, 7)?;
171    worksheet4.set_row_level(8, 6)?;
172    worksheet4.set_row_level(9, 5)?;
173    worksheet4.set_row_level(10, 4)?;
174    worksheet4.set_row_level(11, 3)?;
175    worksheet4.set_row_level(12, 2)?;
176    worksheet4.set_row_level(13, 1)?;
177
178    workbook.save_as("examples/outline.xlsx")?;
179    Ok(())
180}
Source

fn collapse_row(&mut self, row: u32) -> WorkSheetResult<()>

collapse a row by row number, The effect is the same as

§Basic Example
use edit_xlsx::Row;
let mut row = Row::default();
row.collapsed = Some(1);
// worksheet.set_row(1, &row);
Examples found in repository?
examples/outline_collapsed.rs (line 55)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    // Add a general format
7    let bold = Format::default().set_bold();
8
9    //
10    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()
11    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
15    worksheet1.set_row_level(2, 2)?;
16    worksheet1.set_row_level(3, 2)?;
17    worksheet1.set_row_level(4, 2)?;
18    worksheet1.set_row_level(5, 2)?;
19    worksheet1.set_row_level(6, 1)?;
20    worksheet1.set_row_level(7, 2)?;
21    worksheet1.set_row_level(8, 2)?;
22    worksheet1.set_row_level(9, 2)?;
23    worksheet1.set_row_level(10, 2)?;
24    worksheet1.set_row_level(11, 1)?;
25    create_sub_totals(worksheet1)?;
26
27    //
28    // Example 2: Create a worksheet with collapsed outlined rows.
29    // This is the same as the example 1  except that the all rows are collapsed.
30    // Note: We need to indicate the rows that contains the collapsed symbol '+'
31    // with the optional parameter, 'collapsed'.
32    //
33    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows 1")?;
34    worksheet2.set_row_level(2, 2)?;
35    worksheet2.hide_row(2)?;
36    worksheet2.set_row_level(3, 2)?;
37    worksheet2.hide_row(3)?;
38    worksheet2.set_row_level(4, 2)?;
39    worksheet2.hide_row(4)?;
40    worksheet2.set_row_level(5, 2)?;
41    worksheet2.hide_row(5)?;
42    worksheet2.set_row_level(6, 1)?;
43    worksheet2.hide_row(6)?;
44    worksheet2.set_row_level(7, 2)?;
45    worksheet2.hide_row(7)?;
46    worksheet2.set_row_level(8, 2)?;
47    worksheet2.hide_row(8)?;
48    worksheet2.set_row_level(9, 2)?;
49    worksheet2.hide_row(9)?;
50    worksheet2.set_row_level(10, 2)?;
51    worksheet2.hide_row(10)?;
52    worksheet2.set_row_level(11, 1)?;
53    worksheet2.hide_row(11)?;
54
55    worksheet2.collapse_row(12)?;
56
57    // Write the sub-total data that is common to the row examples.
58    create_sub_totals(worksheet2)?;
59
60
61    //
62    // Example 3: Create a worksheet with collapsed outlined rows.
63    // Same as the example 1  except that the two sub-totals are collapsed.
64    //
65    let worksheet3 = workbook.add_worksheet_by_name("Collapsed Rows 2")?;
66    worksheet3.set_row_level(2, 2)?;
67    worksheet3.hide_row(2)?;
68    worksheet3.set_row_level(3, 2)?;
69    worksheet3.hide_row(3)?;
70    worksheet3.set_row_level(4, 2)?;
71    worksheet3.hide_row(4)?;
72    worksheet3.set_row_level(5, 2)?;
73    worksheet3.hide_row(5)?;
74    worksheet3.set_row_level(6, 1)?;
75    worksheet3.collapse_row(6)?;
76    worksheet3.set_row_level(7, 2)?;
77    worksheet3.hide_row(7)?;
78    worksheet3.set_row_level(8, 2)?;
79    worksheet3.hide_row(8)?;
80    worksheet3.set_row_level(9, 2)?;
81    worksheet3.hide_row(9)?;
82    worksheet3.set_row_level(10, 2)?;
83    worksheet3.hide_row(10)?;
84    worksheet3.set_row_level(11, 1)?;
85    worksheet3.collapse_row(11)?;
86    // Write the sub-total data that is common to the row examples.
87    create_sub_totals(worksheet3)?;
88
89
90    //
91    // Example 4: Create a worksheet with outlined rows.
92    // Same as the example 1  except that the two sub-totals are collapsed.
93    //
94    let worksheet4 = workbook.add_worksheet_by_name("Collapsed Rows 3")?;
95    worksheet4.set_row_level(2, 2)?;
96    worksheet4.hide_row(2)?;
97    worksheet4.set_row_level(3, 2)?;
98    worksheet4.hide_row(3)?;
99    worksheet4.set_row_level(4, 2)?;
100    worksheet4.hide_row(4)?;
101    worksheet4.set_row_level(5, 2)?;
102    worksheet4.hide_row(5)?;
103    worksheet4.set_row_level(6, 1)?;
104    worksheet4.hide_row(6)?;
105    worksheet4.collapse_row(6)?;
106    worksheet4.set_row_level(7, 2)?;
107    worksheet4.hide_row(7)?;
108    worksheet4.set_row_level(8, 2)?;
109    worksheet4.hide_row(8)?;
110    worksheet4.set_row_level(9, 2)?;
111    worksheet4.hide_row(9)?;
112    worksheet4.set_row_level(10, 2)?;
113    worksheet4.hide_row(10)?;
114    worksheet4.set_row_level(11, 1)?;
115    worksheet4.hide_row(11)?;
116    worksheet4.collapse_row(11)?;
117    worksheet4.collapse_row(12)?;
118    // Write the sub-total data that is common to the row examples.
119    create_sub_totals(worksheet4)?;
120
121
122
123    //
124    // Example 5: Create a worksheet with outlined columns.
125    //
126    let worksheet5 = workbook.add_worksheet_by_name("Outline Columns")?;
127    worksheet5.set_row_height_with_format(1, 15.0, &bold)?;
128    worksheet5.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
129    worksheet5.set_columns_width_with_format("A:A", 10.0, &bold)?;
130    worksheet5.set_columns_width("B:G", 5.0)?;
131    worksheet5.set_columns_level("B:G", 1)?;
132    worksheet5.set_columns_width("H:H", 10.0)?;
133    worksheet5.write_column("A2", &["North", "South", "East", "East"])?;
134    worksheet5.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
135    worksheet5.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
136    worksheet5.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
137    worksheet5.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
138    worksheet5.write_formula("H2", "=SUM(B2:G2)")?;
139    worksheet5.write_formula("H3", "=SUM(B3:G3)")?;
140    worksheet5.write_formula("H4", "=SUM(B4:G4)")?;
141    worksheet5.write_formula("H5", "=SUM(B5:G5)")?;
142    worksheet5.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
143
144
145
146    //
147    // Example 6: Create a worksheet with collapsed outlined columns.
148    // This is the same as the previous example except with collapsed columns.
149    //
150    let worksheet6 = workbook.add_worksheet_by_name("Collapsed Columns")?;
151    worksheet6.set_row_height_with_format(1, 15.0, &bold)?;
152    worksheet6.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
153    worksheet6.set_columns_width_with_format("A:H", 10.0, &bold)?;
154    worksheet6.set_columns_level("B:G", 1)?;
155    worksheet6.set_columns_level("C:F", 2)?;
156    worksheet6.set_columns_level("D:E", 3)?;
157    worksheet6.hide_columns("D:E")?;
158    worksheet6.collapse_columns("D:E")?;
159    worksheet6.write_column("A2", &["North", "South", "East", "East"])?;
160    worksheet6.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
161    worksheet6.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
162    worksheet6.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
163    worksheet6.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
164    worksheet6.write_formula("H2", "=SUM(B2:G2)")?;
165    worksheet6.write_formula("H3", "=SUM(B3:G3)")?;
166    worksheet6.write_formula("H4", "=SUM(B4:G4)")?;
167    worksheet6.write_formula("H5", "=SUM(B5:G5)")?;
168    worksheet6.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
169
170
171    workbook.save_as("examples/outline_collapsed.xlsx")?;
172    Ok(())
173}
More examples
Hide additional examples
examples/outline.rs (line 89)
3fn main() -> WorkbookResult<()> {
4    // Create a new workbook
5    let mut workbook = Workbook::new();
6    let worksheet1 = workbook.add_worksheet_by_name("Outlined Rows")?;
7    // Add a general format
8    let bold = Format::default().set_bold();
9
10    //
11    // Example 1: A worksheet with outlined rows. It also includes SUBTOTAL()?;    // functions so that it looks like the type of automatic outlines that are
12    // generated when you use the Excel Data->SubTotals menu item.
13    //
14    // For outlines the important parameters are 'level' and 'hidden'. Rows with
15    // the same 'level' are grouped together. The group will be collapsed if
16    // 'hidden' is enabled. The parameters 'height' and 'cell_format' are assigned
17    // default values if they are None.
18    //
19    worksheet1.set_row_level(2, 2)?;
20    worksheet1.set_row_level(3, 2)?;
21    worksheet1.set_row_level(4, 2)?;
22    worksheet1.set_row_level(5, 2)?;
23    worksheet1.set_row_level(6, 1)?;
24    worksheet1.set_row_level(7, 2)?;
25    worksheet1.set_row_level(8, 2)?;
26    worksheet1.set_row_level(9, 2)?;
27    worksheet1.set_row_level(10, 2)?;
28    worksheet1.set_row_level(11, 1)?;
29
30    // Adjust the column width for clarity
31    worksheet1.set_columns_width("A:A", 20.0)?;
32
33    // Add the data, labels and formulas
34    worksheet1.write_with_format("A1", "Region", &bold)?;
35    worksheet1.write("A2", "North")?;
36    worksheet1.write("A3", "North")?;
37    worksheet1.write("A4", "North")?;
38    worksheet1.write("A5", "North")?;
39    worksheet1.write_with_format("A6", "North Total", &bold)?;
40
41    worksheet1.write_with_format("B1", "Sales", &bold)?;
42    worksheet1.write("B2", 1000)?;
43    worksheet1.write("B3", 1200)?;
44    worksheet1.write("B4", 900)?;
45    worksheet1.write("B5", 1200)?;
46    worksheet1.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
47    worksheet1.write("A7", "South")?;
48    worksheet1.write("A8", "South")?;
49    worksheet1.write("A9", "South")?;
50    worksheet1.write("A10", "South")?;
51    worksheet1.write_with_format("A11", "South Total", &bold)?;
52    worksheet1.write("B7", 400)?;
53    worksheet1.write("B8", 600)?;
54    worksheet1.write("B9", 500)?;
55    worksheet1.write("B10", 600)?;
56    worksheet1.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
57    worksheet1.write_with_format("A12", "Grand Total", &bold)?;
58    worksheet1.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
59
60
61    //
62    // Example 2: A worksheet with outlined rows. This is the same as the
63    // previous example except that the rows are collapsed.
64    // Note: We need to indicate the rows that contains the collapsed symbol '+'
65    // with the optional parameter, 'collapsed'. The group will be then be
66    // collapsed if 'hidden' is True.
67    //
68    let worksheet2 = workbook.add_worksheet_by_name("Collapsed Rows")?;
69    worksheet2.set_row_level(2, 2)?;
70    worksheet2.hide_row(2)?;
71    worksheet2.set_row_level(3, 2)?;
72    worksheet2.hide_row(3)?;
73    worksheet2.set_row_level(4, 2)?;
74    worksheet2.hide_row(4)?;
75    worksheet2.set_row_level(5, 2)?;
76    worksheet2.hide_row(5)?;
77    worksheet2.set_row_level(6, 1)?;
78    worksheet2.hide_row(6)?;
79    worksheet2.set_row_level(7, 2)?;
80    worksheet2.hide_row(7)?;
81    worksheet2.set_row_level(8, 2)?;
82    worksheet2.hide_row(8)?;
83    worksheet2.set_row_level(9, 2)?;
84    worksheet2.hide_row(9)?;
85    worksheet2.set_row_level(10, 2)?;
86    worksheet2.hide_row(10)?;
87    worksheet2.set_row_level(11, 1)?;
88    worksheet2.hide_row(11)?;
89    worksheet2.collapse_row(12)?;
90
91    // Adjust the column width for clarity
92    worksheet2.set_columns_width("A:A", 20.0)?;
93
94    // Add the data, labels and formulas
95    worksheet2.write_with_format("A1", "Region", &bold)?;
96    worksheet2.write("A2", "North")?;
97    worksheet2.write("A3", "North")?;
98    worksheet2.write("A4", "North")?;
99    worksheet2.write("A5", "North")?;
100    worksheet2.write_with_format("A6", "North Total", &bold)?;
101
102    worksheet2.write_with_format("B1", "Sales", &bold)?;
103    worksheet2.write("B2", 1000)?;
104    worksheet2.write("B3", 1200)?;
105    worksheet2.write("B4", 900)?;
106    worksheet2.write("B5", 1200)?;
107    worksheet2.write_formula_with_format("B6", "=SUBTOTAL(9,B2:B5)", &bold)?;
108    worksheet2.write("A7", "South")?;
109    worksheet2.write("A8", "South")?;
110    worksheet2.write("A9", "South")?;
111    worksheet2.write("A10", "South")?;
112    worksheet2.write_with_format("A11", "South Total", &bold)?;
113    worksheet2.write("B7", 400)?;
114    worksheet2.write("B8", 600)?;
115    worksheet2.write("B9", 500)?;
116    worksheet2.write("B10", 600)?;
117    worksheet2.write_formula_with_format("B11", "=SUBTOTAL(9,B7:B10)", &bold)?;
118    worksheet2.write_with_format("A12", "Grand Total", &bold)?;
119    worksheet2.write_formula_with_format("B12", "=SUBTOTAL(9,B2:B10)", &bold)?;
120
121    //
122    // Example 3: Create a worksheet with outlined columns.
123    //
124    let worksheet3 = workbook.add_worksheet_by_name("Outline Columns")?;
125    // Add bold format to the first row.
126    worksheet3.set_row_height_with_format(1, 15.0, &bold)?;
127    worksheet3.write_row("A1", &["Month", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Total"])?;
128    worksheet3.set_columns_width_with_format("A:A", 10.0, &bold)?;
129    worksheet3.set_columns_width("B:G", 10.0)?;
130    worksheet3.set_columns_level("B:G", 1)?;
131    worksheet3.set_columns_width("H:H", 10.0)?;
132    worksheet3.write_column("A2", &["North", "South", "East", "East"])?;
133    worksheet3.write_row("B2", &[50, 20, 15, 25, 65, 80])?;
134    worksheet3.write_row("B3", &[10, 20, 30, 50, 50, 50])?;
135    worksheet3.write_row("B4", &[45, 75, 50, 15, 75, 100])?;
136    worksheet3.write_row("B5", &[15, 15, 55, 35, 20, 50])?;
137    worksheet3.write_formula("H2", "=SUM(B2:G2)")?;
138    worksheet3.write_formula("H3", "=SUM(B3:G3)")?;
139    worksheet3.write_formula("H4", "=SUM(B4:G4)")?;
140    worksheet3.write_formula("H5", "=SUM(B5:G5)")?;
141    worksheet3.write_formula_with_format("H6", "=SUM(H2:H5)", &bold)?;
142
143    //
144    // Example 4: Show all possible outline levels.
145    //
146    let levels = [
147        "Level 1",
148        "Level 2",
149        "Level 3",
150        "Level 4",
151        "Level 5",
152        "Level 6",
153        "Level 7",
154        "Level 6",
155        "Level 5",
156        "Level 4",
157        "Level 3",
158        "Level 2",
159        "Level 1",
160    ];
161    let worksheet4 = workbook.add_worksheet_by_name("Outline levels")?;
162    worksheet4.write_column("A1", &levels)?;
163
164    worksheet4.set_row_level(1, 1)?;
165    worksheet4.set_row_level(2, 2)?;
166    worksheet4.set_row_level(3, 3)?;
167    worksheet4.set_row_level(4, 4)?;
168    worksheet4.set_row_level(5, 5)?;
169    worksheet4.set_row_level(6, 6)?;
170    worksheet4.set_row_level(7, 7)?;
171    worksheet4.set_row_level(8, 6)?;
172    worksheet4.set_row_level(9, 5)?;
173    worksheet4.set_row_level(10, 4)?;
174    worksheet4.set_row_level(11, 3)?;
175    worksheet4.set_row_level(12, 2)?;
176    worksheet4.set_row_level(13, 1)?;
177
178    workbook.save_as("examples/outline.xlsx")?;
179    Ok(())
180}

Implementors§