Class Chart3D
Inheritance
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class Chart3D : EJTagHelper
Constructors
Chart3D()
Declaration
public Chart3D()
Properties
AfterExport
Triggers after the export completed.
Declaration
public string AfterExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Axes
Secondary axis collection for the chart.
Declaration
public List<Chart3DAxis> Axes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Chart3DAxis> | The default value is null |
AxisLabelRender
Triggers before each axis label is rendered.
Declaration
public string AxisLabelRender { 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
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
public string BackgroundImage { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeExport
Triggers before the export gets started.
Declaration
public string BeforeExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePrint
Triggers before the prints gets started.
Declaration
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeResize
Triggers before resizing of chart
Declaration
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
public Chart3DBorder Border { get; set; }
Property Value
Type | Description |
---|---|
Chart3DBorder | The default value is null |
Chart3DMouseClick
Triggered when the user clicks on a 3D chart.
Declaration
public string Chart3DMouseClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Chart3DMouseDown
Triggered when the mouse is pressed down on a 3D chart.
Declaration
public string Chart3DMouseDown { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Chart3DMouseLeave
Triggered when the cursor leaves a 3D chart.
Declaration
public string Chart3DMouseLeave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Chart3DMouseMove
Triggered when the user hovers over a 3D chart.
Declaration
public string Chart3DMouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Chart3DMouseUp
Triggered when the mouse button is released on a 3D chart.
Declaration
public string Chart3DMouseUp { 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
public List<Chart3DColumn> Columns { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.Charts.Chart3DColumn> | 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
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
Depth
Depth of the 3D Chart from front view of the series to the background wall.
Declaration
public double Depth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 50 |
Description
Description for chart.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
EnableExport
Enables or disables the export feature in the 3D chart.
Declaration
public bool EnableExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRotation
If set true, enables the rotation in the 3D chart.
Declaration
public bool EnableRotation { 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
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
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
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
HighlightColor
Defines the color for the highlighted data point.
Declaration
public string HighlightColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
HighlightMode
Specifies whether a series or data point should be highlighted. The options are: none: Disables the highlight. series: highlight a series. point: highlight a point. cluster: highlight a cluster of point
Declaration
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
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
public object HtmlAttributes { get; set; }
Property Value
Type |
---|
System.Object |
IsMultiSelect
If set true, enables the multi selection in chart. It requires selectionMode
to be Point
| Series
| or Cluster
.
Declaration
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
public bool IsTransposed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
LegendClick
Triggered when the user clicks on the legend.
Declaration
public string LegendClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LegendRender
Triggered when the legend is ready to render on the screen.
Declaration
public string LegendRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LegendSettings
The chart legend configuration options.
Declaration
public Chart3DLegendSettings LegendSettings { get; set; }
Property Value
Type | Description |
---|---|
Chart3DLegendSettings | The default value is null |
Load
Triggered before the chart is loaded.
Declaration
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Loaded
Triggered after the chart is loaded.
Declaration
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
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
public Chart3DMargin Margin { get; set; }
Property Value
Type | Description |
---|---|
Chart3DMargin | The default value is null |
Palettes
Palette for the chart series.
Declaration
public string[] Palettes { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
PerspectiveAngle
Defines the perspective angle for the 3D chart.
Declaration
public double PerspectiveAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 90 |
PointClick
Triggered when the user clicks on data points.
Declaration
public string PointClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PointMove
Triggered when the user hovers over data points.
Declaration
public string PointMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PointRender
Triggered when the data point is ready to render on the screen.
Declaration
public string PointRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PrimaryXAxis
Options to configure the horizontal axis.
Declaration
public Chart3DPrimaryXAxis PrimaryXAxis { get; set; }
Property Value
Type | Description |
---|---|
Chart3DPrimaryXAxis | The default value is null |
PrimaryYAxis
Options to configure the vertical axis.
Declaration
public Chart3DPrimaryYAxis PrimaryYAxis { get; set; }
Property Value
Type | Description |
---|---|
Chart3DPrimaryYAxis | The default value is null |
Resized
Triggers after resizing of chart.
Declaration
public string Resized { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Rotation
Defines the rotating angle for the 3D chart.
Declaration
public double Rotation { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Rows
Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in the Chart.
Declaration
public List<Chart3DRow> Rows { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.Charts.Chart3DRow> | 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
public List<Chart3DSelectedDataIndex> SelectedDataIndexes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.Charts.Chart3DSelectedDataIndex> | The default value is null |
SelectionComplete
Triggers after the selection is completed.
Declaration
public string SelectionComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SelectionMode
Specifies whether a series or data point should be highlighted. The options are: none: Disables the selection. series: selects a series. point: selects a point. cluster: selects a cluster of point
Declaration
public Chart3DSelectionMode SelectionMode { get; set; }
Property Value
Type | Description |
---|---|
Chart3DSelectionMode | The default value is Chart3DSelectionMode.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
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
public List<Chart3DSeries> Series { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Chart3DSeries> | The default value is null |
SeriesRender
Triggered when the series is ready to render on the screen.
Declaration
public string SeriesRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SubTitle
SubTitle of the chart.
Declaration
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
public Chart3DTitleSettings SubTitleStyle { get; set; }
Property Value
Type | Description |
---|---|
Chart3DTitleSettings | The default value is null |
TextRender
Triggered when the data label is ready to render on the screen.
Declaration
public string TextRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Theme
Specifies the theme for the chart.
Declaration
public ChartTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
ChartTheme | The default value is ChartTheme.Bootstrap5 |
Tilt
Defines the slope angle for the 3D chart.
Declaration
public double Tilt { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Title
Title of the chart
Declaration
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
public Chart3DTitleSettings TitleStyle { get; set; }
Property Value
Type | Description |
---|---|
Chart3DTitleSettings | The default value is null |
Tooltip
The chart tooltip configuration options.
Declaration
public Chart3DTooltipSettings Tooltip { get; set; }
Property Value
Type | Description |
---|---|
Chart3DTooltipSettings | The default value is null |
TooltipRender
Triggered when the tooltip is ready to render on the screen.
Declaration
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
public bool UseGroupingSeparator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
WallColor
Represents the color of the 3D wall.
Declaration
public string WallColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
WallSize
Defines the width of the 3D chart wall.
Declaration
public double WallSize { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 2 |
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
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |