Go-Excelize API源码阅读二十四——SetColVisible、SetRowHeight

Go-Excelize API源码阅读(二十三)——SetColVisible

开源摘星计划(WeOpen Star) 是由腾源会 2022 年推出的全新项目,旨在为开源人提供成长激励,为开源项目提供成长支持,助力开发者更好地了解开源,更快地跨越鸿沟,参与到开源的具体贡献与实践中。

不管你是开源萌新,还是希望更深度参与开源贡献的老兵,跟随“开源摘星计划”开启你的开源之旅,从一篇学习笔记、到一段代码的提交,不断挖掘自己的潜能,最终成长为开源社区的“闪亮之星”。

我们将同你一起,探索更多的可能性!

项目地址: WeOpen-Star:https://github.com/weopenprojects/WeOpen-Star

一、Go-Excelize简介

Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376,ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式,高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档,并提供流式读写 API,用于处理包含大规模数据的工作簿。可应用于各类报表平台、云计算、边缘计算等系统。使用本类库要求使用的 Go 语言为 1.15 或更高版本。

二、 SetColVisible(sheet, col string, visible bool)

设置列可见性

func (f *File) SetColVisible(sheet, col string, visible bool) error

根据给定的工作表名称和列名称设置列可见性。此功能是并发安全的。例如隐藏名为 Sheet1 工作表上的 D 列:

err := f.SetColVisible("Sheet1", "D", false)

隐藏名称为 Sheet1 的工作表中的 D 至 F 列:

err := f.SetColVisible("Sheet1", "D:F", false)

废话少说,我们来看源码:

func (f *File) SetColVisible(sheet, columns string, visible bool) error {
	start, end, err := f.parseColRange(columns)
	if err != nil {
		return err
	}
	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
	colData := xlsxCol{
		Min:         start,
		Max:         end,
		Width:       defaultColWidth, // default width
		Hidden:      !visible,
		CustomWidth: true,
	}
	if ws.Cols == nil {
		cols := xlsxCols{}
		cols.Col = append(cols.Col, colData)
		ws.Cols = &cols
		return nil
	}
	ws.Cols.Col = flatCols(colData, ws.Cols.Col, func(fc, c xlsxCol) xlsxCol {
		fc.BestFit = c.BestFit
		fc.Collapsed = c.Collapsed
		fc.CustomWidth = c.CustomWidth
		fc.OutlineLevel = c.OutlineLevel
		fc.Phonetic = c.Phonetic
		fc.Style = c.Style
		fc.Width = c.Width
		return fc
	})
	return nil
}

parseColRange 解析列范围并将列名转换为列号。 其内容如下:

将字符串类型的列范围转换为范围起始和结束。

	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}

然后使用工作表阅读器读取工作表sheet,进行以下操作:

	colData := xlsxCol{
		Min:         start,
		Max:         end,
		Width:       defaultColWidth, // default width
		Hidden:      !visible,
		CustomWidth: true,
	}
	if ws.Cols == nil {
		cols := xlsxCols{}
		cols.Col = append(cols.Col, colData)
		ws.Cols = &cols
		return nil
	}
	ws.Cols.Col = flatCols(colData, ws.Cols.Col, func(fc, c xlsxCol) xlsxCol {
		fc.BestFit = c.BestFit
		fc.Collapsed = c.Collapsed
		fc.CustomWidth = c.CustomWidth
		fc.OutlineLevel = c.OutlineLevel
		fc.Phonetic = c.Phonetic
		fc.Style = c.Style
		fc.Width = c.Width
		return fc
	})
	return nil

先建立一个xlsxCol结构体并放入数据。 如果工作表的列数即其参数Cols为空,我们就建立一个空xlsxCols结构体,然后将上面建立的xlsxCol结构体colData放入cols.Col中。

否则我们使用flatCols函数,其为提供了一种方法来展平和检查工作表列。

三、SetRowHeight(sheet string, row int, height float64)

func (f *File) SetRowHeight(sheet string, row int, height float64) error

根据给定的工作表名称、行号和高度值设置单行高度。例如设置名为 Sheet1 工作表首行的高度为 50:

err := f.SetRowHeight("Sheet1", 1, 50)

下面直接来看源代码:

// SetRowHeight provides a function to set the height of a single row. For
// example, set the height of the first row in Sheet1:
//
//    err := f.SetRowHeight("Sheet1", 1, 50)
//
func (f *File) SetRowHeight(sheet string, row int, height float64) error {
	if row < 1 {
		return newInvalidRowNumberError(row)
	}
	if height > MaxRowHeight {
		return ErrMaxRowHeight
	}
	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}

	prepareSheetXML(ws, 0, row)

	rowIdx := row - 1
	ws.SheetData.Row[rowIdx].Ht = height
	ws.SheetData.Row[rowIdx].CustomHeight = true
	return nil
}

如果行高小于1,也就是为0,那么直接返回Error:

// newInvalidRowNumberError defined the error message on receiving the invalid
// row number.
func newInvalidRowNumberError(row int) error {
	return fmt.Errorf("invalid row number %d", row)
}

如果行高大于最大行高的话,就返回ErrMaxRowHeight。

否则,我们读取工作表,然后使用prepareSheetXML(ws, 0, row)

fillSheetData 确保所选行中有足够的行和列来接受数据。 缺失的行被回填并给出它们的行号。 使用最后填充的行作为要添加的下一行大小的提示

	rowIdx := row - 1
	ws.SheetData.Row[rowIdx].Ht = height
	ws.SheetData.Row[rowIdx].CustomHeight = true
	return nil

然后获取最后一列,将height赋给ws.SheetData.Row[rowIdx].Ht,将ws.SheetData.Row[rowIdx].CustomHeight属性设置为true,也就是使用自定义高度。

相关文章

显卡天梯图2024最新版,显卡是电脑进行图形处理的重要设备,...
初始化电脑时出现问题怎么办,可以使用win系统的安装介质,连...
todesk远程开机怎么设置,两台电脑要在同一局域网内,然后需...
油猴谷歌插件怎么安装,可以通过谷歌应用商店进行安装,需要...
虚拟内存这个名词想必很多人都听说过,我们在使用电脑的时候...
win11本地账户怎么改名?win11很多操作都变了样,用户如果想要...