Class ChartControl
ChartControl is the root class of the chart control.
Inheritance
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Windows.dll
Syntax
public class ChartControl : Control, IChartAreaHost, IVisualStyle
Remarks
The ChartControl lets you create enterprise level charts with support for numerous chart types (see Type). A ChartSeries containing pints of X and Y values can be added to the Series collection to get a chart rendered. The chart control has a built in "nice range calculation" engine which will automatically determine the appropriate ranges for the axes based on the series data. Chart readily supports rendering multiple series.
There is also support for multiple axes, in case you want to render multiple series with each series rendered against a unique axes. Use the Axes collection to add one or more custom axis to the default set of PrimaryXAxis and PrimaryYAxis, which also can be referred from the Axes collection. Numerous customization can be done on the axis labels through the corresponding ChartAxis instance.
The default Legend renders some default ChartLegendItems representing each series in the chart. You can add custom legends to the chart through the Legends collection. You can add custom legend items to the ChartLegend instance through the CustomItems collection.
There is also a default Title and the ability to add multiple titles through the Titles collection.
The look and feel of the plot can also be customized through the ChartArea property.
There is also built in support for applying some statistical formulas and functions to the series data. Take a look at the BasicStatisticalFormulas type and the UtilityFunctions type.4
Constructors
ChartControl()
Initializes a new instance of the ChartControl class.
Declaration
public ChartControl()
ChartControl(Boolean)
Initializes a new instance of the ChartControl class.
Declaration
public ChartControl(bool addRandomData)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | addRandomData | if set to |
ChartControl(Boolean, Boolean)
Initializes a new instance of the ChartControl class. For internal use. Do not use this constructor directly.
Declaration
public ChartControl(bool addRandomData, bool isWindowLess)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | addRandomData | if set to |
| System.Boolean | isWindowLess | if set to |
Fields
AspMode
The AspMode.
Declaration
[Obsolete("This member isn't used anymore.")]
public static bool AspMode
Field Value
| Type |
|---|
| System.Boolean |
m_seriesHighlightIndex
Specifies the series's index when mouse hovering on the legend item and the correspnding series will be highlighted.
Declaration
public int m_seriesHighlightIndex
Field Value
| Type |
|---|
| System.Int32 |
Properties
AcceptFocus
Gets or sets a value indicating whether the chartcontrol is selectable.
Declaration
public bool AcceptFocus { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ActiveIndex
Gets the Index of ChartRegion which was selected. For internal use.
Declaration
public int ActiveIndex { get; }
Property Value
| Type |
|---|
| System.Int32 |
AddRandomSeries
Gets or sets a value indicating whether random series will be added.
Declaration
public bool AddRandomSeries { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
AllowDrop
Hides the base Allow Drop property from the designer property grid and IntelliSense. This property is explicitly hidden because it is not used at designer time.
Declaration
public override bool AllowDrop { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
AllowGapForEmptyPoints
Gets or sets a value indicating whether allow or disallow the gap when points are empty in indexed mode
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool AllowGapForEmptyPoints { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
AllowGradientPalette
Gets or sets a value indicating whether allow the gradient palette.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool AllowGradientPalette { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
AllowUserEditStyles
Gets or sets a value indicating whether allow the user to edit series styles when double clicking on a series.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool AllowUserEditStyles { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
AutoHighlight
Gets or sets a value indicating whether the points on the chart should be highlighted when the mouse hovers over them or not.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool AutoHighlight { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Axes
Gets the collection of axes associated with this chart. You can add and remove axes from this collection. Primary X and Y axes may not be removed. Use the PrimaryXAxis and PrimaryYAxis to access the primary axes.
Declaration
public ChartAxisCollection Axes { get; }
Property Value
| Type |
|---|
| ChartAxisCollection |
BackColor
Gets or sets the background color for the control.
Declaration
public override Color BackColor { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Color |
BackgroundImage
Gets or sets the background image displayed in the control.
Declaration
public override Image BackgroundImage { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Image |
BackInterior
Gets or sets backcolor of the chart control.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo BackInterior { get; set; }
Property Value
| Type |
|---|
| BrushInfo |
BorderAppearance
Gets or sets the border appearance.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartBorderInfo BorderAppearance { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartBorderInfo | The border appearance. |
CalcRegions
Gets or sets a value indicating whether calculate the regions for visual update. If ToolTips, AutoHighlighting, or RegionHit events are used, set this to True (default). If the previous aren't used, for better performance set to False.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool CalcRegions { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ChartArea
Gets the chart area of the ChartControl.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartArea ChartArea { get; }
Property Value
| Type |
|---|
| ChartArea |
ChartAreaBackImage
The chart can display an image as its background. This property specifies the image to be used as the background.
Declaration
public Image ChartAreaBackImage { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Image |
ChartAreaMargins
Gets or sets a value that indicates the margins that will be deduced from the ChartArea's representation rectangle. Negative values are supported.
Declaration
public ChartMargins ChartAreaMargins { get; set; }
Property Value
| Type |
|---|
| ChartMargins |
ChartAreaShadow
Gets or sets a value indicating whether display the chart area shadow.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ChartAreaShadow { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ChartAreaToolTip
Gets or sets the ToolTip text that is to be displayed when the mouse is over the area of the chart but not over other elements of interest within the chart area.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public string ChartAreaToolTip { get; set; }
Property Value
| Type |
|---|
| System.String |
ChartContextMenu
Gets the configuration information for the chart context menu object
Declaration
public ChartContextMenu ChartContextMenu { get; }
Property Value
| Type |
|---|
| ChartContextMenu |
ChartInterior
Gets or sets the interior of the chart. Please refer to BrushInfo for more information.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo ChartInterior { get; set; }
Property Value
| Type |
|---|
| BrushInfo |
ChartInteriorBackImage
The chart can display an image as its interior background. This property specifies the image to be used as the chart interior background.
Declaration
public Image ChartInteriorBackImage { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Image |
ChartRegions
Gets the list of ChartRegions. Please refer to ChartRegion for more information.
Declaration
public ChartRegionCollection ChartRegions { get; }
Property Value
| Type |
|---|
| ChartRegionCollection |
ChartToolTip
Gets or sets the ToolTip text that is to be displayed when the mouse is over the chart but not over other elements of interest within the chart.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public string ChartToolTip { get; set; }
Property Value
| Type |
|---|
| System.String |
ClickPoint
Gets last mouse position on the chartcontrol on mouse click.
Declaration
public Point ClickPoint { get; }
Property Value
| Type | Description |
|---|---|
| System.Drawing.Point | The mouse position |
Remarks
This property is used for zooming only.
ColumnDrawMode
Gets or sets the mode of drawing the column chart. See also ColumnWidthMode.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartColumnDrawMode ColumnDrawMode { get; set; }
Property Value
| Type |
|---|
| ChartColumnDrawMode |
ColumnFixedWidth
Gets or sets the width of each column when ColumnWidthMode is set to FixedWidthMode.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int ColumnFixedWidth { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
ColumnWidthMode
Gets or sets the mode of column drawing. See also ColumnDrawMode.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartColumnWidthMode ColumnWidthMode { get; set; }
Property Value
| Type |
|---|
| ChartColumnWidthMode |
CompatibleSeries
Gets or sets a value indicating whether the series are compatible.
Declaration
public bool CompatibleSeries { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Controls
Gets the collection of controls contained within the control.
Declaration
public Control.ControlCollection Controls { get; }
Property Value
| Type |
|---|
| System.Windows.Forms.Control.ControlCollection |
Crosshair
Gets or sets the Crosshair. Use this property to customize crosshair line and crosshair tooltip
Declaration
public ChartCrosshair Crosshair { get; set; }
Property Value
| Type |
|---|
| ChartCrosshair |
Cursor
Gets or sets the cursor that is displayed when the mouse pointer is over the control.
Declaration
public override Cursor Cursor { get; set; }
Property Value
| Type |
|---|
| System.Windows.Forms.Cursor |
CustomPalette
Gets or sets an array of custom palette colors. If Palette is Custom this colors is to be used to provide colors of series and other elements. This property duplicates CustomColors property. Palette
Declaration
public Color[] CustomPalette { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Color[] |
CustomPoints
Gets the collection of custom points. Please refer to ChartCustomPoint for more information.
Declaration
public ChartCustomPointCollection CustomPoints { get; }
Property Value
| Type |
|---|
| ChartCustomPointCollection |
DataSourceName
Gets or sets the name of data source bound with chart control in ChartWizard
Declaration
public string DataSourceName { get; set; }
Property Value
| Type |
|---|
| System.String |
DataSourceType
Gets or sets the type of object bounded with Chart in Chart Wizard.
Declaration
public string DataSourceType { get; set; }
Property Value
| Type |
|---|
| System.String |
Depth
Gets or sets axes depth, "coordinate Z". Only for enabled Series3D.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float Depth { get; set; }
Property Value
| Type |
|---|
| System.Single |
DesignTimeSeriesType
This property specifies the SeriesType to be displayed during design-time. Series displayed during design-time will be reset during run-time and are provided for representative display only.
Declaration
public ChartSeriesType DesignTimeSeriesType { get; set; }
Property Value
| Type |
|---|
| ChartSeriesType |
DisplayChartContextMenu
Gets or sets a value indicating whether the Chart Context menu should be shown. This is used only if ShowContextMenu is true.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DisplayChartContextMenu { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
DisplaySeriesContextMenu
Gets or sets a value indicating whether the Series Context Menu should be shown. This is used only if ShowContextMenu is true.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DisplaySeriesContextMenu { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
DockingManager
Gets a reference to the ChartDockingManager that manages the position of elements on the chart, like the legend.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartDockingManager DockingManager { get; }
Property Value
| Type |
|---|
| ChartDockingManager |
DropSeriesPoints
When a huge amount of points are drawn on the chart and these points can't be drawn correctly because of monitor resolution. Then performance can be improved by dropping points ( not drawing ). This property controls the intelligent point dropping. Default is false.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool DropSeriesPoints { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ElementsSpacing
Gets or sets value for spacing from border inside ChartControl e.g. space between ChartControl right border and legend right border if LegendPosition set to right.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int ElementsSpacing { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
EnableMouseRotation
Gets or sets a value indicating whether the mouse rotation should be enabled.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool EnableMouseRotation { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
EnableXZooming
Gets or sets a value indicating whether zooming should be enabled for the chart along the X axis.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool EnableXZooming { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
EnableYZooming
Gets or sets a value indicating whether zooming should be enabled for the chart along the Y axis.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool EnableYZooming { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
FancyToolTipController
Gets the fancy tool tip controller.
Declaration
public ChartFancyToolTipController FancyToolTipController { get; }
Property Value
| Type | Description |
|---|---|
| ChartFancyToolTipController | The fancy tool tip controller. |
Font
Hides the base Font property from the designer property grid and IntelliSense. This property is explicitly hidden because individual chart elements (titles, axes, legends) implement their own font styling properties.
Declaration
public override Font Font { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Font |
ForeColor
Gets or sets Chart's ForeColor. This member overrides System.Windows.Forms.Control.ForeColor
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public override Color ForeColor { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Color |
FormatAxisLabels
Gets whether ChartFormatAxisLabel event will be fired or not
Declaration
public bool FormatAxisLabels { get; }
Property Value
| Type |
|---|
| System.Boolean |
HidePartialLabels
Gets or sets a value indicating whether if a partially visible axis label should be hidden or shown. Default is false.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
[Obsolete("Use ChartAxis.HidePartialLabels instead.")]
public bool HidePartialLabels { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
HighlightSymbol
Gets or sets a value indicating whether symbols on the series should be highlighted when the mouse hovers over them or not.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool HighlightSymbol { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ImprovePerformance
Gets or sets a value indicating whether improve the chart performance. If set this property instructs chart to calculate axes ranges only before painting, not at avery series adding or removing. So while adding a large number of points to a series, performance is improved significantly.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ImprovePerformance { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Indexed
Specifies if this chart is to be rendered in indexed mode. By default, chart points have X and Y values, both of which are taken into account for plotting. In indexed mode, the X values are ignored. The X axis purely represents the position of the points and not their X value. This mode is useful when representing data that has no real X axis value except position. For example, sales of two months side-by-side.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool Indexed { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IndexValues
Gets a collection of all the indexed values. It's used for indexed mode.
Declaration
public ChartIndexedValues IndexValues { get; }
Property Value
| Type |
|---|
| ChartIndexedValues |
InteractiveCursorMouseDown
Gets a value indicating whether the state of Interactive mouse cursor is down.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool InteractiveCursorMouseDown { get; }
Property Value
| Type |
|---|
| System.Boolean |
InvertedSeriesIsCompatible
Gets or sets a value indicating whether the inverted series is compatible
Declaration
public bool InvertedSeriesIsCompatible { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsWindowLess
Gets or sets a value indicating whether the chart control is working as simple object. If it's true then chart don't uses functional of the control. This property is hidden from the designer property grid and IntelliSense. This is primarily for advanced rendering scenarios and should not be set in the designer.
Declaration
public bool IsWindowLess { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
KeyZoom
Gets or sets a value that Enables or Disables zooming with keyboard shortcuts.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool KeyZoom { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Legend
Gets the configuration information for the default legend object. Please refer to ChartLegend for more information.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartLegend Legend { get; }
Property Value
| Type |
|---|
| ChartLegend |
LegendAlignment
Gets or sets the legend alignment.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAlignment LegendAlignment { get; set; }
Property Value
| Type |
|---|
| ChartAlignment |
LegendPainted
Gets or sets a value indicating whether legend is painted.
Declaration
[Obsolete("This property isn't used anymore.")]
public bool LegendPainted { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
LegendPosition
Gets or sets the position of the legend element. Please refer to Position for more information on legend positioning options. Default is Right.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartDock LegendPosition { get; set; }
Property Value
| Type |
|---|
| ChartDock |
Legends
Gets a collection of ChartLegends that are shown in the chart. The first one is the default Legend.
Declaration
public ChartLegendsList Legends { get; }
Property Value
| Type |
|---|
| ChartLegendsList |
LegendsPlacement
Gets or sets a value indicates whether legends is located inside or outside of chart.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartPlacement LegendsPlacement { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartPlacement | The legends placement. |
Localize
Gets or sets the localize, Hides the Localize property from design-time property browsers. This property is used internally by the localization API to manage localization values. It should not be modified directly in the designer.
Declaration
public string Localize { get; set; }
Property Value
| Type |
|---|
| System.String |
MinZoomFactorX
Gets or sets the minimum allowable zooming factor for X axis.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double MinZoomFactorX { get; set; }
Property Value
| Type |
|---|
| System.Double |
MinZoomFactorY
Gets or sets the minimum allowable zooming factor for Y axis.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double MinZoomFactorY { get; set; }
Property Value
| Type |
|---|
| System.Double |
Model
The model contains all the data that is associated with a chart. Models can be shared between charts. Each model can be seen as a collection of a series. Each of these series contains data points and associated style information.
Declaration
public ChartModel Model { get; set; }
Property Value
| Type |
|---|
| ChartModel |
MouseAction
Gets or sets the mouse action.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public ChartMouseAction MouseAction { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartMouseAction | The mouse action. |
MouseDownPosition
Gets the last mouse position on the chartcontrol when the any mouse button was pressed.
Declaration
public Point MouseDownPosition { get; }
Property Value
| Type |
|---|
| System.Drawing.Point |
Remarks
This property is used for zooming only.
NeedPerformance
Gets or sets a value indicating whether improve the Performance. This property will automatically set to true when BeginUpdate() is called and improve the ChartType rendering time. So while adding a large number of points to a series, performance is improved significantly.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool NeedPerformance { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
NeedRegionUpdate
Gets or sets indicating whether the Regions are need to update. It specifies if the internal ChartRegions are to be updated. Also redraws the chart.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool NeedRegionUpdate { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Palette
Gets or sets the palette that is to be used to provide default colors for series and other elements of a chart. Please refer to ChartColorPalette for available options and customization.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartColorPalette Palette { get; set; }
Property Value
| Type |
|---|
| ChartColorPalette |
Polar
Gets a value indicating whether the chart is Polar. This returns True if type of the first series is ChartSeriesType.Polar.
Declaration
public bool Polar { get; }
Property Value
| Type |
|---|
| System.Boolean |
PrimaryXAxis
Gets the primary X axis.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartAxis PrimaryXAxis { get; }
Property Value
| Type | Description |
|---|---|
| ChartAxis | The primary X axis. |
PrimaryYAxis
Gets the primary Y axis.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartAxis PrimaryYAxis { get; }
Property Value
| Type | Description |
|---|---|
| ChartAxis | The primary Y axis. |
PrintColorMode
Gets or sets the print color mode.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public ChartPrintColorMode PrintColorMode { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartPrintColorMode | The print color mode. |
PrintDocument
Gets the print document.
Declaration
public ChartPrintDocument PrintDocument { get; }
Property Value
| Type | Description |
|---|---|
| ChartPrintDocument | The print document. |
Radar
Gets a value indicating whether the chart is Radar. This returns True if type of the first series is ChartSeriesType.Radar.
Declaration
public bool Radar { get; }
Property Value
| Type |
|---|
| System.Boolean |
RadarStyle
Gets or sets a value indicates the style of the radar chart.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartRadarAxisStyle RadarStyle { get; set; }
Property Value
| Type |
|---|
| ChartRadarAxisStyle |
RealMode3D
Gets or sets a value indicating whether the chart should be displayed in a 3D plane.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool RealMode3D { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
RequireAxes
Gets or sets a value indicating whether the chart requires axes.
Declaration
public bool RequireAxes { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
RequireInvertedAxes
Gets or sets a value indicating whether the chart requires inverted axes.
Declaration
public bool RequireInvertedAxes { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ResetOnDoubleClick
Gets or sets a value indicating whether to reset the chart on double click
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool ResetOnDoubleClick { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Rotation
Gets or sets the angle rotation of axes relative to axis X.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float Rotation { get; set; }
Property Value
| Type |
|---|
| System.Single |
RoundingPlaces
Gets or sets the number of places to round data to for display (by default).
Declaration
[Obsolete("This property is useless")]
public int RoundingPlaces { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
ScrollPrecision
Gets or sets the scroll precision. Specifies the scrolling accuracy of the scroll bars.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public int ScrollPrecision { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The scroll precision. |
Series
Shortcut method that provides access to the ChartSeriesCollection contained in the chart's model.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleAndCollection, typeof(ChartSeries))]
public ChartSeriesCollection Series { get; }
Property Value
| Type |
|---|
| ChartSeriesCollection |
Series3D
Specifies if the chart is displayed as 3D.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool Series3D { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
SeriesContextMenu
Gets the configuration information for the series context menu object
Declaration
public ChartSeriesContextMenu SeriesContextMenu { get; }
Property Value
| Type |
|---|
| ChartSeriesContextMenu |
SeriesHighlight
Specified if series on the chart should be highlighted when the mouse hovers over them or on legend item.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool SeriesHighlight { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
SeriesHighlightIndex
Specifies the series's index when mouse hovering on the legend item and the correspnding series will be highlighted. It is used for internal purpose. If it is set externally, only the specified series will be others won't.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int SeriesHighlightIndex { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
ShadowColor
Gets or sets color of shadow.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo ShadowColor { get; set; }
Property Value
| Type |
|---|
| BrushInfo |
ShadowWidth
Gets or sets width of shadow.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int ShadowWidth { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
ShowContextMenu
Gets or sets a value indicating whether show the context menu. It specifies if chart area and series context menus can be shown. See DisplayChartContextMenu and DisplaySeriesContextMenu.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowContextMenu { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowContextMenuInLegend
Gets or sets a value indicating whether show the Context menu for the Legend. It specifies if the context menu in the legend is enabled.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowContextMenuInLegend { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowLegend
Gets or sets a value indicating whether display the ChartLegend or not.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowLegend { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowScrollBars
Gets or sets a value indicating whether show the scroll bars.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool ShowScrollBars { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ShowToolbar
Gets or sets a value indicating whether show the toolbar or not.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowToolbar { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowToolbarInImage
Gets or sets a value indicating whether [show toolbar while saving the Chartcontrol as image].
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowToolbarInImage { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ShowToolTips
Gets or sets a value indicating whether show the tool tips.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool ShowToolTips { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
SizeMargins
Gets size with minimal height and width of chart control with enough places to draw chart area. This property must be used generally by parent control of chart control in order to determine the size margins.
Declaration
[Obsolete("Use properties of ChartArea.")]
public Size SizeMargins { get; }
Property Value
| Type |
|---|
| System.Drawing.Size |
Skins
Gets or sets the skin wich describes the appearance of the ChartControl.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Skins Skins { get; set; }
Property Value
| Type |
|---|
| Skins |
SmoothingMode
Specified how the chart elements should be rendered. Default is AntiAlias. Please refer to SmoothingMode in the GDI+ documentation for more information.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public SmoothingMode SmoothingMode { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Drawing2D.SmoothingMode |
Spacing
Spacing is set as a percentage value and controls what portion of the interval partitioned for rendering gets used for empty space. Default value is 10%.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float Spacing { get; set; }
Property Value
| Type |
|---|
| System.Single |
SpacingBetweenPoints
Gets or sets the spacing between points. Default value is 10%.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float SpacingBetweenPoints { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The spacing between points. |
SpacingBetweenSeries
Series Spacing is set as a percentage value and it controls the spacing between the series. Default value is 10%.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float SpacingBetweenSeries { get; set; }
Property Value
| Type |
|---|
| System.Single |
Style3D
Specifies if the 3D chart is displayed with 3D style.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool Style3D { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
StyleDialogOptions
Gets the style dialog options.
Declaration
public ChartStyleDialogOptions StyleDialogOptions { get; }
Property Value
| Type | Description |
|---|---|
| ChartStyleDialogOptions | The style dialog options. |
Text
Specifies the default title text.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public override string Text { get; set; }
Property Value
| Type |
|---|
| System.String |
TextAlignment
Gets or sets a value which specifies the alignment of the chart's text.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public StringAlignment TextAlignment { get; set; }
Property Value
| Type |
|---|
| System.Drawing.StringAlignment |
TextPosition
Gets or sets the position of text displayed as the chart's caption. Please refer to ChartTextPosition for available options.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartTextPosition TextPosition { get; set; }
Property Value
| Type |
|---|
| ChartTextPosition |
TextRenderingHint
Gets or sets the way text is drawn. Default is SystemDefault.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public TextRenderingHint TextRenderingHint { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Text.TextRenderingHint |
Tilt
Gets or sets the angle tilt of axes relative to axis Y.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float Tilt { get; set; }
Property Value
| Type |
|---|
| System.Single |
Title
Gets the default title.
Declaration
public ChartTitle Title { get; }
Property Value
| Type |
|---|
| ChartTitle |
Titles
Gets the list of ChartTitle entries. The first one is the default Title.
Declaration
public ChartTitlesList Titles { get; }
Property Value
| Type |
|---|
| ChartTitlesList |
ToolBar
Gets the configuration information for the toolbar object.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartToolBarInfo ToolBar { get; }
Property Value
| Type |
|---|
| ChartToolBarInfo |
Tooltip
Declaration
public ChartTooltip Tooltip { get; set; }
Property Value
| Type |
|---|
| ChartTooltip |
Trackball
Gets or sets the trackball. Use this property to customize trackball line, tooltip, symbol etc..,
Declaration
public ChartTrackball Trackball { get; set; }
Property Value
| Type |
|---|
| ChartTrackball |
VisualTheme
Hidden from designer property grid - this property sets the Public API Skins property that controls the chart's visual theme appearance.
Declaration
public string VisualTheme { get; set; }
Property Value
| Type |
|---|
| System.String |
ZoomCancel
Gets or sets the zoom cancel. Specifies the keyboard shortcut to control ZoomCancel.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomCancel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.Keys | The zoom cancel. |
ZoomDown
Gets or sets the zoom down. Specifies the keyboard shortcut to control Zoom down.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomDown { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.Keys | The zoom down. |
ZoomFactorX
Gets or sets the ZoomFactor. The zooming factor is the value by which intervals are multiplied to have the effect of a more fine grained range. For example, if the calculated interval is 5 and the zoom factor is 0.5, then the zoomed interval with this zoom factor will be 2.5. Therefore, there will be twice as many interval points across the same range. Scrollbars will automatically appear to allow any section of the zoomed range to be viewed.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomFactorX { get; set; }
Property Value
| Type |
|---|
| System.Double |
ZoomFactorY
The zooming factor is the value by which intervals are multiplied to have the effect of a more fine grained range. For example, if the calculated interval is 5 and the zoom factor is 0.5, then the zoomed interval with this zoom factor will be 2.5. Therefore, there will be twice as many interval points across the same range. Scrollbars will automatically appear to allow any section of the zoomed range to be viewed.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomFactorY { get; set; }
Property Value
| Type |
|---|
| System.Double |
ZoomIn
Gets or sets the zoom in. Specifies the keyboard shortcut to control Zoom in.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomIn { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.Keys | The zoom in. |
Zooming
Gets a value indicating the chart is currently zoomed in.
Declaration
[ChartTemplate(ChartTemplateSet.ContentBehavior)]
public ChartZooming Zooming { get; }
Property Value
| Type |
|---|
| ChartZooming |
ZoomLeft
Gets or sets the keyboard shortcut to control zoom left
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomLeft { get; set; }
Property Value
| Type |
|---|
| System.Windows.Forms.Keys |
ZoomOut
Gets or sets the zoom out. Specifies the keyboard shortcut to control zoom out.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomOut { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.Keys | The zoom out. |
ZoomOutIncrement
Gets or sets what value to add to the ZoomFactors when the zoom out button is pressed.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomOutIncrement { get; set; }
Property Value
| Type |
|---|
| System.Double |
ZoomPositionX
Gets or sets the offset position when zoomed along the X axis.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomPositionX { get; set; }
Property Value
| Type |
|---|
| System.Double |
ZoomPositionY
Gets or sets the offset position when zoomed along the Y axis.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomPositionY { get; set; }
Property Value
| Type |
|---|
| System.Double |
ZoomRight
Gets or sets the zoom right keyboard shortcut..
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomRight { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.Keys | The zoom right. |
ZoomType
Gets or sets the zooming type.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public ZoomType ZoomType { get; set; }
Property Value
| Type | Description |
|---|---|
| ZoomType | The zooming type. |
ZoomUp
Gets or sets the zoom up keyboard shortcut.
Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public Keys ZoomUp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.Keys | The zoom up. |
Methods
AppendSeries(ChartSeries, ChartPoint)
Append point to series.
Declaration
[Obsolete("This method is not used anymore. Use ChartSeries.Points collection.")]
public void AppendSeries(ChartSeries series, ChartPoint point)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartSeries | series | The series. |
| ChartPoint | point | The point. |
BeginUpdate()
Call this method if you perform multiple changes in quick succession. EndUpdate()
Declaration
public void BeginUpdate()
BeginUpdate(Boolean)
When we called this method then it improves the performance by dropping some points(not drawing). This method controls the intelligent point dropping and also it disables some visual related features like tooltip. EndUpdate()
Declaration
public void BeginUpdate(bool improvePerformance)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | improvePerformance | if set to |
ChartAreaPointToChartControl(Point)
The ChartAreaPointToChartControl method takes a point object in ChartArea coordinates and returns a point object in ChartControl coordinates.
Declaration
public Point ChartAreaPointToChartControl(Point p)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Point | p | The point in ChartArea coordinates. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | A System.Drawing.Point value that represents the point in ChartControl coordinates. |
ChartAreaRectToChartControl(RectangleF)
The ChartAreaRectToChartControl method takes a RectangleF object in ChartArea coordinates and returns a RectangleF object in ChartControl coordinates.
Declaration
public RectangleF ChartAreaRectToChartControl(RectangleF rect)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.RectangleF | rect | The RectangleF in ChartArea coordinates. |
Returns
| Type | Description |
|---|---|
| System.Drawing.RectangleF | A System.Drawing.RectangleF value that represents the RectangleF in ChartControl coordinates. |
DisplayUserEditStylesDialog(Int32)
Displays the dialog to edit user styles for a series.
Declaration
public void DisplayUserEditStylesDialog(int seriesIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | seriesIndex | The index of the series. |
DisplayWizard()
Displays the Wizard.
Declaration
public void DisplayWizard()
Dispose(Boolean)
Dispose this control and its children.
Declaration
protected override void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
Draw(Graphics, Rectangle)
Paints the chart to graphics.
Declaration
public void Draw(Graphics g, Rectangle rc)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | Instance of the System.Drawing.Graphics. |
| System.Drawing.Rectangle | rc | The Rectangle within which to paint. |
Draw(Graphics, Size)
Paints the chart to graphics.
Declaration
public void Draw(Graphics g, Size sz)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | Instance of the System.Drawing.Graphics. |
| System.Drawing.Size | sz | The size of rectangle within which to paint. |
Draw(Image)
Paints the chart to image.
Declaration
public void Draw(Image img)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Image | img | Instance of the System.Drawing.Image. |
Draw(Image, Size)
Paints the chart to image.
Declaration
public void Draw(Image img, Size sz)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Image | img | Instance of the System.Drawing.Image. |
| System.Drawing.Size | sz | The size of rectangle within which to paint. |
DrawThumbnail(Image)
Paints the thumbnail of chart to image.
Declaration
public void DrawThumbnail(Image img)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Image | img | Instance of the System.Drawing.Image. |
DrawThumbnail(Image, Rectangle)
Paints the thumbnail of chart to image.
Declaration
public void DrawThumbnail(Image img, Rectangle r)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Image | img | Instance of the System.Drawing.Image. |
| System.Drawing.Rectangle | r | The rectangle within which to paint. |
EndUpdate()
Call this method if you called BeginUpdate() earlier and you are done with your changes. BeginUpdate()
Declaration
public void EndUpdate()
GetChartAreaBounds()
The GetChartAreaBounds method provides access to the bounds of the ChartArea.
Declaration
public Rectangle GetChartAreaBounds()
Returns
| Type | Description |
|---|---|
| System.Drawing.Rectangle | A System.Drawing.Rectangle value of the bounds of the ChartArea in ChartControl coordinates. |
GetChartAreaCoordinates(DateTime, DateTime)
Returns the client coordinates on ChartArea for the primary x and y axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(DateTime xValue, DateTime yValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | xValue | An X System.DateTime value. |
| System.DateTime | yValue | An Y System.DateTime value. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(DateTime, DateTime, ChartAxis, ChartAxis)
Returns the client coordinates on ChartArea for the specified data points in the specified axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(DateTime xValue, DateTime yValue, ChartAxis xAxis, ChartAxis yAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | xValue | An X System.DateTime value. |
| System.DateTime | yValue | An Y System.DateTime value. |
| ChartAxis | xAxis | An X axis. |
| ChartAxis | yAxis | An Y axis. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(DateTime, Double)
Returns the client coordinates on ChartArea for the primary x and y axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(DateTime xValue, double yValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | xValue | An X System.DateTime value. |
| System.Double | yValue | An Y value. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(DateTime, Double, ChartAxis, ChartAxis)
Returns the client coordinates on ChartArea for the specified data points in the specified axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(DateTime xValue, double yValue, ChartAxis xAxis, ChartAxis yAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | xValue | An X System.DateTime value. |
| System.Double | yValue | An Y value. |
| ChartAxis | xAxis | An X axis. |
| ChartAxis | yAxis | An Y axis. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(Double, DateTime)
Returns the client coordinates on ChartArea for the primary x and y axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(double xValue, DateTime yValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xValue | An X value. |
| System.DateTime | yValue | An Y System.DateTime value. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(Double, DateTime, ChartAxis, ChartAxis)
Returns the client coordinates on ChartArea for the specified data points in the specified axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(double xValue, DateTime yValue, ChartAxis xAxis, ChartAxis yAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xValue | An X value. |
| System.DateTime | yValue | An Y System.DateTime value. |
| ChartAxis | xAxis | An X axis. |
| ChartAxis | yAxis | An Y axis. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(Double, Double)
Returns the client coordinates on ChartArea for the primary x and y axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(double xValue, double yValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xValue | An X value. |
| System.Double | yValue | An Y value. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinates(Double, Double, ChartAxis, ChartAxis)
Returns the client coordinates on ChartArea for the specified data points in the specified axes.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public Point GetChartAreaCoordinates(double xValue, double yValue, ChartAxis xAxis, ChartAxis yAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xValue | An X value. |
| System.Double | yValue | An Y value. |
| ChartAxis | xAxis | An X axis. |
| ChartAxis | yAxis | An Y axis. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Point | The coordinates on ChartArea. |
GetChartAreaCoordinateX(DateTime)
Returns the matching X client coordinate on ChartArea for the specified X date time value in the specified axis.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateX(DateTime xValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | xValue | An X System.DateTime value. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The X coordinate on ChartArea. |
GetChartAreaCoordinateX(DateTime, ChartAxis)
Returns the matching X client coordinate on ChartArea for the specified X value in the specified axis.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateX(DateTime xValue, ChartAxis xAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | xValue | An X System.DateTime value. |
| ChartAxis | xAxis | An X axis. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The X coordinate on ChartArea. |
GetChartAreaCoordinateX(Double)
Returns the matching X client coordinate on ChartArea for the specified X value.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateX(double xValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xValue | An X value. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The X coordinate on ChartArea. |
GetChartAreaCoordinateX(Double, ChartAxis)
Returns the matching X client coordinate on ChartArea for the specified X value in the specified axis.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateX(double xValue, ChartAxis xAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xValue | An X value. |
| ChartAxis | xAxis | An X axis. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The X coordinate on ChartArea. |
GetChartAreaCoordinateY(DateTime)
Returns a Y client coordinate on ChartArea for the specified Y value.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateY(DateTime yValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | yValue | An Y System.DateTime value. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The Y coordinate on ChartArea. |
GetChartAreaCoordinateY(DateTime, ChartAxis)
Returns a Y client coordinate on ChartArea for the specified Y value on the specified axis.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateY(DateTime yValue, ChartAxis yAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | yValue | An Y System.DateTime value. |
| ChartAxis | yAxis | An Y axis. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The Y coordinate on ChartArea. |
GetChartAreaCoordinateY(Double)
Returns the Y client coordinate on ChartArea for the specified Y value.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateY(double yValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | yValue | An Y value. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The Y coordinate on ChartArea. |
GetChartAreaCoordinateY(Double, ChartAxis)
Returns the Y client coordinate on ChartArea for the specified Y value in the specified axis.
Declaration
[Obsolete("This method is obsolete. Use the ChartArea.GetPointByValue or ChartAxis.GetVisibleValue methods.")]
public int GetChartAreaCoordinateY(double yValue, ChartAxis yAxis)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | yValue | An Y value. |
| ChartAxis | yAxis | An Y axis. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The Y coordinate on ChartArea. |
GetChartRegions()
List of all ChartRegion objects that make up the ChartControl.
Declaration
[Obsolete("This method is obsolete. Use the ChartControl.ChartRegions property.")]
public IList GetChartRegions()
Returns
| Type | Description |
|---|---|
| System.Collections.IList | A System.Collections.IList of the ChartRegions. |
GetGraphics()
Creates the instance of Graphics for the control.
Declaration
public Graphics GetGraphics()
Returns
| Type | Description |
|---|---|
| System.Drawing.Graphics | Graphics context. |
GetHScrollBar(ChartAxis)
Returns the horizontal scrollbar corresponding to the axis supplied.
Declaration
public IChartScrollBar GetHScrollBar(ChartAxis axis)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartAxis | axis | Instance of ChartAxis. |
Returns
| Type | Description |
|---|---|
| IChartScrollBar | The object that implements interface IChartScrollBar. |
GetMinSize()
Returns the minimum size needed to display the chart.
Declaration
public SizeF GetMinSize()
Returns
| Type | Description |
|---|---|
| System.Drawing.SizeF | Minimal size. |
GetRegionFromIndexed(Int32, Int32)
Returns the ChartRegion corresponding to the series and point indexed supplied.
Declaration
public ChartRegion GetRegionFromIndexed(int seriesIndex, int pointIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | seriesIndex | Index of the series. |
| System.Int32 | pointIndex | Index of the point. |
Returns
| Type | Description |
|---|---|
| ChartRegion | The ChartRegion. |
GetSideBySideInfo(ChartSeries, ChartSeriesRenderer)
Returns the value of side by side displacement in pixels.
Declaration
[Obsolete("This method isn't used anymore and may be deleted.")]
public PointF GetSideBySideInfo(ChartSeries ser, ChartSeriesRenderer renderer)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartSeries | ser | Instance of ChartSeries. |
| ChartSeriesRenderer | renderer | Instance of ChartSeriesRenderer. |
Returns
| Type | Description |
|---|---|
| System.Drawing.PointF | A instance of PointF where X - location of side; Y - width of side. |
GetSideBySideInfoValue(ChartSeries, ChartSeriesRenderer)
Returns the value of side by side displacement in chart coordinates.
Declaration
[Obsolete("This method isn't used anymore and may be deleted.")]
public ChartPoint GetSideBySideInfoValue(ChartSeries ser, ChartSeriesRenderer renderer)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartSeries | ser | Instance of ChartSeries. |
| ChartSeriesRenderer | renderer | Instance of ChartSeriesRenderer. |
Returns
| Type | Description |
|---|---|
| ChartPoint | A instance of ChartPoint where X - location of side; Y - width of side. |
GetStackInfo(ChartSeries, Int32)
This method is used when series are rendered stacked. The value returned is a cumulative value of Y from all series that are below the series passed in in the contained ChartSeriesCollection. ChartSeriesRenderer
Declaration
[Obsolete("This method isn't used anymore and may be deleted.")]
public double GetStackInfo(ChartSeries ser, int pos)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartSeries | ser | Instance of the ChartSeries. |
| System.Int32 | pos | The index value of the point |
Returns
| Type | Description |
|---|---|
| System.Double | A sum of Y values from all series are below the series. |
GetStackInfo(ChartSeries, Int32, Boolean)
This method is used when series are rendered stacked. The value returned is a cumulative value of Y from all series that are below the series passed in in the contained ChartSeriesCollection. ChartSeriesRenderer
Declaration
[Obsolete("This method isn't used anymore and may be deleted.")]
public double GetStackInfo(ChartSeries ser, int pos, bool isWithMe)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartSeries | ser | Instance of the ChartSeries. |
| System.Int32 | pos | The index value of the point |
| System.Boolean | isWithMe | If true the value form this series added too. |
Returns
| Type | Description |
|---|---|
| System.Double | A sum of Y values from all series are below the series. |
GetVScrollBar(ChartAxis)
Returns the vertical scrollbar corresponding to the axis supplied.
Declaration
public IChartScrollBar GetVScrollBar(ChartAxis axis)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartAxis | axis | Instance of ChartAxis. |
Returns
| Type | Description |
|---|---|
| IChartScrollBar | The object that implements interface IChartScrollBar. |
IsRandomSeries(ChartSeries)
Checks is whether a series is added by ChartControl (Random datas).
Declaration
public static bool IsRandomSeries(ChartSeries series)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartSeries | series | Instance of the ChartSeries. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the series is added by ChartControl. |
NotifySeriesChanged()
Calls the SeriesChanged(Object, ChartSeriesCollectionChangedEventArgs) method.
Declaration
public void NotifySeriesChanged()
OnBackColorChanged(EventArgs)
This member overrides System.Windows.Forms.Control.OnBackColorChanged(System.EventArgs).
Declaration
protected override void OnBackColorChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An EventArgs that contains the event data. |
OnChartFormatAxisLabel(ChartAxis, ChartFormatAxisLabelEventArgs)
Raises the ChartFormatAxisLabelevent.
Declaration
public void OnChartFormatAxisLabel(ChartAxis axis, ChartFormatAxisLabelEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartAxis | axis | Instance of ChartAxis. |
| ChartFormatAxisLabelEventArgs | args | Argument. |
OnClick(EventArgs)
This member overrides System.Windows.Forms.Control.OnClick(System.EventArgs).
Declaration
protected override void OnClick(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnDoubleClick(EventArgs)
This member overrides System.Windows.Forms.Control.OnDoubleClick(System.EventArgs).
Declaration
protected override void OnDoubleClick(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnFontChanged(EventArgs)
This member overrides System.Windows.Forms.Control.OnFontChanged(System.EventArgs).
Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnForeColorChanged(EventArgs)
Raises the System.Windows.Forms.Control.ForeColorChanged event.
Declaration
protected override void OnForeColorChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnLayoutCompleted(Object, EventArgs)
Raises the LayoutCompleted event.
Declaration
public void OnLayoutCompleted(object sender, EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The sender of the event. |
| System.EventArgs | e | An System.EventArgs object that contains the event data. |
OnLostFocus(EventArgs)
This member overrides System.Windows.Forms.Control.OnLostFocus(System.EventArgs).
Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnMouseDown(MouseEventArgs)
This member overrides System.Windows.Forms.Control.OnMouseDown(System.Windows.Forms.MouseEventArgs).
Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
OnMouseLeave(EventArgs)
This member overrides System.Windows.Forms.Control.OnMouseLeave(System.EventArgs).
Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnMouseMove(MouseEventArgs)
This member overrides System.Windows.Forms.Control.OnMouseMove(System.Windows.Forms.MouseEventArgs).
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
OnMouseUp(MouseEventArgs)
This member overrides System.Windows.Forms.Control.OnMouseUp(System.Windows.Forms.MouseEventArgs).
Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
OnMouseWheel(MouseEventArgs)
This member overrides System.Windows.Forms.Control.OnMouseWheel(System.Windows.Forms.MouseEventArgs).
Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
OnSeriesIncompatible(Object, EventArgs)
Raises the SeriesIncompatible event.
Declaration
public void OnSeriesIncompatible(object sender, EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The sender of the event. |
| System.EventArgs | e | An System.EventArgs object that contains the event data. |
OnSizeChanged(EventArgs)
Raises the System.Windows.Forms.Control.SizeChanged event.
Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | Argument. |
OnTextChanged(EventArgs)
This member overrides System.Windows.Forms.Control.OnTextChanged(System.EventArgs).
Declaration
protected override void OnTextChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
RecalculateSizes()
Updates necessary sizes.
Declaration
public virtual void RecalculateSizes()
RecalculateSizes(Graphics)
Updates necessary sizes.
Declaration
public virtual void RecalculateSizes(Graphics g)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | Instance of Graphics. |
Redraw(Boolean)
Forces the redraw of the Chart Area.
Declaration
public void Redraw(bool update)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | update |
|
Refresh()
This method overrides System.Windows.Forms.Control.Refresh
Declaration
public override void Refresh()
ResetText()
Used by the designer to reset the current value of the Text property.
Declaration
public override void ResetText()
SaveImage(String)
Saves the chart as an image in the specified format.
Declaration
public void SaveImage(string filename)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filename | The filename with extension that specifies the type of format to save to. |
Remarks
Supported formats are bmp, jpg, gif, tiff, wmf, emf, svg and eps.
SeriesChanged(Object, ChartSeriesCollectionChangedEventArgs)
Method is called when the series was changed.
Declaration
public void SeriesChanged(object sender, ChartSeriesCollectionChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | |
| ChartSeriesCollectionChangedEventArgs | e |
SetLegend(ChartLegend)
This method is not used anymore. Use the Legends collection.
Declaration
[Obsolete("This method is not used anymore. Please use Legends collection.")]
public void SetLegend(ChartLegend legend)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartLegend | legend | Instance of the new legend. |
WndProc(ref Message)
Declaration
protected override void WndProc(ref Message m)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Message | m |
ZoomingChanged(ChartAxis)
Call this method for updated settings of the scrollbar corresponding to the axis supplied.
Declaration
public void ZoomingChanged(ChartAxis axis)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartAxis | axis | An Axis that indicates the scrollbar. |
Events
ChartAreaPaint
Event that is raised when the ChartArea is painted.
Declaration
public event PaintEventHandler ChartAreaPaint
Event Type
| Type |
|---|
| System.Windows.Forms.PaintEventHandler |
ChartAxisLabelClick
Event that will be raised when the mouse is clicked on an axis label.
Declaration
public event EventHandler<ChartRegionMouseEventArgs> ChartAxisLabelClick
Event Type
| Type |
|---|
| System.EventHandler<ChartRegionMouseEventArgs> |
ChartFormatAxisLabel
Event for dynamic formatting of axis labels.
Declaration
public event ChartFormatAxisLabelEventHandler ChartFormatAxisLabel
Event Type
| Type |
|---|
| ChartFormatAxisLabelEventHandler |
ChartImage
Event that is raised when image is created for chart.
Declaration
public event ChartAreaImageEventHandler ChartImage
Event Type
| Type |
|---|
| ChartAreaImageEventHandler |
ChartRegionClick
Event that will be raised when the mouse is clicked within a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionClick
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionDoubleClick
Event that will be raised when the mouse is double clicked within a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionDoubleClick
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionMouseDown
Event that will be raised when the mouse is pressed down within a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionMouseDown
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionMouseEnter
Event that will be raised when the mouse enters a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionMouseEnter
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionMouseHover
Event that will be raised when the mouse hovers over a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionMouseHover
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionMouseLeave
Event that will be raised when the mouse leaves a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionMouseLeave
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionMouseMove
Event that will be raised when the mouse is released within a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionMouseMove
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
ChartRegionMouseUp
Event that will be raised when the mouse is released within a chart region.
Declaration
public event ChartRegionMouseEventHandler ChartRegionMouseUp
Event Type
| Type |
|---|
| ChartRegionMouseEventHandler |
LayoutCompleted
Event that will be raised when Chart has completed laying out of axes, legend
Declaration
public event EventHandler LayoutCompleted
Event Type
| Type |
|---|
| System.EventHandler |
PreChartAreaPaint
Event that is raised before the ChartArea is painted.
Declaration
public event PaintEventHandler PreChartAreaPaint
Event Type
| Type |
|---|
| System.Windows.Forms.PaintEventHandler |
SeriesIncompatible
Event that will be raised when Chart completed updating series and finds out that series are incompatible.
Declaration
public event EventHandler SeriesIncompatible
Event Type
| Type |
|---|
| System.EventHandler |
VisibleRangeChanged
Event that will be raised when the visible range changes during zooming.
Declaration
public event EventHandler VisibleRangeChanged
Event Type
| Type |
|---|
| System.EventHandler |
VisibleRangeChanging
Event that will be raised when the visible range is changing during zooming.
Declaration
public event ChartAxisZoomingEventHandler VisibleRangeChanging
Event Type
| Type |
|---|
| ChartAxisZoomingEventHandler |
Explicit Interface Implementations
IChartAreaHost.IsDesignTime
Gets a value indicating whether it's design time.
Declaration
bool IChartAreaHost.IsDesignTime { get; }
Returns
| Type | Description |
|---|---|
| System.Boolean |
|