Dundas Chart for ASP.NET
Custom Attributes Overview
See Also Send comments on this topic.
Custom Attributes > Custom Attributes Overview



Glossary Item Box

Overview

Dundas Chart for ASP.NET has many different chart types, and each chart type may have a unique set of custom attributes associated with it (e.g. width of bars and columns, exploded pie slices, etc.). See each chart type description for the custom attributes that are available.

Custom attributes are implemented using the CustomAttributes property of both Series objects and their associated DataPoint objects.

Some custom attributes are specifically used with Series objects, and others can only be set using  DataPoint objects, while still others can be set using either a Series or DataPoint objects. For example, Exploded is a pie chart custom attribute, which can only be set with a DataPoint object. However, the LabelStyle attribute of a pie chart can be set for both a Series object or one of its DataPoint objects.

Any attribute that is set for a series is then applied to all data points contained within that series (provided that custom attribute is used at the point level). Data point custom attributes have a higher priority then series custom attributes. If the same custom attribute is used for a series and one of its data points, then the data point attribute will be used.

 

Note

Custom attribute names are case-sensitive. You should be mindful of this fact when formatting custom attributes in code-behind. Further, if the CustomAttribute value contains a comma, then each comma must be preceded by a '\' character to escape the comma. This is useful when, for example, an RGB color value is set in your application. In such cases, the setting of custom attributes that contain commas can either be done at runtime, or design-time.

 

For more information on using custom attributes either at design-time, or at runtime, see the topic on Using Custom Attributes.

 

Custom Attributes

Attribute

Description

Applies To

3DLabelLineSize Gets or sets the 3D label line size as a percentage of the default size. This attribute is only applicable to Pie and Doughnut chart. Series Only
AreaDrawingStyle Gets or sets the shape of the Radar or Polar chart. Series Only
BarLabelStyle Gets or sets the data point label placement. DataPoint and Series
BoxPlotPercentile Gets or sets the percentile value of the box of the chart. Series Only
BoxPlotSeries Gets or sets the name of the series used as the datasource for the box plot.  Series Only
BoxPlotShowAverage Indicates that the average value will be shown. Series Only
BoxPlotShowMedian Indicates that the median value will be shown. Series Only
BoxPlotShowUnusualValues Indicates that the unusual values will be shown. Series Only
BoxPlotWhiskerPercentile Gets or sets the percentile value of the whiskers. Series Only
BoxSize Gets or sets the Renko or Point And Figure chart box size as either a percentage or a fixed amount. Series Only
BubbleMaxSize Gets or sets the maximum size of the bubble radius as a percentage of the chart area size. Series Only
BubbleMinSize Gets or sets the minimum size of the bubble radius as a percentage of the chart area size. Series Only
BubbleScaleMax Gets or sets the bubble size that will be used as the maximum bubble size. Series Only
BubbleScaleMin Gets or sets the bubble size that will be used as the minimum bubble size. Series Only
BubbleUseSizeForLabel Indicates that the bubble size is used to generate the data point labels. Series Only
CalloutLineColor Gets or sets the data point labels callout line color. Applies only for Funnel or Pyramid charts with OutsideInColumn label style. DataPoint and Series
CircularLabelStyle Gets or sets the label drawing style for Polar and Radar charts. Series Only
CollectedLabel Gets or sets the label of the collected pie slice. Applies only for Pie or Doughnut charts with CollectedThreshold set to a non-zero value. Series Only
CollectedLegendText Gets or sets the legend text of the collected pie slice. Applies only for Pie or Doughnut charts with CollectedThreshold set to a non-zero value. Series Only
CollectedSliceExploded Gets or sets a boolean value that indicates whether the collected pie slice will be shown as exploded. Applies only for Pie or Doughnut charts with CollectedThreshold set to a non-zero value. Series Only
CollectedThreshold Gets or sets the threshold at which all data points are collected into one point. Series Only
CollectedThresholdUsePercent Gets or sets a boolean value that indicates the collected threshold type that will be used. Applies only for Pie or Doughnut charts with CollectedThreshold set to a non-zero value. Series Only
CollectedToolTip Gets or sets the tooltip of the collected pie slice. Applies only for Pie or Doughnut charts with CollectedThreshold set to a non-zero value. Series Only
DoughnutRadius Gets or sets the inner radius of a Doughnut chart. If the attribute is set to zero (0), the Doughnut chart will look like a Pie chart. Series Only
DrawingStyle Gets or sets the drawing style of the bar or column when rendered in 3D. DataPoint and Series
DrawSideBySide Determines if data points that have the same X value are drawn side by side or are drawn using the same X value. DataPoint and Series
EmptyPointValue Determines how an empty point is treated when the chart is drawn. Series Only
ErrorBarCenterMarkerStyle Gets or sets the appearance type of the marker shown at the center value of the Error Bar. DataPoint and Series
ErrorBarSeries Gets or sets the name of the series used as the datasource for the Error Bar calculations. The named series MUST exist. Series Only
ErrorBarStyle Gets or sets the visibility of the Upper and Lower Error values. DataPoint and Series
ErrorBarType Defines how the Upper and Lower errors are calculated for the center values of the Error Bar series. Series Only
Exploded Indicates that the Pie or Doughnut data point is exploded (separated from the rest of the Pie or Doughnut). DataPoint Only
Funnel3DDrawingStyle Gets or sets the 3D drawing style for the Funnel chart. Series Only
Funnel3DRotationAngle Gets or sets the 3D rotation angle for the Funnel chart. Series Only
FunnelInsideLabelAlignment Gets or sets the vertical alignment for the data point labels for the Funnel chart when the labels are positioned inside the Funnel. DataPoint and Series
FunnelLabelStyle Gets or sets the Funnel chart data point label style. DataPoint and Series
FunnelMinPointHeight Gets or sets the minimum height of a Funnel chart data point measured in relative coordinates. DataPoint and Series
FunnelNeckHeight Gets or sets the Funnel chart data neck height. This is only applicable when a predefined Funnel shape is used. Series Only
FunnelNeckWidth Gets or sets the Funnel chart data neck width. This is only applicable when a predefined Funnel shape is used. Series Only
FunnelOutsideLabelPlacement Gets or sets the outside labels placement relative to the Funnel. DataPoint and Series
FunnelPointGap Gets or sets the gap size between the points measured in relative coordinates. DataPoint and Series
FunnelStyle Gets or sets the Funnel chart style. Series Only
LabelsHorizonalLineSize Gets or sets the horizontal callout line size. This attribute is only applicable to Pie or Doughnut charts where the labels are placed outside. DataPoint and Series
LabelsRadialLineSize Gets or sets the radial line size. This attribute is only applicable to Pie or Doughnut charts where the labels are placed outside. DataPoint and Series
LabelStyle Gets or sets the data point label position (for most XY chart types and Polar / Radar charts). DataPoint and Series
LabelValueType Gets or sets the Y value to use as the data point label. DataPoint and Series
LineTension Gets or sets the tension for the drawn curve. A curve with a zero (0) tension has the appearance of a line. Series Only
MaxPixelPointWidth Gets or sets the maximum data point width in pixels Series Only
MinimumRelativePieSize Gets or sets the minimum Pie or Doughnut size to prevent too small of a chart. Series Only
MinPixelPointWidth Gets or sets the minimum data point width in pixels Series Only
NumberOfLinesInBreak Gets or sets the number of lines to use in a ThreeLineBreak chart. Series Only
OpenCloseStyle Gets or sets the marker style for Open and Close values. DataPoint and Series
PieDrawingStyle Gets or sets the pie drawing style (shape) of a pie or doughnut chart.  Series Only
PieLabelStyle Gets or sets the data point label position for Pie and Doughnut charts. DataPoint and Series
PieLineArrowSize Gets or sets the size of the arrow. DataPoint and Series
PieLineArrowType Gets or sets the type of arrow. DataPoint and Series
PieLineColor Gets or sets the color of the radial and horizontal label lines. DataPoint and Series
PieStartAngle Gets or sets the start angle of the first Pie or Doughnut slice. Series Only
PixelPointDepth Gets or sets the 3D series depth in pixels. Series Only
PixelPointGapDepth Gets or sets the 3D series gap in pixels. Series Only
PixelPointWidth Gets or sets the data point width in pixels. Series Only
PointWidth Gets or sets the relative point width of the data point. Series Only
PolarDrawingStyle Gets or sets the Polar chart drawing style. Series Only
PriceDownColor Gets or sets the data point color to use that indicates a decreasing price. Series Only
PriceUpColor Gets or sets the data point color to use that indicates an increasing price. Series Only
ProportionalSymbols Indicates that a Point And Figure chart should attempt to draw 'X' and 'O' symbols proportionally. Series Only
Pyramid3DDrawingStyle Gets or sets the 3D drawing style for the Pyramid chart. Series Only
Pyramid3DRotationAngle Gets or sets the 3D rotation angle for the Pyramid chart. Series Only
PyramidInsideLabelAlignment Gets or sets the vertical alignment for the data point labels for the Funnel chart when the labels are positioned inside the Pyramid. DataPoint and Series
PyramidLabelStyle Gets or sets the Pyramid chart data point label style. DataPoint and Series
PyramidMinPointHeight Gets or sets the minimum height of a Pyramid chart data point measured in relative coordinates. Series Only
PyramidOutsideLabelPlacement Gets or sets the outside labels placement relative to the Pyramid. DataPoint and Series
PyramidPointGap Gets or sets the gap size between the points measured in relative coordinates. Series Only
PyramidValueType Gets or sets a value that determines whether the DataPoint value represents a linear height or the surface of the segment. Series Only
RadarDrawingStyle Gets or sets the Radar chart drawing style. Series Only
ReversalAmount Gets or sets the Reversal Amount for the chart PointAndFigure or Kagi charts. Series Only
ShowMarkerLines Indicates if marker lines are displayed when rendered in 3D. DataPoint and Series
ShowOpenClose Determines if Open and Close markers (lines or triangles) are displayed. DataPoint and Series
StackedGroupName Gets or sets the stacked group name. This attribute is only applicable to StackedBar, StackedBar100, StackedColumn and StackedColumn100 charts. Series Only
UsedYValue Gets or sets the zero based index of the Y value used to plot the Kagi, Renko or ThreeLineBreak chart. Series Only
UsedYValueHigh Gets or sets the zero based index of the high Y value for a PointAndFigure chart. Series Only
UsedYValueLow Gets or sets the zero based index of the low Y value for a PointAndFigure chart. Series Only

See Also

Copyright © 2001 - 2009 Dundas Data Visualization, Inc. and others.