IntensitySeriesBase Class

LightningChart .NET Help

Base class for intensity series classes.

Inheritance Hierarchy

SystemObject
  Arction.WinForms.ChartingChartNode
    Arction.WinForms.ChartingUserInteractiveObjectInt
      Arction.WinForms.ChartingUserInteractiveObject
        Arction.WinForms.ChartingHighlightingItemBase
          Arction.WinForms.Charting.SeriesXYSeriesBaseXY
            Arction.WinForms.Charting.SeriesXYIntensitySeriesBase
              Arction.WinForms.Charting.SeriesXYIntensityGridSeries
              Arction.WinForms.Charting.SeriesXYIntensityMeshSeries

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 IntensitySeriesBase : SeriesBaseXY

<SerializableAttribute>
Public Class IntensitySeriesBase
	Inherits SeriesBaseXY

[SerializableAttribute]
public ref class IntensitySeriesBase : public SeriesBaseXY

The IntensitySeriesBase type exposes the following members.

Constructors

	Name	Description
	IntensitySeriesBase	Constructor.
	IntensitySeriesBase(IChartNode)	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.)
	ContourLineLabels	Contour Line Label's properties. Property tree: if enabled; format, font and color of text. Default state is disabled;
	ContourLineStyle	Line style.
	ContourLineType	Contour line style.
	Data	Intensity point data.
	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.)
	FastContourZoneRange	Data value range for fast contour zones. The fast contour zone is a contour line equivalent.
	Fill	Fill.
	FullInterpolation	Render with full interpolation. If only half interpolation is used, it can give performance increment with large intensity series.
	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.)
	InitialValue	Initial value for data Y. Clears the series. It is applied when creating or resizing Data array.
	LegendBoxIndex	Legendbox index. (Inherited from SeriesBaseXY.)
	LegendBoxUnits	Intensity series units, shown in legend box. Use this for intensity data units, not Y-axis units.
	LegendBoxValuesFormat	Numeric format for showing legend box value labels.
	LegendBoxValueType	Value type: time, numeric or coordinates. Affects legend box value formatting.
	LimitYToStackSegment	Limit Y draw range to segment area when y-axes are stacked. (Inherited from SeriesBaseXY.)
	Optimization	Optimization selection for the series usage. Use StaticData if data does not changed frequently, allowing faster updates when other objects in the chart are updating. DynamicData selection is better when the data is changed many times / second.
	OwnerView	Owner view. (Inherited from SeriesBaseXY.)
	ShowInLegendBox	Enlists the series title text in Legend box of the chart (Inherited from SeriesBaseXY.)
	ShowNodes	Show nodes.
	SizeX	Grid size in X dimension (Data array columns).
	SizeY	Grid size in Y dimension (Data array rows).
	Stencil	Stencil.
	Title	Series title.
	ToneColor	Surface tone color.
	TraceCell	Tracing the surface cell is enabled.
	ValueRangePalette	Color palette for Y value information.
	WireframeLineStyle	Wireframe line style.
	WireframeType	Wireframe type.
	Visible	Is the series visible (Inherited from SeriesBaseXY.)

Top

Methods

	Name	Description
	CheckSurfaceSizeForGPU	Check if the given surface size can be used with the GPU. GPU index buffer capacity is verified.
	Clear	Clears the series. Initializes Data with InitialValues. Sets the data point colors to BaseColor. (Overrides SeriesBaseXYClear.)
	CreateNewDataArray	Create new data array.
	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.)
	GetClipAreas	Get clipping areas. (Inherited from SeriesBaseXY.)
	GetContourRoutes	Get Contour to the List of levels, which is List of polylines/routes. The contour lines are rebuild with current palette steps' value and color.
	GetDataColor	Get Data array color
	GetDataValue	Get Data array value.
	GetDataXValue	Get Data array X value.
	GetDataYValue	Get Data array Y value.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMinimumsAndMaximums	Get minimums and maximums of Series X, Y and data Values.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InvalidateColorsOnly	Invalidate colors only. Use this together with Optimization = DynamicValuesData. Does not update the geometry to the GPU when not needed, allowing significantly faster rendering.
	InvalidateData	Series data has been modified directly by its array. Use this method to notify chart that this series needs a refresh. (Overrides SeriesBaseXYInvalidateData.)
	InvalidateStencil	Invalidate stencil data.
	InvalidateValuesDataOnly	Invalidate values data only. Use this together with Optimization = DynamicValuesData. Does not update the geometry to the GPU when not needed, allowing significantly faster rendering.
	IsCoordinateOverCell	Check if coordinate is over cell in the series.
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsPositionOver	Is position over series. (Overrides SeriesBaseXYIsPositionOver(Int32, Int32, Boolean).)
	LoadFromCSV	Loads series data from a CSV file. (Overrides SeriesBaseXYLoadFromCSV(String, SeparatorCSV).)
	RefreshRenderingData	Rebuilds rendering data. Expert's method for allowing multi-threaded application to pre-build rendering data before rendering stage. Rendering stage must always be synchronized to main thread, but this call can be called parallel for every series of this type.
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	SaveToCSV	Saves series data into a CSV file. (Overrides SeriesBaseXYSaveToCSV(String, SeparatorCSV).)
	SetClipAreas	Set clipping areas. Give null to disable all clip areas. (Inherited from SeriesBaseXY.)
	SetColorsData	Sets colors. Doesn't update the Data array contents itself. Very handy to make the chart render fast when the colors are being changed frequently, especially with IntensityGridSeries' PixelRendering mode enabled.
	SetDataValue	[Missing <summary> documentation for "M:Arction.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)"]
	SetHeightDataFromBitmap	Create data based on bitmap file contents. Data array will have dimensions of the bitmap Width X Height. Use options to reduce resolution and smooth it if needed. Height data of is calculated for each pixel from R, G, and B sum. 0 (black) will have the minimum value, and maximum value is obtained from 3*255 (white). If bitmap has alpha value of 0, the data is set to -INF, and the value is not drawn.
	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.)
	SetSize	Set grid size, both X and Y at same time. If you already have a large existing data, using this method is faster than setting SizeX and SizeY separately.
	SetValuesData(Double, IntensityGridValuesDataOrder)	Sets values. Doesn't update the Data array contents itself. Very handy to make the chart render fast when the data is being changed frequently, especially with IntensityGridSeries' PixelRendering mode enabled.
	SetValuesData(Single, IntensityGridValuesDataOrder)	Sets values. Doesn't update the Data array contents itself. Very handy to make the chart render fast when the data is being changed frequently, especially with IntensityGridSeries' PixelRendering mode enabled.
	ToString	Item to string. (Inherited from SeriesBaseXY.)

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.)
	TraceCellChanged	Tracing has been moved to over different intensity series cell.

Top

Fields

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

Top

Reference

Arction.WinForms.Charting.SeriesXY Namespace