PivotTable класс

PivotTable класс

Краткое описание для PivotTable.

Тип PivotTable предоставляет следующие элементы:

Характеристики

СвойствоОписание
is_excel_2003_compatibleУказывает, совместима ли сводная таблица с Excel2003 при обновлении сводной таблицы,
Если true, строка должна быть меньше или равна 255 символам, поэтому, если строка больше 255 символов,
она будет усечена. Если false, строка не будет иметь вышеупомянутого ограничения.
Значение по умолчанию — true.
refreshed_by_whoПолучает имя последнего пользователя, обновившего эту сводную таблицу.
refresh_dateВозвращает дату и время последнего обновления сводной таблицы.
pivot_table_style_nameПолучает и задает имя стиля сводной таблицы.
pivot_table_style_typeПолучает и задает стиль встроенной сводной таблицы.
column_fieldsВозвращает объект PivotFields, которые в данный момент отображаются как поля столбцов.
row_fieldsВозвращает объект PivotFields, которые в данный момент отображаются как поля строк.
page_fieldsВозвращает объект PivotFields, которые в данный момент отображаются как поля страницы.
data_fieldsПолучает объект PivotField, представляющий все поля данных в сводной таблице.
Только для чтения. Инициализация будет выполнена только в том случае, если в DataPiovtFiels есть два или более полей данных.
Используется только для добавления поля DataPivotField в область строк/столбцов сводной таблицы. По умолчанию поле находится в области строк.
data_fieldПолучает объект PivotField, представляющий все поля данных в сводной таблице.
Только для чтения.
Он будет создан только в том случае, если в области данных есть два или более полей данных.
По умолчанию он находится в области строк. Вы можете перетащить его в область строк/столбцов с помощью метода PivotTable.AddFieldToArea().
base_fieldsВозвращает все базовые поля сводной таблицы.
pivot_filtersВозвращает все фильтры полей сводной таблицы.
column_rangeВозвращает объект CellArea, представляющий диапазон
содержащий область столбцов в отчете сводной таблицы. Только для чтения.
row_rangeВозвращает объект CellArea, представляющий диапазон
содержащий область строк в отчете сводной таблицы. Только для чтения.
data_body_rangeВозвращает объект CellArea, представляющий диапазон, содержащий область данных.
в списке между строкой заголовка и строкой вставки. Только для чтения.
table_range1Возвращает объект CellArea, представляющий диапазон, содержащий весь отчет сводной таблицы,
но не включает поля страницы. Только для чтения.
table_range2Возвращает объект CellArea, представляющий диапазон, содержащий весь отчет сводной таблицы,
Включает поля страницы. Только для чтения.
is_grid_drop_zonesУказывает, отображает ли отчет сводной таблицы классический макет сводной таблицы.
(позволяет перетаскивать поля в сетке)
show_column_grand_totalsУказывает, следует ли показывать общие итоги для столбцов данной сводной таблицы.
show_row_grand_totalsУказывает, следует ли показывать общие итоги для строк сводной таблицы.
column_grandУказывает, отображает ли отчет сводной таблицы общие итоги по столбцам.
row_grandУказывает, следует ли показывать общие итоги для строк этой сводной таблицы.
display_null_stringУказывает, отображает ли отчет сводной таблицы пользовательскую строку, если значение равно NULL.
null_stringПолучает строку, отображаемую в ячейках, содержащих нулевые значения.
когда свойство DisplayNullString имеет значение true. Значение по умолчанию — пустая строка.
display_error_stringУказывает, отображает ли отчет сводной таблицы пользовательскую строку в ячейках, содержащих ошибки.
data_field_header_nameВозвращает и задает имя заголовка поля области значений в сводной таблице.
error_stringПолучает строку, отображаемую в ячейках, содержащих ошибки.
когда свойство DisplayErrorString имеет значение true. Значение по умолчанию — пустая строка.
is_auto_formatУказывает, форматируется ли отчет сводной таблицы автоматически.
Флажок «Автоформат таблицы» в опции сводной таблицы Excel 2003
autofit_column_width_on_updateУказывает, будет ли автоматически подбираться ширина столбца при обновлении
auto_format_typeПолучает и задает тип автоматического форматирования сводной таблицы.
has_blank_rowsУказывает, следует ли добавлять пустые строки.
Это свойство применяется только к типам автоматического форматирования сводных таблиц, которым необходимо добавлять пустые строки.
merge_labelsTrue, если метки элементов внешней строки, столбца, промежуточных итогов и общих итогов указанного отчета сводной таблицы используют объединенные ячейки.
preserve_formattingУказывает, сохраняется ли форматирование при обновлении или пересчете сводной таблицы.
show_drillВозвращает и задает, отображать ли кнопки «развернуть/свернуть».
enable_drilldownПроверяет, включена ли детализация.
enable_field_dialogУказывает, доступно ли диалоговое окно «Поле сводной таблицы»
когда пользователь дважды щелкает поле сводной таблицы.
enable_field_listУказывает, доступен ли список полей сводной таблицы в представлении Excel.
enable_wizardУказывает, доступен ли мастер сводных таблиц.
subtotal_hidden_page_itemsУказывает, скрыты ли элементы полей страницы в отчете сводной таблицы.
включены в промежуточные итоги по строкам и столбцам, итоги по блокам и общие итоги.
Значение по умолчанию — Ложь.
grand_total_nameВозвращает метку, которая отображается в заголовке столбца или строки общего итога.
Значением по умолчанию является строка «Общий итог».
manual_updateУказывает, пересчитывается ли отчет сводной таблицы только по запросу пользователя.
is_multiple_field_filtersЗадает логическое значение, указывающее, могут ли поля сводной таблицы иметь несколько фильтров.
allow_multiple_filters_per_fieldЗадает логическое значение, указывающее, могут ли поля сводной таблицы иметь несколько фильтров.
missing_items_limitЗадает логическое значение, указывающее, могут ли поля сводной таблицы иметь несколько фильтров.
enable_data_value_editingЗадает логическое значение, указывающее, разрешено ли пользователю редактировать ячейки в области данных сводной таблицы.
Включить редактирование ячеек в области значений
show_data_tipsЗадает логическое значение, указывающее, следует ли отображать подсказки для ячеек данных сводной таблицы.
show_member_property_tipsЗадает логическое значение, указывающее, следует ли исключать информацию о свойствах элемента из подсказок сводной таблицы.
show_values_rowУказывает, отображать ли строку значений.
show_empty_colУказывает, следует ли включать пустые столбцы в таблицу.
show_empty_rowУказывает, следует ли включать пустые строки в таблицу.
field_list_sort_ascendingУказывает, сортируются ли поля сводной таблицы в порядке, отличном от порядка по умолчанию в списке полей.
print_drillЗадает логическое значение, указывающее, следует ли печатать индикаторы сверления.
печатать кнопки «развернуть/свернуть» при отображении на сводной таблице.
alt_text_titleПолучает и задает заголовок альтернативного текста.
alt_text_descriptionПолучает описание альтернативного текста.
nameПолучает имя сводной таблицы
column_header_captionПолучает заголовок столбца сводной таблицы.
indentЗадает шаг отступа для компактной оси и может использоваться для установки макета отчета в компактную форму.
row_header_captionПолучает заголовок строки сводной таблицы.
show_row_header_captionУказывает, отображается ли заголовок строки в отчете сводной таблицы.
Указывает, отображать ли заголовки полей и раскрывающиеся списки фильтров.
custom_list_sortУказывает, следует ли учитывать встроенный пользовательский список при сортировке данных.
pivot_format_conditionsПолучает условия форматирования сводной таблицы.
conditional_formatsПолучает условные форматы сводной таблицы.
page_field_orderВозвращает и задает порядок, в котором поля страницы добавляются в макет отчета сводной таблицы.
page_field_wrap_countВозвращает количество полей страницы в каждом столбце или строке отчета сводной таблицы.
tagПолучает строку, сохраненную в отчете сводной таблицы.
save_dataУказывает, сохраняются ли данные для отчета сводной таблицы вместе с рабочей книгой.
refresh_data_on_opening_fileУказывает, обновлять ли данные при открытии файла.
refresh_data_flagУказывает, происходит ли обновление данных.
source_typeПолучает тип источника данных сводной таблицы.
external_connection_data_sourceПолучает внешний источник данных соединения.
data_sourceПолучает и задает источник данных сводной таблицы.
pivot_formatsПолучает коллекцию форматов, примененных к сводной таблице.
item_print_titlesУказывает, следует ли повторять имена PivotItem в верхней части каждой распечатанной страницы.
repeat_items_on_each_printed_pageУказывает, повторяются ли заголовки элементов сводки в области строк на каждой печатной странице для полей сводки в табличной форме.
print_titlesУказывает, задаются ли заголовки для печати на рабочем листе на основе
В отчёте сводной таблицы. Значение по умолчанию — false.
display_immediate_itemsУказывает, видны ли элементы в строках и столбцах.
Когда область данных сводной таблицы пуста. Значение по умолчанию — true.
is_selectedУказывает, выбрана ли данная сводная таблица.
show_pivot_style_row_headerУказывает, следует ли применять стиль к заголовку строки в сводной таблице.
show_pivot_style_column_headerУказывает, следует ли применять стиль к заголовку столбца в сводной таблице.
show_pivot_style_row_stripesУказывает, применяется ли форматирование полос строк.
show_pivot_style_column_stripesУказывает, применяется ли к столбцу форматирование полос.
show_pivot_style_last_columnУказывает, применяется ли форматирование столбца.

Методы

МетодОписание
remove_field(self, field_type, field_name)Удаляет поле из определенной области полей
remove_field(self, field_type, base_field_index)Удаляет поле из определенной области полей
remove_field(self, field_type, pivot_field)Удалить поле из определенной области полей
add_field_to_area(self, field_type, field_name)Добавляет поле в определенную область.
add_field_to_area(self, field_type, base_field_index)Добавляет поле в определенную область.
add_field_to_area(self, field_type, pivot_field)Добавляет поле в определенную область.
add_calculated_field(self, name, formula, drag_to_data_area)Добавляет вычисляемое поле к сводному полю.
add_calculated_field(self, name, formula)Добавляет вычисляемое поле в сводное поле и перетаскивает его в область данных.
move(self, row, column)Перемещает сводную таблицу в другое место на листе.
move(self, dest_cell_name)Перемещает сводную таблицу в другое место на листе.
move_to(self, row, column)Перемещает сводную таблицу в другое место на листе.
move_to(self, dest_cell_name)Перемещает сводную таблицу в другое место на листе.
get_source(self)Получить исходные данные сводной таблицы.
get_source(self, is_original)Получить исходные данные сводной таблицы.
refresh_data(self)Обновляет данные и настройки сводной таблицы из ее источника данных.
refresh_data(self, option)Обновляет данные и настройки сводной таблицы из ее источника данных с параметрами.
calculate_data(self)Рассчитывает данные сводной таблицы по ячейкам.
calculate_data(self, option)Расчет сводных таблиц с параметрами
format(self, pivot_area, style)Форматирует выбранную область сводной таблицы.
format(self, ca, style)Форматирует выбранную область сводной таблицы.
format(self, row, column, style)Отформатируйте ячейку в области сводной таблицы.
set_auto_group_field(self, base_field_index)Устанавливает автоматическую группировку полей по сводной таблице.
set_auto_group_field(self, pivot_field)Устанавливает автоматическую группировку полей по сводной таблице.
set_manual_group_field(self, base_field_index, start_val, end_val, group_by_list, interval_num)Устанавливает ручную группировку полей по сводной таблице.
set_manual_group_field(self, pivot_field, start_val, end_val, group_by_list, interval_num)Устанавливает ручную группировку полей по сводной таблице.
set_manual_group_field(self, base_field_index, start_val, end_val, group_by_list, interval_num)Устанавливает ручную группировку полей по сводной таблице.
set_manual_group_field(self, pivot_field, start_val, end_val, group_by_list, interval_num)Устанавливает ручную группировку полей по сводной таблице.
set_ungroup(self, base_field_index)Разгруппировать наборы по сводной таблице
set_ungroup(self, pivot_field)Разгруппировать наборы по сводной таблице
copy_style(self, pivot_table)Копирует именованный стиль из другой сводной таблицы.
show_report_filter_page(self, page_field)Показывать все страницы фильтров отчета в соответствии с PivotField, PivotField должен располагаться в PageFields.
show_report_filter_page_by_name(self, field_name)Показывать все страницы фильтров отчета в соответствии с именем PivotField, PivotField должен располагаться в PageFields.
show_report_filter_page_by_index(self, pos_index)Показать все страницы фильтра отчета в соответствии с индексом позиции в PageFields
get_fields(self, field_type)Получает конкретный список полей сводки по региону.
fields(self, field_type)Получает конкретные поля по типу поля.
get_source_data_connections(self)Получает внешние источники данных соединения.
get_names_of_source_data_connections(self)Получает имя подключений к внешнему источнику данных.
change_data_source(self, source)Задайте исходные данные сводной таблицы.
clear_data(self)Очистить данные и форматирование сводной таблицы
calculate_range(self)Вычисляет диапазон сводной таблицы.
format_all(self, style)Форматировать все ячейки в области сводной таблицы
format_row(self, row, style)Отформатируйте данные строки в области сводной таблицы.
select_area(self, ca)Выберите область представления сводной таблицы.
show_detail(self, row_offset, column_offset, new_sheet, dest_row, dest_column)Отобразить подробную информацию об одном элементе в области данных в новой таблице.
get_horizontal_page_breaks(self)Получает горизонтальные разрывы страниц этой сводной таблицы.
get_horizontal_breaks(self)Получает список индексов строк сводной таблицы горизонтальных разрывов страниц.
show_in_compact_form(self)Размещает сводную таблицу в компактном виде.
show_in_outline_form(self)Макетирует сводную таблицу в виде структуры.
show_in_tabular_form(self)Макетирует сводную таблицу в табличной форме.
get_cell_by_display_name(self, display_name)Получает объект Cell по отображаемому имени PivotField.
get_children(self)Получает дочерние сводные таблицы, которые используют данные этой сводной таблицы в качестве источника данных.

Пример

from aspose.cells import FormatConditionType, OperatorType, Workbook
from aspose.cells.pivot import PivotFieldType, PivotFilterType, PivotTableStyleType
from aspose.pydrawing import Color

book = Workbook()
sheet = book.worksheets[0]
cells = sheet.cells
cells.get(0, 0).value = "fruit"
cells.get(1, 0).value = "grape"
cells.get(2, 0).value = "blueberry"
cells.get(3, 0).value = "kiwi"
cells.get(4, 0).value = "cherry"
cells.get(5, 0).value = "grape"
cells.get(6, 0).value = "blueberry"
cells.get(7, 0).value = "kiwi"
cells.get(8, 0).value = "cherry"
cells.get(0, 1).value = "year"
cells.get(1, 1).value = 2020
cells.get(2, 1).value = 2020
cells.get(3, 1).value = 2020
cells.get(4, 1).value = 2020
cells.get(5, 1).value = 2021
cells.get(6, 1).value = 2021
cells.get(7, 1).value = 2021
cells.get(8, 1).value = 2021
cells.get(0, 2).value = "amount"
cells.get(1, 2).value = 50
cells.get(2, 2).value = 60
cells.get(3, 2).value = 70
cells.get(4, 2).value = 80
cells.get(5, 2).value = 90
cells.get(6, 2).value = 100
cells.get(7, 2).value = 110
cells.get(8, 2).value = 120
pivots = sheet.pivot_tables
pivotIndex = pivots.add("=Sheet1!A1:C9", "A12", "TestPivotTable")
pivot = pivots[pivotIndex]
pivot.add_field_to_area(PivotFieldType.ROW, "fruit")
pivot.add_field_to_area(PivotFieldType.COLUMN, "year")
pivot.add_field_to_area(PivotFieldType.DATA, "amount")
pivot.pivot_table_style_type = PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM10
# Change PivotField's attributes
rowField = pivot.row_fields[0]
rowField.display_name = "custom display name"
# Add PivotFilter
index = pivot.pivot_filters.add(0, PivotFilterType.COUNT)
filter = pivot.pivot_filters[index]
filter.auto_filter.filter_top10(0, False, False, 2)
# Add PivotFormatCondition
formatIndex = pivot.pivot_format_conditions.add()
pfc = pivot.pivot_format_conditions[formatIndex]
fcc = pfc.format_conditions
fcc.add_area(pivot.data_body_range)
idx = fcc.add_condition(FormatConditionType.CELL_VALUE)
fc = fcc[idx]
fc.formula1 = "100"
fc.operator = OperatorType.GREATER_OR_EQUAL
fc.style.background_color = Color.red
pivot.refresh_data()
pivot.calculate_data()
# do your business
book.save("out.xlsx")

Смотрите также