PivotGridV2Builder
Properties
WriteAction - Func
Methods
DataSource(System.Action)
Sets the DataSource configuration of the grid.
Parameters
configurator - System.Action<PivotDataSourceV2Builder>
The lambda that configures the DataSource settings.
RETURNS
Returns the current PivotGridV2Builder instance.
Example
@(Html.Kendo().PivotGridV2()
.Name("pivotgrid")
.DataSource(dataSource => dataSource.Xmla()
.Columns(columns => {
columns.Add("[Product].[Category]");
})
.Rows(rows => rows.Add("[Geography].[City]"))
.Measures(measures => measures.Values(new string[]{"[Measures].[Reseller Freight Cost]"}))
.Transport(transport => transport
.Connection(connection => connection
.Catalog("Adventure Works DW 2008R2")
.Cube("Adventure Works"))
.Read("https://demos.telerik.com/service/v2/olap/msmdpump.dll")
)
)
)
DataSource(System.String)
Sets an existing DataSource as a DataSource of the PivotGridV2.
Parameters
dataSourceId - System.String
The name of the existing DataSource.
RETURNS
Returns the current PivotGridV2Builder instance.
Example
@(Html.Kendo().PivotGridV2()
.Name("pivotgrid")
.DataSource("externalDS")
)
Configurator(System.String)
Defines the PivotConfiguratorV2.
Parameters
configurator - System.String
The Name() option of the PivotConfiguratorV2.
RETURNS
Returns the current PivotGridV2Builder instance.
Example
@(Html.Kendo().PivotConfiguratorV2()
.Name("configurator")
.Sortable()
.Filterable()
.Height(570)
)
@(Html.Kendo().PivotGridV2()
.Name("pivotgrid")
.Configurator("#configurator")
)
BindTo(System.Collections.Generic.IEnumerable)
Binds the PivotGridV2 to a collection of objects (local data).
Parameters
dataSource - System.Collections.Generic.IEnumerable<T>
The IEnumerable collection that contains the data.
RETURNS
Returns the current PivotGridV2Builder instance.
Example
@model IEnumerable<ProductViewModel>
@(Html.Kendo().PivotGridV2<ProductViewModel>()
.Name("pivotgrid")
.BindTo(Model)
)
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
RETURNS
Returns the current PivotGridV2Builder instance.
Navigatable(System.Boolean)
If set to true the user could navigate the component using the keyboard navigation. By default keyboard navigation is disabled.
Parameters
value - System.Boolean
The value for Navigatable
RETURNS
Returns the current PivotGridV2Builder instance.
Navigatable()
If set to true the user could navigate the component using the keyboard navigation. By default keyboard navigation is disabled.
RETURNS
Returns the current PivotGridV2Builder instance.
Excel(System.Action)
Configures the Kendo UI PivotGridV2 Excel export settings.
Parameters
configurator - System.Action<PivotGridV2ExcelSettingsBuilder>
The configurator for the excel setting.
RETURNS
Returns the current instance of PivotGridV2Builder .
Pdf(System.Action)
Configures the Kendo UI PivotGridV2 PDF export settings.
Parameters
configurator - System.Action<PivotGridV2PdfSettingsBuilder>
The configurator for the pdf setting.
RETURNS
Returns the current instance of PivotGridV2Builder .
ColumnWidth(System.Double)
The width of the table columns. Value is treated as pixels.
Parameters
value - System.Double
The value for ColumnWidth
RETURNS
Returns the current PivotGridV2Builder instance.
Height(System.Double)
The height of the PivotGridV2. Numeric values are treated as pixels.
Parameters
value - System.Double
The value for Height
RETURNS
Returns the current PivotGridV2Builder instance.
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
RETURNS
Returns the current PivotGridV2Builder instance.
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
RETURNS
Returns the current PivotGridV2Builder instance.
ColumnHeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
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
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for ColumnHeaderTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
ColumnHeaderTemplateHandler(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
templateHandler - System.String
The handler that returs the template for ColumnHeaderTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
ColumnHeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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
template - TemplateBuilder<TModel>
A Template component that configures the columnheadertemplate.
RETURNS
Returns the current PivotGridV2Builder instance.
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
RETURNS
Returns the current PivotGridV2Builder instance.
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
RETURNS
Returns the current PivotGridV2Builder instance.
DataCellTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
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
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for DataCellTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
DataCellTemplateHandler(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
templateHandler - System.String
The handler that returs the template for DataCellTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
DataCellTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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
template - TemplateBuilder<TModel>
A Template component that configures the datacelltemplate.
RETURNS
Returns the current PivotGridV2Builder instance.
KpiStatusTemplate(System.String)
The template which renders the content of the KPI Status value. By default renders "open", "hold" and "denied" status icons.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.
Parameters
value - System.String
The value for KpiStatusTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiStatusTemplateId(System.String)
The template which renders the content of the KPI Status value. By default renders "open", "hold" and "denied" status icons.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.
Parameters
templateId - System.String
The ID of the template element for KpiStatusTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiStatusTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the content of the KPI Status value. By default renders "open", "hold" and "denied" status icons.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.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for KpiStatusTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiStatusTemplateHandler(System.String)
The template which renders the content of the KPI Status value. By default renders "open", "hold" and "denied" status icons.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.
Parameters
templateHandler - System.String
The handler that returs the template for KpiStatusTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiStatusTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the content of the KPI Status value. By default renders "open", "hold" and "denied" status icons.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.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the kpistatustemplate.
RETURNS
Returns the current PivotGridV2Builder instance.
KpiTrendTemplate(System.String)
The template which renders the content of the KPI Trend value. By default renders "increase", "decrease" and "equal" status icons.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.
Parameters
value - System.String
The value for KpiTrendTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiTrendTemplateId(System.String)
The template which renders the content of the KPI Trend value. By default renders "increase", "decrease" and "equal" status icons.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.
Parameters
templateId - System.String
The ID of the template element for KpiTrendTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiTrendTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the content of the KPI Trend value. By default renders "increase", "decrease" and "equal" status icons.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.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for KpiTrendTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiTrendTemplateHandler(System.String)
The template which renders the content of the KPI Trend value. By default renders "increase", "decrease" and "equal" status icons.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.
Parameters
templateHandler - System.String
The handler that returs the template for KpiTrendTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
KpiTrendTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the content of the KPI Trend value. By default renders "increase", "decrease" and "equal" status icons.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.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the kpitrendtemplate.
RETURNS
Returns the current PivotGridV2Builder instance.
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
RETURNS
Returns the current PivotGridV2Builder instance.
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
RETURNS
Returns the current PivotGridV2Builder instance.
RowHeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
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
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for RowHeaderTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
RowHeaderTemplateHandler(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
templateHandler - System.String
The handler that returs the template for RowHeaderTemplate
RETURNS
Returns the current PivotGridV2Builder instance.
RowHeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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
template - TemplateBuilder<TModel>
A Template component that configures the rowheadertemplate.
RETURNS
Returns the current PivotGridV2Builder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<PivotGridV2EventBuilder>
The client events action.
RETURNS
Returns the current PivotGridV2Builder instance.
Example
@(Html.Kendo().PivotGridV2()
.Name("PivotGridV2")
.Events(events => events
.DataBinding("onDataBinding")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.