Defines the fluent API for configuring the Telerik UI PivotGridV2 for ASP.NET MVC.
Definition
Namespace:Kendo.Mvc.UI.Fluent
Assembly:Kendo.Mvc.dll
Type Parameters:
TModel
Syntax:
public class PivotGridV2Builder<TModel> : WidgetBuilderBase<PivotGridV2<TModel>, PivotGridV2Builder<TModel>>, IHtmlString where TModel : class
Inheritance: objectWidgetBuilderBase<PivotGridV2<TModel>, PivotGridV2Builder<TModel>>PivotGridV2Builder<TModel>
Implements:
Inherited Members
Constructors
Initializes a new instance of the PivotGridV2 class.
public PivotGridV2Builder(PivotGridV2<TModel> component)
The component.
Methods
If set to "false", the PivotGridV2 will not bind to the DataSource during initialization. In this case, the data binding will occur when the Change event of the DataSource fires. By default the PivotGridV2 will bind to its DataSource specified in the configuration.
public PivotGridV2Builder<TModel> AutoBind(bool value)
The value that configures the AutoBind option.
Returns:PivotGridV2Builder<TModel>
Binds the PivotGridV2 to a collection of objects (local data).
public PivotGridV2Builder<TModel> BindTo(IEnumerable<TModel> dataSource)
The IEnumerable collection that contains the data.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the column header cell. By default, the column header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding column header cell.
- tuple: The tuple of the corresponding column header cell.
public PivotGridV2Builder<TModel> ColumnHeaderTemplate(string value)
The value that configures the column header template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the column header cell. By default, the column header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding column header cell.
- tuple: The tuple of the corresponding column header cell.
public PivotGridV2Builder<TModel> ColumnHeaderTemplateHandler(string value)
The JavaScript function that will return the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the column header cell. By default, the column header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding column header cell.
- tuple: The tuple of the corresponding column header cell.
public PivotGridV2Builder<TModel> ColumnHeaderTemplateId(string value)
The "id" of the external Kendo UI template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the column header cell. By default, the column header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding column header cell.
- tuple: The tuple of the corresponding column header cell.
public PivotGridV2Builder<TModel> ColumnHeaderTemplateView(MvcHtmlString value)
The Razor View that will render the template content.
Returns:PivotGridV2Builder<TModel>
Defines the width of the table columns. The value is treated as pixels.
public PivotGridV2Builder<TModel> ColumnWidth(double value)
The value that configures the width of the table columns.
Returns:PivotGridV2Builder<TModel>
Defines the PivotConfiguratorV2.
public PivotGridV2Builder<TModel> Configurator(string configurator)
The Name() option of the PivotConfiguratorV2.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the data cell. By default, the data cell renders the formatted value (fmtValue) of the data item. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> DataCellTemplate(string value)
The value that configures the data cell template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the data cell. By default, the data cell renders the formatted value (fmtValue) of the data item. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> DataCellTemplateHandler(string value)
The JavaScript function that will return the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the data cell. By default, the data cell renders the formatted value (fmtValue) of the data item. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> DataCellTemplateId(string value)
The "id" of the external Kendo UI template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the data cell. By default, the data cell renders the formatted value (fmtValue) of the data item. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> DataCellTemplateView(MvcHtmlString value)
The Razor View that will render the template content.
Returns:PivotGridV2Builder<TModel>
Sets the DataSource configuration of the grid.
public PivotGridV2Builder<TModel> DataSource(Action<PivotDataSourceV2Builder<TModel>> configurator)
The lambda that configures the DataSource settings.
Returns:PivotGridV2Builder<TModel>
Sets an existing DataSource as a DataSource of the PivotGridV2.
public PivotGridV2Builder<TModel> DataSource(string dataSourceId)
The name of the existing DataSource.
Returns:PivotGridV2Builder<TModel>
Configures the handled client-side events of the PivotGridV2.
public PivotGridV2Builder<TModel> Events(Action<PivotGridV2EventBuilder> configurator)
The action that configures the available events.
Returns:PivotGridV2Builder<TModel>
Configures the PivotGridV2 Excel export settings.
public PivotGridV2Builder<TModel> Excel(Action<PivotGridV2ExcelSettingsBuilder<TModel>> configurator)
The action that configures the Excel export settings.
Returns:PivotGridV2Builder<TModel>
The height of the PivotGridV2. The value is treated as pixels.
public PivotGridV2Builder<TModel> Height(double value)
The value that configures the height.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Status value. By default, the KPI Status value is rendered through "open", "hold" and "denied" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiStatusTemplate(string value)
The value that configures the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Status value. By default, the KPI Status value is rendered through "open", "hold" and "denied" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiStatusTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Status value. By default, the KPI Status value is rendered through "open", "hold" and "denied" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiStatusTemplateHandler(string templateHandler)
The JavaScript function that will return the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Status value. By default, the KPI Status value is rendered through "open", "hold" and "denied" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiStatusTemplateId(string templateId)
The "id" of the external Kendo UI template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Status value. By default, the KPI Status value is rendered through "open", "hold" and "denied" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiStatusTemplateView(MvcHtmlString value)
The Razor View that will render the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Trend value. By default, the KPI Trend value is rendered through "increase", "decrease" and "equal" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiTrendTemplate(string value)
The value that configures the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Trend value. By default, the KPI Trend value is rendered through "increase", "decrease" and "equal" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiTrendTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Trend value. By default, the KPI Trend value is rendered through "increase", "decrease" and "equal" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiTrendTemplateHandler(string templateHandler)
The JavaScript function that will return the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Trend value. By default, the KPI Trend value is rendered through "increase", "decrease" and "equal" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiTrendTemplateId(string templateId)
The "id" of the external Kendo UI template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the KPI Trend value. By default, the KPI Trend value is rendered through "increase", "decrease" and "equal" status icons. The available fields 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.
- dataItem: The data item itself.
public PivotGridV2Builder<TModel> KpiTrendTemplateView(MvcHtmlString value)
The Razor View that will render the template content.
Returns:PivotGridV2Builder<TModel>
If set to "true", the user could navigate the component by using the keyboard navigation. By default, keyboard navigation is disabled.
public PivotGridV2Builder<TModel> Navigatable(bool value)
The value that configures the Navigatable option.
Returns:PivotGridV2Builder<TModel>
Configures the PivotGridV2 PDF PDF export settings.
public PivotGridV2Builder<TModel> Pdf(Action<PivotGridV2PdfSettingsBuilder> configurator)
The action that configures the PDF export settings.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the row header cell. By default, the row header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding row header cell.
- tuple: The tuple of the corresponding row header cell.
public PivotGridV2Builder<TModel> RowHeaderTemplate(string value)
The value that configures the row header template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the row header cell. By default, the row header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding row header cell.
- tuple: The tuple of the corresponding row header cell.
public PivotGridV2Builder<TModel> RowHeaderTemplateHandler(string value)
The JavaScript function that will return the template content.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the row header cell. By default, the row header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding row header cell.
- tuple: The tuple of the corresponding row header cell.
public PivotGridV2Builder<TModel> RowHeaderTemplateId(string value)
The "id" of the external Kendo UI template.
Returns:PivotGridV2Builder<TModel>
Defines the template that renders the content of the row header cell. By default, the row header cell renders the caption of the tuple member. The available fields in the template are:
- member: The member of the corresponding row header cell.
- tuple: The tuple of the corresponding row header cell.
public PivotGridV2Builder<TModel> RowHeaderTemplateView(MvcHtmlString value)
The Razor View that will render the template content.
Returns:PivotGridV2Builder<TModel>