2021-11-10

StyleFrame模块 参数及函数翻译-Pandas

StyleFrame
所述StyleFrame模块包含单个类StyleFrame哪些服务器作为主要交互点。
class StyleFrame.StyleFrame(obj, styler_obj=None)
代表一个程式化的数据框
参数：
obj –可通过以下方式初始化pandas数据框的任何对象：现有数据框，字典，词典列表或另一个StyleFrame。
styler_obj（Styler）–一个Styler对象。将用作所有单元格的默认样式。

1、apply_style_by_indexes(indexes_to_style, styler_obj, cols_to_style=None, height=None, complement_style=None, complement_height=None, overwrite_default_style=True)
参数：
index_to_style（列表或元组或int 或Container）–要样式的StyleFrame索引。通常作为选择语法的熊猫传递。例如，sf[sf[‘some_col’] = 20]
styler_obj（Styler）– 包含将应用于indexs_to_style中的索引的样式的Styler对象
cols_to_style（None 或str 或list [ str ]或tuple [ str ]或set [ str ]）–应用于提供的样式的列名。如果None将对所有列进行样式设置。
height（无或int 或float）–如果提供，则其索引为indexs_to_style的行的高度。
complement_style（无或斯泰勒） - 斯泰勒对象，其中包含将在被施加到索引不是风格indexes_to_style
补全高度（无或整型或浮点型）–索引不在indexs_to_style中的行的高度。如果未提供，则将使用 高度（如果提供）。
overwrite_default_style（bool）–如果为True，则将覆盖默认样式（初始化StyleFrame时使用的样式）。如果为False，则将使用Styler.combine方法将默认样式和提供的样式进行组合。

2、apply_column_style(cols_to_style, styler_obj, style_header=False, use_default_formats=True, width=None, overwrite_default_style=True)
参数：
cols_to_style（str 或list 或tuple 或set）–要样式的列名称。
styler_obj（Styler）–一个Styler对象。
style_header（bool）–如果为True，则还将对列标题设置样式。
use_default_formats（bool）–如果为True，则将使用日期和时间的默认格式。
width（无或int 或float）–如果提供，则指定列的新宽度。
overwrite_default_style（bool）–（bool）如果为True，则将覆盖默认样式（初始化StyleFrame时使用的样式）。如果为False，则将使用Styler.combine方法将默认样式和提供的样式进行组合。

3、apply_headers_style(styler_obj, style_index_header, cols_to_style)
参数：
styler_obj（Styler）–一个Styler对象。
style_index_header（bool）–如果为True，则样式也将应用于索引列的标题
cols_to_style（None 或str 或list [ str ]或tuple [ str ]或set [ str ]）–要应用样式的列，如果未提供，则将对所有列进行样式设置

4、style_alternate_rows(styles)
注意
style_alternate_rows还接受StyleFrame.apply_style_by_indexes接受为kwargs的所有参数。
参数： styles (list[Styler] or tuple[Styler] or set[Styler]) – List, 将以交替方式应用于行的Styler对象的列表，元组或集合

5、rename(columns, inplace=False)
参数：
columns（dict）–从旧列名称到新列名称的字典。
inplace（bool）–如果为False，则将返回一个新的StyleFrame对象。如果为True，则将列重命名为原位。
返回值： 如果inplace 为True，则为self ，新的StyleFrame对象为False

6、set_column_width(columns, width)
参数：
columns (str or list[str] or tuple[str]) – （str 或list [ str ]或tuple [ str ]）–列名。
width（int 或float）–指定列的新宽度。

7、set_column_width_dict(col_width_dict)
参数： col_width_dict (dict[str, int or float]) – （dict [ str ，int 或float ]）–从列名到宽度的字典

8、set_row_height(rows, height)
参数：
rows (int or list[int] or tuple[int] or set[int]) – （int 或list [ int ]或元组[ int ]或set [ int ]）–行索引.
height (int or float) – (int 或float）–指定索引的新高度.

9、set_row_height_dict(row_height_dict)
参数：row_height_dict (dict[int, int or float]) – （dict [ int ，int 或float ]）–从行索引到高度的字典。

10、add_color_scale_conditional_formatting(start_type, start_value, start_color, end_type, end_value, end_color, mid_type=None, mid_value=None, mid_color=None, columns_range=None)
参数：
start_type（str：utils.conditional_formatting_types或Excel支持的任何其他类型之一）–最小界限的类型
start_value –最小界限的阈值
start_color（str：utils.colors，十六进制字符串或颜色名称之一，即Excel支持的“黄色”）–最小界限的颜色
end_type（str：utils.conditional_formatting_types或Excel支持的任何其他类型之一）–最大界限的类型
end_value –最大界限的阈值
end_color（str：utils.colors，十六进制字符串或颜色名称之一，即Excel支持的“黄色”）–最大界限的颜色
mid_type（无或str：utils.conditional_formatting_types或Excel支持的任何其他类型之一）–中间界限的类型
mid_value –中间界限的阈值
mid_color（无或str：utils.colors，十六进制字符串或颜色名称之一，即Excel支持的“黄色”）–中间界限的颜色
columns_range（无或列表[ str 或int ]或元组[ str 或int ] ））–将要添加条件格式的列的两个元素的列表或元组。如果根本不提供，则条件格式将添加到所有列。如果提供单个元素，则条件格式将添加到提供的列中。如果提供了两个元素，则条件格式将在第一列开始，在第二列结束。提供的列可以是列名称，字母或索引。

11、read_excel(path, sheet_name=0, read_style=False, use_openpyxl_styles=False, read_comments=False)
用于从现有Excel创建StyleFrame对象的类方法。

注意: read_excel也接受所有pandas.read_excel接受为kwargs的参数。
参数：
path（str）–要读取的Excel文件的路径。
工作表名称 –从版本1.6开始不推荐使用：改为sheet_name使用。
sheet_name（str 或int）–要读取的工作表名称。如果提供整数，则将其用作从零开始的工作表索引。默认值为0。
read_style（bool）–如果为True，则工作表的样式将被加载到返回的StyleFrame对象中。
use_openpyxl_styles（bool）–
如果为True（并且read_style也是True），则返回的StyleFrame对象中的样式将为Openpyxl的样式对象。如果为False，则样式将为Styler对象。
注意:use_openpyxl_styles=False如果要按样式过滤列或行，则使用很有用，
例如：sf = sf[[col for col in sf.columns if col.style.font == utils.fonts.arial]]
read_comments（bool）–如果为True（并且read_style也是True），则单元格的注释将加载到返回的StyleFrame对象中。请注意，当前不支持不带阅读样式的阅读注释。

12、to_excel(excel_writer=‘output.xlsx’, sheet_name=‘Sheet1’, allow_protection=False, right_to_left=False, columns_to_hide=None, row_to_add_filters=None, columns_and_rows_to_freeze=None, best_fit=None)
注意
to_excel也接受所有pandas.DataFrame.to_excel接受为kwargs的参数。
参数：
excel_writer（str 或pandas.ExcelWriter）–文件路径或现有的ExcelWriter
sheet_name（str）– StyleFrame将导出到的图纸的名称
allow_protection（bool）–允许保护指定为被保护的单元。如果protection=True 在Styler对象中使用，则必须将其设置为True。
right_to_lef（bool）–使工作表从右到左。
columns_to_hide（None 或str 或list 或tuple 或set）–要隐藏的列名。
row_to_add_filters（None 或int）–将过滤器添加到给定的行索引，从0开始（它将过滤器添加到标题行）。
columns_and_rows_to_freeze（None 或str）–要冻结的列和行字符串。例如，“ C3”将冻结列：A，B和行：1、2。
best_fit（None 或str 或list 或tuple 或set）–单列，列表，集合或列名称的元组，以尝试最适合其宽度。
注意:
best_fit会尝试根据每个提供的列中的最长值来计算正确的列宽。但是，不能保证此功能适用于所有字体（对等宽字体效果最好）。用于计算列宽的公式等于
(len(longest_value_in_column) + A_FACTOR) * P_FACTOR
的默认值A_FACTOR和P_FACTOR13和1.3分别与可以在调用之前被修改StyleFrame.to_excel通过直接修改StyleFrame.A_FACTOR和tyleFrame.P_FACTOR

原文链接：https://www.jianshu.com/p/eb0d78e07bc9