ChartDataMapping
public class ChartDataMappingInspector-editable mapping that tells a file/live data source which columns of a parsed ChartGuru.ChartTabularData become which axes.
Two flavours of multi-series data are supported:
- Long format (default): one Y column, plus an optional `ChartGuru.ChartDataMapping.SeriesByColumn`. Each distinct value of that column becomes a series.
- Wide format (`ChartGuru.ChartDataMapping.WideFormat` = true): every column listed in `ChartGuru.ChartDataMapping.YColumns` is a series; `ChartGuru.ChartDataMapping.SeriesByColumn` is ignored.
OHLC mappings (Candlestick) are configured via `ChartGuru.ChartDataMapping.OpenColumn`/`ChartGuru.ChartDataMapping.HighColumn`/`ChartGuru.ChartDataMapping.LowColumn`/`ChartGuru.ChartDataMapping.CloseColumn`. When all four are non-empty the source emits [ChartGuru.CandleStickMark](/tools/chartguru/api/chartguru-candlestickmark/)s regardless of the chart's selected type.
Fields
Section titled “Fields”
XColumn
Section titled “XColumn”public string XColumnReturns
System.String
LabelColumn
Section titled “LabelColumn”public string LabelColumnReturns
System.String
YColumns
Section titled “YColumns”public string[] YColumnsReturns
System.String[]
WideFormat
Section titled “WideFormat”public bool WideFormatReturns
System.Boolean
SeriesByColumn
Section titled “SeriesByColumn”public string SeriesByColumnReturns
System.String
DateFormat
Section titled “DateFormat”public string DateFormatReturns
System.String
DateCulture
Section titled “DateCulture”public string DateCultureReturns
System.String
OpenColumn
Section titled “OpenColumn”public string OpenColumnReturns
System.String
HighColumn
Section titled “HighColumn”public string HighColumnReturns
System.String
LowColumn
Section titled “LowColumn”public string LowColumnReturns
System.String
CloseColumn
Section titled “CloseColumn”public string CloseColumnReturns
System.String
MaxRows
Section titled “MaxRows”public int MaxRowsReturns
System.Int32
Methods
Section titled “Methods”
Clone()
Section titled “Clone()”public ChartDataMapping Clone()Creates an independent copy of this Chart Data Mapping; later configuration changes do not affect the original instance.
Returns
ChartGuru.ChartDataMapping
ShapeEquals(ChartDataMapping)
Section titled “ShapeEquals(ChartDataMapping)”public bool ShapeEquals(ChartDataMapping other)Quick equality check used by the diff fast-path.
Parameters
| Name | Type |
|---|---|
other |
ChartGuru.ChartDataMapping |
Returns
System.Boolean
Constructors
Section titled “Constructors”
ChartDataMapping()
Section titled “ChartDataMapping()”public ChartDataMapping()Properties
Section titled “Properties”
IsOhlc
Section titled “IsOhlc”public bool IsOhlc { get; }True when ChartGuru.ChartDataMapping.OpenColumn/ChartGuru.ChartDataMapping.HighColumn/ChartGuru.ChartDataMapping.LowColumn/ChartGuru.ChartDataMapping.CloseColumn are all non-empty.
Returns
System.Boolean
IsConfigured
Section titled “IsConfigured”public bool IsConfigured { get; }True when there is at least one Y column (or OHLC) to plot.
Returns
System.Boolean