Class PivotFieldListDataSourceSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
PivotFieldListDataSourceSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotFieldListDataSourceSettingsBuilder : ControlBuilder
Constructors
PivotFieldListDataSourceSettingsBuilder()
Declaration
public PivotFieldListDataSourceSettingsBuilder()
PivotFieldListDataSourceSettingsBuilder(PivotFieldListDataSourceSettings)
Declaration
public PivotFieldListDataSourceSettingsBuilder(PivotFieldListDataSourceSettings model)
Parameters
Methods
AllowLabelFilter(Boolean)
Allows to perform filter operation based on the selective headers used to be displayed in the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder AllowLabelFilter(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
AllowMemberFilter(Boolean)
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 PivotFieldListDataSourceSettingsBuilder AllowMemberFilter(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
AllowValueFilter(Boolean)
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 PivotFieldListDataSourceSettingsBuilder AllowValueFilter(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
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 PivotFieldListDataSourceSettingsBuilder AlwaysShowValueHeader(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
Authentication(PivotFieldListAuthentication)
Allows you to set the credential information to access the specified SSAS cube.
It is applicable only for OLAP data source.
Declaration
public PivotFieldListDataSourceSettingsBuilder Authentication(PivotFieldListAuthentication value)
Parameters
Returns
Authentication(Action<PivotFieldListAuthenticationBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder Authentication(Action<PivotFieldListAuthenticationBuilder> authentication)
Parameters
Returns
CalculatedFieldSettings(Action<PivotFieldListCalculatedFieldSettingBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder CalculatedFieldSettings(Action<PivotFieldListCalculatedFieldSettingBuilder> calculatedFieldSettings)
Parameters
Returns
CalculatedFieldSettings(List<PivotFieldListCalculatedFieldSetting>)
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 PivotFieldListDataSourceSettingsBuilder CalculatedFieldSettings(List<PivotFieldListCalculatedFieldSetting> value)
Parameters
Returns
Catalog(String)
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 PivotFieldListDataSourceSettingsBuilder Catalog(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
Columns(Action<ColumnFieldListDataSourceBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder Columns(Action<ColumnFieldListDataSourceBuilder> columns)
Parameters
Returns
Columns(List<ColumnFieldListDataSource>)
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.
expandAll
: Allows you to expand or collapse all of the pivot table's headers for a specific field.
Declaration
public PivotFieldListDataSourceSettingsBuilder Columns(List<ColumnFieldListDataSource> value)
Parameters
Returns
Declaration
public PivotFieldListDataSourceSettingsBuilder ConditionalFormatSettings(Action<PivotFieldListConditionalFormatSettingBuilder> conditionalFormatSettings)
Parameters
Returns
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 PivotFieldListDataSourceSettingsBuilder ConditionalFormatSettings(List<PivotFieldListConditionalFormatSetting> value)
Parameters
Returns
Cube(String)
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 PivotFieldListDataSourceSettingsBuilder Cube(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Type |
Name |
Description |
System.Action<Syncfusion.EJ2.DataManagerBuilder> |
dataSource |
|
Returns
DataSource(Object)
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 PivotFieldListDataSourceSettingsBuilder DataSource(object value)
Parameters
Type |
Name |
Description |
System.Object |
value |
|
Returns
DrilledMembers(Action<PivotFieldListDrilledMemberBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder DrilledMembers(Action<PivotFieldListDrilledMemberBuilder> drilledMembers)
Parameters
Returns
DrilledMembers(List<PivotFieldListDrilledMember>)
Allows specific fields used to display their the headers to be either expanded or collapsed in the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder DrilledMembers(List<PivotFieldListDrilledMember> value)
Parameters
Returns
EmptyCellsTextContent(String)
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 PivotFieldListDataSourceSettingsBuilder EmptyCellsTextContent(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
EnableSorting(Boolean)
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 PivotFieldListDataSourceSettingsBuilder EnableSorting(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ExcludeFields(String[])
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 PivotFieldListDataSourceSettingsBuilder ExcludeFields(string[] value)
Parameters
Type |
Name |
Description |
System.String[] |
value |
|
Returns
ExpandAll(Boolean)
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 PivotFieldListDataSourceSettingsBuilder ExpandAll(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
FieldMapping(Action<FieldMappingFieldListDataSourceBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder FieldMapping(Action<FieldMappingFieldListDataSourceBuilder> fieldMapping)
Parameters
Returns
FieldMapping(List<FieldMappingFieldListDataSource>)
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.
expandAll
: Allows you to expand or collapse all of the pivot table's headers for a specific field.
Declaration
public PivotFieldListDataSourceSettingsBuilder FieldMapping(List<FieldMappingFieldListDataSource> value)
Parameters
Returns
Filters(Action<FilterFieldListDataSourceBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder Filters(Action<FilterFieldListDataSourceBuilder> filters)
Parameters
Returns
Filters(List<FilterFieldListDataSource>)
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.
expandAll
: Allows you to expand or collapse all of the pivot table's headers for a specific field.
Declaration
public PivotFieldListDataSourceSettingsBuilder Filters(List<FilterFieldListDataSource> value)
Parameters
Returns
FilterSettings(Action<PivotFieldListFilterSettingBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder FilterSettings(Action<PivotFieldListFilterSettingBuilder> filterSettings)
Parameters
Returns
FilterSettings(List<PivotFieldListFilterSetting>)
Allows specific fields associated with either selective or conditional-based filter members that used to be displayed in the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder FilterSettings(List<PivotFieldListFilterSetting> value)
Parameters
Returns
Declaration
public PivotFieldListDataSourceSettingsBuilder FormatSettings(Action<PivotFieldListFormatSettingBuilder> formatSettings)
Parameters
Returns
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 PivotFieldListDataSourceSettingsBuilder FormatSettings(List<PivotFieldListFormatSetting> value)
Parameters
Returns
GrandTotalsPosition(GrandTotalsPosition)
Allows the grand totals to be displayed at the top or bottom of the pivot table's row and column axes.
By default, the grand totals are displayed at the bottom of the pivot table's row and column axes.
Declaration
public PivotFieldListDataSourceSettingsBuilder GrandTotalsPosition(GrandTotalsPosition value)
Parameters
Returns
GroupSettings(Action<PivotFieldListGroupSettingBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder GroupSettings(Action<PivotFieldListGroupSettingBuilder> groupSettings)
Parameters
Returns
GroupSettings(List<PivotFieldListGroupSetting>)
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 PivotFieldListDataSourceSettingsBuilder GroupSettings(List<PivotFieldListGroupSetting> value)
Parameters
Returns
LocaleIdentifier(Int32)
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 applicable only for OLAP data source.
Declaration
public PivotFieldListDataSourceSettingsBuilder LocaleIdentifier(int value)
Parameters
Type |
Name |
Description |
System.Int32 |
value |
|
Returns
Mode(RenderMode)
Allows to set the mode of rendering the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder Mode(RenderMode value)
Parameters
Returns
ProviderType(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 PivotFieldListDataSourceSettingsBuilder ProviderType(ProviderType value)
Parameters
Returns
Roles(String)
Allows you to assign multiple roles to the OLAP cube, separated by commas, each of which can access only restricted OLAP cube information such as measures, dimensions, and more that can be rendered in the pivot table.
It is applicable only for OLAP data source.
Declaration
public PivotFieldListDataSourceSettingsBuilder Roles(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
Rows(Action<PivotFieldListRowBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder Rows(Action<PivotFieldListRowBuilder> rows)
Parameters
Returns
Rows(List<PivotFieldListRow>)
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.
expandAll
: Allows you to expand or collapse all of the pivot table's headers for a specific field.
Declaration
public PivotFieldListDataSourceSettingsBuilder Rows(List<PivotFieldListRow> value)
Parameters
Returns
ShowAggregationOnValueField(Boolean)
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 PivotFieldListDataSourceSettingsBuilder ShowAggregationOnValueField(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ShowColumnGrandTotals(Boolean)
Allows to show or hide grand totals in column axis of the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ShowColumnGrandTotals(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ShowColumnSubTotals(Boolean)
Allows to show or hide sub-totals in column axis of the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ShowColumnSubTotals(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ShowGrandTotals(Boolean)
Allows to show or hide grand totals in both rows and columns axis of the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ShowGrandTotals(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
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 PivotFieldListDataSourceSettingsBuilder ShowHeaderWhenEmpty(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ShowRowGrandTotals(Boolean)
Allows to show or hide grand totals in row axis of the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ShowRowGrandTotals(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ShowRowSubTotals(Boolean)
Allows to show or hide sub-totals in row axis of the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ShowRowSubTotals(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
ShowSubTotals(Boolean)
Allows to show or hide sub-totals in both rows and columns axis of the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ShowSubTotals(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
SortSettings(Action<PivotFieldListSortSettingBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder SortSettings(Action<PivotFieldListSortSettingBuilder> sortSettings)
Parameters
Returns
SortSettings(List<PivotFieldListSortSetting>)
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 PivotFieldListDataSourceSettingsBuilder SortSettings(List<PivotFieldListSortSetting> value)
Parameters
Returns
SubTotalsPosition(SubTotalsPosition)
Allows the row and column sub-totals to be displayed at the top or bottom of the header group in the pivot table.
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.
Declaration
public PivotFieldListDataSourceSettingsBuilder SubTotalsPosition(SubTotalsPosition value)
Parameters
Returns
Type(DataSourceType)
Allows to define the data source type.
Declaration
public PivotFieldListDataSourceSettingsBuilder Type(DataSourceType value)
Parameters
Returns
Url(String)
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 PivotFieldListDataSourceSettingsBuilder Url(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
ValueAxis(String)
Allows you to set the value fields that to be plotted either in row or column axis in the pivot table.
Declaration
public PivotFieldListDataSourceSettingsBuilder ValueAxis(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
ValueIndex(Int32)
Allows you to display the value headers based on the index position in row or column axis in the pivot table.
By default, the value headers are displayed at last index position based on the valueAxis
property.
It is applicable only for relational data source.
Declaration
public PivotFieldListDataSourceSettingsBuilder ValueIndex(int value)
Parameters
Type |
Name |
Description |
System.Int32 |
value |
|
Returns
Values(Action<ValueFieldListDataSourceBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder Values(Action<ValueFieldListDataSourceBuilder> values)
Parameters
Returns
Values(List<ValueFieldListDataSource>)
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.
expandAll
: Allows you to expand or collapse all of the pivot table's headers for a specific field.
Declaration
public PivotFieldListDataSourceSettingsBuilder Values(List<ValueFieldListDataSource> value)
Parameters
Returns
ValueSortSettings(PivotFieldListValueSortSettings)
Allows to sort individual value field and its aggregated values either in row or column axis to ascending or descending order.
Declaration
public PivotFieldListDataSourceSettingsBuilder ValueSortSettings(PivotFieldListValueSortSettings value)
Parameters
Returns
ValueSortSettings(Action<PivotFieldListValueSortSettingsBuilder>)
Declaration
public PivotFieldListDataSourceSettingsBuilder ValueSortSettings(Action<PivotFieldListValueSortSettingsBuilder> valueSortSettings)
Parameters
Returns