menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotChartSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PivotChartSettings

    Allows a set of options to customize a pivot chart with a variety of settings, such as chart series, chart area, axis labels, legends, border, crosshairs, theme, title, tooltip, zooming, etc. The following options are available to customize the pivot chart.

    • 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)"**.
    • 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 to0.5.
    • 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.
    • 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**.
    • 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.
    • description: Allows you to add a description of the pivot chart.
    • enableAnimation: Allows you to enable/disable the tooltip animation while performing the mouse move from one point to another in the pivot chart.
    • enableExport: Allows the pivot chart to be exported to either** PDF** or** PNG** or** JPEG** or** SVG** filter formats.
    • enableMultipleAxis: Allows you to draw the pivot chart with multiple value fields as separate chart area.
    • enableSideBySidePlacement: Allows you to draw points of the column type pivot chart series as side by side.
    • 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.
    • isTransposed: Allows you to render the pivot chart in a transposed manner or not.
    • 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.
    • margin: Allow options to customize the left, right, top and bottom margins of the pivot chart.
    • palettes: Allows you to draw the chart series points with custom color in the pivot chart.
    • 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.
    • 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.
    • 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.
    • 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**.
    • 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.
    • subTitle: Allows you to add the subtitle to the pivot chart.
    • 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.
    • tabIndex: Allows you to highlight specific legends by clicking the mouse or by interacting with the keyboard in the pivot chart.
    • theme: Allows you to draw a pivot chart with either material, fabric, bootstrap, highcontrast light, material dark, fabric dark, highcontrast, bootstrap dark, bootstrap4 theme.
    • title: Allows you to add title to the pivot chart.
    • 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.
    • 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.
    • useGroupingSeparator: Allows the group separator to be shown to the values in the pivot chart.
    • value: Allows you to draw a pivot chart with a specific value field during initial loading.
    • zoomSettings: Allow options to customize the pivot chart zooming with different properties such as enablePinchZooming, enableSelectionZooming, enableDeferredZooming, enableMouseWheelZooming, zoom modes, toolbarItems, enableScrollbar and enablePan.
    Inheritance
    System.Object
    PivotChartSettings
    Namespace: Syncfusion.Blazor.PivotView
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class PivotChartSettings : OwningComponentBase

    Constructors

    PivotChartSettings()

    Declaration
    public PivotChartSettings()

    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 SelectionMode to Point. The available modes are, none: Disables the selection. point: selects a point.

    Declaration
    public PivotAccumulationChartSelectionMode AccumulationSelectionMode { get; set; }
    Property Value
    Type
    PivotAccumulationChartSelectionMode

    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
    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 PivotChartBorder Border { get; set; }
    Property Value
    Type
    PivotChartBorder

    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 PivotChartAreaSettings ChartArea { get; set; }
    Property Value
    Type
    PivotChartAreaSettings

    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 PivotChartSeries ChartSeries { get; set; }
    Property Value
    Type
    PivotChartSeries

    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
    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
    System.String

    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 PivotChartCrosshairSettings Crosshair { get; set; }
    Property Value
    Type
    PivotChartCrosshairSettings

    Description

    Allows you to add a description of the pivot chart.

    Declaration
    public string Description { get; set; }
    Property Value
    Type
    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
    System.Boolean

    EnableBorderOnMouseMove

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

    Declaration
    public bool EnableBorderOnMouseMove { get; set; }
    Property Value
    Type
    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
    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 Grouped, to show the chart area as either stacked or single based on value fields.

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

    EnableScrollOnMultiAxis

    Enable or disable scroll bar while multiple axis.

    Declaration
    public bool EnableScrollOnMultiAxis { get; set; }
    Property Value
    Type
    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
    System.Boolean

    EnableSmartLabels

    Allows to set the labels placed smartly without overlapping.

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

    HighLightMode

    Specifies whether point has to get highlighted or not. Takes value either 'None 'or 'Point'.

    Declaration
    public PivotAccumulationChartSelectionMode HighLightMode { get; set; }
    Property Value
    Type
    PivotAccumulationChartSelectionMode

    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.

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

    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
    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
    System.Boolean

    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 PivotChartLegendSettings LegendSettings { get; set; }
    Property Value
    Type
    PivotChartLegendSettings

    Margin

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

    Declaration
    public PivotChartMarginSettings Margin { get; set; }
    Property Value
    Type
    PivotChartMarginSettings

    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 with separate Y-axes for each value field.
    Combined - Allows to draw chart series with a single Y-axis for all value fields in the pivot chart area. These chart series will be drawn based on the Y-axis range values calculated from all of the bound value fields.

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

    MultipleAxisModeChanged

    Gets or sets a callback of the bound value.

    Declaration
    public EventCallback<MultipleAxisMode> MultipleAxisModeChanged { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<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
    System.String[]

    PieCenter

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

    Declaration
    public PivotPieChartCenter PieCenter { get; set; }
    Property Value
    Type
    PivotPieChartCenter

    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 PivotChartPrimaryXAxis PrimaryXAxis { get; set; }
    Property Value
    Type
    PivotChartPrimaryXAxis

    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 PivotChartPrimaryYAxis PrimaryYAxis { get; set; }
    Property Value
    Type
    PivotChartPrimaryYAxis

    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 List<PivotChartIndexes> SelectedDataIndexes { get; set; }
    Property Value
    Type
    System.Collections.Generic.List<PivotChartIndexes>

    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
    ChartSelectionMode

    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
    System.Boolean

    ShowPointColorByMembers

    Gets or sets a boolean value to display data points in different colors in multiple charts. The multiple charts are actually drawn as a result of the "n" of measures bound in the datasource.

    It is only applicable when the EnableMultipleAxis property is enabled and the MultipleAxisMode property is set to MultipleAxisMode.Stacked.

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

    SubTitle

    Allows you to add the subtitle to the pivot chart.

    Declaration
    public string SubTitle { get; set; }
    Property Value
    Type
    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 PivotChartSubTitleStyle SubTitleStyle { get; set; }
    Property Value
    Type
    PivotChartSubTitleStyle

    TabIndex

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

    Declaration
    public int TabIndex { get; set; }
    Property Value
    Type
    System.Int32

    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 Theme Theme { get; set; }
    Property Value
    Type
    Theme

    Title

    Allows you to add title to the pivot chart.

    Declaration
    public string Title { get; set; }
    Property Value
    Type
    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 PivotChartTitleStyle TitleStyle { get; set; }
    Property Value
    Type
    PivotChartTitleStyle

    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 PivotChartTooltipSettings Tooltip { get; set; }
    Property Value
    Type
    PivotChartTooltipSettings

    UseGroupingSeparator

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

    Declaration
    public bool UseGroupingSeparator { get; set; }
    Property Value
    Type
    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
    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 PivotChartZoomSettings ZoomSettings { get; set; }
    Property Value
    Type
    PivotChartZoomSettings

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    Dispose()

    Dispose the unmanaged resources.

    Declaration
    public virtual void Dispose()

    Dispose(Boolean)

    Dispose unmanaged resources in the component.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    Boolean value to dispose the object.

    OnInitializedAsync()

    Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing any asynchronous operation.

    OnParametersSetAsync()

    Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing any asynchronous operation.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved