Class Chart3DBuilder
Inheritance
System.Object
Chart3DBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class Chart3DBuilder : ControlBuilder
Constructors
Chart3DBuilder()
Declaration
Chart3DBuilder(Chart3D)
Declaration
public Chart3DBuilder(Chart3D model)
Parameters
Type |
Name |
Description |
Chart3D |
model |
|
Fields
model
Declaration
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
System.Collections.Generic.IDictionary<System.String, System.Object> |
ID
Declaration
public string ID { get; set; }
Property Value
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
System.IO.TextWriter |
Overrides
Methods
AfterExport(String)
Triggers after the export completed.
Declaration
public Chart3DBuilder AfterExport(string afterExport)
Parameters
Type |
Name |
Description |
System.String |
afterExport |
|
Returns
Axes(Action<Chart3DAxisBuilder>)
Declaration
public Chart3DBuilder Axes(Action<Chart3DAxisBuilder> axes)
Parameters
Returns
Axes(List<Chart3DAxis>)
Secondary axis collection for the chart.
Declaration
public Chart3DBuilder Axes(List<Chart3DAxis> axes)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<Chart3DAxis> |
axes |
|
Returns
AxisLabelRender(String)
Triggers before each axis label is rendered.
Declaration
public Chart3DBuilder AxisLabelRender(string axisLabelRender)
Parameters
Type |
Name |
Description |
System.String |
axisLabelRender |
|
Returns
Background(String)
The background color of the chart that accepts value in hex and rgba as a valid CSS color string.
Declaration
public Chart3DBuilder Background(string background)
Parameters
Type |
Name |
Description |
System.String |
background |
|
Returns
BackgroundImage(String)
The background image of the chart that accepts value in string as url link or location of an image.
Declaration
public Chart3DBuilder BackgroundImage(string backgroundImage)
Parameters
Type |
Name |
Description |
System.String |
backgroundImage |
|
Returns
BeforeExport(String)
Triggers before the export gets started.
Declaration
public Chart3DBuilder BeforeExport(string beforeExport)
Parameters
Type |
Name |
Description |
System.String |
beforeExport |
|
Returns
BeforePrint(String)
Triggers before the prints gets started.
Declaration
public Chart3DBuilder BeforePrint(string beforePrint)
Parameters
Type |
Name |
Description |
System.String |
beforePrint |
|
Returns
BeforeResize(String)
Triggers before resizing of chart
Declaration
public Chart3DBuilder BeforeResize(string beforeResize)
Parameters
Type |
Name |
Description |
System.String |
beforeResize |
|
Returns
Border(Chart3DBorder)
Options for customizing the color and width of the chart border.
Declaration
public Chart3DBuilder Border(Chart3DBorder border)
Parameters
Returns
Border(Action<Chart3DBorderBuilder>)
Declaration
public Chart3DBuilder Border(Action<Chart3DBorderBuilder> border)
Parameters
Returns
Chart3DMouseClick(String)
Triggered when the user clicks on a 3D chart.
Declaration
public Chart3DBuilder Chart3DMouseClick(string chart3DMouseClick)
Parameters
Type |
Name |
Description |
System.String |
chart3DMouseClick |
|
Returns
Chart3DMouseDown(String)
Triggered when the mouse is pressed down on a 3D chart.
Declaration
public Chart3DBuilder Chart3DMouseDown(string chart3DMouseDown)
Parameters
Type |
Name |
Description |
System.String |
chart3DMouseDown |
|
Returns
Chart3DMouseLeave(String)
Triggered when the cursor leaves a 3D chart.
Declaration
public Chart3DBuilder Chart3DMouseLeave(string chart3DMouseLeave)
Parameters
Type |
Name |
Description |
System.String |
chart3DMouseLeave |
|
Returns
Chart3DMouseMove(String)
Triggered when the user hovers over a 3D chart.
Declaration
public Chart3DBuilder Chart3DMouseMove(string chart3DMouseMove)
Parameters
Type |
Name |
Description |
System.String |
chart3DMouseMove |
|
Returns
Chart3DMouseUp(String)
Triggered when the mouse button is released on a 3D chart.
Declaration
public Chart3DBuilder Chart3DMouseUp(string chart3DMouseUp)
Parameters
Type |
Name |
Description |
System.String |
chart3DMouseUp |
|
Returns
Columns(Action<Chart3DColumnBuilder>)
Declaration
public Chart3DBuilder Columns(Action<Chart3DColumnBuilder> columns)
Parameters
Returns
Columns(List<Chart3DColumn>)
Options to split chart into multiple plotting areas vertically.
Each object in the collection represents a plotting area in the chart.
Declaration
public Chart3DBuilder Columns(List<Chart3DColumn> columns)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<Chart3DColumn> |
columns |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public Chart3DBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Returns
DataSource(Object)
Specifies the DataSource for the chart. It can be an array of JSON objects or an instance of DataManager.
Declaration
public Chart3DBuilder DataSource(object dataSource)
Parameters
Type |
Name |
Description |
System.Object |
dataSource |
|
Returns
Depth(Double)
Depth of the 3D Chart from front view of the series to the background wall.
Declaration
public Chart3DBuilder Depth(double depth)
Parameters
Type |
Name |
Description |
System.Double |
depth |
|
Returns
Description(String)
Declaration
public Chart3DBuilder Description(string description)
Parameters
Type |
Name |
Description |
System.String |
description |
|
Returns
EnableExport(Boolean)
Enables or disables the export feature in the 3D chart.
Declaration
public Chart3DBuilder EnableExport(bool enableExport = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableExport |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public Chart3DBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRotation(Boolean)
If set true, enables the rotation in the 3D chart.
Declaration
public Chart3DBuilder EnableRotation(bool enableRotation = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRotation |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public Chart3DBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
EnableSideBySidePlacement(Boolean)
To enable the side by side placing the points for column type series.
Declaration
public Chart3DBuilder EnableSideBySidePlacement(bool enableSideBySidePlacement = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableSideBySidePlacement |
|
Returns
Height(String)
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 Chart3DBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
HighlightColor(String)
Defines the color for the highlighted data point.
Declaration
public Chart3DBuilder HighlightColor(string highlightColor)
Parameters
Type |
Name |
Description |
System.String |
highlightColor |
|
Returns
HighlightMode(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 Chart3DBuilder HighlightMode(HighlightMode highlightMode)
Parameters
Returns
HighlightPattern(SelectionPattern)
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 Chart3DBuilder HighlightPattern(SelectionPattern highlightPattern)
Parameters
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public Chart3DBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
IsMultiSelect(Boolean)
If set true, enables the multi selection in chart. It requires selectionMode
to be Point
| Series
| or Cluster
.
Declaration
public Chart3DBuilder IsMultiSelect(bool isMultiSelect = true)
Parameters
Type |
Name |
Description |
System.Boolean |
isMultiSelect |
|
Returns
IsTransposed(Boolean)
It specifies whether the chart should be render in transposed manner or not.
Declaration
public Chart3DBuilder IsTransposed(bool isTransposed = true)
Parameters
Type |
Name |
Description |
System.Boolean |
isTransposed |
|
Returns
LegendClick(String)
Triggered when the user clicks on the legend.
Declaration
public Chart3DBuilder LegendClick(string legendClick)
Parameters
Type |
Name |
Description |
System.String |
legendClick |
|
Returns
LegendRender(String)
Triggered when the legend is ready to render on the screen.
Declaration
public Chart3DBuilder LegendRender(string legendRender)
Parameters
Type |
Name |
Description |
System.String |
legendRender |
|
Returns
LegendSettings(Chart3DLegendSettings)
The chart legend configuration options.
Declaration
public Chart3DBuilder LegendSettings(Chart3DLegendSettings legendSettings)
Parameters
Returns
LegendSettings(Action<Chart3DLegendSettingsBuilder>)
Declaration
public Chart3DBuilder LegendSettings(Action<Chart3DLegendSettingsBuilder> legendSettings)
Parameters
Returns
Load(String)
Triggered before the chart is loaded.
Declaration
public Chart3DBuilder Load(string load)
Parameters
Type |
Name |
Description |
System.String |
load |
|
Returns
Loaded(String)
Triggered after the chart is loaded.
Declaration
public Chart3DBuilder Loaded(string loaded)
Parameters
Type |
Name |
Description |
System.String |
loaded |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public Chart3DBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Margin(Chart3DMargin)
Options to customize left, right, top and bottom margins of the chart.
Declaration
public Chart3DBuilder Margin(Chart3DMargin margin)
Parameters
Returns
Margin(Action<Chart3DMarginBuilder>)
Declaration
public Chart3DBuilder Margin(Action<Chart3DMarginBuilder> margin)
Parameters
Returns
Palettes(String[])
Palette for the chart series.
Declaration
public Chart3DBuilder Palettes(string[] palettes)
Parameters
Type |
Name |
Description |
System.String[] |
palettes |
|
Returns
PerspectiveAngle(Double)
Defines the perspective angle for the 3D chart.
Declaration
public Chart3DBuilder PerspectiveAngle(double perspectiveAngle)
Parameters
Type |
Name |
Description |
System.Double |
perspectiveAngle |
|
Returns
PointClick(String)
Triggered when the user clicks on data points.
Declaration
public Chart3DBuilder PointClick(string pointClick)
Parameters
Type |
Name |
Description |
System.String |
pointClick |
|
Returns
PointMove(String)
Triggered when the user hovers over data points.
Declaration
public Chart3DBuilder PointMove(string pointMove)
Parameters
Type |
Name |
Description |
System.String |
pointMove |
|
Returns
PointRender(String)
Triggered when the data point is ready to render on the screen.
Declaration
public Chart3DBuilder PointRender(string pointRender)
Parameters
Type |
Name |
Description |
System.String |
pointRender |
|
Returns
PrimaryXAxis(Chart3DPrimaryXAxis)
Options to configure the horizontal axis.
Declaration
public Chart3DBuilder PrimaryXAxis(Chart3DPrimaryXAxis primaryXAxis)
Parameters
Returns
PrimaryXAxis(Action<Chart3DAxisBuilder>)
Declaration
public Chart3DBuilder PrimaryXAxis(Action<Chart3DAxisBuilder> primaryXAxis)
Parameters
Returns
PrimaryYAxis(Chart3DPrimaryYAxis)
Options to configure the vertical axis.
Declaration
public Chart3DBuilder PrimaryYAxis(Chart3DPrimaryYAxis primaryYAxis)
Parameters
Returns
PrimaryYAxis(Action<Chart3DAxisBuilder>)
Declaration
public Chart3DBuilder PrimaryYAxis(Action<Chart3DAxisBuilder> primaryYAxis)
Parameters
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Microsoft.AspNetCore.Html.HtmlString |
Resized(String)
Triggers after resizing of chart.
Declaration
public Chart3DBuilder Resized(string resized)
Parameters
Type |
Name |
Description |
System.String |
resized |
|
Returns
Rotation(Double)
Defines the rotating angle for the 3D chart.
Declaration
public Chart3DBuilder Rotation(double rotation)
Parameters
Type |
Name |
Description |
System.Double |
rotation |
|
Returns
Rows(Action<Chart3DRowBuilder>)
Declaration
public Chart3DBuilder Rows(Action<Chart3DRowBuilder> rows)
Parameters
Returns
Rows(List<Chart3DRow>)
Options to split Chart into multiple plotting areas horizontally.
Each object in the collection represents a plotting area in the Chart.
Declaration
public Chart3DBuilder Rows(List<Chart3DRow> rows)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<Chart3DRow> |
rows |
|
Returns
SelectedDataIndexes(Action<Chart3DSelectedDataIndexBuilder>)
Declaration
public Chart3DBuilder SelectedDataIndexes(Action<Chart3DSelectedDataIndexBuilder> selectedDataIndexes)
Parameters
Returns
SelectedDataIndexes(List<Chart3DSelectedDataIndex>)
Specifies the point indexes to be selected while loading a chart.
It requires selectionMode
or highlightMode
to be Point
| Series
| or Cluster
.
Declaration
public Chart3DBuilder SelectedDataIndexes(List<Chart3DSelectedDataIndex> selectedDataIndexes)
Parameters
Returns
SelectionComplete(String)
Triggers after the selection is completed.
Declaration
public Chart3DBuilder SelectionComplete(string selectionComplete)
Parameters
Type |
Name |
Description |
System.String |
selectionComplete |
|
Returns
SelectionMode(Chart3DSelectionMode)
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 Chart3DBuilder SelectionMode(Chart3DSelectionMode selectionMode)
Parameters
Returns
SelectionPattern(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 Chart3DBuilder SelectionPattern(SelectionPattern selectionPattern)
Parameters
Returns
Series(Action<Chart3DSeriesBuilder>)
Declaration
public Chart3DBuilder Series(Action<Chart3DSeriesBuilder> series)
Parameters
Returns
Series(List<Chart3DSeries>)
The configuration for series in the chart.
Declaration
public Chart3DBuilder Series(List<Chart3DSeries> series)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<Chart3DSeries> |
series |
|
Returns
SeriesRender(String)
Triggered when the series is ready to render on the screen.
Declaration
public Chart3DBuilder SeriesRender(string seriesRender)
Parameters
Type |
Name |
Description |
System.String |
seriesRender |
|
Returns
SubTitle(String)
Declaration
public Chart3DBuilder SubTitle(string subTitle)
Parameters
Type |
Name |
Description |
System.String |
subTitle |
|
Returns
SubTitleStyle(Chart3DTitleSettings)
Options for customizing the Subtitle of the Chart.
Declaration
public Chart3DBuilder SubTitleStyle(Chart3DTitleSettings subTitleStyle)
Parameters
Returns
SubTitleStyle(Action<Chart3DTitleSettingsBuilder>)
Declaration
public Chart3DBuilder SubTitleStyle(Action<Chart3DTitleSettingsBuilder> subTitleStyle)
Parameters
Returns
TextRender(String)
Triggered when the data label is ready to render on the screen.
Declaration
public Chart3DBuilder TextRender(string textRender)
Parameters
Type |
Name |
Description |
System.String |
textRender |
|
Returns
Theme(ChartTheme)
Specifies the theme for the chart.
Declaration
public Chart3DBuilder Theme(ChartTheme theme)
Parameters
Returns
Tilt(Double)
Defines the slope angle for the 3D chart.
Declaration
public Chart3DBuilder Tilt(double tilt)
Parameters
Type |
Name |
Description |
System.Double |
tilt |
|
Returns
Title(String)
Declaration
public Chart3DBuilder Title(string title)
Parameters
Type |
Name |
Description |
System.String |
title |
|
Returns
TitleStyle(Chart3DTitleSettings)
Options for customizing the title of the Chart.
Declaration
public Chart3DBuilder TitleStyle(Chart3DTitleSettings titleStyle)
Parameters
Returns
TitleStyle(Action<Chart3DTitleSettingsBuilder>)
Declaration
public Chart3DBuilder TitleStyle(Action<Chart3DTitleSettingsBuilder> titleStyle)
Parameters
Returns
The chart tooltip configuration options.
Declaration
public Chart3DBuilder Tooltip(Chart3DTooltipSettings tooltip)
Parameters
Returns
Declaration
public Chart3DBuilder Tooltip(Action<Chart3DTooltipSettingsBuilder> tooltip)
Parameters
Returns
Triggered when the tooltip is ready to render on the screen.
Declaration
public Chart3DBuilder TooltipRender(string tooltipRender)
Parameters
Type |
Name |
Description |
System.String |
tooltipRender |
|
Returns
UseGroupingSeparator(Boolean)
Specifies whether a grouping separator should be used for a number.
Declaration
public Chart3DBuilder UseGroupingSeparator(bool useGroupingSeparator = true)
Parameters
Type |
Name |
Description |
System.Boolean |
useGroupingSeparator |
|
Returns
WallColor(String)
Represents the color of the 3D wall.
Declaration
public Chart3DBuilder WallColor(string wallColor)
Parameters
Type |
Name |
Description |
System.String |
wallColor |
|
Returns
WallSize(Double)
Defines the width of the 3D chart wall.
Declaration
public Chart3DBuilder WallSize(double wallSize)
Parameters
Type |
Name |
Description |
System.Double |
wallSize |
|
Returns
Width(String)
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 Chart3DBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns