Dundas Chart for ASP.NET
Chart Class Members
See Also  Properties  Methods  Events Send comments on this topic.
Dundas.Charting.WebControl Namespace : Chart Class


The following tables list the members exposed by Chart.

Public Constructors

  Name Description
Public Constructor Chart Constructor

Creates a new instance of the Chart class.


Chart control constructor.  
Top

Public Properties

  Name Description
Public Property AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property AJAXZoomEnabled The AJAXZoomEnabled property switches the type of calls made by the zoom functionality from using callbacks to using page postbacks. This allows for the refreshing of many charts in a one quick simultaneous manner.  
Public Property AnimationDuration

Enterprise Edition Only Feature. The AnimationDuration property is used to set or get the time in seconds that the animation sequence should be run.


Gets or sets the time, in seconds, that the Animation should end.  
Public Property AnimationFramesPerSecond Enterprise Edition Only Feature. Gets or sets the number of frames displayed per second.
Gets or sets number of frames per second in Flash animation.  
Public Property AnimationStartTime

Enterprise Edition Only Feature. The AnimationStartTime represents the time, in seconds, from the moment when the page is loaded to when the animation should begin.


Gets or sets the time, in seconds, that the Animation should begin.  
Public Property AnimationTheme

Enterprise Edition Only Feature. Gets or sets a predefined chart animation theme.


Gets or sets one of a predefined Animation themes.  
Public Property Annotations

This collection property stores a chart's annotations.


Chart annotation collection.  
Public Property AntiAliasing

Gets or sets a value that determines if anti-aliasing is used when text and graphics are drawn.


Specifies whether smoothing (antialiasing) is applied while drawing chart.  
Public Property AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from System.Web.UI.Control)
Public Property Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property AutoSize  
Public Property BackColor Overridden. 

Gets or sets the background color of the Chart object.


Back ground color for the Chart  
Public Property BackGradientEndColor

Gets or sets the secondary color of the chart.


The second color which is used for a gradient  
Public Property BackGradientType

Gets or sets the orientation of the Chart control's gradient, and also determines whether or not a gradient is used.


A type for the background gradient  
Public Property BackHatchStyle

Gets or sets the hatching style of the Chart control.


Back Hatch style  
Public Property BackImage

Gets or sets the background image of of the Chart control.


Chart area background image  
Public Property BackImageAlign

Gets or sets the alignment of the of the Chart control.


Background image alignment used by ClampUnscale drawing mode.  
Public Property BackImageMode

Gets or sets the drawing mode of the of the Chart control.


Chart area background image drawing mode.  
Public Property BackImageTranspColor

Gets or sets the color of the Chart control that will be implemented as transparent.


Background image transparent color.  
Public Property BorderColor

Gets or sets the border color of the Chart control.


Border color for the Chart  
Public Property BorderLineColor

Gets or sets the color of the entire chart picture's border.


Border color for the Chart  
Public Property BorderLineStyle

Gets or sets the style of the entire chart picture's border.


The style of the border line  
Public Property BorderLineWidth

Gets or sets the width of the entire chart picture's border.


The width of the border line  
Public Property BorderSkin

Returns a BorderSkinAttributes object, which provides border skin functionality for the chart.


Chart border skin style.  
Public Property BorderStyle The style of the border line  
Public Property BorderWidth The width of the border line  
Public Property CallbackManager Gets the chart callback manager.  
Public Property CallbackStateContent Indicates what type of chart state must be keeped into session variable to track chart callback changes.  
Public Property ChartAreas

Gets a read-only ChartAreaCollection object, used to store ChartArea objects.


Reference to chart area collection  
Public Property ChartScrollTimeout Time delay in milliseconds before sending callback to call ChartScroll server side event. If during this time frame another user scroll is occured, it lets send callback only for last scroll and avoid extra trips on server side.  
Public Property ClientID Gets the server control identifier generated by ASP.NET. (Inherited from System.Web.UI.Control)
Public Property Compression

Gets or sets the amount of compression for the chart image.


Image compression value  
Public Property Controls Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from System.Web.UI.Control)
Public Property ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property CustomAnimation

Gets a AnimationCollection object, which stores custom animation sequences.


Custom Animation collection.  
Public Property DataManipulator

Returns a DataManipulator object, which allows for the manipulation of data.


Series data manipulator  
Public Property DataMember Gets or sets the name of the list of data that the data-bound control binds to, in cases where the data source contains more than one distinct list of data items. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public Property DataSource Overridden. 

Gets or sets the data source for the Chart object.


"The data source used to populate series data. Series ValueMember properties must be also set."  
Public Property DataSourceID Gets or sets the ID of the control from which the data-bound control retrieves its list of data items. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public Property DataSourceObject (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public Property Enabled Gets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property EnableViewState Overridden. 

Gets or sets a boolean value that determines if state management is enabled.


Gets or sets a value indicating whether the control persists its view state.  
Public Property Font Overridden. 

Gets or sets a Font object, used to set font properties of the applicable chart element.


Font property is not used.  
Public Property ForeColor Overridden.  Fore color propery (not used)  
Public Property HasAttributes Gets a value indicating whether the control has attributes set. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property Height Overridden. 

Gets or sets the height of the entire chart image.


Chart height  
Public Property ID Gets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
Public Property ImageResolution  
Public Property ImageStorageMode Chart rendering type. Image tag, input tag, binary data streaming and image map are the options.  
Public Property ImageType

Determines the image type the chart is rendered as if "image tag" or "input tag" rendering is used.


Image type (Jpeg, BMP, Png, Svg, Flash)  
Public Property ImageUrl

Determines where an image file is saved when either image tag or input tag rendering is used.


Chart image URL. Location where chart image is saved, when image tag is used for rendering.  
Public Property Legends This collection property stores all Legend objects used by the Chart control.
Chart legend collection.  
Public Property MapAreas

Gets a MapAreasCollection object, which stores the map areas for the chart.


Chart map areas collection.  
Public Property MapEnabled

Gets or sets a boolean value that determines if client-side image maps are enabled.


Indicates that chart image map is enabled.  
Public Property NamingContainer Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from System.Web.UI.Control)
Public Property Page Gets a reference to the Page instance that contains the server control. (Inherited from System.Web.UI.Control)
Public Property Palette

Gets or sets the palette of the Chart control.


Color palette to use  
Public Property PaletteCustomColors Gets or sets an array of custom palette colors.
Array of custom palette colors.  
Public Property Parent Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
Public Property RenderType

Gets or sets the rendering method used to display a chart image.


Chart rendering type. Image tag, input tag, binary data streaming and image map are the options.  
Public Property RepeatAnimation

The RepeatAnimation property is a boolean value that is used to infinitely repeat the animation sequence after the time specified by the RepeatDelay property.


Indicates that animation must be repeated. Supported only by the Flash animation rendering engine.  
Public Property RepeatDelay

The RepeatDelay property is a double value that represents the time in seconds that should be waited between the end of an animation and the restart of the animation sequence.


Gets or sets the time, in seconds, that will be delayed before repeating the animation. The RepeatAnimation property must be set to true.  
Public Property Serializer

Gets a ChartSerializer object, which is used for chart serialization.


Chart serializer object.  
Public Property Series

Gets a SeriesCollection object.


Chart series collection.  
Public Property Site Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
Public Property SkinID Gets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property SoftShadows

Gets or sets a boolean value that determines if a smooth gradient is applied when shadows are drawn.


Specifies whether smoothing is applied while drawing shadows.  
Public Property Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property SuppressExceptions

Gets or sets a boolean value that determines if non-critical exceptions should be suppressed.


Indicates that non-critical chart exceptions will be suppressed.  
Public Property TabIndex Gets or sets the tab index of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property TemplateControl Gets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
Public Property TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
Public Property TextAntiAliasingQuality

Gets or sets the TextAntiAliasingQuality type to use when applying anti-aliasing to text.


Specifies the quality of text antialiasing.  
Public Property Titles This collection property stores all Title objects used by the Chart control.
Chart title collection.  
Public Property ToolTip

Gets or sets the tooltip for the chart image. Inherited from the WebControl class.


Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public Property UI  Gets or sets the Chart control's user interface.
Chart border skin style.  
Public Property UniqueID Gets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
Public Property ViewStateContent

Determines the view state to be persisted at the client.


Chart content saved in the view state.  
Public Property ViewStateData

Gets or sets the user-defined view state of the control.


User defined control state data in XML format.  
Public Property Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
Public Property Width Overridden. 

Gets or sets the width of the entire chart image.


Chart width  
Top

Public Methods

  Name Description
Public Method AlignDataPointsByAxisLabel Overloaded. Aligns data points along the X axis using their axis labels. Applicable when multiple series are indexed and their X-values are strings.  
Public Method ApplyPaletteColors

Causes the setting of the automatically assigned series and data point colors to allow programmatic access at runtime.


Applies palette colors to series or data points.  
Public Method ApplyStyle Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Method ApplyStyleSheetSkin Applies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
Public Method CopyBaseAttributes Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Method DataBind Overridden. 

Data binds the Chart control to a data source.


Data binds control to the data source  
Public Method DataBindCrossTab Overloaded. Data binds the chart to the table, and creates one series per unique value in a column.  
Public Method DataBindTable Overloaded. Data binds the chart to a table.  
Public Method Dispose Disposes of the object, using the IDisposable interface.  
Public Method FindControl Searches the current naming container for a server control with the specified id parameter. (Inherited from System.Web.UI.Control)
Public Method Focus Sets input focus to a control. (Inherited from System.Web.UI.Control)
Public Method GetCurrentImageUrl

Returns the URL of the current chart that will be rendered.


Gets current image URL the chart control will be rendered into.  
Public Method GetHtmlImageMap Gets the HTML image map of the currently rendered chart. Note that the control's Save method must first be called before calling this method.
Gets HTML image map of the currently rendered chart. Save(...) method MUST be called before calling this method!  
Public Method GetService Returns the service type.
Gets the requested chart service.  
Public Method HasControls Determines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
Public Method HitTest Overloaded. Call this method to determine the chart element, if any, that is located at a point defined by the given X and Y coordinates.  
Public Method LoadTemplate Overloaded. Loads a template into the control.  
Public Method MergeStyle Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Method RaisePostBackEvent A method of the IPostBackEventHandler interface that raises postback events.
Method of IPostBackEventHandler that raises change events.  
Public Method RenderBeginTag Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Method RenderControl Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from System.Web.UI.Control)
Public Method RenderEndTag Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public Method ResetAutoValues

Resets automatically calculated chart property values back to "Auto".


Reset auto calculated chart properties values to "Auto".  
Public Method ResolveClientUrl Gets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
Public Method ResolveUrl Converts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
Public Method Save Overloaded. Saves a chart image.  
Public Method Select

Retrieves the data point and series that a user selected (i.e. clicked on).


Function, which returns selected data point and selected series from x, and y coordinate position.  
Public Method SetRenderMethodDelegate Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Top

Public Events

  Name Description
Public Event AxisViewChanged Called when axis view position/size is changed.  
Public Event AxisViewChanging Called when axis view position/size is about to change.  
Public Event AxisViewZoomReset Fires when axis view zoom reset button is pressed.  
Public Event BackPaint Fires when chart element backround must be drawn. This event is fired for elements like: ChartPicture, ChartArea and Legend  
Public Event Callback  
Public Event CallbackComplete  
Public Event ChartScroll Called when axis scrolled.  
Public Event Click

This server-side event fires when a chart element is clicked on by the user.


Defines the Click event using the event property syntax. The Events property stores all the event delegates of a control as name/value pairs.  
Public Event CommandFired Fires after executing a command.  
Public Event CommandFiring Fires before executing a command.  
Public Event Customize This event fires just prior to the chart being drawn. All chart data is available and all chart properties have been set.
Fires just before the chart image is drawn. Use this event to customize the chart picture.  
Public Event CustomizeLegend This event fires just prior to the chart legend being drawn.
Fires just before the chart legend is drawn. Use this event to customize the chart legend items.  
Public Event CustomizeMapAreas This event is used to customize map areas.
Fires just before the chart image map is rendered. Use this event to customize the map areas items.  
Public Event DataBinding Occurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
Public Event DataBound Occurs after the server control binds to a data source. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Public Event Disposed Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
Public Event Init Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
Public Event Load Occurs when the server control is loaded into the Page object. (Inherited from System.Web.UI.Control)
Public Event Paint Fires when chart element must be drawn. This event is fired for elements like: ChartPicture, ChartArea and Legend  
Public Event PostPaint

This event fires after a chart element is drawn.


Fires after chart element was drawn. This event is fired for elements like: ChartPicture, ChartArea and Legend  
Public Event PrePaint

This event fires just prior to a chart element being drawn.


Fires after the chart element backround was drawn. This event is fired for elements like: ChartPicture, ChartArea and Legend  
Public Event PreRender Occurs after the Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
Public Event Unload Occurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
Top

See Also

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