Skip to content

Commit d4b09f5

Browse files
authored
Merge pull request #289 from IgniteUI/dtsvetkov/update-charts-missing-links
Update charts missing links
2 parents 4562b85 + 53f4ee6 commit d4b09f5

36 files changed

Lines changed: 246 additions & 261 deletions

docs/angular/src/content/en/components/charts/chart-api.mdx

Lines changed: 15 additions & 16 deletions
Large diffs are not rendered by default.

docs/angular/src/content/en/components/charts/features/chart-axis-layouts.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,12 @@ d in the above sections:
8989
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> <ApiLink pkg="charts" type="Axis" member="crossingValue" label="CrossingValue" /> | None |
9090
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> <ApiLink pkg="charts" type="Axis" member="isInverted" label="IsInverted" /> | <ApiLink pkg="charts" type="CategoryChart" member="xAxisInverted" label="XAxisInverted" /> |
9191
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> <ApiLink pkg="charts" type="Axis" member="isInverted" label="IsInverted" /> | <ApiLink pkg="charts" type="CategoryChart" member="yAxisInverted" label="YAxisInverted" /> |
92-
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> `LabelLocation` | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelLocation" label="YAxisLabelLocation" /> |
93-
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> `LabelLocation` | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelLocation" label="XAxisLabelLocation" /> |
94-
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> `LabelHorizontalAlignment` | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelHorizontalAlignment" label="YAxisLabelHorizontalAlignment" /> |
95-
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> `LabelVerticalAlignment` | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelVerticalAlignment" label="XAxisLabelVerticalAlignment" /> |
96-
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> `LabelVisibility` | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelVisibility" label="YAxisLabelVisibility" /> |
97-
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> `LabelVisibility` | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelVisibility" label="XAxisLabelVisibility" /> |
92+
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> <ApiLink pkg="charts" type="Axis" member="labelLocation" label="LabelLocation" /> | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelLocation" label="YAxisLabelLocation" /> |
93+
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> <ApiLink pkg="charts" type="Axis" member="labelLocation" label="LabelLocation" /> | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelLocation" label="XAxisLabelLocation" /> |
94+
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> <ApiLink pkg="charts" type="Axis" member="labelHorizontalAlignment" label="LabelHorizontalAlignment" /> | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelHorizontalAlignment" label="YAxisLabelHorizontalAlignment" /> |
95+
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> <ApiLink pkg="charts" type="Axis" member="labelVerticalAlignment" label="LabelVerticalAlignment" /> | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelVerticalAlignment" label="XAxisLabelVerticalAlignment" /> |
96+
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> <ApiLink pkg="charts" type="NumericYAxis" member="labelVisibility" label="LabelVisibility" /> | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelVisibility" label="YAxisLabelVisibility" /> |
97+
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> <ApiLink pkg="charts" type="NumericXAxis" member="labelVisibility" label="LabelVisibility" /> | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelVisibility" label="XAxisLabelVisibility" /> |
9898

9999
{/*TODO correct links in Transformer */}
100100
{/*
@@ -104,4 +104,3 @@ d in the above sections:
104104
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> `labelSettings.verticalAlignment` | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelVerticalAlignment" label="XAxisLabelVerticalAlignment" /> |
105105
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericYAxis" /> -> `labelSettings.visibility` | <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelVisibility" label="YAxisLabelVisibility" /> |
106106
| <ApiLink pkg="charts" type="DataChart" member="Axes" label="Axes" /> -> <ApiLink pkg="charts" type="NumericXAxis" /> -> `labelSettings.visibility` | <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelVisibility" label="XAxisLabelVisibility" /> |*/}
107-

docs/angular/src/content/en/components/charts/features/chart-data-legend.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -138,30 +138,30 @@ By default, DataLegend will hide names of groups, but you can display group name
138138

139139
Several properties are exposed including grouping portions of the legend.
140140

141-
- `GroupRowMargin`
142-
- `GroupTextMargin`
141+
- <ApiLink pkg="charts" type="DataLegend" member="groupRowMargin" label="GroupRowMargin" />
142+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextMargin" label="GroupTextMargin" />
143143
- <ApiLink pkg="charts" type="DataLegend" member="groupTextColor" label="GroupTextColor" />
144-
- `GroupTextFontSize`
145-
- `GroupTextFontFamily`
146-
- `GroupTextFontStyle`
147-
- `GroupTextFontStretch`
148-
- `GroupTextFontWeight`
149-
- `HeaderTextMargin`
144+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontSize" label="GroupTextFontSize" />
145+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontFamily" label="GroupTextFontFamily" />
146+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontStyle" label="GroupTextFontStyle" />
147+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontStretch" label="GroupTextFontStretch" />
148+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontWeight" label="GroupTextFontWeight" />
149+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextMargin" label="HeaderTextMargin" />
150150
- <ApiLink pkg="charts" type="DataLegend" member="headerTextColor" label="HeaderTextColor" />
151-
- `HeaderTextFontSize`
152-
- `HeaderTextFontFamily`
153-
- `HeaderTextFontStyle`
154-
- `HeaderTextFontStretch`
155-
- `HeaderTextFontWeight`
151+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontSize" label="HeaderTextFontSize" />
152+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontFamily" label="HeaderTextFontFamily" />
153+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontStyle" label="HeaderTextFontStyle" />
154+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontStretch" label="HeaderTextFontStretch" />
155+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontWeight" label="HeaderTextFontWeight" />
156156

157157
The <ApiLink pkg="charts" type="DataLegend" /> has several events that fire when rendering their corresponding row, even during mouse interactions where the values are updating. These events are listed below with a description of what they are designed to be used for:
158158

159-
- `StyleGroupRow`: This event fires for each group to style text displayed in group rows.
160-
- `StyleHeaderRow`: This event fires when rendering the header row.
161-
- `StyleSeriesRow`: This event fires once for each series row, which allows conditional styling of the values of the series.
162-
- `StyleSeriesColumn`: This event fires once for each series column, which allows conditional styling of the different columns for the series in the chart.
163-
- `StyleSummaryRow`: This event fires once when rendering the summary row.
164-
- `StyleSummaryColumn`: This event fires once when rendering the summary column.
159+
- <ApiLink pkg="charts" type="DataLegend" member="styleGroupRow" label="StyleGroupRow" />: This event fires for each group to style text displayed in group rows.
160+
- <ApiLink pkg="charts" type="DataLegend" member="styleHeaderRow" label="StyleHeaderRow" />: This event fires when rendering the header row.
161+
- <ApiLink pkg="charts" type="DataLegend" member="styleSeriesRow" label="StyleSeriesRow" />: This event fires once for each series row, which allows conditional styling of the values of the series.
162+
- <ApiLink pkg="charts" type="DataLegend" member="styleSeriesColumn" label="StyleSeriesColumn" />: This event fires once for each series column, which allows conditional styling of the different columns for the series in the chart.
163+
- <ApiLink pkg="charts" type="DataLegend" member="styleSummaryRow" label="StyleSummaryRow" />: This event fires once when rendering the summary row.
164+
- <ApiLink pkg="charts" type="DataLegend" member="styleSummaryColumn" label="StyleSummaryColumn" />: This event fires once when rendering the summary column.
165165

166166
Some of the events exposes a <ApiLink pkg="charts" type="DataLegendStylingRowEventArgs" suffix={false} /> parameter as its arguments, which lets you customize each item's text, text color, and the overall visibility of the row. The event arguments also expose event-specific properties. For example, since the `StyleSeriesRow` event fires for each series, the event arguments will return the series index and series title for the row that represents the series.
167167

docs/angular/src/content/en/components/charts/features/chart-data-tooltip.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,20 +137,20 @@ The following example demonstrates usage of the styling properties mentioned abo
137137

138138
Several properties are exposed including grouping portions of the tooltip.
139139

140-
- `GroupTextMargin`
140+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextMargin" label="GroupTextMargin" />
141141
- <ApiLink pkg="charts" type="DataLegend" member="groupTextColor" label="GroupTextColor" />
142-
- `GroupTextFontSize`
143-
- `GroupTextFontFamily`
144-
- `GroupTextFontStyle`
145-
- `GroupTextFontStretch`
146-
- `GroupTextFontWeight`
147-
- `HeaderTextMargin`
142+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontSize" label="GroupTextFontSize" />
143+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontFamily" label="GroupTextFontFamily" />
144+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontStyle" label="GroupTextFontStyle" />
145+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontStretch" label="GroupTextFontStretch" />
146+
- <ApiLink pkg="charts" type="DataLegend" member="groupTextFontWeight" label="GroupTextFontWeight" />
147+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextMargin" label="HeaderTextMargin" />
148148
- <ApiLink pkg="charts" type="DataLegend" member="headerTextColor" label="HeaderTextColor" />
149-
- `HeaderTextFontSize`
150-
- `HeaderTextFontFamily`
151-
- `HeaderTextFontStyle`
152-
- `HeaderTextFontStretch`
153-
- `HeaderTextFontWeight`
149+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontSize" label="HeaderTextFontSize" />
150+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontFamily" label="HeaderTextFontFamily" />
151+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontStyle" label="HeaderTextFontStyle" />
152+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontStretch" label="HeaderTextFontStretch" />
153+
- <ApiLink pkg="charts" type="DataLegend" member="headerTextFontWeight" label="HeaderTextFontWeight" />
154154

155155

156156
## API References

docs/angular/src/content/en/components/charts/features/chart-highlight-filter.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following example demonstrates the usage of the data legend grouping and hig
4242
<Sample src="/charts/data-chart/data-tooltip-grouping-and-highlighting" height={500} alt="Angular Data Tooltip Grouping Highlight Example" />
4343

4444

45-
The following example demonstrates the usage of the data highlighting overlay feature within the <ApiLink pkg="charts" type="DataChart" /> control using the `HighlightedValueMemberPath`:
45+
The following example demonstrates the usage of the data highlighting overlay feature within the <ApiLink pkg="charts" type="DataChart" /> control using the <ApiLink pkg="charts" type="ColumnSeries" member="highlightedValueMemberPath" label="HighlightedValueMemberPath" />:
4646

4747
<Sample src="/charts/data-chart/chart-highlight-filter" height={500} alt="Angular Highlight Filter Example" />
4848

@@ -80,11 +80,11 @@ The following is a list of API members mentioned in the above sections:
8080

8181
| <ApiLink pkg="charts" type="CategoryChart" /> Properties | <ApiLink pkg="charts" type="DataChart" /> Properties |
8282
| ----------------------------------------------|---------------------------|
83-
| `CategoryChart.HighlightedItemsSource` | `Series.HighlightedItemsSource` |
84-
| `CategoryChart.HighlightedTitleSuffix` | `Series.HighlightedTitleSuffix` |
85-
| `CategoryChart.HighlightedValueMemberPath` | `Series.HighlightedValueMemberPath` |
86-
| `CategoryChart.HighlightedValuesDisplayMode` | `Series.HighlightedValuesDisplayMode` |
87-
| `CategoryChart.HighlightedValuesFadeOpacity` | `Series.HighlightedValuesFadeOpacity` |
88-
| `CategoryChart.HighlightedValuesDisplayMode` | `Series.HighlightedValuesDisplayMode` |
89-
| `CategoryChart.InitialHighlightFilter` | |
90-
| `CategoryChart.InitialGroups` | |
83+
| <ApiLink pkg="charts" type="CategoryChart" member="highlightedDataSource" label="HighlightedItemsSource" /> | <ApiLink pkg="charts" type="Series" member="highlightedDataSource" label="HighlightedItemsSource" /> |
84+
| <ApiLink pkg="charts" type="CategoryChart" member="highlightedTitleSuffix" label="HighlightedTitleSuffix" /> | <ApiLink pkg="charts" type="Series" member="highlightedTitleSuffix" label="HighlightedTitleSuffix" /> |
85+
| <ApiLink pkg="charts" type="CategoryChart" member="highlightedValueMemberPath" label="HighlightedValueMemberPath" /> | <ApiLink pkg="charts" type="ColumnSeries" member="highlightedValueMemberPath" label="HighlightedValueMemberPath" /> |
86+
| <ApiLink pkg="charts" type="CategoryChart" member="highlightedValuesDisplayMode" label="HighlightedValuesDisplayMode" /> | <ApiLink pkg="charts" type="Series" member="highlightedValuesDisplayMode" label="HighlightedValuesDisplayMode" /> |
87+
| <ApiLink pkg="charts" type="CategoryChart" member="highlightedValuesFadeOpacity" label="HighlightedValuesFadeOpacity" /> | <ApiLink pkg="charts" type="Series" member="highlightedValuesFadeOpacity" label="HighlightedValuesFadeOpacity" /> |
88+
| <ApiLink pkg="charts" type="CategoryChart" member="highlightedValuesDisplayMode" label="HighlightedValuesDisplayMode" /> | <ApiLink pkg="charts" type="Series" member="highlightedValuesDisplayMode" label="HighlightedValuesDisplayMode" /> |
89+
| <ApiLink pkg="charts" type="CategoryChart" member="initialHighlightFilter" label="InitialHighlightFilter" /> | |
90+
| <ApiLink pkg="charts" type="CategoryChart" member="initialGroups" label="InitialGroups" /> | |

docs/angular/src/content/en/components/charts/types/bar-chart.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,4 @@ You can find more information about related chart types in these topics:
127127
<ApiLink type="CalloutLayer" pkg="charts" />
128128
<ApiLink type="StackedBarSeries" pkg="charts" />
129129
<ApiLink type="Stacked100BarSeries" pkg="charts" />
130+
<ApiLink pkg="charts" type="BarSeries" member="dataSource" label="DataSource" />

docs/angular/src/content/en/components/charts/types/composite-chart.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ The following example demonstrates how to create Composite Chart using <ApiLink
2828

2929
- [Bar Chart](bar-chart.md)
3030
- [Column Chart](column-chart.md)
31-
{/*- [Gantt Chart](gantt-chart.md)*/}
3231
- [Line Chart](line-chart.md)
3332
- [Stacked Chart](stacked-chart.md)
3433

docs/angular/src/content/en/components/charts/types/data-pie-chart.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,7 @@ First, the <ApiLink pkg="charts" type="DataPieChart" member="highlightingBehavio
139139
The <ApiLink pkg="charts" type="DataPieChart" member="highlightingMode" label="HighlightingMode" /> enumerated property determines how the data pie chart slices respond to being highlighted. The following are the options of that property and what they do:
140140

141141
- <ApiLink pkg="charts" kind="enum" type="SeriesSelectionMode" member="Brighten" label="Brighten" prefixed={false} />: The series will have its color brightened when the mouse position is over or near it.
142-
- `BrightenSpecific`: The specific slice will have its color brightened when the mouse position is over or near it.
143142
- <ApiLink pkg="charts" kind="enum" type="SeriesSelectionMode" member="FadeOthers" label="FadeOthers" prefixed={false} />: The series will retain its color when the mouse position is over or near it, while the others will appear faded.
144-
- `FadeOthersSpecific`: The specific slice will retain its color when the mouse position is over or near it, while the others will appear faded.
145143
- <ApiLink pkg="charts" kind="enum" type="SeriesSelectionMode" member="None" label="None" prefixed={false} />: The series and slices will not be highlighted.
146144

147145
The following example demonstrates the mouse highlighting behaviors of the <ApiLink pkg="charts" type="DataPieChart" /> component:

docs/angular/src/content/en/components/charts/types/donut-chart.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ You can create Donut Chart using the <ApiLink pkg="charts" type="DoughnutChart"
2323
Donut Charts are appropriate for small data sets and are easy to read at a glance. Donut charts are just one type of part-to-whole visualization. Others include:
2424

2525
- [Pie](pie-chart.md)
26-
{/*- Funnel*/}
2726
- [Stacked Area](area-chart.md)
2827
- [Stacked 100% Area (Stacked Percentage Area)](area-chart.md)
2928
- [Stacked Bar](bar-chart.md)
@@ -54,7 +53,7 @@ The Angular Donut Chart includes interactive features that give the viewer tools
5453
- You have negative data, as this can not be represented in a donut chart.
5554

5655
## Angular Donut Chart - Slice Selection
57-
The Angular Donut Chart has the ability to select slices on click. Optionally, you may apply a single custom visual style to the selected slices. The `SliceClick` event is raised when the user clicks on a slice. Enabling slice selection allows you to modify the slice's selection upon click. The following sample demonstrates how to enable slice selection and set the selected slice color to gray.
56+
The Angular Donut Chart has the ability to select slices on click. Optionally, you may apply a single custom visual style to the selected slices. The <ApiLink pkg="charts" type="DoughnutChart" member="sliceClick" label="SliceClick" /> event is raised when the user clicks on a slice. Enabling slice selection allows you to modify the slice's selection upon click. The following sample demonstrates how to enable slice selection and set the selected slice color to gray.
5857

5958
<Sample src="/charts/doughnut-chart/selection" height={600} alt="Angular Donut Slice Selection" />
6059

0 commit comments

Comments
 (0)