Skip to content

ChartDataMapping

ClassChartGuruChartGuru
[Serializable]
public class ChartDataMapping

Inspector-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.

[Tooltip("Column whose values become the X axis. Optional — when empty, the row index is used.")]
public string XColumn

No description is available for this member.

Returns

System.String — No return description is available.

[Tooltip("Column used as the data label. Falls back to XColumn, then row index.")]
public string LabelColumn

No description is available for this member.

Returns

System.String — No return description is available.

[Tooltip("Y column (long format) or list of Y columns (wide format).")]
public string[] YColumns

No description is available for this member.

Returns

System.String[] — No return description is available.

[Tooltip("When true, every YColumn is its own series. When false, SeriesByColumn pivots a single Y column into multiple series.")]
public bool WideFormat

No description is available for this member.

Returns

System.Boolean — No return description is available.

[Tooltip("Long-format only: column whose distinct values become series keys.")]
public string SeriesByColumn

No description is available for this member.

Returns

System.String — No return description is available.

[Header("Date Parsing")]
[Tooltip("DateTime.ParseExact format string. Empty = auto-detect via DateTime.Parse.")]
public string DateFormat

No description is available for this member.

Returns

System.String — No return description is available.

[Tooltip("Culture name for date parsing (e.g. 'en-US', 'de-DE'). Empty = invariant.")]
public string DateCulture

No description is available for this member.

Returns

System.String — No return description is available.

[Header("OHLC (Candlestick)")]
[Tooltip("Open column. When all four OHLC fields are set, candlestick marks are emitted.")]
public string OpenColumn

No description is available for this member.

Returns

System.String — No return description is available.

public string HighColumn

No description is available for this member.

Returns

System.String — No return description is available.

public string LowColumn

No description is available for this member.

Returns

System.String — No return description is available.

public string CloseColumn

No description is available for this member.

Returns

System.String — No return description is available.

[Header("Filtering")]
[Tooltip("Maximum rows to consume from the parsed data (0 = unlimited).")]
public int MaxRows

No description is available for this member.

Returns

System.Int32 — No return description is available.

public ChartDataMapping Clone()

No description is available for this member.

Returns

ChartGuru.ChartDataMapping — No return description is available.

public bool ShapeEquals(ChartDataMapping other)

Quick equality check used by the diff fast-path.

Parameters

Name Type Description
other ChartGuru.ChartDataMapping

Returns

System.Boolean — No return description is available.

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 — No return description is available.

public bool IsConfigured { get; }

True when there is at least one Y column (or OHLC) to plot.

Returns

System.Boolean — No return description is available.