Class DataOptions

Allows the following pivot report information such as rows, columns, values, filters, etc., that are used to render the pivot table and field list.

Inheritance

System.Object

DataOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.EJ2.Pivot

Assembly: Syncfusion.EJ2.Pivot.dll

Syntax

public class DataOptions

Constructors

DataOptions()

Declaration

public DataOptions()

Properties

AllowLabelFilter

Allows to perform filter operation based on the selective headers used to be displayed in the pivot table.

Declaration

public bool AllowLabelFilter { get; set; }

Property Value

Type
System.Boolean

AllowMemberFilter

Allows to perform filter operation based on the selective filter members of the specific fields used to be displayed in the pivot table.

Declaration

public bool AllowMemberFilter { get; set; }

Property Value

Type
System.Boolean

AllowValueFilter

Allows to perform filter operation based only on value fields and its resultant aggregated values over other fields defined in row and column axes that used to be displayed in the pivot table.

Declaration

public bool AllowValueFilter { get; set; }

Property Value

Type
System.Boolean

AlwaysShowValueHeader

Allows to show the value field header always in pivot table, even if it holds a single field in the value field axis.

Declaration

public bool AlwaysShowValueHeader { get; set; }

Property Value

Type
System.Boolean

Authentication

Allows you to set the credential information to access the specified SSAS cube.

It is applicable only for OLAP data source.

Declaration

public AuthenticationInfo Authentication { get; set; }

Property Value

Type
AuthenticationInfo

CalculatedFieldSettings

Allows to create new calculated fields from the bound data source or using simple formula with basic arithmetic operators in the pivot table.

Declaration

public List<CalculatedFieldSettings> CalculatedFieldSettings { get; set; }

Property Value

Type
System.Collections.Generic.List<CalculatedFieldSettings>

Catalog

Allows to set the database name of SSAS cube as string type that used to retrieve the data from the specified connection string.

It is applicable only for OLAP data source.

Declaration

public string Catalog { get; set; }

Property Value

Type
System.String

Columns

Allows specific fields associated with field information that needs to be displayed in column axis of pivot table. The following configurations which are applicable are as follows: name: Allows you to set the field name that needs to be displayed in column axis of pivot table. caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component's UI. showNoDataItems: Allows you to display all members items of a specific field to the pivot table, even doesn't have any data in its row/column intersection in data source. Note: It is applicable only for relational data source. showSubTotals: Allows to show or hide sub-totals to a specific field in column axis of the pivot table. isNamedSet: Allows you to set whether the specified field is a named set or not. In general, the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: It is applicable only for OLAP data source. isCalculatedField: Allows to set whether the specified field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source. showFilterIcon: Allows you to show or hide the filter icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This filter icon is used to filter the members of a specified field at runtime in the pivot table. showSortIcon: Allows you to show or hide the sort icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This sort icon is used to order members of a specified field either in ascending or descending at runtime. showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime. showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table. allowDragAndDrop: Allows you to restrict the specific field's pivot button that is used to drag on runtime in the grouping bar and field list UI. This will prevent you from modifying the current report.

Declaration

public List<FieldOptions> Columns { get; set; }

Property Value

Type
System.Collections.Generic.List<FieldOptions>

ConditionalFormatSettings

Allows a collection of values fields to change the appearance of the pivot table value cells with different style properties such as background color, font color, font family, and font size based on specific conditions.

Declaration

public List<ConditionalFormatSettings> ConditionalFormatSettings { get; set; }

Property Value

Type
System.Collections.Generic.List<ConditionalFormatSettings>

Cube

Allows you to set the SSAS cube name as string type that used to retrieve data for pivot table rendering.

It is applicable only for OLAP data source.

Declaration

public string Cube { get; set; }

Property Value

Type
System.String

DataSource

Allows you to set the data source as JSON collection to the pivot report either from local or from remote server to the render the pivot that and field list. You can fetch JSON data from remote server by using DataManager.

It is applicable only for relational data source.

Declaration

public object DataSource { get; set; }

Property Value

Type
System.Object

DrilledMembers

Allows specific fields used to display their the headers to be either expanded or collapsed in the pivot table.

Declaration

public List<DrillOptions> DrilledMembers { get; set; }

Property Value

Type
System.Collections.Generic.List<DrillOptions>

EmptyCellsTextContent

Allows to show custom string to the empty value cells that used to display in the pivot table. You can fill empty value cells with any value like “0”, ”-”, ””, “(blank)”, etc.

Declaration

public string EmptyCellsTextContent { get; set; }

Property Value

Type
System.String

EnableSorting

Allows to perform sort operation to order members of a specific fields either in ascending or descending that used to be displayed in the pivot table.

Declaration

public bool EnableSorting { get; set; }

Property Value

Type
System.Boolean

ExcludeFields

Allows you to restrict the specific field(s) from displaying it in the field list UI. You may also be unable to render the pivot table with this field(s) by doing so.

It is applicable only for relational data source.

Declaration

public string[] ExcludeFields { get; set; }

Property Value

Type
System.String[]

ExpandAll

Allows you to either expand or collapse all the headers that are displayed in the pivot table. By default, all the headers are collapsed in the pivot table.

It is applicable only for Relational data.

Declaration

public bool ExpandAll { get; set; }

Property Value

Type
System.Boolean

FieldMapping

Allows specific fields associated with field information that can be used while creating fieldlist. The following configurations which are applicable are as follows: name: Allows you to set the field name which is going to configure while creating the fieldlist. caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component's UI. showNoDataItems: Allows you to display all members items of a specific field to the pivot table, even doesn't have any data in its row/column intersection in data source. Note: It is applicable only for relational data source. showSubTotals: Allows to show or hide sub-totals to a specific field in row axis of the pivot table. isNamedSet: Allows you to set whether the specified field is a named set or not. In general, the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: It is applicable only for OLAP data source. isCalculatedField: Allows to set whether the specified field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source. showFilterIcon: Allows you to show or hide the filter icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This filter icon is used to filter the members of a specified field at runtime in the pivot table. showSortIcon: Allows you to show or hide the sort icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This sort icon is used to order members of a specified field either in ascending or descending at runtime. showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime. showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table. allowDragAndDrop: Allows you to restrict the specific field's pivot button that is used to drag on runtime in the grouping bar and field list UI. This will prevent you from modifying the current report.

Declaration

public List<FieldOptions> FieldMapping { get; set; }

Property Value

Type
System.Collections.Generic.List<FieldOptions>

Filters

Allows to filter the values in other axis based on the collection of filter fields in pivot table. The following configurations which are applicable are as follows: name: Allows you to set the field name that needs to be displayed in row/column/value/filter axis of pivot table. caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component's UI. isNamedSet: Allows you to set whether the specified field is a named set or not. In general, the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: It is applicable only for OLAP data source. isCalculatedField: Allows to set whether the specified field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source. showFilterIcon: Allows you to show or hide the filter icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This filter icon is used to filter the members of a specified field at runtime in the pivot table. showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime. showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table. allowDragAndDrop: Allows you to restrict the specific field's pivot button that is used to drag on runtime in the grouping bar and field list UI. This will prevent you from modifying the current report.

Declaration

public List<FieldOptions> Filters { get; set; }

Property Value

Type
System.Collections.Generic.List<FieldOptions>

FilterSettings

Allows specific fields associated with either selective or conditional-based filter members that used to be displayed in the pivot table.

Declaration

public List<Filter> FilterSettings { get; set; }

Property Value

Type
System.Collections.Generic.List<Filter>

FormatSettings

Allows specific fields used to display the values with specific format that used to be displayed in the pivot table. For example, to display a specific field with currency formatted values in the pivot table, the set the format property to be C.

Declaration

public List<FormatSettings> FormatSettings { get; set; }

Property Value

Type
System.Collections.Generic.List<FormatSettings>

GrandTotalsPosition

Allows the grand totals to be displayed at the top or bottom of the pivot table's row and column axis. The options available are:

• BottomAllows the grand totals to be displayed in bottom position in the pivot table's row and column axis.
• TopAllows the grand totals to be displayed in top position in the pivot table's row and column axis.

Declaration

public GrandTotalsPosition GrandTotalsPosition { get; set; }

Property Value

Type
GrandTotalsPosition

GroupSettings

Allows specific fields to group their data on the basis of their type. For example, the date type fields can be formatted and displayed based on year, quarter, month, and more. Likewise, the number type fields can be grouped range-wise, such as 1-5, 6-10, etc. You can perform custom group to the string type fields that used to displayed in the pivot table.

Declaration

public List<GroupSettings> GroupSettings { get; set; }

Property Value

Type
System.Collections.Generic.List<GroupSettings>

LocaleIdentifier

Allows you to set the specific culture code as number type to render pivot table with desired localization. By default, the pivot table displays with culture code 1033, which indicates "en-US" locale.

It is applicale only for OLAP data source.

Declaration

public double LocaleIdentifier { get; set; }

Property Value

Type
System.Double

ProviderType

Allows to set the provider type to identify the given connection is either Relational or SSAS to render the pivot table and field list. The following options are: Relational: Allows to render the pivot table with JSON data collection either fetch at local or remote server. SSAS: Allows to render the pivot table with OLAP data fetch from OLAP cube.

Declaration

public ProviderType ProviderType { get; set; }

Property Value

Type
ProviderType

Rows

Allows specific fields associated with field information that needs to be displayed in row axis of pivot table. The following configurations which are applicable are as follows: name: Allows you to set the field name that needs to be displayed in row axis of pivot table. caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component's UI. showNoDataItems: Allows you to display all members items of a specific field to the pivot table, even doesn't have any data in its row/column intersection in data source. Note: It is applicable only for relational data source. showSubTotals: Allows to show or hide sub-totals to a specific field in row axis of the pivot table. isNamedSet: Allows you to set whether the specified field is a named set or not. In general, the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: It is applicable only for OLAP data source. isCalculatedField: Allows to set whether the specified field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source. showFilterIcon: Allows you to show or hide the filter icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This filter icon is used to filter the members of a specified field at runtime in the pivot table. showSortIcon: Allows you to show or hide the sort icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This sort icon is used to order members of a specified field either in ascending or descending at runtime. showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime. showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table. allowDragAndDrop: Allows you to restrict the specific field's pivot button that is used to drag on runtime in the grouping bar and field list UI. This will prevent you from modifying the current report.

Declaration

public List<FieldOptions> Rows { get; set; }

Property Value

Type
System.Collections.Generic.List<FieldOptions>

ShowAggregationOnValueField

Allows the pivot button with specific value field caption along with the aggregation type, to be displayed in the grouping bar and field list UI. For example, if the value field "Sold Amount" is aggregated with Sum, it will be displayed with caption "Sum of Sold Amount" in its pivot button.

Declaration

public bool ShowAggregationOnValueField { get; set; }

Property Value

Type
System.Boolean

ShowColumnGrandTotals

Allows to show or hide grand totals in column axis of the pivot table.

Declaration

public bool ShowColumnGrandTotals { get; set; }

Property Value

Type
System.Boolean

ShowColumnSubTotals

Allows to show or hide sub-totals in column axis of the pivot table.

Declaration

public bool ShowColumnSubTotals { get; set; }

Property Value

Type
System.Boolean

ShowGrandTotals

Allows to show or hide grand totals in both rows and columns axis of the pivot table.

Declaration

public bool ShowGrandTotals { get; set; }

Property Value

Type
System.Boolean

ShowHeaderWhenEmpty

Allows the undefined headers to be displayed in the pivot table, when the specific field(s) are not defined in the raw data. For example, if the raw data for the field ‘Country’ is defined as “United Kingdom” and “State” is not defined means, it will be shown as “United Kingdom >> Undefined” in the header section.

Declaration

public bool ShowHeaderWhenEmpty { get; set; }

Property Value

Type
System.Boolean

ShowRowGrandTotals

Allows to show or hide grand totals in row axis of the pivot table.

Declaration

public bool ShowRowGrandTotals { get; set; }

Property Value

Type
System.Boolean

ShowRowSubTotals

Allows to show or hide sub-totals in row axis of the pivot table.

Declaration

public bool ShowRowSubTotals { get; set; }

Property Value

Type
System.Boolean

ShowSubTotals

Allows to show or hide sub-totals in both rows and columns axis of the pivot table.

Declaration

public bool ShowSubTotals { get; set; }

Property Value

Type
System.Boolean

SortSettings

Allows specific fields associated with sort settings to order their members either in ascending or descending that used to be displayed in the pivot table. By default, the data source containing fields are display with Ascending order alone. To use this option, it requires the enableSorting property to be true.

Declaration

public List<Sort> SortSettings { get; set; }

Property Value

Type
System.Collections.Generic.List<Sort>

SubTotalsPosition

Allows the sub-totals to be displayed at the top or bottom of their header group in the pivot table’s row and column axes. The options available are:

• NoneAllows the sub-totals to be displayed at their default position.
  
• TopAllows the sub-totals to be displayed at the top position of the header group in the pivot table's row and column axes.
• BottomAllows the sub-totals to be displayed in bottom position of the header group in the pivot table's row and column axes.

Note: By default, the column sub-totals are displayed at the bottom and row sub-totals are displayed at the top of their header group in the pivot table’s row and column axes.

Declaration

public SubTotalsPosition SubTotalsPosition { get; set; }

Property Value

Type
SubTotalsPosition

Type

Allows to define the data source type.

Declaration

public DataSourceType Type { get; set; }

Property Value

Type
DataSourceType

Url

Allows to set the URL as string type, which helps to identify the service endpoint where the data are processed and retrieved to render the pivot table and field list.

It is applicable only for OLAP data source.

Declaration

public string Url { get; set; }

Property Value

Type
System.String

ValueAxis

Allows you to set the value fields that to be plotted either in row or column axis in the pivot table.

Declaration

public string ValueAxis { get; set; }

Property Value

Type
System.String

Values

Allows specific fields associated with field information that needs to be displayed as aggregated numeric values in pivot table. The following configurations which are applicable are as follows: name: Allows you to set the field name that needs to be displayed in row/column/value/filter axis of pivot table. caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component's UI. type: Allows to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… Note: It is applicable only for relational data source. baseField: Allows you to set the selective field, which used to display the values with either DifferenceFrom or PercentageOfDifferenceFrom or PercentageOfParentTotal aggregate types. Note: It is applicable only for relational data source. baseItem: Allows you to set the selective item of a specific field, which used to display the values with either DifferenceFrom or PercentageOfDifferenceFrom aggregate types. The selective item should be set the from field specified in the baseField property. Note: It is applicable only for relational data source. isCalculatedField: Allows to set whether the specified field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source. showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime. showValueTypeIcon: Allows you to show or hide the value type icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI. This value type icon helps to select the appropriate aggregation type to specified value field at runtime. showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table. allowDragAndDrop: Allows you to restrict the specific field's pivot button that is used to drag on runtime in the grouping bar and field list UI. This will prevent you from modifying the current report.

Declaration

public List<FieldOptions> Values { get; set; }

Property Value

Type
System.Collections.Generic.List<FieldOptions>

ValueSortSettings

Allows to sort individual value field and its aggregated values either in row or column axis to ascending or descending order.

Declaration

public ValueSortSettings ValueSortSettings { get; set; }

Property Value

Type
ValueSortSettings