Circular3DSeries

23 Sep 20258 minutes to read

Configures the series in a circular 3D chart.

Properties

animation AnimationModel

Options for customizing the animation of the series.

dataLabel Circular3DDataLabelSettingsModel

The data label settings for the circular 3D series.

dataSource Object|DataManager

Specifies the dataSource for the series. It can be an array of JSON objects or an instance of DataManager.

<div id='Pie'></div>
let dataManager: DataManager = new DataManager({
        url: 'http://mvc.syncfusion.com/Services/Northwnd.svc/Tasks/'
});
let query: Query = new Query().take(50).where('Estimate', 'greaterThan', 0, false);
let pie: Circular3D = new Circular3D({
...
    series: [{
       dataSource: dataManager,
       xName: 'Id',
       yName: 'Estimate',
       query: query
   }],
...
});
pie.appendTo('#Pie');

Defaults to ’’

emptyPointSettings Circular3DEmptyPointSettingsModel

Options to customize the appearance of empty points in the circular 3D series.

enableTooltip boolean

Specifies whether the tooltip is enabled or disabled for the circular 3D series.

Defaults to true

explode boolean

If set true, series points will be exploded on mouse click or touch.

Defaults to false

explodeAll boolean

If set true, all the points in the series will get exploded on load.

Defaults to false

explodeIndex number

Index of the point to be exploded on load. Set to null for no explosion.

Defaults to null

explodeOffset string

Distance of the point from the center, which takes values in both pixels and percentage.

Defaults to ‘30%’

innerRadius string

When the innerRadius value is greater than 0 percentage, a donut will appear in the pie series. It takes values only in percentage.

Defaults to ‘0’

legendImageUrl string

The URL for the image that is to be displayed as a legend icon. It requires legendShape value to be an Image.

Defaults to ’’

legendShape LegendShape

The shape of the legend. Each series has its own legend shape. Available shapes:

  • Circle - Renders a circle.
  • Rectangle - Renders a rectangle.
  • Triangle - Renders a triangle.
  • Diamond - Renders a diamond.
  • Cross - Renders a cross.
  • HorizontalLine - Renders a horizontal line.
  • VerticalLine - Renders a vertical line.
  • Pentagon - Renders a pentagon.
  • InvertedTriangle - Renders an inverted triangle.
  • SeriesType -Render a legend shape based on series type.
  • Image - Render an image. *

Defaults to ‘SeriesType’

name string

The name of the series as displayed in the legend.

Defaults to ’’

opacity number

The opacity of the series.

Defaults to 1.

palettes string[]

Palette configuration for the points in the circular 3D series.

Defaults to []

pointColorMapping string

The DataSource field that contains the point colors.

Defaults to ’’

query Query

Specifies the query to select data from the dataSource. This property is applicable only when the dataSource is ej.DataManager.

Defaults to null

radius string

Specifies the radius of the pie series in percentage. Set to null for default.

Defaults to null

tooltipMappingName string

The data source field that contains the tooltip value.

Defaults to ’’

visible boolean

Specifies the visibility of the series.

Defaults to true

xName string

The DataSource field that contains the x value

Defaults to ’’

yName string

The DataSource field that contains the y value.

Defaults to ’’

Methods

createPoints

Creates Circular3DSegments based on the provided Circular3D series and Circular3D chart.

Parameter Type Description
series Circular3DSeries The circular 3D series for which to generate points.
chart Circular3D The circular 3D chart instance.

Returns Circular3DSegments[]

createPolygons

Creates polygons for a 3D circular chart series.

Parameter Type Description
series Circular3DSeries The Circular3D series for which to create polygons.
chart Circular3D The circular 3D chart instance.

Returns Circular3DPolygon[][]

createSegment

Creates a segment based on the provided parameters.

Parameter Type Description
center Circular3DVector The center point of the segment.
start number The starting angle of the segment in radians.
end number The ending angle of the segment in radians.
height number The height of the segment.
radius number The radial distance from the center to the segment.
index number The index value of the segment.
yValue number The y value associated with the segment.
insideRadius number The inside radius of the segment.
pointIndex number The index of the point associated with the segment.
series Circular3DSeries The Circular3DSeries to which the segment belongs.
accessibilityText string The accessibility text of the segment.

Returns Circular3DSegments

draw

Draws the circular 3D series on the chart.

Parameter Type Description
series Circular3DSeries The series to be drawn.
chart Circular3D The circular 3D chart instance.

Returns void

findMaxBounds

Updates the total bounds to encompass the maximum area covered by the specified bound and the current total bounds.

Parameter Type Description
totalBound Rect The current total bounds to be updated.
bound Rect The new bound to compare and update the total bounds.

Returns void

getYValues

Gets the Y values from an array of circular 3D series points.

Parameter Type Description
points Circular3DPoints[] An array of Circular3DPoints.

Returns number[]

vector

Creates a new Vector3D instance from provided coordinates.

Parameter Type Description
vx Object | number Either an object with x and y properties or the x-coordinate.
vy number The y-coordinate.
vz number The z-coordinate.

Returns Circular3DVector