ChartSettings

Configures the chart settings.

Properties

background

string

The background color of the chart that accepts value in hex and rgba as a valid CSS color string.

Defaults to null

border

BorderModel

Options for customizing the color and width of the chart border.

chartArea

ChartAreaModel

Options for configuring the border and background of the chart area.

chartSeries

PivotSeriesModel

Options to configures the series of chart.

crosshair

CrosshairSettingsModel

Options for customizing the crosshair of the chart.

description

string

Description for chart.

Defaults to null

enableAnimation

boolean

If set true, Animation process will be executed.

Defaults to true

enableExport

boolean

To enable export feature in chart.

Defaults to true

enableMultiAxis

boolean

Defines the measure to load in chart

Defaults to false

enableSideBySidePlacement

boolean

To enable the side by side placing the points for column type series.

Defaults to true

isMultiSelect

boolean

If set true, enables the multi selection in chart. It requires selectionMode to be Point | Series | or Cluster.

Defaults to false

isTransposed

boolean

It specifies whether the chart should be render in transposed manner or not.

Defaults to false

legendSettings

LegendSettingsModel

Options for customizing the legend of the chart.

margin

MarginModel

Options to customize left, right, top and bottom margins of the chart.

palettes

string[]

Palette for the chart series.

Defaults to []

primaryXAxis

PivotAxisModel

Options to configure the horizontal axis of chart.

primaryYAxis

PivotAxisModel

Options to configure the vertical axis of chart.

selectedDataIndexes

IndexesModel[]

Specifies the point indexes to be selected while loading a chart. It requires selectionMode to be Point | Series. … selectionMode: ‘Point’, selectedDataIndexes: [ { series: 0, point: 1}, { series: 2, point: 3} ], …

Defaults to []

selectionMode

string

Specifies whether series or data point has to be selected. They 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

Defaults to ‘None’

showMultiLevelLabels

boolean

Specifies whether to show multilevel labels in chart.

Defaults to true

subTitle

string

SubTitle of the chart

Defaults to ”

subTitleStyle

FontModel

Options for customizing the Subtitle of the Chart.

tabIndex

number

TabIndex value for the chart.

Defaults to 1

theme

ChartTheme

Specifies the theme for the chart.

Defaults to ‘Material’

title

string

Title of the chart

Defaults to ”

titleStyle

FontModel

Options for customizing the title of the Chart.

tooltip

PivotTooltipSettingsModel

Options for customizing the tooltip of the chart.

useGroupingSeparator

boolean

Specifies whether a grouping separator should be used for a number.

Defaults to true

value

string

Defines the measure to load in chart

Defaults to ”

zoomSettings

PivotZoomSettingsModel

Options to enable the zooming feature in the chart.

Events

animationComplete

EmitType<IAnimationCompleteEventArgs>

Triggers after animation is completed for the series.

axisLabelRender

EmitType<IAxisLabelRenderEventArgs>

Triggers before each axis label is rendered.

beforePrint

EmitType<IPrintEventArgs>

Triggers before the prints gets started.

chartMouseClick

EmitType<IMouseEventArgs>

Triggers on clicking the chart.

chartMouseDown

EmitType<IMouseEventArgs>

Triggers on mouse down.

chartMouseLeave

EmitType<IMouseEventArgs>

Triggers when cursor leaves the chart.

chartMouseMove

EmitType<IMouseEventArgs>

Triggers on hovering the chart.

chartMouseUp

EmitType<IMouseEventArgs>

Triggers on mouse up.

dragComplete

EmitType<IDragCompleteEventArgs>

Triggers after the drag selection is completed.

legendRender

EmitType<ILegendRenderEventArgs>

Triggers before the legend is rendered.

load

EmitType<ILoadedEventArgs>

Triggers before chart load.

loaded

EmitType<ILoadedEventArgs>

Triggers after chart load.

pointClick

EmitType<IPointEventArgs>

Triggers on point click.

pointMove

EmitType<IPointEventArgs>

Triggers on point move.

pointRender

EmitType<IPointRenderEventArgs>

Triggers before each points for the series is rendered.

resized

EmitType<IResizeEventArgs>

Triggers after resizing of chart

scrollChanged

EmitType<IScrollEventArgs>

Triggers when change the scroll.

scrollEnd

EmitType<IScrollEventArgs>

Triggers after the scroll end.

scrollStart

EmitType<IScrollEventArgs>

Triggers when start the scroll.

seriesRender

EmitType<ISeriesRenderEventArgs>

Triggers before the series is rendered.

textRender

EmitType<ITextRenderEventArgs>

Triggers before the data label for series is rendered.

tooltipRender

EmitType<ITooltipRenderEventArgs>

Triggers before the tooltip for series is rendered.

zoomComplete

EmitType<IZoomCompleteEventArgs>

Triggers after the zoom selection is completed.