Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

ExcelPivotGrouping

Edit on GitHub
Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Source ExcelPivotGrouping.cs:33
Modifiers sealed

Describes date or numeric grouping metadata for a pivot source field.

Inheritance

  • Object
  • ExcelPivotGrouping

Usage

Explore 5 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Accepted by parameters 2

Methods

public static ExcelPivotGrouping Date(String fieldName, ExcelPivotGroupBy groupBy, DateTime? startDate = null, DateTime? endDate = null, Double? interval = null) #
ExcelPivotGrouping.cs:33
Returns: ExcelPivotGrouping

Creates date grouping metadata for a pivot field.

Parameters

fieldName System.String requiredposition: 0
groupBy OfficeIMO.Excel.ExcelPivotGroupBy requiredposition: 1
startDate System.DateTime? = null optionalposition: 2
endDate System.DateTime? = null optionalposition: 3
interval System.Double? = null optionalposition: 4
DateHierarchy 2 overloads
public static ExcelPivotGrouping DateHierarchy(String fieldName, params ExcelPivotGroupBy[] levels) #
ExcelPivotGrouping.cs:45
Returns: ExcelPivotGrouping

Creates generated date hierarchy fields for a pivot field, such as years, quarters, and months.

Parameters

fieldName System.String requiredposition: 0
levels OfficeIMO.Excel.ExcelPivotGroupBy[] requiredposition: 1
public static ExcelPivotGrouping DateHierarchy(String fieldName, IEnumerable<ExcelPivotGroupBy> levels, DateTime? startDate = null, DateTime? endDate = null) #
ExcelPivotGrouping.cs:50
Returns: ExcelPivotGrouping

Creates generated date hierarchy fields for a pivot field, such as years, quarters, and months.

Parameters

fieldName System.String requiredposition: 0
levels System.Collections.Generic.IEnumerable<OfficeIMO.Excel.ExcelPivotGroupBy> requiredposition: 1
startDate System.DateTime? = null optionalposition: 2
endDate System.DateTime? = null optionalposition: 3
public static ExcelPivotGrouping Number(String fieldName, Double interval, Double? startNumber = null, Double? endNumber = null) #
ExcelPivotGrouping.cs:66
Returns: ExcelPivotGrouping

Creates numeric range grouping metadata for a pivot field.

Parameters

fieldName System.String requiredposition: 0
interval System.Double requiredposition: 1
startNumber System.Double? = null optionalposition: 2
endNumber System.Double? = null optionalposition: 3

Properties

public String FieldName { get; } #
ExcelPivotGrouping.cs:80

Gets the source field name.

public ExcelPivotGroupBy GroupBy { get; } #
ExcelPivotGrouping.cs:83

Gets the OpenXML grouping mode.

public DateTime? StartDate { get; } #
ExcelPivotGrouping.cs:86

Gets the optional date grouping start.

public DateTime? EndDate { get; } #
ExcelPivotGrouping.cs:89

Gets the optional date grouping end.

public Double? StartNumber { get; } #
ExcelPivotGrouping.cs:92

Gets the optional numeric grouping start.

public Double? EndNumber { get; } #
ExcelPivotGrouping.cs:95

Gets the optional numeric grouping end.

public Double? Interval { get; } #
ExcelPivotGrouping.cs:98

Gets the grouping interval.

public Boolean AutoStart { get; } #
ExcelPivotGrouping.cs:101

Gets whether Excel should infer the start of the grouping range.

public Boolean AutoEnd { get; } #
ExcelPivotGrouping.cs:104

Gets whether Excel should infer the end of the grouping range.

public IReadOnlyList<ExcelPivotGroupBy> GeneratedDateLevels { get; } #
ExcelPivotGrouping.cs:107

Gets generated date hierarchy levels requested for this source field.