Class BarSettings

Class that handles the global settings for bar charts

Inheritance
Object
BarSettings
Implements
Inherited Members
Namespace: ZedGraph
Assembly: ZedGraph.dll
Syntax
[Serializable]
public class BarSettings : ISerializable

Constructors

| Improve this Doc View Source

BarSettings(BarSettings, GraphPane)

Copy constructor

Declaration
public BarSettings(BarSettings rhs, GraphPane parentPane)
Parameters
Type Name Description
BarSettings rhs

the BarSettings instance to be copied.
GraphPane parentPane

The GraphPane that will be the parent of this new BarSettings object.
| Improve this Doc View Source

BarSettings(GraphPane)

Constructor to build a BarSettings instance from the defaults.

Declaration
public BarSettings(GraphPane parentPane)
Parameters
Type Name Description
GraphPane parentPane

Fields

| Improve this Doc View Source

schema

Current schema value that defines the version of the serialized file

Declaration
public const int schema = 10
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

Base

Determines the base axis from which Bar graphs will be displayed.

Declaration
public BarBase Base { get; set; }
Property Value
Type Description
BarBase
Remarks

The base axis is the axis from which the bars grow with increasing value. The value is of the enumeration type BarBase.

See Also
| Improve this Doc View Source

ClusterScaleWidth

The width of an individual bar cluster on a Bar graph. This value only applies to bar graphs plotted on non-ordinal X axis types (Linear, Log, and Date.

Declaration
public double ClusterScaleWidth { get; set; }
Property Value
Type Description
Double
Remarks

This value can be calculated automatically if ClusterScaleWidthAuto is set to true. In this case, ClusterScaleWidth will be calculated if Base refers to an Axis of a non-ordinal type (IsAnyOrdinal is false). The ClusterScaleWidth is calculated from the minimum difference found between any two points on the Base Axis for any BarItem in the CurveList. The ClusterScaleWidth is set automatically each time AxisChange() is called. Calculations are done by the CalcClusterScaleWidth() method.

See Also
| Improve this Doc View Source

ClusterScaleWidthAuto

Gets or sets a property that determines if the ClusterScaleWidth will be calculated automatically.

Declaration
public bool ClusterScaleWidthAuto { get; set; }
Property Value
Type Description
Boolean
Remarks

true for the ClusterScaleWidth to be calculated automatically based on the available data, false otherwise. This value will be set to false automatically if the ClusterScaleWidth value is changed by the user.

See Also
| Improve this Doc View Source

MinBarGap

The minimum space between individual Bar within a cluster, expressed as a fraction of the bar size.

Declaration
public float MinBarGap { get; set; }
Property Value
Type Description
Single
See Also
| Improve this Doc View Source

MinClusterGap

The minimum space between Bar clusters, expressed as a fraction of the bar size.

Declaration
public float MinClusterGap { get; set; }
Property Value
Type Description
Single
See Also
| Improve this Doc View Source

Type

Determines how the BarItem graphs will be displayed. See the BarType enum for the individual types available.

Declaration
public BarType Type { get; set; }
Property Value
Type Description
BarType
See Also

Methods

| Improve this Doc View Source

BarBaseAxis()

Determine the Axis from which the Bar charts are based.

Declaration
public Axis BarBaseAxis()
Returns
Type Description
Axis

The Axis class for the axis from which the bars are based
See Also
| Improve this Doc View Source

CalcClusterScaleWidth()

Calculate the width of an individual bar cluster on a BarItem graph. This value only applies to bar graphs plotted on non-ordinal X axis types (IsAnyOrdinal is false).

Declaration
public void CalcClusterScaleWidth()
Remarks

This value can be calculated automatically if ClusterScaleWidthAuto is set to true. In this case, ClusterScaleWidth will be calculated if Base refers to an Axis of a non-ordinal type (IsAnyOrdinal is false). The ClusterScaleWidth is calculated from the minimum difference found between any two points on the Base Axis for any BarItem in the CurveList. The ClusterScaleWidth is set automatically each time AxisChange() is called.

See Also
| Improve this Doc View Source

GetClusterWidth()

Determine the width, in screen pixel units, of each bar cluster including the cluster gaps and bar gaps.

Declaration
public float GetClusterWidth()
Returns
Type Description
Single

The width of each bar cluster, in pixel units
Remarks

This method calls the GetClusterWidth(GraphPane) method for the base Axis for Bar graphs (the base Axis is assigned by the Base property).

See Also
| Improve this Doc View Source

GetObjectData(SerializationInfo, StreamingContext)

Populates a SerializationInfo instance with the data needed to serialize the target object

Declaration
[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
SerializationInfo info

A SerializationInfo instance that defines the serialized data
StreamingContext context

A StreamingContext instance that contains the serialized data

Implements