New to Telerik UI for ASP.NET Core? Download free 30-day trial

PivotGridBuilder

Defines the fluent API for configuring the Kendo UI PivotGrid

Properties

WriteAction - Func

Methods

Configurator(System.String)

Use it to set the Id of the PivotConfigurator.

Parameters

configurator - System.String

The configurator

DataSource(System.Action)

Sets the data source configuration of the grid.

Parameters

configurator - System.Action<PivotDataSourceBuilder>

The lambda which configures the data source

DataSource(System.String)

Parameters

dataSourceId - System.String

BindTo(System.Collections.Generic.IEnumerable)

Binds the pivotGrid to a list of objects

Parameters

dataSource - System.Collections.Generic.IEnumerable<T>

The data source.

Messages(System.Action)

Sets the messages of the pivotGrid.

Parameters

addViewAction - System.Action<PivotGridMessagesBuilder>

The lambda which configures the pivotGrid messages

KPIStatusTemplate(System.String)

Sets the KPI Status template of the pivot grid.

Parameters

template - System.String

The template

Example

 ")
                  .DataSource(dataSource =>
                    dataSource.Xmla()
                       .Columns(columns => columns.Add("[Date].[Calendar]").Expand(true))
                       .Rows(rows => rows.Add("[Geography].[City]"))
                       .Measures(measures => measures.Values(new string[]{"[Measures].[Internet Sales Amount]"}))
                       .Transport(transport => transport
                           .Connection(connection => connection
                               .Catalog("Adventure Works DW 2008R2")
                               .Cube("Adventure Works"))
                           .Read(read => read
                               .Url("http://demos.telerik.com/olap/msmdpump.dll")
                               .DataType("text")
                               .ContentType("text/xml")
                               .Type(HttpVerbs.Post)
                           )
                       )
                   )
               )

KPIStatusTemplateId(System.String)

Sets the KPI Status template of the pivot grid.

Parameters

templateId - System.String

The template id

Example


            @(Html.Kendo().PivotGrid()
                  .Name("pivotgrid")
                  .KPIStatusTemplateId("kpiStatusTemplateId")
                  .DataSource(dataSource =>
                    dataSource.Xmla()
                       .Columns(columns => columns.Add("[Date].[Calendar]").Expand(true))
                       .Rows(rows => rows.Add("[Geography].[City]"))
                       .Measures(measures => measures.Values(new string[]{"[Measures].[Internet Sales Amount]"}))
                       .Transport(transport => transport
                           .Connection(connection => connection
                               .Catalog("Adventure Works DW 2008R2")
                               .Cube("Adventure Works"))
                           .Read(read => read
                               .Url("http://demos.telerik.com/olap/msmdpump.dll")
                               .DataType("text")
                               .ContentType("text/xml")
                               .Type(HttpVerbs.Post)
                           )
                       )
                   )
               )

KPITrendTemplate(System.String)

Sets the KPI Trend template of the pivot grid.

Parameters

template - System.String

The template

Example

 ")
                  .DataSource(dataSource =>
                    dataSource.Xmla()
                       .Columns(columns => columns.Add("[Date].[Calendar]").Expand(true))
                       .Rows(rows => rows.Add("[Geography].[City]"))
                       .Measures(measures => measures.Values(new string[]{"[Measures].[Internet Sales Amount]"}))
                       .Transport(transport => transport
                           .Connection(connection => connection
                               .Catalog("Adventure Works DW 2008R2")
                               .Cube("Adventure Works"))
                           .Read(read => read
                               .Url("http://demos.telerik.com/olap/msmdpump.dll")
                               .DataType("text")
                               .ContentType("text/xml")
                               .Type(HttpVerbs.Post)
                           )
                       )
                   )
               )

KPITrendTemplateId(System.String)

Sets the KPI Trend template of the pivot grid.

Parameters

templateId - System.String

The template id

Example


            @(Html.Kendo().PivotGrid()
                  .Name("pivotgrid")
                  .KPITrendTemplateId("kpiTrendTemplateId")
                  .DataSource(dataSource =>
                    dataSource.Xmla()
                       .Columns(columns => columns.Add("[Date].[Calendar]").Expand(true))
                       .Rows(rows => rows.Add("[Geography].[City]"))
                       .Measures(measures => measures.Values(new string[]{"[Measures].[Internet Sales Amount]"}))
                       .Transport(transport => transport
                           .Connection(connection => connection
                               .Catalog("Adventure Works DW 2008R2")
                               .Cube("Adventure Works"))
                           .Read(read => read
                               .Url("http://demos.telerik.com/olap/msmdpump.dll")
                               .DataType("text")
                               .ContentType("text/xml")
                               .Type(HttpVerbs.Post)
                           )
                       )
                   )
               )

AutoBind(System.Boolean)

If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.

Parameters

value - System.Boolean

The value for AutoBind

Reorderable(System.Boolean)

If set to false the user will not be able to add/close/reorder current fields for columns/rows/measures.

Parameters

value - System.Boolean

The value for Reorderable

Excel(System.Action)

Configures the Kendo UI PivotGrid Excel export settings.

Parameters

configurator - System.Action<PivotGridExcelSettingsBuilder>

The configurator for the excel setting.

Pdf(System.Action)

Configures the Kendo UI PivotGrid PDF export settings.

Parameters

configurator - System.Action<PivotGridPdfSettingsBuilder>

The configurator for the pdf setting.

Filterable(System.Boolean)

If set to true the user will be able to filter by using the field menu.

Parameters

value - System.Boolean

The value for Filterable

Filterable()

If set to true the user will be able to filter by using the field menu.

Sortable(System.Action)

If set to true the user could sort the pivotgrid by clicking the dimension fields. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.

Parameters

configurator - System.Action<PivotGridSortableSettingsBuilder>

The configurator for the sortable setting.

Sortable()

If set to true the user could sort the pivotgrid by clicking the dimension fields. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.

Sortable(System.Boolean)

If set to true the user could sort the pivotgrid by clicking the dimension fields. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.

Parameters

enabled - System.Boolean

Enables or disables the sortable option.

ColumnWidth(System.Double)

The width of the table columns. Value is treated as pixels.

Parameters

value - System.Double

The value for ColumnWidth

Height(System.Double)

The height of the PivotGrid. Numeric values are treated as pixels.

Parameters

value - System.Double

The value for Height

ColumnHeaderTemplate(System.String)

The template which renders the content of the column header cell. By default it renders the caption of the tuple member.The fields which can be used in the template are: member - the member of the corresponding column header cell or tuple - the tuple of the corresponding column header cell. For information about the tuple structure check this link.

Parameters

value - System.String

The value for ColumnHeaderTemplate

ColumnHeaderTemplateId(System.String)

The template which renders the content of the column header cell. By default it renders the caption of the tuple member.The fields which can be used in the template are: member - the member of the corresponding column header cell or tuple - the tuple of the corresponding column header cell. For information about the tuple structure check this link.

Parameters

templateId - System.String

The ID of the template element for ColumnHeaderTemplate

DataCellTemplate(System.String)

The template which renders the content of the data cell. By default renders the formatted value (fmtValue) of the data item.The fields which can be used in the template are: columnTuple - the tuple of the corresponding column header cell; rowTuple - the tuple of the corresponding row header cell; measure - the value of the data cell measure or dataItem - the data item itself. For information about the tuple structure check this link. About the data item structure review this help topic.

Parameters

value - System.String

The value for DataCellTemplate

DataCellTemplateId(System.String)

The template which renders the content of the data cell. By default renders the formatted value (fmtValue) of the data item.The fields which can be used in the template are: columnTuple - the tuple of the corresponding column header cell; rowTuple - the tuple of the corresponding row header cell; measure - the value of the data cell measure or dataItem - the data item itself. For information about the tuple structure check this link. About the data item structure review this help topic.

Parameters

templateId - System.String

The ID of the template element for DataCellTemplate

RowHeaderTemplate(System.String)

The template which renders the content of the row header cell. By default it renders the caption of the tuple member.The fields which can be used in the template are: member - the member of the corresponding row header cell or tuple - the tuple of the corresponding row header cell. For information about the tuple structure check this link.

Parameters

value - System.String

The value for RowHeaderTemplate

RowHeaderTemplateId(System.String)

The template which renders the content of the row header cell. By default it renders the caption of the tuple member.The fields which can be used in the template are: member - the member of the corresponding row header cell or tuple - the tuple of the corresponding row header cell. For information about the tuple structure check this link.

Parameters

templateId - System.String

The ID of the template element for RowHeaderTemplate

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<PivotGridEventBuilder>

The client events action.

Example


            @(Html.Kendo().PivotGrid()
                  .Name("PivotGrid")
                  .Events(events => events
                      .DataBinding("onDataBinding")
                  )
            )

ToComponent()

Returns the internal view component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

Render()

Renders the component in place.

ToHtmlString()

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

In this article
Not finding the help you need?