BarSeries Class

LightningChart .NET Help

Bar series. Bars series present the data as vertical column(s).

Inheritance Hierarchy

SystemObject
  Arction.WinForms.ChartingChartNode
    Arction.WinForms.ChartingUserInteractiveObjectInt
      Arction.WinForms.ChartingUserInteractiveObject
        Arction.WinForms.ChartingHighlightingItemBase
          Arction.WinForms.Charting.SeriesXYSeriesBaseXY
            Arction.WinForms.Charting.SeriesXYBarSeries

Namespace: Arction.WinForms.Charting.SeriesXY
Assembly: Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1

Syntax

C++

Copy

[SerializableAttribute]
public class BarSeries : SeriesBaseXY

<SerializableAttribute>
Public Class BarSeries
	Inherits SeriesBaseXY

[SerializableAttribute]
public ref class BarSeries : public SeriesBaseXY

The BarSeries type exposes the following members.

Constructors

	Name	Description
	BarSeries	Constructor for Form designer list editor.
	BarSeries(ViewXY, AxisX, AxisY)	Constructor.

Top

Properties

	Name	Description
	AllowUserInteraction	Allow series reacting to user interaction device movement. Device hit testing with objects cause CPU overhead when the device is moved. If user interaction is not absolute necessary directly within chart and if you want to maximize the performance, set this false. (Inherited from SeriesBaseXY.)
	AssignableXAxes	List of assignable X axes (Inherited from SeriesBaseXY.)
	AssignableYAxes	List of assignable Y axes (Inherited from SeriesBaseXY.)
	AssignXAxisIndex	Index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis. (Inherited from SeriesBaseXY.)
	AssignYAxisIndex	Index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis. (Inherited from SeriesBaseXY.)
	BarThickness	Bar width in pixels
	BaseLevel	Base level value.
	BorderColor	Border color
	BorderWidth	Border width
	DisableDragToAnotherAxis	Disable dragging from Y axis to another Y axis or from chart to another chart. Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available. (Inherited from SeriesBaseXY.)
	Fill	Fill
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. (Inherited from HighlightingItemBase.)
	IncludeInAutoFit	Include series values in automatic fit. (Inherited from SeriesBaseXY.)
	LabelStyle	Bar labels style
	LegendBoxIndex	Legendbox index. (Inherited from SeriesBaseXY.)
	LimitYToStackSegment	Limit Y draw range to segment area when y-axes are stacked. (Inherited from SeriesBaseXY.)
	OwnerView	Owner view. (Inherited from SeriesBaseXY.)
	Shadow	Shadow below the bar
	ShowInLegendBox	Enlists the series title text in Legend box of the chart (Inherited from SeriesBaseXY.)
	Title	Series title
	Values	Series values
	ValuesCount	Values count stored in the Values array.
	Visible	Is the series visible (Inherited from SeriesBaseXY.)

Top

Methods

	Name	Description
	AddValue	Add value to end of Values array
	Clear	Clear all points (Overrides SeriesBaseXYClear.)
	DeleteValue	Delete a value by given index.
	DeleteValuesBeforeX	Delete values having smaller X value than given value.
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetBarRectangles	Get rendered bar rectangles of all data items of this series.
	GetClipAreas	Get clipping areas. (Inherited from SeriesBaseXY.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetText	Get Text by given index.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetXValue	Get X value by given index.
	GetYValue	Get Y value by given index.
	InvalidateData	Notify series that data has been changed and refresh is required. (Overrides SeriesBaseXYInvalidateData.)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsPositionOver(Int32, Int32, Boolean)	Is position over item. (Overrides SeriesBaseXYIsPositionOver(Int32, Int32, Boolean).)
	IsPositionOver(Int32, Int32, Int32, Boolean)	Is position over item.
	LoadFromCSV	Loads series data from a CSV file. (Overrides SeriesBaseXYLoadFromCSV(String, SeparatorCSV).)
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	SaveToCSV	Saves series data into CSV file. (Overrides SeriesBaseXYSaveToCSV(String, SeparatorCSV).)
	SetClipAreas	Set clipping areas. Give null to disable all clip areas. (Inherited from SeriesBaseXY.)
	SetHighlight	Highlights the object. This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. (Inherited from HighlightingItemBase.)
	SetProperCursor	Set proper drag cursor. Default is hand. (Inherited from UserInteractiveObject.)
	SetValue	Set value by given index
	SortData	Sort data values ascending or descending. Makes big values to be drawn closest to axis zero if sort by ascending.
	ToString	Item to string. (Overrides SeriesBaseXYToString.)

Top

Events

	Name	Description
	BeforeSeriesRendering	Occurs just before the rendering of the series takes place. (Inherited from SeriesBaseXY.)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase.)
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	OldDataDropped	Occurs when old data points have been dropped.

Top

Fields

	Name	Description
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt.)

Top

Reference

Arction.WinForms.Charting.SeriesXY Namespace