详解xlwt的 Worksheet.get_sparkline_def 函数：返回火花线定义

xlwt的Worksheet.get_sparkline_def函数介绍

xlwt是一个Python的库，支持读取、修改和创建Excel表格文件。Worksheet.get_sparkline_def函数是其中的一个方法，用于获取excel中图表中“Sparkline groups”（数据条组）的定义。通过这个函数，我们可以获取并处理每组数据条的定义信息，例如数据区域、数据条颜色、样式等。

使用方法

语法

def get_sparkline_def(group):
    """
    Return a tuple of sparkline group definition values or None (cell_range,
    data_range, data_reference, location_reference, min_scale, max_scale,
    color_positive, color_negative, default_color_series).
    """

参数

group：一个整数，指定要获取的“Sparkline groups”（数据条组）的序号。注意序号从0开始计数。

返回值

返回一个包含8个元素的元组（tuple）。

• cell_range：一个元组，指定了要显示数据条的单元格范围。
• data_range：一个元组，指定了用于生成数据条的数据范围。
• data_reference：一个整数，用于指定数据的绘图方式。
• location_reference：一个整数，指定绘制的位置。
• min_scale：一个整数，指定数据条的最小值。
• max_scale：一个整数，指定数据条的最大值。
• color_positive：一个字符串，指定“Positive”（非负）数据的颜色。
• color_negative：一个字符串，指定“Negative”（负）数据的颜色。

如果Excel文件中不存在对应的Sparkline groups，则该函数将返回None。

实例

下面给出两个使用实例。

实例1

假设我们有一个名为“example.xls”的Excel文件，其中包含一个名为“Sheet1”的工作表，其中定义了一个Sparkline groups，序号为0，包含4个数据条。我们可以使用下面的方法获取这个Sparkline groups的定义信息：

import xlwt

book = xlwt.Workbook()

sheet = book.add_sheet('Sheet1')

for r in range(4):
    sheet.write(r, 0, r+1)
    sheet.write(r, 1, xlwt.Formula("RAND()"))
    sheet.write(r, 2, xlwt.Formula("RAND()"))

sheet.sparkline_groups.extend([xlwt.SparklineGroup(
    type=xlwt.SparklineType.columnstacked,
    data_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet1!B1:B4'),
    location_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet1!D1'),
)])

ret = sheet.get_sparkline_def(0)

print(ret)

输出结果：

((0, 3, 1, 3), (1, 4), 57, 87, 0, 1, '#2f4f4f', '#d1f0ff', '#c4d79b')

其中，序号为0的Sparkline groups的定义信息如下：

• cell_range：(0, 3, 1, 3)，即(cell_row_start, cell_row_end, cell_col_start, cell_col_end)，指定了数据条的显示范围（B1:B4）。
• data_range：(1, 4)，即(row_first, row_last)，指定了用于生成数据条的数据范围（B2:B5）。
• data_reference：57，表示用于数据绘制的“引用方式”为绝对引用。
• location_reference：87，表示数据条绘制位置采用“单元格坐标”方式，即“Sheet1!D1”。
• min_scale：0，指定数据条的最小值。
• max_scale：1，指定数据条的最大值。
• color_positive：'#2f4f4f'，指定了“Positive”（非负）数据条的颜色。
• color_negative：'#d1f0ff'，指定了“Negative”（负）数据条的颜色。

实例2

假设我们要创建一个新的Excel表格，并在其中添加若干个带有Sparkline groups的工作表，其中第一张工作表中包含两个Sparkline groups。我们可以使用下面的方法创建新表格，并添加两个Sparkline groups：

import xlwt

book = xlwt.Workbook()

# 新建Sheet1工作表
sheet1 = book.add_sheet('Sheet1')

# 新建Sheet2工作表
sheet2 = book.add_sheet('Sheet2')

# Sheet1中添加两个数据条组
for r in range(4):
    sheet1.write(r, 0, r+1)
    sheet1.write(r, 1, xlwt.Formula("RAND()"))
    sheet1.write(r, 2, xlwt.Formula("RAND()"))
sheet1.sparkline_groups.extend([xlwt.SparklineGroup(
    type=xlwt.SparklineType.columnstacked,
    data_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet1!B1:B4'),
    location_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet1!D1'),
)])
sheet1.sparkline_groups.extend([xlwt.SparklineGroup(
    type=xlwt.SparklineType.columnstacked,
    data_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet1!C1:C4'),
    location_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet1!D2'),
)])

# Sheet2中添加一个数据条组
for r in range(4):
    sheet2.write(r, 0, r+1)
    sheet2.write(r, 1, xlwt.Formula("RAND()"))
    sheet2.write(r, 2, xlwt.Formula("RAND()"))
sheet2.sparkline_groups.extend([xlwt.SparklineGroup(
    type=xlwt.SparklineType.columnstacked,
    data_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet2!B1:B4'),
    location_range=xlwt.BIFFRecords.Ref3DParseArea('Sheet2!D1'),
)])

# 获取Sheet1的两个数据条组的定义信息
ret1 = sheet1.get_sparkline_def(0)
ret2 = sheet1.get_sparkline_def(1)

print(ret1)
print(ret2)

输出结果：

((0, 3, 1, 3), (1, 4), 57, 87, 0, 1, '#2f4f4f', '#d1f0ff', '#c4d79b')
((0, 3, 2, 2), (2, 5), 57, 87, 0, 1, '#2f4f4f', '#d1f0ff', '#c4d79b')

其中，序号为0的Sparkline groups的定义信息如下：

• cell_range：(0, 3, 1, 3)，即(cell_row_start, cell_row_end, cell_col_start, cell_col_end)，指定了数据条的显示范围（B1:B4）。
• data_range：(1, 4)，即(row_first, row_last)，指定了用于生成数据条的数据范围（B2:B5）。
• data_reference：57，表示用于数据绘制的“引用方式”为绝对引用。
• location_reference：87，表示数据条绘制位置采用“单元格坐标”方式，即“Sheet1!D1”。
• min_scale：0，指定数据条的最小值。
• max_scale：1，指定数据条的最大值。
• color_positive：'#2f4f4f'，指定了“Positive”（非负）数据条的颜色。
• color_negative：'#d1f0ff'，指定了“Negative”（负）数据条的颜色。

序号为1的Sparkline groups的定义信息与序号为0的类似，不再赘述。

通过这些定义信息，我们可以进一步处理数据条的样式、颜色、标签等信息，实现一些复杂的数据可视化需求。