Skip to content

Commit 0d372de

Browse files
committed
docs(htmlchart): add series notes article
1 parent 48af84d commit 0d372de

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed
Loading
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
---
2+
title: Series Notes
3+
page_title: Series Notes - RadHtmlChart
4+
description: Check our Web Forms article about Series Notes.
5+
slug: htmlchart/functionality/series-notes
6+
tags: series, notes
7+
published: True
8+
position: 9
9+
---
10+
11+
# Series Notes
12+
13+
The **Series Notes** functionality of **RadHtmlChart** can be used as of R2 2022.
14+
15+
The **Series Notes** enables you to display the metadata of series points.
16+
17+
![Series Notes Sample](images/htmlchart-seriesnotes.png)
18+
19+
>important The Series Notes functionality is not supported in **Donut**, **Pie**, **Funnel**, **Polar**, **Radar** and **BoxPlot** **series**.
20+
21+
>note Test the Series Notes feature in our **[SeriesNotes live demo](https://demos.telerik.com/aspnet-ajax/htmlchart/examples/functionality/seriesnotes/defaultcs.aspx)**. You can try various NotesAppearance customizations via the Demo Configuration Panel.
22+
23+
## Getting Started
24+
25+
To display additional information for series points, set the `DataNoteTextField` property of the series to a field from the data which contains the information.
26+
27+
You can customize the look of the Notes element through the series `NotesAppearance` inner tag. Each Series Note consist of a **Label**, **Icon** and a **Line**. The appearance of all three parts can be customized via the corresponding nested tag.
28+
29+
Sample declaration of LineSeries with customized NotesAppearance:
30+
31+
````ASPX
32+
<telerik:LineSeries Name="Wins" DataFieldY="Win" DataNoteTextField="Extremum">
33+
<NotesAppearance Position="Bottom">
34+
<Icon Type="Circle" Size="8">
35+
<Border Width="1" />
36+
</Icon>
37+
<Label Position="Outside"></Label>
38+
<Line DashType="Solid" Length="10" Width="1" />
39+
</NotesAppearance>
40+
</telerik:LineSeries>
41+
````
42+
43+
A complete list of the properties exposed by the `NoteAppearance` object and its embedded objects (`Icon`, `Label`, `Line`) you can find in the following server-side API resources:
44+
45+
- **NotesAppearance** - [Telerik.Web.UI.HtmlChart.PlotArea.NotesAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea/NotesAppearance)
46+
47+
- **Icon** - [Telerik.Web.UI.HtmlChart.PlotArea.Appearance.NoteIconAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Appearance/NoteIconAppearance)
48+
49+
- **Line** - [Telerik.Web.UI.HtmlChart.PlotArea.Appearance.NoteLineAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Appearance/NoteLineAppearance)
50+
51+
- **Label** - [Telerik.Web.UI.HtmlChart.PlotArea.Appearance.NoteLabelAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Appearance/NoteLabelAppearance)
52+
53+
54+
<!-- ## APIs
55+
56+
The Series Notes are exposing the following inner tag and properties to allow flexible appearance customization:
57+
58+
- `Position` - Sets the position of the series note to one of the predefined `NotePosition` options. It can be set to ***Bottom***, ***Left***, ***Right***, ***Top***. By default the position is set to *Top*.
59+
60+
- `Icon` - Inner tag where you can customize the Note's Icon appearance by specifying the following properties:
61+
62+
* `Type` - Sets the shape of the series note icon to one of the predefined `NoteIconType` options. It can be set to ***Circle***, ***Cross***, ***Square***, ***Triangle***. By default the position is set to *Circle*.
63+
64+
* `Size` - The Size of the Icon.
65+
66+
* `BackgroundColor` - The fill color of the icon.
67+
68+
* `Visible` - Sets if the icon should be visible or not.
69+
70+
* `Border` - Nested tag exposing `Color`, and `Width` properties for customizing the icon border.
71+
72+
- `Line` - Inner tag where you can customize the Note's Line appearance by specifying the following properties:
73+
74+
* `DashType` - Sets the dash type of the note line to one of the predefined `DashType` options. The following dash types are supported: ***Dash***, ***DashDot***, ***Dot***, ***LongDash***, ***LongDashDot***, ***LongDashDotDot***, ***Solid***. By default the DashType is set to *Solid*.
75+
76+
* `Color` - The color of the notes' lines.
77+
78+
* `Width` - The width of the notes' lines.
79+
80+
* `Length` - The length of the notes' lines.
81+
82+
- `Label` - Inner tag where you can customize the Note's Label appearance by specifying the following properties:
83+
84+
* `Position` - Sets the position of the notes labels to ***Inside*** or ***Outside***. Defining whether the label is position inside or outside of the icon. By default the Label-Position is set to *Inside*.
85+
86+
* `DataFormatString` - Data format string of the labels.
87+
88+
* `ClientTemplate` - Nested inner tag for define a client-side template for the labels appearance by leveraging [Kendo UI Templates](https://docs.telerik.com/kendo-ui/framework/templates/overview).
89+
90+
* `Border` - Nested tag exposing `Color`, `Width`, and `DashType` properties for customizing the label border.
91+
92+
* `Visible` - Sets if the label should be visible or not.
93+
94+
* `RotationAngle` - Specifies the rotation angle of the label.
95+
96+
* `TextStyle` - Defines the text style settings. Nested tag exposing `Bold`, `Italic`, `FontFamily` and `FontSize` properties.
97+
98+
* `Color` - The color of the notes' label text.
99+
100+
* `BackgroundColor` - The background color of the label.
101+
102+
- `Visual` - A function that can be used to create a custom visual for the notes. Refer to Kendo Chart documentation on the matter - [series.notes.visual](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/chart/configuration/series.notes.visual) -->
103+
104+
105+
Sample declaration of customized NotesAppearance:
106+
107+
````ASPX
108+
<NotesAppearance Position="Left">
109+
<Line Width="2" Color="#7d7d7d" Length="10" DashType="Solid" />
110+
<Icon BackgroundColor="#7d7d7d" Type="Circle" Size="20" Visible="true">
111+
<Border Color="#3f3f3f" Width="3px" />
112+
</Icon>
113+
<Label Color="Red" Position="Outside" DataFormatString="{0} USD" RotationAngle="15" Visible="true" BackgroundColor="Green">
114+
<Border Color="Yellow" Width="3" DashType="Dash" />
115+
<TextStyle Bold="true" Italic="true" FontFamily="SansSerif" FontSize="18" />
116+
</Label>
117+
</NotesAppearance>
118+
````
119+
120+
121+
## See Also
122+
123+
* [SeriesNotes live demo](https://demos.telerik.com/aspnet-ajax/htmlchart/examples/functionality/seriesnotes/defaultcs.aspx)
124+
125+
* [NotesAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea/NotesAppearance)
126+
127+
* [NoteIconAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Appearance/NoteIconAppearance)
128+
129+
* [NoteLineAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Appearance/NoteLineAppearance)
130+
131+
* [NoteLabelAppearance](https://docs.telerik.com/devtools/aspnet-ajax/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Appearance/NoteLabelAppearance)
132+

0 commit comments

Comments
 (0)