Class Series

Namespace

PolarChart

Assembly

PolarChart.dll

This class contains the details of one series of data/captions.

public class Series : IDisposable

Inheritance

object

Series

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Properties

BackColor

Gets/set the background color color of the series as Windows color.

public int BackColor { get; set; }

Property Value

int

BlibType

Gets/sets the type of blib. Use one of: 0: Rectangle, 1: Rotated Rectangle, 2: Oval, 3: Triangle Up, 4: Triangle Down, 5: Asterix (*), 6: X, 7: +

public int BlibType { get; set; }

Property Value

int

BoxColor

Gets/sets the color of the box as Windows color.

public int BoxColor { get; set; }

Property Value

int

Caption

Gets/sets the caption of the series.

public string Caption { get; set; }

Property Value

string

Dimensions

Returns the number of dimensions of the series

public int Dimensions { get; }

Property Value

int

Elements

Returns the elements in the series.

public Collection<Element> Elements { get; }

Property Value

Collection<Element>

FillColor

Gets/set the fill color of the series as Windows color.

public int FillColor { get; set; }

Property Value

int

FillStyle

Gets/set the fill style (-2: no fill; -1: solid fill, 0-52 using HatchStyle)

public int FillStyle { get; set; }

Property Value

int

Font

Gets/sets the font to use for the series.

public PolarFont Font { get; }

Property Value

PolarFont

Height

Gets/sets the height of the series.

public int Height { get; set; }

Property Value

int

LabelPosition

Gets/sets the label position (0:inside; 1;at value (above))

public int LabelPosition { get; set; }

Property Value

int

LabelType

Gets/sets the label type (0:None; 1:Value; 2:Caption; 3:ValueAndCaption)

public int LabelType { get; set; }

Property Value

int

LineColor

Gets/sets the color of the line as Windows color.

public int LineColor { get; set; }

Property Value

int

LineStyle

Gets/sets the line-style

public int LineStyle { get; set; }

Property Value

int

LineWidth

Gets/sets the width of the line in pixels.

public int LineWidth { get; set; }

Property Value

int

Name

Returns the name of the series.

public string Name { get; }

Property Value

string

SeriesSubType

Gets/sets the series sub-types. Use one of: 'Line', 'Blips', 'LineAndBlips'

public string SeriesSubType { get; set; }

Property Value

string

SeriesType

Gets/sets the type of series. Only applicable for chart or type 'ColumnsAndLines': can no switch to 'Columns' or 'Lines'.

public string SeriesType { get; set; }

Property Value

string

ShadowColor

Gets/sets the color of the shadow as Windows color.

public int ShadowColor { get; set; }

Property Value

int

ShadowX

Gets/sets the x-offset for the shadow in pixels.

public int ShadowX { get; set; }

Property Value

int

ShadowY

Gets/sets the y-offset for the shadow in pixels.

public int ShadowY { get; set; }

Property Value

int

SmoothingFactor

Gets/sets smoothing for lines. 0-3: 0:no smoothing (angles), 3: max smoothing (curved).

public int SmoothingFactor { get; set; }

Property Value

int

Width

Gets/sets the width of the series (bars)

public int Width { get; set; }

Property Value

int

Methods

Add2Dvalue(double, double, string)

Adds a value to a 2 dimensional series (x-y)

public void Add2Dvalue(double pXvalue, double pYvalue, string pCaption = "")

Parameters

pXvalue double

The X value

pYvalue double

The Y value

pCaption string

The caption to show.

Exceptions

PolarException

AddCaption(string)

Adds a caption to a captions seried (Dimensions = 0)

public void AddCaption(string pCaption)

Parameters

pCaption string

The caption to add

Exceptions

PolarException

AddEmptyElement(bool)

Adds an empty element to the series. For example for a month no data is gathered for.

public void AddEmptyElement(bool pContinueLine = false)

Parameters

pContinueLine bool

If true, the line between the poins before and after this point is continued, else it will have a gap.

AddValue(double, string)

Adds a value to the series (1 dimensional).

public void AddValue(double pValue, string pCaption = "")

Parameters

pValue double

The value.

pCaption string

The caption to show.

Exceptions

PolarException

Dispose()

public void Dispose()

~Series()

protected ~Series()