Back to Devexpress

ChartControlSettings Members

aspnetmvc-devexpress-dot-web-dot-mvc-dot-chartcontrolsettings-dot-underscore-members.md

latest26.5 KB
Original Source

ChartControlSettings Members

Contains the Chart extension settings.

Constructors

NameDescription
ChartControlSettings()Initializes a new instance of the ChartControlSettings class with default settings.

Properties

NameDescription
AccessKeyGets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
AlternateTextGets or sets the alternate text displayed instead of the chart image, when this image is unavailable.
AnnotationRepositoryProvides centralized access to all annotations that are present in the ChartControlSettings.
AnnotationsProvides access to the annotations collection of the ChartControlSettings.
AppearanceNameGets or sets the name of the appearance which is currently being used to draw the chart’s elements.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
AutoBindingSettingsEnabledObsolete. Specifies whether or not the chart’s data binding is automatically adjusted during the creation of a Pivot Chart.
AutoLayoutGets or sets a value, which specifies whether the adaptive layout feature is enabled for chart elements in the chart control.
AutoLayoutSettingsEnabledObsolete. Specifies whether or not the chart’s layout is automatically adjusted during the creation of a Pivot Chart.
AxisScaleChangedOccurs when the scale mode, measure unit, grid alignment or grid spacing of the axis scale has been changed.
AxisVisualRangeChangedOccurs when the axis visual range has been changed.
AxisWholeRangeChangedOccurs when the axis whole range has been changed.
BackColorGets or sets the chart control’s background color.
BackImageGets the background image settings of the chart control.
BinaryStorageModeGets or sets a value indicating the mode in which the chart’s image is stored on the server.
BorderOptionsGets the chart control’s border style.
BoundDataChangedOccurs every time a chart control generates its series points from the underlying data source.
Breadcrumbs
CalculatedFieldsReturns a collection of calculated fields.
CallbackRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks.
CallbackStateLoad
CallbackStateSave
ClientSideEventsGets an object that lists the client-side events specific to the ChartControlSettings.
ClientVisibleGets or sets a value that specifies the initial visibility state of a Chart on the client.
ControlStyleProvides access to the style settings declared at the root level of the extension’s wrapped web server control. Inherited from SettingsBase.
CrosshairEnabledGets or sets a value that specifies whether or not a crosshair cursor is enabled for a chart.
CrosshairOptionsGets the settings for a crosshair cursor allowing you to specify its position and appearance on a diagram.
CustomActionRouteValuesDefines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom callbacks initiated by the MVCxClientChart.PerformCallback method.
CustomCallbackObsolete. Fires when a callback has been initiated.
CustomDrawAxisLabelOccurs before axis label items are drawn when the chart’s contents are being drawn.
CustomDrawCrosshair
CustomDrawSeriesOccurs before a series is drawn when the chart’s contents are being drawn.
CustomDrawSeriesPointOccurs before a series point is drawn when the chart’s contents are being drawn.
CustomizeAutoBindingSettingsOccurs after automatic settings are applied to a chart’s data source.
CustomizeLegendObsolete. Occurs before automatic settings are applied to the legend‘s layout properties.
CustomizePieTotalLabel
CustomizeResolveOverlappingModeObsolete. Occurs before an automatic setting is applied to the overlap resolving mode of series labels.
CustomizeSimpleDiagramLayoutOccurs before automatic settings are applied to the Simple Diagram‘s layout properties.
CustomizeStackedBarTotalLabel
CustomizeXAxisLabelsObsolete. Occurs after automatic layout settings are applied to the X-axis’ labels.
CustomJSPropertiesEnables you to supply any server data that can then be parsed on the client.
CustomPaintOccurs after the chart has been drawn.
DescriptionUrlGets or sets the location of a detailed description of the chart.
DiagramGets the web chart control’s diagram and provides access to its settings.
DrillDownStateChanged
DrillDownStateChanging
EmptyChartTextProvides access to the settings of the text to be displayed in the chart, when it has no data to display.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a Chart’s content is updated via a callback.
EnableClientSideAPIGets or sets a value that specifies whether the extension to which this ChartControlSettings object is passed can be manipulated on the client side via code.
EnableClientSidePointToDiagramObsolete. Specifies whether it’s allowed to perform conversions between screen coordinates and diagram coordinates on the client-side.
EnableThemingGets or sets a value indicating whether themes apply to this extension. Inherited from SettingsBase.
FillStyleGets the chart control’s background fill style.
HeightGets or sets the height of the chart.
IndicatorsPaletteNameSpecifies the palette that is used to paint all indicators existing in a chart control.
InitEnables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
LegendGets the chart control’s legend and provides access to its settings.
LegendItemCheckedOccurs when a legend item is checked in the legend check box.
LegendsReturns a collection of additional legends.
LoadingPanelDelayObsolete. Gets or sets the delay before displaying the loading panel in the chart control.
LoadingPanelImageGets the position of an image displayed within a loading panel with respect to the panel’s text content.
LoadingPanelImagePositionObsolete. Gets or sets the position of an image displayed within a loading panel.
LoadingPanelTextObsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response.
NameSpecifies the unique identifier name for the extension. Inherited from SettingsBase.
ObjectSelectedOccurs before any chart element is selected at runtime.
PaddingSpecifies the internal space between the chart’s content (the diagram and legend) and its edge, in pixels.
PaletteBaseColorNumberGets or sets the number of a color within the selected palette, which will be used as a base color to paint series points.
PaletteNameGets or sets the name of the palette currently used to draw the chart’s elements.
PaletteRepositoryGets the palette repository of the chart.
PaneCollapsedChanged
PivotChartingCustomizeLegendOccurs before automatic settings are applied to the legend‘s layout properties.
PivotChartingCustomizeResolveOverlappingModeOccurs before an automatic setting is applied to the overlap resolving mode of series labels.
PivotChartingCustomizeXAxisLabelsOccurs after automatic layout settings are applied to the X-axis’ labels.
PivotGridDataSourceOptionsProvides access to the settings that determine the Chart’s behavior after it has bridged with a Pivot Grid.
PivotGridSeriesExcludedOccurs after a chart has been bound to a Pivot Grid.
PivotGridSeriesPointsExcludedOccurs after a chart has been bound to a Pivot Grid.
PreRenderAllows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
RenderFormatGets or sets a value specifying the image format used to display a chart.
RightToLeftGets or sets a value indicating whether chart elements are aligned using right-to-left alignment.
RuntimeSelectionObsolete. Gets or sets a value indicating if chart elements can be selected by end-users at runtime.
SaveStateOnCallbacksGets or sets a value indicating whether a chart’s view state should be saved between multiple callbacks.
SelectedItemsChangedOccurs after the selection of a chart item has been changed.
SelectedItemsChanging
SelectionModeGets or sets a value which specifies how the chart elements are selected.
SeriesProvides access to the chart control’s collection of series objects.
SeriesDataMemberGets or sets the name of the data field that contains names for automatically generated series.
SeriesNameTemplateGets the settings used to name data bound series.
SeriesSelectionModeGets or sets a value specifying how the series is selected in the chart control.
SeriesSortingGets or sets a value that specifies how series are sorted within the chart control based upon the series names.
SeriesTemplate
SettingsLoadingPanelProvides access to the loading panel settings.
ShowLoadingPanelObsolete. Gets or sets whether the loading panel can be displayed.
ShowLoadingPanelImageObsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response.
SkinIDGets or sets the skin to apply to the control. Inherited from SettingsBase.
SmallChartTextGets the settings for the text to be displayed in the chart, when it’s too small to fit the diagram.
SmallChartTextShowingOccurs when the control size does not allow you to display a readable chart.
StyleGets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
StylesProvides access to style settings that allow the appearance of the extension (and its visual elements) to be defined.
TabIndexGets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
ThemeGets or sets the name of the theme to be applied to the extension. Inherited from SettingsBase.
TitlesGets the collection of chart titles.
ToolTipGets or sets a UI element’s tooltip text. Inherited from SettingsBase.
ToolTipControllerSpecifies the tooltip controller component that controls the appearance, position and other settings of tooltips displayed in the Chart control.
ToolTipEnabledGets or sets a value that specifies whether or not a tooltip is enabled for a chart.
ToolTipOptionsGets the tooltip settings that allow you to specify its position and appearance on a diagram.
WidthGets or sets the width of the chart.

Methods

NameDescription
Dispose()Disposes the ChartControlSettings object.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
FunnelDiagram3D(Action<FunnelDiagram3D>)Configures the chart diagram as a 3D funnel diagram.
GanttDiagram(Action<GanttDiagram>)Configures the chart diagram as a gantt diagram.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
LoadFromFile(String)Restores the chart’s layout from the specified file.
LoadFromStream(Stream)Restores the chart’s layout from the specified stream.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
PolarDiagram(Action<PolarDiagram>)Configures the chart diagram as a polar diagram.
RadarDiagram(Action<RadarDiagram>)Configures the chart diagram as a radar diagram.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RegisterSummaryFunction(String, String, Nullable<ScaleType>, Int32, SummaryFunctionArgumentDescription[], SummaryFunction)Registers the custom summary function with the specified settings.
SaveToFile(String)Saves the chart’s layout to the specified file.
SaveToStream(Stream)Saves the chart’s layout to the specified stream.
SimpleDiagram(Action<SimpleDiagram>)Configures the chart diagram as a simple diagram.
SimpleDiagram3D(Action<SimpleDiagram3D>)Configures the chart diagram as a 3D simple diagram.
SwiftPlotDiagram(Action<SwiftPlotDiagram>)Configures the chart diagram as a swift plot diagram.
ToString()Returns a string that represents the current object. Inherited from Object.
XYDiagram(Action<XYDiagram>)Configures the chart diagram as a XY-diagram.
XYDiagram3D(Action<XYDiagram3D>)Configures the chart diagram as a pseudo 3D XY (Cartesian) diagram.

See Also

ChartControlSettings Class

DevExpress.Web.Mvc Namespace