The requested page is not available for the requested platform. You are viewing the content for Default platform.

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.v19.2.Web.dll

Declaration

[DefaultValue(true)]
public bool EnableClientSideAPI { get; set; }
<DefaultValue(True)>
Public Property EnableClientSideAPI As Boolean

Property Value

Type Default Description
Boolean

true

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.

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, 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 WebChartControl.ClientInstanceName property is defined, or any client event exposed by the WebChartControl.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.

See Also