Skip to content

Commit 8b43d0e

Browse files
committed
fix(skills): correct Financial Chart API reference and data binding docs
1 parent 19b6865 commit 8b43d0e

1 file changed

Lines changed: 18 additions & 25 deletions

File tree

  • skills/igniteui-angular-components/references

skills/igniteui-angular-components/references/charts.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,8 @@ chartComponent.itemsSource = dataArray;
7474
- Requires explicit axis and series components
7575

7676
**IgxFinancialChartComponent** (stock data):
77-
- `dataSource` — Data array with date + OHLC columns
77+
- `dataSource` — Data array with date + OHLC columns (fields are auto-detected by name; no member-path inputs exist on this component)
7878
- `chartType` — Chart type (Auto, Candle, Line, Bar, Column)
79-
- `openMemberPath`, `highMemberPath`, `lowMemberPath`, `closeMemberPath` — OHLC field names
8079

8180
**IgxPieChartComponent**:
8281
- `dataSource` — Data array
@@ -183,22 +182,21 @@ chartComponent.itemsSource = dataArray;
183182
- **Display Modes**:
184183
- **Price Pane**: Show candlestick, OHLC bar, line (configurable via `chartType`)
185184
- **Volume Pane**: Show trading volume (column, line, or area chart)
186-
- **Indicator Pane**: Financial indicators (RSI, MACD, Bollinger Bands, etc.)
185+
- **Indicator Pane**: Financial indicators (e.g. `RelativeStrengthIndex`, `MovingAverageConvergenceDivergence`, `AverageTrueRange` — see `indicatorTypes` below for valid enum values)
187186
- **Zoom Pane**: Navigation slider to zoom/pan
188187
- **Chart Types**: `Auto` (default), `Candle`, `Line`, `Bar`, `Column`
189188
- **API**:
190-
- `chartType` — Price display type (Auto, Line, Candle, Bar, Column)
191-
- `volumeType` — Volume display (None, Column, Line, Area)
192-
- `indicatorTypes` — Array of indicators (0 or more)
193-
- `zoomSliderType` — Zoom pane display (defaults to match chartType)
194-
- **Indicators**: RSI, MACD, Bollinger Bands, Force Index, Standard Deviation, and more
189+
- `chartType` — Price display type (`Auto`, `Line`, `Candle`, `Bar`, `Column` from `FinancialChartType`)
190+
- `volumeType` — Volume display (`None`, `Column`, `Line`, `Area` from `FinancialChartVolumeType`)
191+
- `indicatorTypes``IgxFinancialIndicatorTypeCollection`; accepts a comma-separated string or array of `FinancialIndicatorType` enum names (see list below). **Use the full enum name, not abbreviations** — e.g. `RelativeStrengthIndex` not `RSI`, `MovingAverageConvergenceDivergence` not `MACD`. Invalid values throw `Invalid FinancialIndicatorType value: <name>` at runtime.
192+
- `overlayTypes``IgxFinancialOverlayTypeCollection`; valid values are `BollingerBands` and `PriceChannel` (these are overlays on the price pane, **not** indicators — passing `BollingerBands` to `indicatorTypes` throws).
193+
- `zoomSliderType` — Zoom pane display (`None`, `Auto`, `Bar`, `Candle`, `Column`, `Line`, `Area` from `FinancialChartZoomSliderType`)
194+
- **Valid `FinancialIndicatorType` values**: `AbsoluteVolumeOscillator`, `AccumulationDistribution`, `AverageDirectionalIndex`, `AverageTrueRange`, `BollingerBandWidth`, `ChaikinOscillator`, `ChaikinVolatility`, `CommodityChannelIndex`, `DetrendedPriceOscillator`, `EaseOfMovement`, `FastStochasticOscillator`, `ForceIndex`, `FullStochasticOscillator`, `MarketFacilitationIndex`, `MassIndex`, `MedianPrice`, `MoneyFlowIndex`, `MovingAverageConvergenceDivergence`, `NegativeVolumeIndex`, `OnBalanceVolume`, `PercentagePriceOscillator`, `PercentageVolumeOscillator`, `PositiveVolumeIndex`, `PriceVolumeTrend`, `RateOfChangeAndMomentum`, `RelativeStrengthIndex`, `SlowStochasticOscillator`, `StandardDeviation`, `StochRSI`, `TRIX`, `TypicalPrice`, `UltimateOscillator`, `WeightedClose`, `WilliamsPercentR`
195195
- **Features**:
196196
- Crosshairs with value snapshots
197197
- Trendlines and overlays
198198
- Time-based filters (users can select 1M, 3M, 6M, YTD, 1Y, ALL)
199-
- **Data Binding**:
200-
- `openMemberPath`, `highMemberPath`, `lowMemberPath`, `closeMemberPath`, `volumeMemberPath`
201-
- `dateMemberPath` — Date/time column
199+
- **Data Binding**: The component only exposes `dataSource: Array<any>`. It auto-detects OHLC, volume, and date fields from the data — **no `openMemberPath`/`highMemberPath`/`closeMemberPath`/`volumeMemberPath`/`dateMemberPath` inputs exist on `IgxFinancialChartComponent`**. Those member-path properties live on the individual series/indicator sub-components (e.g. `IgxFinancialPriceSeriesComponent`) if you build the chart from lower-level primitives.
202200

203201
### Pie Chart (`IgxPieChartComponent` or `IgxDataPieChartComponent`)
204202
- **Use**: Part-to-whole visualization (segments sum to 100%)
@@ -258,21 +256,16 @@ transitionInDuration: number; // Animation duration (milliseconds)
258256

259257
### IgxFinancialChartComponent (Stock/Candlestick/OHLC)
260258
```typescript
261-
chartType: FinancialChartType; // Auto, Line, Candle, Bar, Column
262-
itemsSource: any[];
263-
openMemberPath: string;
264-
highMemberPath: string;
265-
lowMemberPath: string;
266-
closeMemberPath: string;
267-
volumeMemberPath: string;
268-
dateMemberPath: string;
269-
volumeType: VolumeType; // None, Column, Line, Area
270-
indicatorTypes: IndicatorType[]; // RSI, MACD, etc.
271-
zoomSliderType: FinancialChartType; // Should match chartType
272-
xAxisTitle: string;
259+
dataSource: Array<any>; // OHLC/volume/date fields are auto-detected — no member-path inputs on this component
260+
chartType: FinancialChartType; // Auto, Bar, Candle, Column, Line
261+
volumeType: FinancialChartVolumeType; // None, Column, Line, Area
262+
indicatorTypes: IgxFinancialIndicatorTypeCollection; // e.g. "MoneyFlowIndex, AverageTrueRange" — use full FinancialIndicatorType enum names, NOT "RSI"/"MACD"
263+
overlayTypes: IgxFinancialOverlayTypeCollection; // "BollingerBands" or "PriceChannel" (overlays, not indicators)
264+
zoomSliderType: FinancialChartZoomSliderType; // None, Auto, Bar, Candle, Column, Line, Area — Auto matches chartType
265+
xAxisMode: FinancialChartXAxisMode; // Ordinal, Time
266+
yAxisMode: FinancialChartYAxisMode; // Numeric, PercentChange
267+
xAxisTitle: string; // inherited from IgxDomainChartComponent
273268
yAxisTitle: string;
274-
xAxisMode: AxisMode; // OrdinalTimeX, DateTimeX
275-
yAxisMode: AxisMode;
276269
showDefaultTooltip: boolean;
277270
isHorizontalZoomEnabled: boolean;
278271
isVerticalZoomEnabled: boolean;

0 commit comments

Comments
 (0)