PivotTable класс
PivotTable класс
Краткое описание для PivotTable.
Тип PivotTable предоставляет следующие члены:
Характеристики
| Свойство | Описание |
|---|---|
| is_excel_2003_compatible | Указывает, совместима ли сводная таблица с Excel2003 при обновлении сводной таблицы,
если true, строка должна быть меньше или равна 255 символам, поэтому, если строка больше 255 символов, он будет усечен. если false, строка не будет иметь вышеупомянутого ограничения. Значение по умолчанию верно. |
| 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, представляющий все поля данных в сводной таблице.
Только для чтения. Это будет инициализироваться только при наличии двух или более полей данных в DataPiovtFiels. Он используется только для добавления DataPivotField в область строк/столбцов сводной таблицы. По умолчанию находится в области строк. |
| base_fields | Возвращает объект PivotFields, включающий все поля отчета сводной таблицы. |
| pivot_filters | Возвращает объект PivotFilterCollection. |
| column_range | Возвращает объект CellArea, представляющий диапазон
который содержит область столбца в отчете сводной таблицы. Только для чтения. |
| row_range | Возвращает объект CellArea, представляющий диапазон
который содержит область строк в отчете сводной таблицы. Только для чтения. |
| data_body_range | Возвращает объект CellArea, представляющий диапазон, содержащий область данных.
в списке между строкой заголовка и строкой вставки. Только для чтения. |
| table_range1 | Возвращает объект CellArea, представляющий диапазон, содержащий весь отчет сводной таблицы.
но не включает поля страницы. Только для чтения. |
| table_range2 | Возвращает объект CellArea, представляющий диапазон, содержащий весь отчет сводной таблицы.
включает поля страницы. Только для чтения. |
| column_grand | Указывает, отображаются ли в отчете сводной таблицы общие итоги для столбцов. |
| is_grid_drop_zones | Указывает, отображает ли отчет сводной таблицы классический макет сводной таблицы.
(позволяет перетаскивать поля в сетке) |
| row_grand | Указывает, отображаются ли в отчете сводной таблицы общие итоги для строк. |
| display_null_string | Указывает, отображает ли отчет сводной таблицы настраиваемую строку.
в ячейках, содержащих нулевые значения. |
| null_string | Получает строку, отображаемую в ячейках, содержащих нулевые значения.
когда свойство DisplayNullString имеет значение true. Значение по умолчанию — пустая строка. |
| display_error_string | Указывает, отображает ли отчет сводной таблицы пользовательскую строку в ячейках, содержащих ошибки. |
| data_field_header_name | Получает и задает имя заголовка поля области значений в сводной таблице. |
| error_string | Получает строку, отображаемую в ячейках, содержащих ошибки
когда свойство DisplayErrorString имеет значение true. Значением по умолчанию является пустая строка. |
| is_auto_format | Указывает, форматируется ли отчет сводной таблицы автоматически.
Флажок «Автоформат таблицы», который находится в опции сводной таблицы для Excel 2003 Флажок «автоподбор ширины столбца при обновлении», который находится в параметрах сводной таблицы: формат макета для Excel 2007 |
| auto_format_type | Получает тип автоматического форматирования сводной таблицы. |
| has_blank_rows | Указывает, добавлять ли пустые строки.
Это свойство применяется только к типам автоматического форматирования сводных таблиц, которым необходимо добавлять пустые строки. |
| merge_labels | Указывает, является ли указанный элемент внешней строки отчета сводной таблицы, элемент столбца, промежуточный итог,
а метки общего итога используют объединенные ячейки. |
| preserve_formatting | Указывает, сохраняется ли форматирование при обновлении или пересчете сводной таблицы. |
| show_drill | Получает, отображаются ли кнопки развертывания/свертывания. |
| enable_drilldown | Получает, включена ли детализация. |
| enable_field_dialog | Указывает, доступно ли диалоговое окно поля сводной таблицы.
когда пользователь дважды щелкает поле сводной таблицы. |
| enable_field_list | Получает, включает ли список полей для сводной таблицы. |
| enable_wizard | Указывает, доступен ли мастер сводных таблиц. |
| subtotal_hidden_page_items | Указывает, будут ли элементы поля скрытой страницы в отчете сводной таблицы
включаются в промежуточные итоги строк и столбцов, итоги блоков и общие итоги. Значение по умолчанию неверно. |
| grand_total_name | Возвращает метку текстовой строки, отображаемую в заголовке столбца общей суммы или строки.
Значением по умолчанию является строка «Общий итог». |
| manual_update | Указывает, пересчитывается ли отчет сводной таблицы только по запросу пользователя. |
| is_multiple_field_filters | Задает логическое значение, указывающее, могут ли поля сводной таблицы иметь несколько фильтров. |
| 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 | Получает условия формата сводной таблицы. |
| page_field_order | Получает порядок, в котором поля страницы добавляются в макет отчета сводной таблицы. |
| page_field_wrap_count | Получает количество полей страницы в каждом столбце или строке отчета сводной таблицы. |
| tag | Получает строку, сохраненную в отчете сводной таблицы. |
| save_data | Указывает, сохраняются ли данные для отчета сводной таблицы вместе с книгой. |
| refresh_data_on_opening_file | Указывает, следует ли обновлять данные при открытии файла. |
| refresh_data_flag | Указывает, следует ли обновлять данные или нет. |
| external_connection_data_source | Получает источник данных внешнего подключения. |
| data_source | Получает и задает источник данных сводной таблицы. |
| item_print_titles | Бит, указывающий, будут ли заголовки сводных элементов на оси строк
повторяются на каждой печатной странице для сводных полей в табличной форме. |
| print_titles | Указывает, установлены ли печатные заголовки рабочего листа на основе
в отчете сводной таблицы. Значение по умолчанию неверно. |
| display_immediate_items | Указывает, видны ли элементы в области строк и столбцов.
когда область данных сводной таблицы пуста. Значение по умолчанию верно. |
| 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(field_type, field_name) | Удаляет поле из определенной области поля |
| remove_field(field_type, base_field_index) | Удаляет поле из определенной области поля |
| remove_field(field_type, pivot_field) | Удалить поле из определенной области поля |
| add_field_to_area(field_type, field_name) | Добавляет поле в определенную область. |
| add_field_to_area(field_type, base_field_index) | Добавляет поле в определенную область. |
| add_field_to_area(field_type, pivot_field) | Добавляет поле в определенную область. |
| add_calculated_field(name, formula, drag_to_data_area) | Добавляет вычисляемое поле в сводное поле. |
| add_calculated_field(name, formula) | Добавляет вычисляемое поле в сводное поле и перетаскивает его в область данных. |
| move(row, column) | Перемещает сводную таблицу в другое место на листе. |
| move(dest_cell_name) | Перемещает сводную таблицу в другое место на листе. |
| set_auto_group_field(base_field_index) | Задает группу автоматических полей по сводной таблице. |
| set_auto_group_field(pivot_field) | Задает группу автоматических полей по сводной таблице. |
| set_manual_group_field(base_field_index, start_val, end_val, group_by_list, interval_num) | Задает группу полей вручную для сводной таблицы. |
| set_manual_group_field(pivot_field, start_val, end_val, group_by_list, interval_num) | Задает группу полей вручную для сводной таблицы. |
| set_manual_group_field(base_field_index, start_val, end_val, group_by_list, interval_num) | Задает группу полей вручную для сводной таблицы. |
| set_manual_group_field(pivot_field, start_val, end_val, group_by_list, interval_num) | Задает группу полей вручную для сводной таблицы. |
| set_ungroup(base_field_index) | Устанавливает разгруппировку по сводной таблице |
| set_ungroup(pivot_field) | Устанавливает разгруппировку по сводной таблице |
| copy_style(pivot_table) | Копирует именованный стиль из другой сводной таблицы. |
| show_report_filter_page(page_field) | Показать все страницы фильтра отчета в соответствии с PivotField, PivotField должен находиться в PageFields. |
| show_report_filter_page_by_name(field_name) | Показать все страницы фильтра отчетов в соответствии с именем PivotField, PivotField должен находиться в PageFields. |
| show_report_filter_page_by_index(pos_index) | Показать все страницы фильтра отчета в соответствии с индексом позиции в PageFields |
| fields(field_type) | Получает определенные поля по типу поля. |
| change_data_source(source) | Установите исходные данные сводной таблицы.
Лист1!$A$1:$C$3 |
| get_source() | Получить исходные данные сводной таблицы. |
| refresh_data() | Обновляет данные сводной таблицы и настройки из ее источника данных. |
| calculate_data() | Вычисляет данные сводной таблицы в ячейки. |
| clear_data() | Очистить данные и форматирование сводной таблицы |
| calculate_range() | Вычисляет диапазон сводной таблицы. |
| format_all(style) | Отформатировать всю ячейку в сводной области |
| format_row(row, style) | Форматирование данных строки в области сводной таблицы |
| format(row, column, style) | Отформатируйте ячейку в сводной области |
| get_horizontal_breaks() | получить список индексов строк сводной таблицы горизонтальных разрывов страниц |
| show_in_compact_form() | Макеты сводной таблицы в компактной форме. |
| show_in_outline_form() | Макеты сводной таблицы в виде схемы. |
| show_in_tabular_form() | Макеты сводной таблицы в табличной форме. |
| get_cell_by_display_name(display_name) | Получает объект Cell по DisplayName поля PivotField. |
| get_children() | Получает дочерние сводные таблицы, которые используют данные этой сводной таблицы в качестве источника данных. |
Пример
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")
Смотрите также
- модуль aspose.cells.pivot
