ZedGraph

https://zedgraph.github.io
Admin
ZedGraph is a .NET class library for creating 2D line, bar, and pie charts with comprehensive...
Tokens:299,631
Snippets:3,121
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### MenuClick_PageSetup(Object, EventArgs)

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Handles the 'Page Setup...' context menu item click event, which displays the page setup dialog.

```APIDOC
## MenuClick_PageSetup(object sender, EventArgs e)

### Description
Handler for the "Page Setup..." context menu item. Displays a .

### Declaration
```csharp
protected void MenuClick_PageSetup(object sender, EventArgs e)
```

### Parameters
#### Path Parameters
- **sender** (System.Object) - 
- **e** (EventArgs) - 
```

--------------------------------

### DoPageSetup() Method

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Displays a page setup dialog to the user, allowing them to modify the print settings for this ZedGraphControl.

```APIDOC
## DoPageSetup() Method

### Description
Display a to the user, allowing them to modify the print settings for this ZedGraphControl.

### Declaration
```csharp
public void DoPageSetup()
```
```

--------------------------------

### RangeMin Property Declaration

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Fill.html

Gets or sets the minimum user-scale value for gradient-by-value determination. This defines the user-scale value for the start of the gradient.

```csharp
public double RangeMin { get; set; }
```

--------------------------------

### Get ZoomState Type as String

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZoomState.html

Gets a string representation of the type of adjustment made when this scale state was saved. This typically returns 'Pan', 'Zoom', or 'Scroll'.

```csharp
public string TypeString { get; }
```

--------------------------------

### SampleMultiPointList Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.SampleMultiPointList.html

Provides constructors for creating and initializing SampleMultiPointList objects.

```APIDOC
## SampleMultiPointList()
### Description
Default constructor.
### Declaration
```csharp
public SampleMultiPointList()
```
## SampleMultiPointList(SampleMultiPointList)
### Description
The Copy Constructor. This method does NOT duplicate the data, it merely makes another "Window" into the same collection. You can make multiple copies and set the XData and/or YData properties to different values to plot different data, while maintaining only one copy of the original values.
### Declaration
```csharp
public SampleMultiPointList(SampleMultiPointList rhs)
```
### Parameters
- **rhs** (SampleMultiPointList) - The SampleMultiPointList from which to copy
```

--------------------------------

### StockPt Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.StockPt.html

Demonstrates the various ways to construct a StockPt object, from a default constructor to constructors that accept specific stock data points and a tag.

```APIDOC
## StockPt()

### Description
Default Constructor.

### Declaration
```csharp
public StockPt()
```
```

```APIDOC
## StockPt(SerializationInfo info, StreamingContext context)

### Description
Constructor for deserializing objects.

### Declaration
```csharp
protected StockPt(SerializationInfo info, StreamingContext context)
```

### Parameters
- **info** (SerializationInfo) - A SerializationInfo instance that defines the serialized data.
- **context** (StreamingContext) - A StreamingContext instance that contains the serialized data.
```

```APIDOC
## StockPt(double date, double high, double low, double open, double close, double vol)

### Description
Construct a new StockPt from the specified data values.

### Declaration
```csharp
public StockPt(double date, double high, double low, double open, double close, double vol)
```

### Parameters
- **date** (double) - The trading date (XDate).
- **high** (double) - The daily high stock price.
- **low** (double) - The daily low stock price.
- **open** (double) - The opening stock price.
- **close** (double) - The closing stock price.
- **vol** (double) - The daily trading volume.
```

```APIDOC
## StockPt(double date, double high, double low, double open, double close, double vol, string tag)

### Description
Construct a new StockPt from the specified data values including a Tag property.

### Declaration
```csharp
public StockPt(double date, double high, double low, double open, double close, double vol, string tag)
```

### Parameters
- **date** (double) - The trading date (XDate).
- **high** (double) - The daily high stock price.
- **low** (double) - The daily low stock price.
- **open** (double) - The opening stock price.
- **close** (double) - The closing stock price.
- **vol** (double) - The daily trading volume.
- **tag** (string) - The user-defined Tag property.
```

```APIDOC
## StockPt(PointPair rhs)

### Description
The StockPt copy constructor.

### Declaration
```csharp
public StockPt(PointPair rhs)
```

### Parameters
- **rhs** (PointPair) - The basis for the copy.
```

```APIDOC
## StockPt(StockPt rhs)

### Description
The StockPt copy constructor.

### Declaration
```csharp
public StockPt(StockPt rhs)
```

### Parameters
- **rhs** (StockPt) - The basis for the copy.
```

--------------------------------

### ZoomStack Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.GraphPane.html

Gets a reference to the ZoomStateStack for this GraphPane.

```APIDOC
## ZoomStack Property

### Description
Gets a reference to the ZoomStateStack for this GraphPane.

### Property Value
- **ZoomStateStack** - 
```

--------------------------------

### Selection

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Readonly property that gets the list of selected CurveItems.

```APIDOC
## Selection

### Description
Readonly property that gets the list of selected CurveItems.

### Property
`public Selection Selection { get; }`

### Property Value
- **Selection**: 
```

--------------------------------

### StickItem Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.StickItem.html

Demonstrates various ways to construct a StickItem, from basic initialization with a label to providing arrays of X and Y values, color, and line width.

```csharp
protected StickItem(SerializationInfo info, StreamingContext context)
```

```csharp
public StickItem(string label)
```

```csharp
public StickItem(string label, double[] x, double[] y, Color color)
```

```csharp
public StickItem(string label, double[] x, double[] y, Color color, float lineWidth)
```

```csharp
public StickItem(string label, IPointList points, Color color)
```

```csharp
public StickItem(string label, IPointList points, Color color, Single lineWidth)
```

--------------------------------

### GraphPane Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Gets or sets the GraphPane property for the control.

```APIDOC
## GraphPane

### Description
Gets or sets the GraphPane property for the control.

### Declaration
```csharp
public GraphPane GraphPane { get; set; }
```

### Property Value
Type | Description
---|---
GraphPane |

### Remarks
ZedGraphControl actually uses a MasterPane object to hold a list of GraphPane objects. This property really only accesses the first GraphPane in the list. If there is more than one GraphPane, use the MasterPane indexer property to access any of the GraphPane objects.
```

--------------------------------

### PolyObj Constructor with Points and Colors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PolyObj.html

Initializes a PolyObj with specified points, border color, and a solid fill color. The points are defined in units determined by the CoordinateFrame.

```csharp
public PolyObj(PointD[] points, Color borderColor, Color fillColor)
```

--------------------------------

### PolyObj Constructor with Points and Gradient Colors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PolyObj.html

Initializes a PolyObj with specified points, border color, and two colors for a gradient fill. The points are defined in units determined by the CoordinateFrame.

```csharp
public PolyObj(PointD[] points, Color borderColor, Color fillColor1, Color fillColor2)
```

--------------------------------

### Type Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Scale.html

Gets the type of the scale as an AxisType enumeration.

```APIDOC
## Type Property

### Description
Gets an AxisType enumeration that indicates the type of this scale.

### Property Value
- **AxisType**: The type of the scale.
```

--------------------------------

### Border Constructor with Visibility, Color, and Width

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Border.html

Initializes a new instance of the Border class specifying visibility, color, and pen width.

```csharp
public Border(bool isVisible, Color color, float width)
```

--------------------------------

### GetMetafile

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PaneBase.html

Gets an enhanced metafile image for the current GraphPane.

```APIDOC
## GetMetafile()

### Description
Gets an enhanced metafile image for the current GraphPane.

### Method Signature
```csharp
public Metafile GetMetafile()
```

### Returns
- **Metafile** - 

### See Also
- GetImage()
- GetImage(Int32, Int32, Single)
- GetMetafile(Int32, Int32)
```

```APIDOC
## GetMetafile(Int32, Int32)

### Description
Gets an enhanced metafile image for the current GraphPane, scaled to the specified size.

### Method Signature
```csharp
public Metafile GetMetafile(int width, int height)
```

### Parameters
#### Path Parameters
- **width** (System.Int32) - The "effective" scaled width of the bitmap in pixels
- **height** (System.Int32) - The "effective" scaled height of the bitmap in pixels

### Returns
- **Metafile** - 

### Remarks
By definition, a Metafile is a vector drawing, and therefore scaling should not matter. However, this method is provided because certain options in Zedgraph, such as IsFontsScaled are affected by the size of the expected image.

### See Also
- GetImage()
- GetImage(Int32, Int32, Single)
- GetMetafile()
```

```APIDOC
## GetMetafile(Int32, Int32, Boolean)

### Description
Gets an enhanced metafile image for the current GraphPane, scaled to the specified size.

### Method Signature
```csharp
public Metafile GetMetafile(int width, int height, bool isAntiAlias)
```

### Parameters
#### Path Parameters
- **width** (System.Int32) - The "effective" scaled width of the bitmap in pixels
- **height** (System.Int32) - The "effective" scaled height of the bitmap in pixels
- **isAntiAlias** (System.Boolean) - 

### Returns
- **Metafile** - 

### See Also
- GetImage()
- GetImage(Int32, Int32, Single)
- GetMetafile()
```

--------------------------------

### YAxisList Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.GraphPane.html

Gets the collection of Y axes that belong to this GraphPane.

```APIDOC
## YAxisList Property

### Description
Gets the collection of Y axes that belong to this GraphPane.

### Property Value
- **YAxisList** - 
```

--------------------------------

### SamplePointList Methods

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.SamplePointList.html

Includes methods for adding samples, cloning the list, and retrieving specific data values from samples.

```APIDOC
## Add(Sample)

### Description
Appends a new sample to the end of the collection.

### Method
```
public int Add(Sample sample)
```

### Parameters
- **sample** (Sample) - Required - The sample to append to the collection.

### Returns
- **Type**: System.Int32
- **Description**: The ordinal position at which the sample was added.
```

```APIDOC
## Clone()

### Description
Creates a typesafe clone of the SamplePointList. This method returns a copy of the structure but does not duplicate the data; it maintains a reference to the original data.

### Method
```
public SamplePointList Clone()
```

### Returns
- **Type**: SamplePointList
- **Description**: A new cloned SamplePointList.
```

```APIDOC
## GetValue(Sample, SampleType)

### Description
Retrieves a specific data value (as a double) from a given sample based on the specified SampleType.

### Method
```
public double GetValue(Sample sample, SampleType type)
```

### Parameters
- **sample** (Sample) - Required - The sample instance from which to extract data.
- **type** (SampleType) - Required - The data type to be extracted from the sample.

### Returns
- **Type**: System.Double
- **Description**: A double value representing the requested data from the sample.
```

--------------------------------

### SampleMultiPointList Methods

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.SampleMultiPointList.html

Methods for adding, inserting, removing, and cloning data points.

```APIDOC
## Add(PerformanceData)
### Description
Adds the specified PerformanceData struct to the end of the collection.
### Declaration
```csharp
public int Add(PerformanceData perfData)
```
### Parameters
- **perfData** (PerformanceData) - A PerformanceData struct to be added
### Returns
- **Type**: System.Int32 - The ordinal position in the collection where the values were added
## Insert(Int32, PerformanceData)
### Description
Insert the specified PerformanceData struct into the list at the specified ordinal location.
### Declaration
```csharp
public void Insert(int index, PerformanceData perfData)
```
### Parameters
- **index** (System.Int32) - The ordinal location at which to insert
- **perfData** (PerformanceData) - The PerformanceData struct to be inserted
## RemoveAt(Int32)
### Description
Remove the PerformanceData struct from the list at the specified ordinal location.
### Declaration
```csharp
public void RemoveAt(int index)
```
### Parameters
- **index** (System.Int32) - The ordinal location of the PerformanceData struct to be removed
## Clone()
### Description
Typesafe, deep-copy clone method.
### Declaration
```csharp
public SampleMultiPointList Clone()
```
### Returns
- **Type**: SampleMultiPointList - A new, independent copy of this class
```

--------------------------------

### Link Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets the hyperlink information for this CurveItem.

```APIDOC
## Link

### Description
Gets or sets the hyperlink information for this CurveItem.

### Property Value
- **Link**
```

--------------------------------

### PointPairList Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PointPairList.html

Demonstrates the different ways to initialize a PointPairList object.

```APIDOC
## PointPairList()
### Description
Default constructor for the collection class.
### Method
`public PointPairList()`

## PointPairList(Double[], Double[])
### Description
Constructor to initialize the PointPairList from two arrays of type double.
### Method
`public PointPairList(double[] x, double[] y)`
### Parameters
- **x** (System.Double[]) - Array of X values.
- **y** (System.Double[]) - Array of Y values.

## PointPairList(Double[], Double[], Double[])
### Description
Constructor to initialize the PointPairList from three arrays of type double.
### Method
`public PointPairList(double[] x, double[] y, double[] baseVal)`
### Parameters
- **x** (System.Double[]) - Array of X values.
- **y** (System.Double[]) - Array of Y values.
- **baseVal** (System.Double[]) - Array of base values.

## PointPairList(IPointList)
### Description
Constructor to initialize the PointPairList from an IPointList.
### Method
`public PointPairList(IPointList list)`
### Parameters
- **list** (IPointList) - The IPointList to copy from.

## PointPairList(PointPairList)
### Description
The Copy Constructor for PointPairList.
### Method
`public PointPairList(PointPairList rhs)`
### Parameters
- **rhs** (PointPairList) - The PointPairList from which to copy.
```

--------------------------------

### Symbol Type Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Symbol.html

Gets or sets the type (shape) of the symbol.

```csharp
public SymbolType Type { get; set; }
```

--------------------------------

### Y2AxisList Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.GraphPane.html

Gets the collection of Y2 axes that belong to this GraphPane.

```APIDOC
## Y2AxisList Property

### Description
Gets the collection of Y2 axes that belong to this GraphPane.

### Property Value
- **Y2AxisList** - 
```

--------------------------------

### Link Constructor with Parameters

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Link.html

Constructs a Link instance with a specified title, URL, and target.

```csharp
public Link(string title, string url, string target)
```

--------------------------------

### Label Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Label.html

Demonstrates the different ways to construct a Label object, from deserialization to specifying all text and font properties.

```APIDOC
## Label(SerializationInfo, StreamingContext)

### Description
Constructor for deserializing objects.

### Parameters
- **info** (SerializationInfo) - A SerializationInfo instance that defines the serialized data.
- **context** (StreamingContext) - A StreamingContext instance that contains the serialized data.
```

```APIDOC
## Label(string text, string fontFamily, float fontSize, Color color, bool isBold, bool isItalic, bool isUnderline)

### Description
Constructor to build an AxisLabel from the text and the associated font properties.

### Parameters
- **text** (string) - The text to be displayed.
- **fontFamily** (string) - The font family name.
- **fontSize** (float) - The size of the font in points and scaled according to the CalcScaleFactor() logic.
- **color** (Color) - The Color instance representing the font color.
- **isBold** (bool) - true for a bold font face.
- **isItalic** (bool) - true for an italic font face.
- **isUnderline** (bool) - true for an underline font face.
```

```APIDOC
## Label(string text, FontSpec fontSpec)

### Description
Constructor that builds a Label from a text and a FontSpec instance.

### Parameters
- **text** (string) - The text to be displayed.
- **fontSpec** (FontSpec) - The FontSpec instance.
```

```APIDOC
## Label(Label rhs)

### Description
Copy constructor.

### Parameters
- **rhs** (Label) - The Label instance to be copied.
```

--------------------------------

### DropShadowColor Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.FontSpec.html

Gets or sets the color of the drop shadow for this FontSpec.

```APIDOC
## DropShadowColor Property

### Description
Gets or sets the color of the drop shadow for this FontSpec.

### Declaration
```csharp
public Color DropShadowColor { get; set; }
```

### Property Value
Type | Description
---|---
Color | 

### Remarks
This value only applies if IsDropShadow is true.
```

--------------------------------

### Legend.Rect Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Legend.html

Gets the bounding rectangle for the Legend in screen coordinates.

```APIDOC
## Rect Property

### Description
Gets the bounding rectangle for the Legend in screen coordinates.

### Property Value
- **Type**: RectangleF
- **Description**: A screen rectangle in pixel units.
```

--------------------------------

### Border Constructor with Color and Width

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Border.html

Initializes a new instance of the Border class with specified color and pen width.

```csharp
public Border(Color color, float width)
```

--------------------------------

### NPts Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets the number of points that define this CurveItem object.

```APIDOC
## NPts

### Description
Readonly property that gives the number of points that define this CurveItem object, which is the number of points in the Points data collection.

### Property Value
- **System.Int32**
```

--------------------------------

### OHLCBarItem Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.OHLCBarItem.html

Demonstrates the different ways to construct an OHLCBarItem object.

```APIDOC
## Constructors

### OHLCBarItem(SerializationInfo info, StreamingContext context)

Constructor for deserializing objects.

### OHLCBarItem(string label)

Create a new OHLCBarItem, specifying only the legend label.

### OHLCBarItem(string label, IPointList points, Color color)

Create a new OHLCBarItem using the specified properties. Note that the IPointList should contain StockPt items.

### OHLCBarItem(OHLCBarItem rhs)

The Copy Constructor.
```

--------------------------------

### ZoomState Methods

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZoomState.html

Methods for applying state, cloning, and checking for changes.

```APIDOC
## ApplyState(GraphPane pane)

### Description
Copy the properties from this ZoomState out to the specified GraphPane.

### Parameters
- **pane** (GraphPane) - The GraphPane to which the scale range properties should be copied.

## Clone()

### Description
Typesafe, deep-copy clone method.

### Returns
- **ZoomState** - A new, independent copy of this class.

## IsChanged(GraphPane pane)

### Description
Determine if the state contained in this ZoomState object is different from the state of the specified GraphPane.

### Parameters
- **pane** (GraphPane) - The GraphPane object with which to compare states.

### Returns
- **System.Boolean** - true if the states are different, false otherwise.
```

--------------------------------

### Link Property Declaration

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets the hyperlink information for this CurveItem.

```csharp
public Link Link { get; set; }
```

--------------------------------

### SamplePointList Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.SamplePointList.html

Provides constructors for initializing a SamplePointList, including a default constructor and a copy constructor.

```APIDOC
## SamplePointList()

### Description
Default constructor for SamplePointList.

### Method
```
public SamplePointList()
```
```

```APIDOC
## SamplePointList(SamplePointList)

### Description
Copy constructor that creates a new SamplePointList structure, referencing the data from the provided SamplePointList.

### Method
```
public SamplePointList(SamplePointList rhs)
```

### Parameters
- **rhs** (SamplePointList) - The SamplePointList to be copied.
```

--------------------------------

### JapaneseCandleStickItem.Stick Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.JapaneseCandleStickItem.html

Gets a reference to the JapaneseCandleStick class associated with this item.

```APIDOC
## Properties

### Stick
Gets a reference to the JapaneseCandleStick class defined for this JapaneseCandleStickItem.

#### Declaration
```csharp
public JapaneseCandleStick Stick { get; }
```

#### Property Value
- **JapaneseCandleStick**: A reference to the associated JapaneseCandleStick object.
```

--------------------------------

### SamplePointList Default Constructor

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.SamplePointList.html

Initializes a new instance of the SamplePointList class with default settings.

```csharp
public SamplePointList()
```

--------------------------------

### RemoveRange

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.RollingPointPairList.html

Removes a range of PointPair objects starting at the specified index.

```APIDOC
## RemoveRange(Int32, Int32)

### Description
Remove a range of PointPair objects starting at the specified index.

### Method
public void RemoveRange(int index, int count)

### Parameters
- **index** (System.Int32) - The ordinal position of the first item to be removed. Throws an ArgumentOutOfRangeException if index is less than zero or greater than or equal to Count.
- **count** (System.Int32) - The number of items to be removed. Throws an ArgumentOutOfRangeException if `count` is less than zero or greater than the total available items in the queue starting from `index`.

### Remarks
All items in the queue that lie after `index` will be shifted back, and the queue will be `count` items shorter.
```

--------------------------------

### PointValueEvent

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Subscribe to this event to get the point value when a point is clicked or hovered over.

```APIDOC
## PointValueEvent

### Description
Subscribe to this event to get the point value when a point is clicked or hovered over. The handler should return a string to be displayed.

### Declaration
```csharp
public event ZedGraphControl.PointValueHandler PointValueEvent
```

### Event Type
Type | Description
---|---
ZedGraphControl.PointValueHandler | A delegate that handles the PointValueEvent.

### Example Usage
```csharp
// In your FormLoad method:
zedGraphControl1.PointValueEvent += new ZedGraphControl.PointValueHandler(MyPointValueHandler);

// Add this method to your Form1.cs:
private string MyPointValueHandler(object sender, GraphPane pane, CurveItem curve, int iPt)
{
    PointPair pt = curve[iPt];
    return "This value is " + pt.Y.ToString("f2") + " gallons";
}
```
```

--------------------------------

### JapaneseCandleStickItem Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.JapaneseCandleStickItem.html

Demonstrates the different ways to construct a JapaneseCandleStickItem. The constructor taking an IPointList requires StockPt objects.

```csharp
protected JapaneseCandleStickItem(SerializationInfo info, StreamingContext context)
```

```csharp
public JapaneseCandleStickItem(string label)
```

```csharp
public JapaneseCandleStickItem(string label, IPointList points)
```

```csharp
public JapaneseCandleStickItem(JapaneseCandleStickItem rhs)
```

--------------------------------

### ArrowObj Constructor with Color and Size

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ArrowObj.html

Initializes a new instance of the ArrowObj class with specified color, arrowhead size, and start/end points.

```csharp
public ArrowObj(Color color, float size, double x1, double y1, double x2, double y2)
```

--------------------------------

### GraphPane CurveList Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.GraphPane.html

Gets or sets the list of CurveItem objects for this GraphPane.

```csharp
public CurveList CurveList { get; set; }
```

--------------------------------

### DropShadowOffset Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.FontSpec.html

Gets or sets the offset distance of the drop shadow for this FontSpec.

```APIDOC
## DropShadowOffset Property

### Description
Gets or sets the offset distance of the drop shadow for this FontSpec.

### Declaration
```csharp
public float DropShadowOffset { get; set; }
```

### Property Value
Type | Description
---|---
System.Single | The offset distance, measured as a fraction of the scaled font height.

### Remarks
This value only applies if IsDropShadow is true.
```

--------------------------------

### HSBColor Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.HSBColor.html

Constructors for creating HSBColor instances.

```APIDOC
## HSBColor(Color)

### Description
Constructor to load an HSBColor struct from a system Color struct.

### Parameters
- **color** (Color) - The RGB struct containing the equivalent color you want to generate.

## HSBColor(Int32, Int32, Int32)

### Description
Constructor to load an HSBColor struct from hue, saturation and brightness values.

### Parameters
- **h** (Int32) - The color hue value, ranging from 0 to 255.
- **s** (Int32) - The color saturation (intensity) value, ranging from 0 (gray scale) to 255 (most colored).
- **b** (Int32) - The brightness value, ranging from 0 (black) to 255 (white).

## HSBColor(Int32, Int32, Int32, Int32)

### Description
Constructor to load an HSBColor struct from hue, saturation, brightness, and alpha values.

### Parameters
- **a** (Int32) - The alpha value (opacity), ranging from 0 (transparent) to 255 (opaque).
- **h** (Int32) - The color hue value, ranging from 0 to 255.
- **s** (Int32) - The color saturation (intensity) value, ranging from 0 (gray scale) to 255 (most colored).
- **b** (Int32) - The brightness value, ranging from 0 (black) to 255 (white).
```

--------------------------------

### ImageObj Image Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ImageObj.html

Gets or sets the Image object associated with this ImageObj.

```csharp
public Image Image { get; set; }
```

--------------------------------

### PaneBase Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PaneBase.html

Provides documentation for the various constructors available for the PaneBase class, including default, serialization, parameterized, and copy constructors.

```APIDOC
## PaneBase()

### Description
Default constructor for the PaneBase class. Leaves the Rect empty.

### Declaration
```csharp
public PaneBase()
```
```

```APIDOC
## PaneBase(SerializationInfo info, StreamingContext context)

### Description
Constructor for deserializing objects.

### Declaration
```csharp
protected PaneBase(SerializationInfo info, StreamingContext context)
```

### Parameters
- **info** (SerializationInfo) - A SerializationInfo instance that defines the serialized data.
- **context** (StreamingContext) - A StreamingContext instance that contains the serialized data.
```

```APIDOC
## PaneBase(string title, RectangleF paneRect)

### Description
Default constructor for the PaneBase class. Specifies the Title of the PaneBase, and the size of the Rect.

### Declaration
```csharp
public PaneBase(string title, RectangleF paneRect)
```

### Parameters
- **title** (string) - The title of the PaneBase.
- **paneRect** (RectangleF) - The size of the pane's rectangle.
```

```APIDOC
## PaneBase(PaneBase rhs)

### Description
The Copy Constructor.

### Declaration
```csharp
public PaneBase(PaneBase rhs)
```

### Parameters
- **rhs** (PaneBase) - The PaneBase object from which to copy.
```

--------------------------------

### YAxisIndex Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets the index number of the Y Axis to which this CurveItem belongs.

```APIDOC
## YAxisIndex

### Description
Gets or sets the index number of the Y Axis to which this CurveItem belongs.

### Property Value
- **System.Int32**

### Remarks
This value is essentially an index number into the YAxisList or Y2AxisList, depending on the setting of IsY2Axis.
```

--------------------------------

### NoDupePointList Default Constructor

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.NoDupePointList.html

Initializes a new instance of the NoDupePointList class with default settings.

```csharp
public NoDupePointList()
```

--------------------------------

### NoDupePointList Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.NoDupePointList.html

Provides documentation for the constructors of the NoDupePointList class.

```APIDOC
## NoDupePointList()

### Description
default constructor

### Declaration
```csharp
public NoDupePointList()
```

## NoDupePointList(NoDupePointList)

### Description
copy constructor -- this returns a copy of the structure, but it does not duplicate the data (it just keeps a reference to the original)

### Declaration
```csharp
public NoDupePointList(NoDupePointList rhs)
```

### Parameters
Type | Name | Description  
---|---|---
NoDupePointList | rhs | The NoDupePointList to be copied
```

--------------------------------

### IsY2Axis Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets a value that determines which Y axis this CurveItem is assigned to.

```APIDOC
## IsY2Axis

### Description
Gets or sets a value that determines which Y axis this CurveItem is assigned to.

### Property Value
- **System.Boolean**: true to assign the curve to the Y2Axis, false to assign the curve to the YAxis.

### Remarks
The YAxis is on the left side of the graph and the Y2Axis is on the right side. Assignment to an axis determines the scale that is used to draw the curve on the graph. Note that this value is used in combination with the YAxisIndex to determine which of the Y Axes (if there are multiples) this curve belongs to.
```

--------------------------------

### SampleMultiPointList Default Constructor

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.SampleMultiPointList.html

The default constructor for the SampleMultiPointList class. Initializes a new instance with default settings.

```csharp
public SampleMultiPointList()
```

--------------------------------

### PrintDocument

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Gets or sets the PrintDocument instance that is used for all of the context menu printing functions.

```APIDOC
## PrintDocument

### Description
Gets or sets the PrintDocument instance that is used for all of the context menu printing functions.

### Property Value
Type: PrintDocument
```

--------------------------------

### MenuClick_Print(Object, EventArgs)

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Handles the 'Print...' context menu item click event, which initiates the printing process.

```APIDOC
## MenuClick_Print(object sender, EventArgs e)

### Description
Handler for the "Print..." context menu item. Displays a .

### Declaration
```csharp
protected void MenuClick_Print(object sender, EventArgs e)
```

### Parameters
#### Path Parameters
- **sender** (System.Object) - 
- **e** (EventArgs) - 
```

--------------------------------

### TextLabels Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Scale.html

Gets or sets an array of strings representing the text labels for an axis.

```APIDOC
## TextLabels Property

### Description
Gets or sets the text labels for this Axis. This property is only applicable if the axis Type is set to Text.

### Property Value
- **string[]**: An array of strings representing the text labels.
```

--------------------------------

### IsVisible

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.Scale.html

Gets or sets a property that determines whether or not the scale values will be shown on the axis.

```APIDOC
## IsVisible

### Description
Gets or sets a property that determines whether or not the scale values will be shown.

### Declaration
```csharp
public bool IsVisible { get; set; }
```
```

--------------------------------

### PointPairList Methods for Adding Points

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PointPairList.html

Illustrates how to add points to the PointPairList using various methods.

```APIDOC
## Add(Double, Double)
### Description
Add a single point to the PointPairList from values of type double.
### Method
`public void Add(double x, double y)`
### Parameters
- **x** (System.Double) - The X value.
- **y** (System.Double) - The Y value.

## Add(Double, Double, Double)
### Description
Add a single point to the PointPairList from values of type double.
### Method
`public void Add(double x, double y, double z)`
### Parameters
- **x** (System.Double) - The X value.
- **y** (System.Double) - The Y value.
- **z** (System.Double) - The Z or lower dependent axis value.

## Add(Double, Double, Double, String)
### Description
Add a single point to the PointPairList from values of type double.
### Method
`public void Add(double x, double y, double z, string tag)`
### Parameters
- **x** (System.Double) - The X value.
- **y** (System.Double) - The Y value.
- **z** (System.Double) - The Z or lower dependent axis value.
- **tag** (System.String) - The Tag value for the PointPair.

## Add(Double, Double, String)
### Description
Add a single point to the PointPairList from values of type double.
### Method
`public void Add(double x, double y, string tag)`
### Parameters
- **x** (System.Double) - The X value.
- **y** (System.Double) - The Y value.
- **tag** (System.String) - The Tag value for the PointPair.

## Add(Double[], Double[])
### Description
Add a set of points to the PointPairList from two arrays of type double. If either array is null, then a set of ordinal values is automatically generated in its place. If the arrays are of different size, then the larger array prevails and the smaller array is padded with Missing values.
### Method
`public void Add(double[] x, double[] y)`
### Parameters
- **x** (System.Double[]) - A double[] array of X values.
- **y** (System.Double[]) - A double[] array of Y values.

## Add(Double[], Double[], Double[])
### Description
Add a set of points to the PointPairList from three arrays of type double. If the X or Y array is null, then a set of ordinal values is automatically generated in its place. If the Z array is null, then it is set to zero. If the arrays are of different size, then the larger array prevails and the smaller array is padded with Missing values.
### Method
`public void Add(double[] x, double[] y, double[] baseVal)`
### Parameters
- **x** (System.Double[]) - A double[] array of X values.
- **y** (System.Double[]) - A double[] array of Y values.
- **baseVal** (System.Double[]) - A double[] array of base values.
```

--------------------------------

### ValuesToolTip Constructor

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ValuesToolTip.html

Initializes a new instance of the ValuesToolTip class with specified control, active callback, and set tooltip callback.

```APIDOC
## ValuesToolTip(Control control, Action<bool> activeCallback, Action<Control, string> setToolTipCallback)

### Description
Initializes a new instance of the ValuesToolTip class.

### Parameters
#### Parameters
- **control** (Control) - The control.
- **activeCallback** (Action<bool>) - The active callback.
- **setToolTipCallback** (Action<Control, string>) - The set tool tip callback.
```

--------------------------------

### Tag Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PaneBase.html

Gets or sets the user-defined tag for this PaneBase. This tag can be any user-defined value.

```APIDOC
## Tag Property

### Description
Gets or sets the user-defined tag for this PaneBase. This tag can be any user-defined value. If it is a type, it can be used as a parameter to the IndexOfTag(String) method.

### Declaration
```csharp
public object Tag { get; set; }
```

### Property Value
Type | Description
---|---
System.Object | 

### Remarks
Note that, if you are going to Serialize ZedGraph data, then any type that you store in Tag must be a serializable type (or it will cause an exception).
```

--------------------------------

### GasGaugeRegion Constructor with Label, Min/Max Values, and Color

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.GasGaugeRegion.html

Use this constructor to create a new GasGaugeRegion instance with a specified label, minimum and maximum values, and display color. This is useful for defining distinct colored bands on a gas gauge chart.

```csharp
public GasGaugeRegion(string label, double minVal, double maxVal, Color color)
```

--------------------------------

### IsDropShadow Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.FontSpec.html

Gets or sets a value that determines if the FontSpec will be displayed with a drop shadow.

```APIDOC
## IsDropShadow Property

### Description
Gets or sets a value that determines if the FontSpec will be displayed with a drop shadow.

### Declaration
```csharp
public bool IsDropShadow { get; set; }
```

### Property Value
Type | Description
---|---
System.Boolean | 
```

--------------------------------

### LineObj.Line Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.LineObj.html

Gets or sets the LineBase object that contains the attributes for drawing this LineObj.

```APIDOC
## Line

### Description
A LineBase class that contains the attributes for drawing this LineObj.

### Declaration
```csharp
public LineBase Line { get; set; }
```

### Property Value
- **LineBase** - Represents the attributes for drawing the line.
```

--------------------------------

### StickItem Constructor

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.StickItem.html

Initializes a new instance of the StickItem class with specified label, points, color, and line width.

```csharp
public StickItem(string label, IPointList points, Color color, float lineWidth)
```

--------------------------------

### HSBColor Constructor with HSB values

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.HSBColor.html

Initializes a new instance of the HSBColor struct with specified hue, saturation, and brightness values.

```csharp
public HSBColor(int h, int s, int b)
```

--------------------------------

### Points Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets the IPointList of X,Y point sets that represent this CurveItem.

```APIDOC
## Points

### Description
The IPointList of X,Y point sets that represent this CurveItem.

### Property Value
- **IPointList**
```

--------------------------------

### Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.X2Axis.html

Provides different ways to instantiate an X2Axis object.

```APIDOC
## X2Axis()

### Description
Default constructor that sets all X2Axis properties to default values as defined in the X2Axis.Default class.

### Declaration
```csharp
public X2Axis()
```
```

```APIDOC
## X2Axis(SerializationInfo info, StreamingContext context)

### Description
Constructor for deserializing objects.

### Declaration
```csharp
protected X2Axis(SerializationInfo info, StreamingContext context)
```

### Parameters
- **info** (SerializationInfo) - A SerializationInfo instance that defines the serialized data.
- **context** (StreamingContext) - A StreamingContext instance that contains the serialized data.
```

```APIDOC
## X2Axis(string title)

### Description
Default constructor that sets all X2Axis properties to default values as defined in the X2Axis.Default class, except for the axis title.

### Declaration
```csharp
public X2Axis(string title)
```

### Parameters
- **title** (string) - The Title for this axis.
```

```APIDOC
## X2Axis(X2Axis rhs)

### Description
The Copy Constructor.

### Declaration
```csharp
public X2Axis(X2Axis rhs)
```

### Parameters
- **rhs** (X2Axis) - The X2Axis object from which to copy.
```

--------------------------------

### IsX2Axis Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets a value that determines which X axis this CurveItem is assigned to.

```APIDOC
## IsX2Axis

### Description
Gets or sets a value that determines which X axis this CurveItem is assigned to.

### Property Value
- **System.Boolean**: true to assign the curve to the X2Axis, false to assign the curve to the XAxis.

### Remarks
The XAxis is on the bottom side of the graph and the X2Axis is on the top side. Assignment to an axis determines the scale that is used to draw the curve on the graph.
```

--------------------------------

### Construct RollingPointPairList with Capacity and Preload Option

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.RollingPointPairList.html

Initializes a new instance of the RollingPointPairList class with a specified capacity. Optionally pre-allocates space for all PointPair objects if 'preLoad' is true, which can improve performance when using the Add(Double, Double, Double) method.

```csharp
public RollingPointPairList(int capacity, bool preLoad)
```

--------------------------------

### IsVisible Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.CurveItem.html

Gets or sets a value indicating whether the curve is visible on the graph.

```APIDOC
## IsVisible

### Description
Gets or sets a value indicating whether the curve is visible on the graph.

### Property Value
- **System.Boolean**
```

--------------------------------

### PointValueFormat

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Gets or sets the format for displaying tooltip values. This format is passed to ToString(String).

```APIDOC
## PointValueFormat

### Description
Gets or sets the format for displaying tooltip values. This format is passed to ToString(String).

### Property Value
Type: System.String

### Remarks
Use the  type to determine the format strings.
```

--------------------------------

### PolyObj Constructor with Points

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PolyObj.html

Initializes a PolyObj with a specified array of points. The points are defined in units determined by the CoordinateFrame.

```csharp
public PolyObj(PointD[] points)
```

--------------------------------

### HSBColor Constructor with HSB and Alpha values

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.HSBColor.html

Initializes a new instance of the HSBColor struct with specified alpha, hue, saturation, and brightness values.

```csharp
public HSBColor(int a, int h, int s, int b)
```

--------------------------------

### PointDateFormat

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.ZedGraphControl.html

Gets or sets the format for displaying tooltip values. This format is passed to ToString(String).

```APIDOC
## PointDateFormat

### Description
Gets or sets the format for displaying tooltip values. This format is passed to ToString(String).

### Property Value
Type: System.String

### Remarks
Use the  type to determine the format strings.
```

--------------------------------

### StickItem Constructors

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.StickItem.html

Provides various constructors for initializing a StickItem object with different parameters, including label, point data, color, and line width.

```APIDOC
## StickItem(SerializationInfo, StreamingContext)

### Description
Constructor for deserializing objects.

### Parameters
- **info** (SerializationInfo) - A SerializationInfo instance that defines the serialized data.
- **context** (StreamingContext) - A StreamingContext instance that contains the serialized data.
```

```APIDOC
## StickItem(String)

### Description
Create a new StickItem, specifying only the legend Label.

### Parameters
- **label** (System.String) - The label that will appear in the legend.
```

```APIDOC
## StickItem(String, Double[], Double[], Color)

### Description
Create a new StickItem using the specified properties.

### Parameters
- **label** (System.String) - The label that will appear in the legend.
- **x** (System.Double[]) - An array of double precision values that define the independent (X axis) values for this curve.
- **y** (System.Double[]) - An array of double precision values that define the dependent (Y axis) values for this curve.
- **color** (Color) - A Color value that will be applied to the Line and Symbol properties.
```

```APIDOC
## StickItem(String, Double[], Double[], Color, Single)

### Description
Create a new StickItem using the specified properties.

### Parameters
- **label** (System.String) - The label that will appear in the legend.
- **x** (System.Double[]) - An array of double precision values that define the independent (X axis) values for this curve.
- **y** (System.Double[]) - An array of double precision values that define the dependent (Y axis) values for this curve.
- **color** (Color) - A Color value that will be applied to the Line and Symbol properties.
- **lineWidth** (System.Single) - The width (in points) to be used for the Line. This width is scaled based on CalcScaleFactor(). Use a value of zero to hide the line (see IsVisible).
```

```APIDOC
## StickItem(String, IPointList, Color)

### Description
Create a new StickItem using the specified properties.

### Parameters
- **label** (System.String) - The label that will appear in the legend.
- **points** (IPointList) - A IPointList of double precision value pairs that define the X and Y values for this curve.
- **color** (Color) - A Color value that will be applied to the Line and Symbol properties.
```

```APIDOC
## StickItem(String, IPointList, Color, Single)

### Description
Create a new StickItem using the specified properties.

### Parameters
- **label** (System.String) - The label that will appear in the legend.
- **points** (IPointList) - A IPointList of double precision value pairs that define the X and Y values for this curve.
- **color** (Color) - A Color value that will be applied to the Line and Symbol properties.
- **lineWidth** (System.Single) - The width (in points) to be used for the Line. This width is scaled based on CalcScaleFactor(). Use a value of zero to hide the line (see IsVisible).
```

--------------------------------

### GraphObjList

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.PaneBase.html

Gets or sets the GraphObjList property, which manages the collection of GraphObj items associated with this pane.

```APIDOC
## GraphObjList

### Description
Gets or sets the list of GraphObj items for this GraphPane

### Declaration
```csharp
public GraphObjList GraphObjList { get; set; }
```

### Property Value
Type | Description  
---|---
GraphObjList | A reference to a GraphObjList collection object  

```

--------------------------------

### OHLCBar IsOpenCloseVisible Property

Source: https://zedgraph.github.io/v5.2/api/ZedGraph.OHLCBar.html

Gets or sets a property to show or hide the open/close 'wings' of the OHLCBar.

```csharp
public bool IsOpenCloseVisible { get; set; }
```
Tokens:
Raw