Class PivotViewChartSettings

Inheritance
System.Object
EJTagHelper
PivotViewChartSettings
Inherited Members
Namespace: Syncfusion.EJ2.PivotView
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotViewChartSettings : EJTagHelper

Constructors

PivotViewChartSettings()

Declaration
public PivotViewChartSettings()

Properties

AccumulationSelectionMode

Allow options for customizing the selection mode to be done either by a specific series or point or cluster or by dragging it to the pivot chart. For example, to highlight a specific point in a specific series of the pivot chart, set the property accumulationSelectionMode to Point. It is applicable for chart types pie, funnel, doughnut and pyramid. The available modes are, none: Disables the selection. point: selects a point.

Declaration
public object AccumulationSelectionMode { get; set; }
Property Value
Type Description
System.Object

AnimationComplete

Declaration
public string AnimationComplete { get; set; }
Property Value
Type Description
System.String

AxisLabelRender

Declaration
public string AxisLabelRender { get; set; }
Property Value
Type Description
System.String

Background

Allows you to change the background color of the chart series in the pivot chart. For example, to display the chart series with background color as red, set the property background to either "red" or "#FF0000" or "rgba(255,0,0,1.0)".

Declaration
public string Background { get; set; }
Property Value
Type Description
System.String

BeforePrint

Declaration
public string BeforePrint { get; set; }
Property Value
Type Description
System.String

Border

Allow options to customize the border of the chart series such as color and border size in the pivot chart. For example, to display the chart series border color as red, set the properties color to either "red" or "#FF0000" or "rgba(255,0,0,1.0)" and width to 0.5.

Declaration
public PivotViewPivotChartSeriesBorder Border { get; set; }
Property Value
Type Description
PivotViewPivotChartSeriesBorder

ChartArea

Allow options to customize the chart area with a variety of settings such as background color, border, opacity and background image in the pivot chart. For example, to change the of the pivot chart's background, set the property opacity to 0.5.

Declaration
public PivotViewPivotChartSettingsChartArea ChartArea { get; set; }
Property Value
Type Description
PivotViewPivotChartSettingsChartArea

ChartMouseClick

Declaration
public string ChartMouseClick { get; set; }
Property Value
Type Description
System.String

ChartMouseDown

Declaration
public string ChartMouseDown { get; set; }
Property Value
Type Description
System.String

ChartMouseLeave

Declaration
public string ChartMouseLeave { get; set; }
Property Value
Type Description
System.String

ChartMouseMove

Declaration
public string ChartMouseMove { get; set; }
Property Value
Type Description
System.String

ChartMouseUp

Declaration
public string ChartMouseUp { get; set; }
Property Value
Type Description
System.String

ChartSeries

Allow options to customize the chart series with different settings such as fill color, animation of the series, series width, border, visibility of the series, opacity, chart series types, marker, tooltip, trendlines, etc., in the pivot chart. For example, to display the line type pivot chart, set the property type to Line.

Declaration
public PivotViewPivotSeries ChartSeries { get; set; }
Property Value
Type Description
PivotViewPivotSeries

ColumnDelimiter

Allows to specify the delimiter to split the column headers. The is applicable for pie, doughnut, funnel and pyramid chart types.

Declaration
public string ColumnDelimiter { get; set; }
Property Value
Type Description
System.String

ColumnHeader

Allows to specify the column whose values will be considered to draw the pivot chart. The is applicable for pie, doughnut, funnel and pyramid chart types.

Declaration
public string ColumnHeader { get; set; }
Property Value
Type Description
System.String

ContentTemplate

To get or set value for ContentTemplate.

Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type Description
MvcTemplate<System.Object>

Crosshair

Allow options to customize the crosshair line with different settings such as color and width of the line, line types that are shown horizontally and vertically to indicate the value of the axis at the mouse hover or touch position in the pivot chart.

Declaration
public PivotViewPivotChartSettingsCrosshairSettings Crosshair { get; set; }
Property Value
Type Description
PivotViewPivotChartSettingsCrosshairSettings

Description

Allows you to add a description of the pivot chart.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

DragComplete

Declaration
public string DragComplete { get; set; }
Property Value
Type Description
System.String

EnableAnimation

Allows you to enable/disable the tooltip animation while performing the mouse move from one point to another in the pivot chart.

Declaration
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean

EnableBorderOnMouseMove

Allows to Enable or disable the border in pie and doughnut chart while mouse moving.

Declaration
public bool EnableBorderOnMouseMove { get; set; }
Property Value
Type Description
System.Boolean

EnableCanvas

Allows you to render the pivot chart in canvas mode.

Declaration
public bool EnableCanvas { get; set; }
Property Value
Type Description
System.Boolean

EnableExport

Allows the pivot chart to be exported to either PDF or PNG or JPEG or SVG filter formats.

Declaration
public bool EnableExport { get; set; }
Property Value
Type Description
System.Boolean

EnableMultiAxis

It allows you to draw a pivot chart with multiple value fields as a single or stacked chart area. Use the multipleAxisMode enum options, either Stacked or Single, to show the chart area as either stacked or single based on value fields.

The enableMultiAxis property is deprecated and will no longer be used. Use enableMultipleAxis with to achieve the same.

Declaration
public bool EnableMultiAxis { get; set; }
Property Value
Type Description
System.Boolean

EnableMultipleAxis

It allows you to draw a pivot chart with multiple value fields as a single or stacked chart area. Use the multipleAxisMode enum options, either Stacked or Single, to show the chart area as either stacked or single based on value fields.

Declaration
public bool EnableMultipleAxis { get; set; }
Property Value
Type Description
System.Boolean

EnableScrollOnMultiAxis

Enable or disable scroll bar while multiple axis.

Declaration
public bool EnableScrollOnMultiAxis { get; set; }
Property Value
Type Description
System.Boolean

EnableSideBySidePlacement

Allows you to draw points of the column type pivot chart series as side by side.

Declaration
public bool EnableSideBySidePlacement { get; set; }
Property Value
Type Description
System.Boolean

EnableSmartLabels

Allows to set the labels placed smartly without overlapping. It is applicable for chart types pie, funnel, doughnut and pyramid.

Declaration
public bool EnableSmartLabels { get; set; }
Property Value
Type Description
System.Boolean

HighlightMode

Specifies whether point has to get highlighted or not. It is applicable for chart types pie, funnel, doughnut and pyramid. Takes value either 'None 'or 'Point'.

Declaration
public object HighlightMode { get; set; }
Property Value
Type Description
System.Object

HighlightPattern

Specifies whether series or data point for accumulation chart has to be selected. They are, none: sets none as selecting pattern to accumulation chart . chessboard: sets chess board as selecting pattern accumulation chart . dots: sets dots as selecting pattern accumulation chart . diagonalForward: sets diagonal forward as selecting pattern to accumulation chart . crosshatch: sets crosshatch as selecting pattern to accumulation chart. pacman: sets pacman selecting pattern to accumulation chart. diagonalbackward: sets diagonal backward as selecting pattern to accumulation chart. grid: sets grid as selecting pattern to accumulation chart. turquoise: sets turquoise as selecting pattern to accumulation chart. star: sets star as selecting pattern to accumulation chart. triangle: sets triangle as selecting pattern to accumulation chart. circle: sets circle as selecting pattern to accumulation chart. tile: sets tile as selecting pattern to accumulation chart. horizontaldash: sets horizontal dash as selecting pattern to accumulation chart. verticaldash: sets vertical dash as selecting pattern to accumulation chart. rectangle: sets rectangle as selecting pattern. box: sets box as selecting pattern to accumulation chart. verticalstripe: sets vertical stripe as selecting pattern to accumulation chart. horizontalstripe: sets horizontal stripe as selecting pattern to accumulation chart. bubble: sets bubble as selecting pattern to accumulation chart. It is applicable for chart types pie, funnel, doughnut and pyramid.

Declaration
public object HighlightPattern { get; set; }
Property Value
Type Description
System.Object

IsComplex

Declaration
protected override bool IsComplex { get; }
Property Value
Type Description
System.Boolean
Overrides

IsMultiSelect

Allows you to perform multiple selection in the pivot chart. To enable this option, it requires the property selectionMode to be Point or Series or Cluster.

Declaration
public bool IsMultiSelect { get; set; }
Property Value
Type Description
System.Boolean

IsTransposed

Allows you to render the pivot chart in a transposed manner or not.

Declaration
public bool IsTransposed { get; set; }
Property Value
Type Description
System.Boolean

LegendRender

Declaration
public string LegendRender { get; set; }
Property Value
Type Description
System.String

LegendSettings

Allow options for customizing legends with different properties such as legend visibility, height, width, position, legend padding, alignment, textStyle, border, margin, background, opacity, description, tabIndex in the pivot chart.

Declaration
public PivotViewPivotChartSettingsLegendSettings LegendSettings { get; set; }
Property Value
Type Description
PivotViewPivotChartSettingsLegendSettings

Load

Declaration
public string Load { get; set; }
Property Value
Type Description
System.String

Loaded

Declaration
public string Loaded { get; set; }
Property Value
Type Description
System.String

Margin

Allow options to customize the left, right, top and bottom margins of the pivot chart.

Declaration
public PivotViewPivotChartSettingsMargin Margin { get; set; }
Property Value
Type Description
PivotViewPivotChartSettingsMargin

MultiLevelLabelClick

Declaration
public string MultiLevelLabelClick { get; set; }
Property Value
Type Description
System.String

MultiLevelLabelRender

Declaration
public string MultiLevelLabelRender { get; set; }
Property Value
Type Description
System.String

MultipleAxisMode

Allows the chart series to be displayed, depending on the value fields specified, in either a stacked or single chart area. The options available are: Stacked: Allows the chart series to be displayed in a separate chart area depending on the value fields specified. Single: Allows the chart series to be displayed in a single chart area for different value fields.

Declaration
public MultipleAxisMode MultipleAxisMode { get; set; }
Property Value
Type Description
MultipleAxisMode

Palettes

Allows you to draw the chart series points with custom color in the pivot chart.

Declaration
public string[] Palettes { get; set; }
Property Value
Type Description
System.String[]

ParentPropertyName

Declaration
protected override string ParentPropertyName { get; }
Property Value
Type Description
System.String
Overrides

PieCenter

Allow options to customize the center of pie series chart with properties x and y.

Declaration
public PivotViewPivotPieChartCenter PieCenter { get; set; }
Property Value
Type Description
PivotViewPivotPieChartCenter

PointClick

Declaration
public string PointClick { get; set; }
Property Value
Type Description
System.String

PointMove

Declaration
public string PointMove { get; set; }
Property Value
Type Description
System.String

PointRender

Declaration
public string PointRender { get; set; }
Property Value
Type Description
System.String

PrimaryXAxis

Allow options to customize the horzontal(row) axis with different properties such as labelIntersectAction, labelStyle, title, description, crosshairTooltip, labelFormat, titleStyle, plotOffset, edgeLabelPlacement, labelPlacement, tickPosition, opposedPosition, minor and major grid lines, minor and major tick lines, border, etc. in the pivot chart.

Declaration
public PivotViewPivotAxis PrimaryXAxis { get; set; }
Property Value
Type Description
PivotViewPivotAxis

PrimaryYAxis

Allow options to customize the vertical(value) axis with different properties such as labelIntersectAction, labelStyle, title, description, crosshairTooltip, labelFormat, titleStyle, plotOffset, edgeLabelPlacement, labelPlacement, tickPosition, opposedPosition, minor and major grid lines, minor and major tick lines, border, etc. in the pivot chart.

Declaration
public PivotViewPivotAxis PrimaryYAxis { get; set; }
Property Value
Type Description
PivotViewPivotAxis

Resized

Declaration
public string Resized { get; set; }
Property Value
Type Description
System.String

ScrollChanged

Declaration
public string ScrollChanged { get; set; }
Property Value
Type Description
System.String

ScrollEnd

Declaration
public string ScrollEnd { get; set; }
Property Value
Type Description
System.String

ScrollStart

Declaration
public string ScrollStart { get; set; }
Property Value
Type Description
System.String

SelectedDataIndexes

Allows you to highlight a specific point of the series while rendering the pivot chart. For example, to highlight first point in the first series, set the properties series to 0 and points to 1. To use this option, it requires the property selectionMode to be Point or Series.

Declaration
public PivotViewPivotChartSettingsIndexes SelectedDataIndexes { get; set; }
Property Value
Type Description
PivotViewPivotChartSettingsIndexes

SelectionMode

Allow options for customizing the selection mode to be done either by a specific series or point or cluster or by dragging it to the pivot chart. For example, to highlight a specific point in a specific series of the pivot chart, set the property selectionMode to Point. The available modes are, none: Disables the selection. series: selects a series. dragXY: selects points by dragging with respect to both horizontal and vertical axes dragX: selects points by dragging with respect to horizontal axis. dragY: selects points by dragging with respect to vertical axis. point: selects a point. cluster: selects a cluster of point

Declaration
public ChartSelectionMode SelectionMode { get; set; }
Property Value
Type Description
ChartSelectionMode

SeriesRender

Declaration
public string SeriesRender { get; set; }
Property Value
Type Description
System.String

ShowMultiLevelLabels

Allows you to display the multi-level label feature in the pivot chart. This multi-level labels used to perform drill operation in the pivot chart.

Declaration
public bool ShowMultiLevelLabels { get; set; }
Property Value
Type Description
System.Boolean

SubTitle

Allows you to add the subtitle to the pivot chart.

Declaration
public string SubTitle { get; set; }
Property Value
Type Description
System.String

SubTitleStyle

Allow options to customize the subtitle in the pivot chart with different properties such as fontStyle, font size, fontWeight, font color, testAlignment, fontFamily, opacity, textOverflow.

Declaration
public PivotViewPivotChartAxisFont SubTitleStyle { get; set; }
Property Value
Type Description
PivotViewPivotChartAxisFont

TabIndex

Allows you to highlight specific legends by clicking the mouse or by interacting with the keyboard in the pivot chart.

Declaration
public double TabIndex { get; set; }
Property Value
Type Description
System.Double

TextRender

Declaration
public string TextRender { get; set; }
Property Value
Type Description
System.String

Theme

Allows you to draw a pivot chart with either material, fabric, bootstrap, highcontrast light, material dark, fabric dark, highcontrast, bootstrap dark, bootstrap4 theme.

Declaration
public object Theme { get; set; }
Property Value
Type Description
System.Object

Title

Allows you to add title to the pivot chart.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

TitleStyle

Allow options to customize the title in the pivot chart with different properties such as fontStyle, font size, fontWeight, font color, testAlignment, fontFamily, opacity, textOverflow.

Declaration
public PivotViewPivotChartAxisFont TitleStyle { get; set; }
Property Value
Type Description
PivotViewPivotChartAxisFont

Tooltip

Allow options to customize the tooltip of the pivot chart with different properties such as visibility of the tooltip, enableMarker, fill color, opacity, header for tooltip, format, textStyle, template, border, enableAnimation.

Declaration
public PivotViewPivotTooltipSettings Tooltip { get; set; }
Property Value
Type Description
PivotViewPivotTooltipSettings

TooltipRender

Declaration
public string TooltipRender { get; set; }
Property Value
Type Description
System.String

UseGroupingSeparator

Allows the group separator to be shown to the values in the pivot chart.

Declaration
public bool UseGroupingSeparator { get; set; }
Property Value
Type Description
System.Boolean

Value

Allows you to draw a pivot chart with a specific value field during initial loading.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

ZoomComplete

Declaration
public string ZoomComplete { get; set; }
Property Value
Type Description
System.String

ZoomSettings

Allow options to customize the pivot chart zooming with different properties such as enablePinchZooming, enableSelectionZooming, enableDeferredZooming, enableMouseWheelZooming, zoom modes, toolbarItems, enableScrollbar and enablePan.

Declaration
public PivotViewPivotZoomSettings ZoomSettings { get; set; }
Property Value
Type Description
PivotViewPivotZoomSettings