Class Chart

Inheritance
System.Object
TagHelper
EJTagHelper
Chart
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class Chart : EJTagHelper

Constructors

Chart()

Declaration
public Chart()

Properties

AfterExport

Triggers after the export completed.

Declaration
[HtmlAttributeName("afterExport")]
public string AfterExport { get; set; }
Property Value
Type Description
System.String

The default value is null

AllowExport

To enable export feature in blazor chart.

Declaration
[HtmlAttributeName("allowExport")]
public bool AllowExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowMultiSelection

If set true, enables the multi drag selection in chart. It requires selectionMode to be Dragx | DragY | or DragXY.

Declaration
[HtmlAttributeName("allowMultiSelection")]
public bool AllowMultiSelection { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AnimationComplete

Triggers after animation is completed for the series.

Declaration
[HtmlAttributeName("animationComplete")]
public string AnimationComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

AnnotationRender

Triggers before the annotation gets rendered.

Declaration
[HtmlAttributeName("annotationRender")]
public string AnnotationRender { get; set; }
Property Value
Type Description
System.String

The default value is null

Annotations

The configuration for annotation in chart.

Declaration
[HtmlAttributeName("annotations")]
public List<ChartAnnotation> Annotations { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartAnnotation>

The default value is null

Axes

Secondary axis collection for the chart.

Declaration
[HtmlAttributeName("axes")]
public List<ChartAxis> Axes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartAxis>

The default value is null

AxisLabelClick

Triggers when x axis label clicked.

Declaration
[HtmlAttributeName("axisLabelClick")]
public string AxisLabelClick { get; set; }
Property Value
Type Description
System.String

The default value is null

AxisLabelRender

Triggers before each axis label is rendered.

Declaration
[HtmlAttributeName("axisLabelRender")]
public string AxisLabelRender { get; set; }
Property Value
Type Description
System.String

The default value is null

AxisMultiLabelRender

Triggers before each axis multi label is rendered.

Declaration
[HtmlAttributeName("axisMultiLabelRender")]
public string AxisMultiLabelRender { get; set; }
Property Value
Type Description
System.String

The default value is null

AxisRangeCalculated

Triggers before each axis range is rendered.

Declaration
[HtmlAttributeName("axisRangeCalculated")]
public string AxisRangeCalculated { get; set; }
Property Value
Type Description
System.String

The default value is null

Background

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

Declaration
[HtmlAttributeName("background")]
public string Background { get; set; }
Property Value
Type Description
System.String

The default value is null

BackgroundImage

The background image of the chart that accepts value in string as url link or location of an image.

Declaration
[HtmlAttributeName("backgroundImage")]
public string BackgroundImage { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeExport

Triggers before the export gets started.

Declaration
[HtmlAttributeName("beforeExport")]
public string BeforeExport { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforePrint

Triggers before the prints gets started.

Declaration
[HtmlAttributeName("beforePrint")]
public string BeforePrint { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeResize

Triggers before resizing of chart

Declaration
[HtmlAttributeName("beforeResize")]
public string BeforeResize { get; set; }
Property Value
Type Description
System.String

The default value is null

Border

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

Declaration
[HtmlAttributeName("border")]
public ChartBorder Border { get; set; }
Property Value
Type Description
ChartBorder

The default value is null

ChartArea

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

Declaration
[HtmlAttributeName("chartArea")]
public ChartArea ChartArea { get; set; }
Property Value
Type Description
ChartArea

The default value is null

ChartDoubleClick

Triggers on double clicking the chart.

Declaration
[HtmlAttributeName("chartDoubleClick")]
public string ChartDoubleClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ChartMouseClick

Triggers on clicking the chart.

Declaration
[HtmlAttributeName("chartMouseClick")]
public string ChartMouseClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ChartMouseDown

Triggers on mouse down.

Declaration
[HtmlAttributeName("chartMouseDown")]
public string ChartMouseDown { get; set; }
Property Value
Type Description
System.String

The default value is null

ChartMouseLeave

Triggers when cursor leaves the chart.

Declaration
[HtmlAttributeName("chartMouseLeave")]
public string ChartMouseLeave { get; set; }
Property Value
Type Description
System.String

The default value is null

ChartMouseMove

Triggers on hovering the chart.

Declaration
[HtmlAttributeName("chartMouseMove")]
public string ChartMouseMove { get; set; }
Property Value
Type Description
System.String

The default value is null

ChartMouseUp

Triggers on mouse up.

Declaration
[HtmlAttributeName("chartMouseUp")]
public string ChartMouseUp { get; set; }
Property Value
Type Description
System.String

The default value is null

Columns

Options to split chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in the chart.

Declaration
[HtmlAttributeName("columns")]
public List<ChartColumn> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartColumn>

The default value is null

Crosshair

Options for customizing the crosshair of the chart.

Declaration
[HtmlAttributeName("crosshair")]
public ChartCrosshairSettings Crosshair { get; set; }
Property Value
Type Description
ChartCrosshairSettings

The default value is null

DataSource

Specifies the DataSource for the chart. It can be an array of JSON objects or an instance of DataManager.

Declaration
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

The default value is null

Description

Description for chart.

Declaration
[HtmlAttributeName("description")]
public string Description { get; set; }
Property Value
Type Description
System.String

The default value is null

Drag

Triggers when the point is dragging.

Declaration
[HtmlAttributeName("drag")]
public string Drag { get; set; }
Property Value
Type Description
System.String

The default value is null

DragComplete

Triggers after the drag selection is completed.

Declaration
[HtmlAttributeName("dragComplete")]
public string DragComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

DragEnd

Triggers when the point drag end.

Declaration
[HtmlAttributeName("dragEnd")]
public string DragEnd { get; set; }
Property Value
Type Description
System.String

The default value is null

DragStart

Triggers when the point drag start.

Declaration
[HtmlAttributeName("dragStart")]
public string DragStart { get; set; }
Property Value
Type Description
System.String

The default value is null

EnableAnimation

If set true, Animation process will be executed.

Declaration
[HtmlAttributeName("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableAutoIntervalOnBothAxis

If set to true, both axis interval will be calculated automatically with respect to the zoomed range.

Declaration
[HtmlAttributeName("enableAutoIntervalOnBothAxis")]
public bool EnableAutoIntervalOnBothAxis { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableCanvas

It specifies whether the chart should be rendered in canvas mode.

Declaration
[HtmlAttributeName("enableCanvas")]
public bool EnableCanvas { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableExport

To enable export feature in chart.

Declaration
[HtmlAttributeName("enableExport")]
public bool EnableExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSideBySidePlacement

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

Declaration
[HtmlAttributeName("enableSideBySidePlacement")]
public bool EnableSideBySidePlacement { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

Height

The height of the chart as a string accepts input both as '100px' or '100%'. If specified as '100%, chart renders to the full height of its parent element.

Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

The default value is null

HighlightColor

Define the color for the data point on highlight.

Declaration
[HtmlAttributeName("highlightColor")]
public string HighlightColor { get; set; }
Property Value
Type Description
System.String

The default value is ""

HighlightMode

Specifies whether series or data point has to be selected. They are, none: Disables the highlight. series: highlight a series. point: highlight a point. cluster: highlight a cluster of point

Declaration
[HtmlAttributeName("highlightMode")]
public HighlightMode HighlightMode { get; set; }
Property Value
Type Description
HighlightMode

The default value is HighlightMode.None

HighlightPattern

Specifies whether series or data point has to be selected. They are, none: sets none as highlighting pattern. chessboard: sets chess board as highlighting pattern. dots: sets dots as highlighting pattern. diagonalForward: sets diagonal forward as highlighting pattern. crosshatch: sets crosshatch as highlighting pattern. pacman: sets pacman highlighting pattern. diagonalbackward: sets diagonal backward as highlighting pattern. grid: sets grid as highlighting pattern. turquoise: sets turquoise as highlighting pattern. star: sets star as highlighting pattern. triangle: sets triangle as highlighting pattern. circle: sets circle as highlighting pattern. tile: sets tile as highlighting pattern. horizontaldash: sets horizontal dash as highlighting pattern. verticaldash: sets vertical dash as highlighting pattern. rectangle: sets rectangle as highlighting pattern. box: sets box as highlighting pattern. verticalstripe: sets vertical stripe as highlighting pattern. horizontalstripe: sets horizontal stripe as highlighting pattern. bubble: sets bubble as highlighting pattern.

Declaration
[HtmlAttributeName("highlightPattern")]
public SelectionPattern HighlightPattern { get; set; }
Property Value
Type Description
SelectionPattern

The default value is SelectionPattern.None

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

Indicators

Defines the collection of technical indicators, that are used in financial markets.

Declaration
[HtmlAttributeName("indicators")]
public List<ChartIndicator> Indicators { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartIndicator>

The default value is null

IsMultiSelect

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

Declaration
[HtmlAttributeName("isMultiSelect")]
public bool IsMultiSelect { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

IsTransposed

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

Declaration
[HtmlAttributeName("isTransposed")]
public bool IsTransposed { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

LegendClick

Triggers after click on legend.

Declaration
[HtmlAttributeName("legendClick")]
public string LegendClick { get; set; }
Property Value
Type Description
System.String

The default value is null

LegendRender

Triggers before the legend is rendered.

Declaration
[HtmlAttributeName("legendRender")]
public string LegendRender { get; set; }
Property Value
Type Description
System.String

The default value is null

LegendSettings

Options for customizing the legend of the chart.

Declaration
[HtmlAttributeName("legendSettings")]
public ChartLegendSettings LegendSettings { get; set; }
Property Value
Type Description
ChartLegendSettings

The default value is null

Load

Triggers before chart load.

Declaration
[HtmlAttributeName("load")]
public string Load { get; set; }
Property Value
Type Description
System.String

The default value is null

Loaded

Triggers after chart load.

Declaration
[HtmlAttributeName("loaded")]
public string Loaded { get; set; }
Property Value
Type Description
System.String

The default value is null

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

The default value is ""

Margin

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

Declaration
[HtmlAttributeName("margin")]
public ChartMargin Margin { get; set; }
Property Value
Type Description
ChartMargin

The default value is null

MultiLevelLabelClick

Triggers after click on multiLevelLabelClick.

Declaration
[HtmlAttributeName("multiLevelLabelClick")]
public string MultiLevelLabelClick { get; set; }
Property Value
Type Description
System.String

The default value is null

OnZooming

Triggers after the zoom selection is triggered.

Declaration
[HtmlAttributeName("onZooming")]
public string OnZooming { get; set; }
Property Value
Type Description
System.String

The default value is null

Palettes

Palette for the chart series.

Declaration
[HtmlAttributeName("palettes")]
public string[] Palettes { get; set; }
Property Value
Type Description
System.String[]

The default value is null

PointClick

Triggers on point click.

Declaration
[HtmlAttributeName("pointClick")]
public string PointClick { get; set; }
Property Value
Type Description
System.String

The default value is null

PointDoubleClick

Triggers on point double click.

Declaration
[HtmlAttributeName("pointDoubleClick")]
public string PointDoubleClick { get; set; }
Property Value
Type Description
System.String

The default value is null

PointMove

Triggers on point move.

Declaration
[HtmlAttributeName("pointMove")]
public string PointMove { get; set; }
Property Value
Type Description
System.String

The default value is null

PointRender

Triggers before each points for the series is rendered.

Declaration
[HtmlAttributeName("pointRender")]
public string PointRender { get; set; }
Property Value
Type Description
System.String

The default value is null

PrimaryXAxis

Options to configure the horizontal axis.

Declaration
[HtmlAttributeName("primaryXAxis")]
public ChartAxis PrimaryXAxis { get; set; }
Property Value
Type Description
ChartAxis

The default value is null

PrimaryYAxis

Options to configure the vertical axis.

Declaration
[HtmlAttributeName("primaryYAxis")]
public ChartAxis PrimaryYAxis { get; set; }
Property Value
Type Description
ChartAxis

The default value is null

RangeColorSettings

Options for customizing the points fill color based on condition.

Declaration
[HtmlAttributeName("rangeColorSettings")]
public List<ChartRangeColorSetting> RangeColorSettings { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartRangeColorSetting>

The default value is null

Resized

Triggers after resizing of chart.

Declaration
[HtmlAttributeName("resized")]
public string Resized { get; set; }
Property Value
Type Description
System.String

The default value is null

Rows

Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in the Chart.

Declaration
[HtmlAttributeName("rows")]
public List<ChartRow> Rows { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartRow>

The default value is null

ScrollChanged

Triggers when change the scroll.

Declaration
[HtmlAttributeName("scrollChanged")]
public string ScrollChanged { get; set; }
Property Value
Type Description
System.String

The default value is null

ScrollEnd

Triggers after the scroll end.

Declaration
[HtmlAttributeName("scrollEnd")]
public string ScrollEnd { get; set; }
Property Value
Type Description
System.String

The default value is null

ScrollStart

Triggers when start the scroll.

Declaration
[HtmlAttributeName("scrollStart")]
public string ScrollStart { get; set; }
Property Value
Type Description
System.String

The default value is null

SelectedDataIndexes

Specifies the point indexes to be selected while loading a chart. It requires selectionMode or highlightMode to be Point | Series | or Cluster.

Declaration
[HtmlAttributeName("selectedDataIndexes")]
public List<ChartSelectedDataIndex> SelectedDataIndexes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartSelectedDataIndex>

The default value is null

SelectionComplete

Triggers after the selection is completed.

Declaration
[HtmlAttributeName("selectionComplete")]
public string SelectionComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

SelectionMode

Specifies whether series or data point has to be selected. They are, none: Disables the selection. series: selects a series. point: selects a point. cluster: selects a cluster of point 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. lasso: selects points by dragging with respect to free form.

Declaration
[HtmlAttributeName("selectionMode")]
public SelectionMode SelectionMode { get; set; }
Property Value
Type Description
SelectionMode

The default value is SelectionMode.None

SelectionPattern

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

Declaration
[HtmlAttributeName("selectionPattern")]
public SelectionPattern SelectionPattern { get; set; }
Property Value
Type Description
SelectionPattern

The default value is SelectionPattern.None

Series

The configuration for series in the chart.

Declaration
[HtmlAttributeName("series")]
public List<ChartSeries> Series { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ChartSeries>

The default value is null

SeriesRender

Triggers before the series is rendered.

Declaration
[HtmlAttributeName("seriesRender")]
public string SeriesRender { get; set; }
Property Value
Type Description
System.String

The default value is null

SharedTooltipRender

Triggers before the shared tooltip for series is rendered.

Declaration
[HtmlAttributeName("sharedTooltipRender")]
public string SharedTooltipRender { get; set; }
Property Value
Type Description
System.String

The default value is null

SubTitle

SubTitle of the chart.

Declaration
[HtmlAttributeName("subTitle")]
public string SubTitle { get; set; }
Property Value
Type Description
System.String

The default value is ""

SubTitleStyle

Options for customizing the Subtitle of the Chart.

Declaration
[HtmlAttributeName("subTitleStyle")]
public ChartTitleSettings SubTitleStyle { get; set; }
Property Value
Type Description
ChartTitleSettings

The default value is null

TabIndex

TabIndex value for the chart.

Declaration
[HtmlAttributeName("tabIndex")]
public double TabIndex { get; set; }
Property Value
Type Description
System.Double

The default value is 1

TextRender

Triggers before the data label for series is rendered.

Declaration
[HtmlAttributeName("textRender")]
public string TextRender { get; set; }
Property Value
Type Description
System.String

The default value is null

Theme

Specifies the theme for the chart.

Declaration
[HtmlAttributeName("theme")]
public ChartTheme Theme { get; set; }
Property Value
Type Description
ChartTheme

The default value is ChartTheme.Material

Title

Title of the chart

Declaration
[HtmlAttributeName("title")]
public string Title { get; set; }
Property Value
Type Description
System.String

The default value is ""

TitleStyle

Options for customizing the title of the Chart.

Declaration
[HtmlAttributeName("titleStyle")]
public ChartTitleSettings TitleStyle { get; set; }
Property Value
Type Description
ChartTitleSettings

The default value is null

Tooltip

Options for customizing the tooltip of the chart.

Declaration
[HtmlAttributeName("tooltip")]
public ChartTooltipSettings Tooltip { get; set; }
Property Value
Type Description
ChartTooltipSettings

The default value is null

TooltipRender

Triggers before the tooltip for series is rendered.

Declaration
[HtmlAttributeName("tooltipRender")]
public string TooltipRender { get; set; }
Property Value
Type Description
System.String

The default value is null

UseGroupingSeparator

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

Declaration
[HtmlAttributeName("useGroupingSeparator")]
public bool UseGroupingSeparator { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Width

The width of the chart as a string accepts input as both like '100px' or '100%'. If specified as '100%, chart renders to the full width of its parent element.

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is null

ZoomComplete

Triggers after the zoom selection is completed.

Declaration
[HtmlAttributeName("zoomComplete")]
public string ZoomComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

ZoomSettings

Options to enable the zooming feature in the chart.

Declaration
[HtmlAttributeName("zoomSettings")]
public ChartZoomSettings ZoomSettings { get; set; }
Property Value
Type Description
ChartZoomSettings

The default value is null