Class CircularChart3DBuilder
Inheritance
System.Object
CircularChart3DBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class CircularChart3DBuilder : ControlBuilder
Constructors
CircularChart3DBuilder()
Declaration
public CircularChart3DBuilder()
CircularChart3DBuilder(CircularChart3D)
Declaration
public CircularChart3DBuilder(CircularChart3D model)
Parameters
Fields
model
Declaration
public CircularChart3D model
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 is completed.
Declaration
public CircularChart3DBuilder AfterExport(string afterExport)
Parameters
Type |
Name |
Description |
System.String |
afterExport |
|
Returns
Background(String)
The background color of the circular 3D chart, which accepts a value in hex, rgba as a valid CSS color string.
Declaration
public CircularChart3DBuilder Background(string background)
Parameters
Type |
Name |
Description |
System.String |
background |
|
Returns
BackgroundImage(String)
The background image of the chart, specified as a URL link or the location of an image.
Declaration
public CircularChart3DBuilder BackgroundImage(string backgroundImage)
Parameters
Type |
Name |
Description |
System.String |
backgroundImage |
|
Returns
BeforeExport(String)
Triggers before the export starts.
Declaration
public CircularChart3DBuilder BeforeExport(string beforeExport)
Parameters
Type |
Name |
Description |
System.String |
beforeExport |
|
Returns
BeforePrint(String)
Triggers before printing starts.
Declaration
public CircularChart3DBuilder BeforePrint(string beforePrint)
Parameters
Type |
Name |
Description |
System.String |
beforePrint |
|
Returns
BeforeResize(String)
Triggered before resizing the chart.
Declaration
public CircularChart3DBuilder BeforeResize(string beforeResize)
Parameters
Type |
Name |
Description |
System.String |
beforeResize |
|
Returns
Border(CircularChart3DContainerBorder)
Options for customizing the color and width of the circular 3D chart border.
Declaration
public CircularChart3DBuilder Border(CircularChart3DContainerBorder border)
Parameters
Returns
Border(Action<CircularChart3DBorderBuilder>)
Declaration
public CircularChart3DBuilder Border(Action<CircularChart3DBorderBuilder> border)
Parameters
Returns
CircularChart3DMouseClick(String)
Triggered when the user clicks on a circular 3D chart.
Declaration
public CircularChart3DBuilder CircularChart3DMouseClick(string circularChart3DMouseClick)
Parameters
Type |
Name |
Description |
System.String |
circularChart3DMouseClick |
|
Returns
CircularChart3DMouseDown(String)
Triggered when the mouse is pressed down on a circular 3D chart.
Declaration
public CircularChart3DBuilder CircularChart3DMouseDown(string circularChart3DMouseDown)
Parameters
Type |
Name |
Description |
System.String |
circularChart3DMouseDown |
|
Returns
CircularChart3DMouseLeave(String)
Triggered when the cursor leaves a circular 3D chart.
Declaration
public CircularChart3DBuilder CircularChart3DMouseLeave(string circularChart3DMouseLeave)
Parameters
Type |
Name |
Description |
System.String |
circularChart3DMouseLeave |
|
Returns
CircularChart3DMouseMove(String)
Triggered when the user hovers over a circular 3D chart.
Declaration
public CircularChart3DBuilder CircularChart3DMouseMove(string circularChart3DMouseMove)
Parameters
Type |
Name |
Description |
System.String |
circularChart3DMouseMove |
|
Returns
CircularChart3DMouseUp(String)
Triggered when the mouse button is released on a circular 3D chart.
Declaration
public CircularChart3DBuilder CircularChart3DMouseUp(string circularChart3DMouseUp)
Parameters
Type |
Name |
Description |
System.String |
circularChart3DMouseUp |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public CircularChart3DBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Returns
DataSource(Object)
Specifies the dataSource for the circular 3D chart. It can be an array of JSON objects or an instance of DataManager.
Declaration
public CircularChart3DBuilder DataSource(object dataSource)
Parameters
Type |
Name |
Description |
System.Object |
dataSource |
|
Returns
Depth(Double)
Specifies the depth of the circular 3D chart.
Declaration
public CircularChart3DBuilder Depth(double depth)
Parameters
Type |
Name |
Description |
System.Double |
depth |
|
Returns
EnableAnimation(Boolean)
If set true, enables the animation for circular 3D chart.
Declaration
public CircularChart3DBuilder EnableAnimation(bool enableAnimation = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableAnimation |
|
Returns
EnableExport(Boolean)
Enables or disables the export feature in the circular 3D chart.
Declaration
public CircularChart3DBuilder 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 CircularChart3DBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRotation(Boolean)
Enables or disables rotation in the circular 3D chart.
Declaration
public CircularChart3DBuilder 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 CircularChart3DBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
Height(String)
The height of the chart as a string, accepting input as both '100px' or '100%'.
If specified as '100%', the chart renders to the full height of its parent element.
Declaration
public CircularChart3DBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
HighlightColor(String)
Defines the color for the highlighted data point.
Declaration
public CircularChart3DBuilder HighlightColor(string highlightColor)
Parameters
Type |
Name |
Description |
System.String |
highlightColor |
|
Returns
HighlightMode(CircularChart3DHighlightMode)
Specifies whether a point has to be highlighted or not.
Takes values: 'None' or 'Point'.
None: Disables the highlight.
Point: Highlights a point.
Declaration
public CircularChart3DBuilder HighlightMode(CircularChart3DHighlightMode highlightMode)
Parameters
Returns
HighlightPattern(SelectionPattern)
Specifies the highlight pattern for series or data points in the circular 3D chart. Options include:
none: No specific selection pattern.
chessboard: Chessboard pattern.
dots: Dots pattern.
diagonalForward: Diagonal forward pattern.
crosshatch: Crosshatch pattern.
pacman: Pacman pattern.
diagonalbackward: Diagonal backward pattern.
grid: Grid pattern.
turquoise: Turquoise pattern.
star: Star pattern.
triangle: Triangle pattern.
circle: Circle pattern.
tile: Tile pattern.
horizontaldash: Horizontal dash pattern.
verticaldash: Vertical dash pattern.
rectangle: Rectangle pattern.
box: Box pattern.
verticalstripe: Vertical stripe pattern.
horizontalstripe: Horizontal stripe pattern.
bubble: Bubble pattern.
Declaration
public CircularChart3DBuilder 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 CircularChart3DBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
IsMultiSelect(Boolean)
Enables or disables multi-selection in the circular 3D chart.
If set true, enables the multi selection in circular 3D chart. It requires selectionMode
to be Point
.
Declaration
public CircularChart3DBuilder IsMultiSelect(bool isMultiSelect = true)
Parameters
Type |
Name |
Description |
System.Boolean |
isMultiSelect |
|
Returns
LegendClick(String)
Triggers after a legend is clicked.
Declaration
public CircularChart3DBuilder LegendClick(string legendClick)
Parameters
Type |
Name |
Description |
System.String |
legendClick |
|
Returns
LegendRender(String)
Triggers before the legend is rendered.
Declaration
public CircularChart3DBuilder LegendRender(string legendRender)
Parameters
Type |
Name |
Description |
System.String |
legendRender |
|
Returns
LegendSettings(CircularChart3DLegendSettings)
Options for customizing the legend of the circular 3D chart.
Declaration
public CircularChart3DBuilder LegendSettings(CircularChart3DLegendSettings legendSettings)
Parameters
Returns
LegendSettings(Action<CircularChart3DLegendSettingsBuilder>)
Declaration
public CircularChart3DBuilder LegendSettings(Action<CircularChart3DLegendSettingsBuilder> legendSettings)
Parameters
Returns
Load(String)
Triggered before the circular 3D is loaded.
Declaration
public CircularChart3DBuilder Load(string load)
Parameters
Type |
Name |
Description |
System.String |
load |
|
Returns
Loaded(String)
Triggers after the circular 3D chart is loaded.
Declaration
public CircularChart3DBuilder 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 CircularChart3DBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Margin(CircularChart3DMargin)
Options to customize the left, right, top, and bottom margins of the circular 3D chart.
Declaration
public CircularChart3DBuilder Margin(CircularChart3DMargin margin)
Parameters
Returns
Margin(Action<CircularChart3DMarginBuilder>)
Declaration
public CircularChart3DBuilder Margin(Action<CircularChart3DMarginBuilder> margin)
Parameters
Returns
PointClick(String)
Triggered when the user clicks on data points.
Declaration
public CircularChart3DBuilder PointClick(string pointClick)
Parameters
Type |
Name |
Description |
System.String |
pointClick |
|
Returns
PointMove(String)
Triggered when the user hovers over data points.
Declaration
public CircularChart3DBuilder PointMove(string pointMove)
Parameters
Type |
Name |
Description |
System.String |
pointMove |
|
Returns
PointRender(String)
Triggers before each point for a series is rendered.
Declaration
public CircularChart3DBuilder PointRender(string pointRender)
Parameters
Type |
Name |
Description |
System.String |
pointRender |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Microsoft.AspNetCore.Html.HtmlString |
Resized(String)
Triggered after the chart is resized.
Declaration
public CircularChart3DBuilder Resized(string resized)
Parameters
Type |
Name |
Description |
System.String |
resized |
|
Returns
Rotation(Double)
Defines the rotation angle for the circular 3D chart.
Declaration
public CircularChart3DBuilder Rotation(double rotation)
Parameters
Type |
Name |
Description |
System.Double |
rotation |
|
Returns
SelectedDataIndexes(Action<CircularChart3DSelectedDataIndexBuilder>)
Declaration
public CircularChart3DBuilder SelectedDataIndexes(Action<CircularChart3DSelectedDataIndexBuilder> selectedDataIndexes)
Parameters
Returns
SelectedDataIndexes(List<CircularChart3DSelectedDataIndex>)
Specifies the point indexes to be selected while loading a circular 3D chart.
It requires selectionMode
to be Point
.
Declaration
public CircularChart3DBuilder SelectedDataIndexes(List<CircularChart3DSelectedDataIndex> selectedDataIndexes)
Parameters
Returns
SelectionComplete(String)
Triggers after the selection is completed.
Declaration
public CircularChart3DBuilder SelectionComplete(string selectionComplete)
Parameters
Type |
Name |
Description |
System.String |
selectionComplete |
|
Returns
SelectionMode(CircularChart3DSelectionMode)
Specifies whether a point has to be selected or not.
Takes values: 'None' or 'Point'.
None: Disables the selection.
Point: Selects a point.
Declaration
public CircularChart3DBuilder SelectionMode(CircularChart3DSelectionMode selectionMode)
Parameters
Returns
SelectionPattern(SelectionPattern)
Specifies the selection pattern for series or data points in the circular 3D chart. Options include:
none: No specific selection pattern.
chessboard: Chessboard pattern.
dots: Dots pattern.
diagonalForward: Diagonal forward pattern.
crosshatch: Crosshatch pattern.
pacman: Pacman pattern.
diagonalbackward: Diagonal backward pattern.
grid: Grid pattern.
turquoise: Turquoise pattern.
star: Star pattern.
triangle: Triangle pattern.
circle: Circle pattern.
tile: Tile pattern.
horizontaldash: Horizontal dash pattern.
verticaldash: Vertical dash pattern.
rectangle: Rectangle pattern.
box: Box pattern.
verticalstripe: Vertical stripe pattern.
horizontalstripe: Horizontal stripe pattern.
bubble: Bubble pattern.
Declaration
public CircularChart3DBuilder SelectionPattern(SelectionPattern selectionPattern)
Parameters
Returns
Series(Action<CircularChart3DSeriesBuilder>)
Declaration
public CircularChart3DBuilder Series(Action<CircularChart3DSeriesBuilder> series)
Parameters
Returns
Series(List<CircularChart3DSeries>)
The configuration for series in circular 3D chart.
The series
property allows you to define an array of circular 3D series, each with its own settings and data.
Declaration
public CircularChart3DBuilder Series(List<CircularChart3DSeries> series)
Parameters
Returns
SeriesRender(String)
Triggers before a series is rendered.
Declaration
public CircularChart3DBuilder SeriesRender(string seriesRender)
Parameters
Type |
Name |
Description |
System.String |
seriesRender |
|
Returns
SubTitle(String)
Represents the subtitle for the circular 3D chart.
Declaration
public CircularChart3DBuilder SubTitle(string subTitle)
Parameters
Type |
Name |
Description |
System.String |
subTitle |
|
Returns
SubTitleStyle(CircularChart3DFont)
Options for customizing the subtitle of the circular 3D Chart.
Declaration
public CircularChart3DBuilder SubTitleStyle(CircularChart3DFont subTitleStyle)
Parameters
Returns
SubTitleStyle(Action<CircularChart3DFontBuilder>)
Declaration
public CircularChart3DBuilder SubTitleStyle(Action<CircularChart3DFontBuilder> subTitleStyle)
Parameters
Returns
TextRender(String)
Triggers before the data label for a series is rendered.
Declaration
public CircularChart3DBuilder TextRender(string textRender)
Parameters
Type |
Name |
Description |
System.String |
textRender |
|
Returns
Theme(CircularChart3DTheme)
Specifies the theme for the circular 3D chart.
Declaration
public CircularChart3DBuilder Theme(CircularChart3DTheme theme)
Parameters
Returns
Tilt(Double)
Defines the slope angle for the circular 3D chart.
Declaration
public CircularChart3DBuilder Tilt(double tilt)
Parameters
Type |
Name |
Description |
System.Double |
tilt |
|
Returns
Title(String)
Represents the title for the circular 3D chart.
Declaration
public CircularChart3DBuilder Title(string title)
Parameters
Type |
Name |
Description |
System.String |
title |
|
Returns
TitleStyle(CircularChart3DFont)
Options for customizing the title of the circular 3D chart.
Declaration
public CircularChart3DBuilder TitleStyle(CircularChart3DFont titleStyle)
Parameters
Returns
TitleStyle(Action<CircularChart3DFontBuilder>)
Declaration
public CircularChart3DBuilder TitleStyle(Action<CircularChart3DFontBuilder> titleStyle)
Parameters
Returns
Options for customizing the tooltip of the circular 3D chart.
Declaration
public CircularChart3DBuilder Tooltip(CircularChart3DTooltipSettings tooltip)
Parameters
Returns
Declaration
public CircularChart3DBuilder Tooltip(Action<CircularChart3DTooltipSettingsBuilder> tooltip)
Parameters
Returns
Triggered when the tooltip is ready to render on the screen.
Declaration
public CircularChart3DBuilder TooltipRender(string tooltipRender)
Parameters
Type |
Name |
Description |
System.String |
tooltipRender |
|
Returns
UseGroupingSeparator(Boolean)
Specifies whether a grouping separator should be used for numbers.
Declaration
public CircularChart3DBuilder UseGroupingSeparator(bool useGroupingSeparator = true)
Parameters
Type |
Name |
Description |
System.Boolean |
useGroupingSeparator |
|
Returns
Width(String)
The width of the chart as a string, accepting input as both '100px' or '100%'
If specified as '100%', the chart renders to the full width of its parent element.
Declaration
public CircularChart3DBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns