PivotField classe

PivotField classe

Représente un champ dans un rapport de tableau croisé dynamique.

Le type PivotField expose les membres suivants :

Propriétés

PropriétéDescription
pivot_itemsObtient les éléments pivot du champ pivot
rangeObtient la plage de groupe du champ pivot
group_settingsObtient les paramètres de groupe du champ pivot.
is_calculated_fieldIndique si le champ de tableau croisé dynamique spécifié est un champ calculé.
is_value_fieldsIndique si ce champ représente des champs de valeurs.
base_indexReprésente l’index PivotField dans les PivotFields de base.
positionReprésente l’indice de PivotField dans la région.
region_typeSpécifie la région du tableau croisé dynamique dans laquelle ce champ est affiché.
nameReprésente le nom du champ croisé dynamique.
display_nameReprésente le nom d’affichage du champ croisé dynamique.
is_auto_subtotalsIndique si le champ spécifié affiche les sous-totaux automatiques. La valeur par défaut est « vrai ».
drag_to_columnIndique si le champ spécifié peut être déplacé vers la position de la colonne.
La valeur par défaut est vrai.
drag_to_hideIndique si le champ spécifié peut être déplacé vers la position de masquage.
La valeur par défaut est vrai.
drag_to_rowIndique si le champ spécifié peut être déplacé vers la position de la ligne.
La valeur par défaut est vrai.
drag_to_pageIndique si le champ spécifié peut être déplacé vers la position de la page.
La valeur par défaut est vrai.
drag_to_dataIndique si le champ spécifié peut être déplacé vers la position des données.
La valeur par défaut est vrai.
is_multiple_item_selection_allowedindique si le champ peut contenir plusieurs éléments
sélectionné dans le champ de page
La valeur par défaut est false.
is_repeat_item_labelsIndique si les étiquettes du champ se répètent dans la région.
La valeur par défaut est false.
is_include_new_items_in_filterIndique si de nouveaux éléments doivent être inclus dans le champ dans le filtre manuel.
La valeur par défaut est false.
is_insert_page_breaks_between_itemsIndique si des sauts de page doivent être insérés après chaque élément.
La valeur par défaut est false.
show_all_itemsIndique si tous les éléments s’affichent dans le rapport de tableau croisé dynamique,
même s’ils ne contiennent pas de données récapitulatives.
afficher les éléments sans données
La valeur par défaut est false.
non_auto_sort_defaultIndique si une opération de tri qui sera appliquée à ce champ pivot est une opération de tri automatique ou un tri de données simple.
is_auto_sortIndique si le champ de tableau croisé dynamique spécifié est automatiquement trié.
is_ascend_sortIndique si le champ de tableau croisé dynamique spécifié est trié automatiquement par ordre croissant.
sort_settingObtient tous les paramètres du tri automatique
auto_sort_fieldReprésente l’index du champ qui est trié automatiquement.
-1 signifie PivotField lui-même, les autres signifient la position des champs de données.
is_auto_showIndique si le champ de tableau croisé dynamique spécifié est automatiquement affiché, valable uniquement pour Excel 2003.
is_ascend_showIndique si le champ de tableau croisé dynamique spécifié est affiché automatiquement par ordre croissant.
auto_show_countReprésente le nombre d’éléments supérieurs ou inférieurs
qui sont automatiquement affichés dans le champ de tableau croisé dynamique spécifié.
auto_show_fieldReprésente l’index du champ d’affichage automatique. -1 signifie PivotField lui-même.
Il devrait s’agir de l’index des champs de données.
functionReprésente la fonction utilisée pour résumer le champ de données du tableau croisé dynamique.
show_values_settingObtient les paramètres d’affichage des valeurs lorsque le calcul ShowDataAs est en cours d’utilisation.
data_display_formatReprésente comment afficher les valeurs dans un champ de données du rapport croisé dynamique.
base_field_indexReprésente le champ de base pour un calcul personnalisé lorsque le calcul ShowDataAs est utilisé.
base_item_positionReprésente l’élément dans le champ de base pour un calcul personnalisé lorsque le calcul ShowDataAs est utilisé.
Valable uniquement pour les champs de données.
Étant donné que PivotItemPosition.Custom est uniquement destiné à la lecture, si vous devez définir PivotItemPosition.Custom,
veuillez définir l’attribut PivotField.BaseItemIndex.
base_item_indexReprésente l’élément dans le champ de base pour un calcul personnalisé lorsque le calcul ShowDataAs est utilisé.
Valable uniquement pour les champs de données.
current_page_itemReprésente l’élément de page actuel affiché pour le champ de page (valable uniquement pour les champs de page).
numberReprésente le format d’affichage intégré des nombres et des dates.
insert_blank_rowIndique si une ligne vide doit être insérée après chaque élément.
show_subtotal_at_toplorsque ShowInOutlineForm est vrai, affichez les sous-totaux en haut de la liste des éléments au lieu d’en bas
show_in_outline_formIndique si ce champ doit être présenté sous forme de plan dans la vue Tableau croisé dynamique
number_formatReprésente le format d’affichage personnalisé des nombres et des dates.
itemsObtenez toutes les étiquettes des éléments pivots dans ce champ.
original_itemsObtenez les éléments de base d’origine ;
item_countObtient le nombre d’éléments de base dans ce champ pivot.
show_compactIndique si les étiquettes du champ suivant dans la même colonne doivent être affichées dans la vue Tableau croisé dynamique

Méthodes

MéthodeDescription
group_by(self, interval, new_field)Regrouper automatiquement le champ avec les champs internes
group_by(self, start, end, groups, interval, first_as_new_field)Regroupez le fichier par types de groupes de dates.
group_by(self, start, end, interval, new_field)Regroupez le fichier par numéro.
group_by(self, custom_group_items, new_field)Personnalisez le groupe de champs.
sort_by(self, sort_type, field_sorted_by)Trie ce champ pivot.
sort_by(self, sort_type, field_sorted_by, data_type, cell_name)Trie ce champ pivot.
hide_item(self, index, is_hidden)Définit si l’élément PivotItem spécifique dans un champ de données est masqué.
hide_item(self, item_value, is_hidden)Définit si l’élément PivotItem spécifique dans un champ de données est masqué.
init_pivot_items(self)Initialiser les éléments pivot du champ pivot
ungroup(self)Dissocier le champ pivot.
get_pivot_filter_by_type(self, type)Obtient le filtre pivot du champ pivot par type
get_pivot_filters(self)Obtient les filtres pivot du champ pivot
get_filters(self)Obtient tous les filtres pivot de ce champ pivot.
clear_filter(self)Efface le paramètre de filtre sur ce champ pivot.
filter_top10(self, value_field_index, type, is_top, item_count)Filtre par valeurs du champ pivot de données.
filter_by_value(self, value_field_index, type, value1, value2)Filtre par valeurs du champ pivot de données.
filter_by_label(self, type, label1, label2)Filtre par légendes de champ pivot de ligne ou de colonne.
filter_by_date(self, type, date_time1, date_time2)Filtre par paramètre de date du champ pivot de ligne ou de colonne.
get_calculated_field_formula(self)Obtenir la chaîne de formule du champ calculé spécifié.
get_formula(self)Obtient la formule du champ calculé.
set_subtotals(self, subtotal_type, shown)Définit si le champ spécifié affiche les sous-totaux.
get_subtotals(self, subtotal_type)Indique si le sous-total spécifié doit être affiché.
show_values_as(self, display_format, base_field, base_item_position_type, base_item)Affiche les valeurs du champ de données sous un format d’affichage différent lorsque le calcul ShowDataAs est utilisé.
is_hidden_item(self, index)Obtient si le PivotItem spécifique est masqué.
is_hidden_item_detail(self, index)Obtient si le détail du PivotItem spécifique est masqué.
hide_item_detail(self, index, is_hidden_detail)Définit si l’élément PivotItem spécifique dans un champ de pivot est un détail masqué.
hide_detail(self, is_hidden_detail)Définit si les éléments de pivot dans un champ de pivot sont masqués en détail. Cela permet de réduire/développer ce champ.
add_calculated_item(self, name, formula)Ajoutez un élément de formule calculée au champ pivot.

Exemple

from aspose.cells import Workbook
from aspose.cells.pivot import PivotFieldType, PivotTableStyleType

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"
pivot.refresh_data()
pivot.calculate_data()
# do your business
book.save("out.xlsx")

Voir également