fix(skills): correct Financial Chart API reference and data binding docs#17226
fix(skills): correct Financial Chart API reference and data binding docs#17226dkalinovInfra wants to merge 1 commit intomasterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Ignite UI for Angular charts skill reference to correct and modernize the documented API surface for IgxFinancialChartComponent, focusing on accurate data binding and indicator/overlay configuration to prevent agents from suggesting non-existent inputs.
Changes:
- Corrects Financial Chart binding guidance to
dataSourceand removes member-path inputs that don’t exist onIgxFinancialChartComponent. - Clarifies indicators vs overlays (
indicatorTypesvsoverlayTypes) and expands/normalizes documented enum values (e.g. fullFinancialIndicatorTypenames). - Updates documented type names for axis/zoom-related APIs to Financial Chart–specific types.
| indicatorTypes: IgxFinancialIndicatorTypeCollection; // e.g. "MoneyFlowIndex, AverageTrueRange" — use full FinancialIndicatorType enum names, NOT "RSI"/"MACD" | ||
| overlayTypes: IgxFinancialOverlayTypeCollection; // "BollingerBands" or "PriceChannel" (overlays, not indicators) | ||
| zoomSliderType: FinancialChartZoomSliderType; // None, Auto, Bar, Candle, Column, Line, Area — Auto matches chartType |
There was a problem hiding this comment.
This block declares indicatorTypes/overlayTypes as IgxFinancialIndicatorTypeCollection / IgxFinancialOverlayTypeCollection, but the inline examples show assigning string literals (e.g. "MoneyFlowIndex, AverageTrueRange"). That’s confusing in a TypeScript signature-style section—consider moving the string examples into an Angular template snippet, or explicitly stating that the input also accepts a comma-separated string at runtime despite the collection type.
| zoomSliderType: FinancialChartZoomSliderType; // None, Auto, Bar, Candle, Column, Line, Area — Auto matches chartType | ||
| xAxisMode: FinancialChartXAxisMode; // Ordinal, Time | ||
| yAxisMode: FinancialChartYAxisMode; // Numeric, PercentChange |
There was a problem hiding this comment.
The doc now introduces FinancialChartZoomSliderType, FinancialChartXAxisMode, and FinancialChartYAxisMode, but the “Import Paths” section’s example import list doesn’t include these types. Please update the import example (or add a note about where these types come from) so readers can copy/paste a working set of imports.
| indicatorTypes: IndicatorType[]; // RSI, MACD, etc. | ||
| zoomSliderType: FinancialChartType; // Should match chartType | ||
| xAxisTitle: string; | ||
| dataSource: Array<any>; // OHLC/volume/date fields are auto-detected — no member-path inputs on this component |
There was a problem hiding this comment.
In this TypeScript API block, dataSource is typed as Array<any> but the rest of this doc (e.g. dataSource: any[]; above) uses the T[] style. For consistency and readability, use any[] here as well (or a dedicated data item interface).
| dataSource: Array<any>; // OHLC/volume/date fields are auto-detected — no member-path inputs on this component | |
| dataSource: any[]; // OHLC/volume/date fields are auto-detected — no member-path inputs on this component |
Closes # IgniteUI/igniteui-cli#1653
Description
Corrects inaccurate API documentation in the Financial Chart (
IgxFinancialChartComponent) section of the charts skill reference:itemsSource→dataSource(the component auto-detects OHLC, volume, and date fields)openMemberPath,highMemberPath,lowMemberPath,closeMemberPath,volumeMemberPath,dateMemberPathinputs from both the Required Properties and API Members sectionsoverlayTypes(BollingerBands,PriceChannel) — clarifying they are overlays on the price pane, not indicatorsFinancialIndicatorTypeenum values (e.g.RelativeStrengthIndex,MovingAverageConvergenceDivergence)FinancialIndicatorTypeenum valuesAxisMode→FinancialChartXAxisMode/FinancialChartYAxisMode, addedFinancialChartZoomSliderTypeMotivation / Context
The charts skill reference contained several inaccuracies that could mislead AI agents (and developers) into using non-existent inputs on
IgxFinancialChartComponent, causing runtime errors. Changes were verified against the official Infragistics Financial Chart documentation.Type of Change (check all that apply):
Component(s) / Area(s) Affected:
Skills —
skills/igniteui-angular-components/references/charts.mdHow Has This Been Tested?
Manually reviewed against the official Infragistics Angular Financial Chart documentation and code samples.
Test Configuration:
Screenshots / Recordings
N/A — documentation-only change.
Checklist:
feature/README.MDupdates for the feature docsREADME.MDCHANGELOG.MDupdates for newly added functionalityng updatemigrations for the breaking changes (migrations guidelines)