Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Expand]DevExpress.Web.ASPxGauges
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Expand]DevExpress.Web.ASPxHtmlEditor.Scripts
  [Expand]DevExpress.Web.ASPxPivotGrid
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Expand]DevExpress.Web.ASPxRichEdit
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Expand]DevExpress.Web.ASPxTreeList.Scripts
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Collapse]DevExpress.XtraCharts.Web
   [Expand]CallbackStateEventArgs Class
   [Expand]CallbackStateLoadEventArgs Class
    CallbackStateLoadEventHandler Delegate
   [Expand]CallbackStateSaveEventArgs Class
    CallbackStateSaveEventHandler Delegate
   [Expand]ChartClientSideEvents Class
    ChartImagePosition Enumeration
   [Expand]ChartToolTipController Class
   [Expand]CustomCallbackEventArgs Class
    CustomCallbackEventHandler Delegate
    RenderFormat Enumeration
    ToolTipOpenMode Enumeration
   [Collapse]WebChartControl Class
     WebChartControl Members
     WebChartControl Constructor
    [Collapse]WebChartControl Properties
      AlternateText Property
      AnnotationRepository Property
      Annotations Property
      AppearanceName Property
      AppearanceNameSerializable Property
      AppearanceRepository Property
      AutoBindingSettingsEnabled Property
      AutoLayout Property
      AutoLayoutSettingsEnabled Property
      BackColor Property
      BackgroundImage Property
      BackImage Property
      BinaryStorageMode Property
      Border Property
      BorderBottom Property
      BorderLeft Property
      BorderOptions Property
      BorderRight Property
      BorderTop Property
      ClientInstanceName Property
      ClientSideEvents Property
      ClientVisible Property
      CrosshairEnabled Property
      CrosshairOptions Property
      Cursor Property
      DataAdapter Property
      DescriptionUrl Property
      Diagram Property
      DiagramSerializable Property
      DiagramTypeName Property
      EmptyChartText Property
      EnableCallbackAnimation Property
      EnableCallbackCompression Property
      EnableCallBacks Property
      EnableClientSideAPI Property
      EnableClientSidePointToDiagram Property
      Enabled Property
      EncodeHtml Property
      FakeObject Property
      FillStyle Property
      Font Property
      ForeColor Property
      Height Property
      IndicatorsPaletteName Property
      IndicatorsPaletteRepository Property
      IndicatorsPaletteWrappers Property
      JSProperties Property
      Legend Property
      Legends Property
      LoadingDivStyle Property
      LoadingPanelDelay Property
      LoadingPanelImage Property
      LoadingPanelImagePosition Property
      LoadingPanelStyle Property
      LoadingPanelText Property
      Padding Property
      PaletteBaseColorNumber Property
      PaletteName Property
      PaletteRepository Property
      PaletteWrappers Property
      PivotGridDataSourceOptions Property
      RenderFormat Property
      RightToLeft Property
      RuntimeSelection Property
      SaveStateOnCallbacks Property
      SelectedItems Property
      SelectionMode Property
      Series Property
      SeriesDataMember Property
      SeriesNameTemplate Property
      SeriesSelectionMode Property
      SeriesSerializable Property
      SeriesSorting Property
      SeriesTemplate Property
      SettingsLoadingPanel Property
      ShowLoadingPanel Property
      ShowLoadingPanelImage Property
      SideBySideBarDistanceFixed Property
      SideBySideBarDistanceVariable Property
      SideBySideEqualBarWidth Property
      SmallChartText Property
      Titles Property
      ToolTipController Property
      ToolTipEnabled Property
      ToolTipOptions Property
      Width Property
    [Expand]WebChartControl Events
    [Expand]WebChartControl Methods
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

WebChartControl.EnableClientSideAPI Property

Gets or sets a value that specifies whether the WebChartControl can be manipulated on the client side via code.

Namespace:DevExpress.XtraCharts.Web
Assembly:DevExpress.XtraCharts.v17.2.Web.dll

Expanded Syntax

Property value

Type: Boolean
true if the chart control's client object model is fully available; false if no programmatic interface is available for the chart control on the client side.
The default is true.

Expanded Remarks

The EnableClientSideAPI property controls the availability of the client-side API for the control.

The WebChartControl control implements a comprehensive JavaScript-written client-side object model (client API), allowing you to programmatically manipulate the control on the client (see DevExpress.XtraCharts.Web.Scripts, to learn more on the available client model).

If you want to use the control's client-side API in your application, set the EnableClientSideAPI property to true, to make sure that the client API is available on the client side.

Note

Regardless of the EnableClientSideAPI property setting, the client-side API is automatically enabled if the ClientInstanceName property is defined, or any client event exposed by the ClientSideEvents property is handled.

For more information, refer to Handling Client-side Scripts.

For a related tutorial, refer to How to: Use the Client-Side Model of the WebChartControl.

Expanded See Also

How would you rate this topic?​​​​​​​