Skip to content

Commit 7bd4eec

Browse files
996526: Resolved the review changes in the content of the stripline tooltip UG.
1 parent 000474a commit 7bd4eec

File tree

2 files changed

+43
-10
lines changed

2 files changed

+43
-10
lines changed
3.9 KB
Loading

blazor/chart/strip-line.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -250,16 +250,49 @@ To create a stripline in a specific region with respect to a segment (segmented
250250

251251
## Stripline tooltip
252252

253-
To enable the stripline tooltip add **ChartStriplineTooltip** inside the target Stripline and set **Enable** property to **true**. Use **Header** and **Content** properties to customize the tooltip's content, adjust visual emphasis with **Fill** and **Opacity** properties and style the tooltip's text and border with **ChartStriplineTooltipTextStyle** and **ChartStriplineTooltipBorder** properties.
253+
Stripline tooltips provide additional contextual information on interaction with striplines in the chart. To display a tooltip on a stripline, add the **ChartStriplineTooltip** component inside the desired **ChartStripline** and set the **Enable** property to **true**. This feature is particularly useful for explaining the significance of specific ranges or thresholds marked by striplines.
254254

255-
- Enable - Enables the stripline tooltip.
256-
- Header - Sets the tooltip title text.
257-
- Fill - Sets background color of the tooltip.
258-
- Opacity - Sets transparency of the tooltip (0 to 1).
259-
- Content - Template string for tooltip body content.
260-
- ShowHeaderLine - Shows or hides the header separator line.
261-
- ChartStriplineTooltipTextStyle - Configures the tooltip text (size, color, weight, family).
262-
- ChartStriplineTooltipBorder - Configures the tooltip border (color, width).
255+
### Tooltip customization properties
256+
257+
The stripline tooltip offers comprehensive customization options through the following properties:
258+
259+
- **Enable** - A boolean property that enables or disables the stripline tooltip. Default value is **false**.
260+
261+
- **Header** - Defines the title text displayed at the top of the tooltip.
262+
263+
- **Content** - Allows you to specify custom content for the tooltip body using a format string. The format supports token placeholders that are replaced with corresponding values at runtime. Supported tokens:
264+
- **${stripline.text}** – The stripline label.
265+
- **${stripline.start}** – The stripline start value.
266+
- **${stripline.end}** – The stripline end value.
267+
- **${axis.name}** – The axis name.
268+
- **${stripline.segmentStart}** – The stripline segment start value (if applicable).
269+
- **${stripline.segmentEnd}** – The stripline segment end value (if applicable).
270+
- **${stripline.segmentAxisName}** – The stripline segment axis name (if applicable).
271+
- **${stripline.size}** – The stripline size (if applicable).
272+
273+
This property also supports HTML content, enabling rich formatting and detailed information display. If not specified, the tooltip will display the default stripline information.
274+
275+
- **Fill** - Sets the background color of the tooltip. Accepts any valid CSS color value (hex, rgb, rgba, named colors).
276+
277+
- **Opacity** - Controls the transparency level of the tooltip background. Accepts numeric values between 0 (completely transparent) and 1 (completely opaque). The default value is 0.75.
278+
279+
- **ShowHeaderLine** - A boolean property that controls the visibility of the horizontal separator line between the tooltip header and content. Set to **true** to display the line or **false** to hide it.
280+
281+
The **ChartStriplineTooltipTextStyle** component allows you to customize the appearance of text within the tooltip:
282+
283+
- **Size** - Specifies the font size of the tooltip text. Accepts pixel values (e.g., "12px").
284+
285+
- **Color** - Defines the text color. Accepts any valid CSS color value.
286+
287+
- **FontFamily** - Sets the font family for the tooltip text. Accepts standard CSS font family values (e.g., "Arial", "Segoe UI", "Roboto").
288+
289+
- **FontWeight** - Controls the thickness of the text.
290+
291+
The **ChartStriplineTooltipBorder** component enables you to add and customize borders around the tooltip:
292+
293+
- **Width** - Specifies the thickness of the tooltip border in pixels. Accepts numeric values. Default value is **0**.
294+
295+
- **Color** - Defines the color of the tooltip border. Accepts any valid CSS color value.
263296

264297
```cshtml
265298
@@ -277,7 +310,7 @@ To enable the stripline tooltip add **ChartStriplineTooltip** inside the target
277310
<ChartStripline Start="95" End="110" Text="Target Exceeded" Color="#FFE3B3" HorizontalAlignment="Anchor.Middle" Visible="true">
278311
<ChartStriplineTextStyle Size="12px" Color="#0b3a66" FontWeight="600"></ChartStriplineTextStyle>
279312
<ChartStriplineBorder Width="0"></ChartStriplineBorder>
280-
<ChartStriplineTooltip Enable="true" Header="Target Exceeded">
313+
<ChartStriplineTooltip Enable="true" Header="🎯 Target Exceeded">
281314
<ChartStriplineTooltipTextStyle Size="12px" FontWeight="500"></ChartStriplineTooltipTextStyle>
282315
<ChartStriplineTooltipBorder Width="0"></ChartStriplineTooltipBorder>
283316
</ChartStriplineTooltip>

0 commit comments

Comments
 (0)