Skip to content

Commit b02c773

Browse files
authored
Update User Guide - Show the current time and Null values options on Chart Widget (#11764)
1 parent 23b1527 commit b02c773

4 files changed

Lines changed: 23 additions & 0 deletions

File tree

15.3 KB
Loading
18.5 KB
Loading
5.62 KB
Loading

docs/user-guide/widgets.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ Once the chart type is chosen, it is possible to set up the trace with the follo
7373
* **Trace style**
7474
* **Trace axes**
7575
* **Trace value formatting**
76+
* **Null Value Handling**
7677

7778
##### Trace Data
7879

@@ -182,6 +183,18 @@ An example of a custom trace value tooltip can be the following:
182183

183184
<img src="../img/widgets/custom_trace_value_tooltip.jpg" class="ms-docimage" style="max-width:450px;"/>
184185

186+
##### Null Value Handling
187+
188+
The user can customize how **Null Value** are handled for the `X Attribute` field by selecting a *Strategy* from the following options:
189+
190+
<img src="../img/widgets/trace_null_value.jpg" class="ms-docimage" style="max-width:450px;"/>
191+
192+
* **Ignore** to keep the *Null* values unchanged in the data.
193+
194+
* **Exclude** to remove all records where the value is *Null*
195+
196+
* **Use Placeholder** to replace *Null* values with a custom value provided by the user
197+
185198
##### Trace legend options
186199

187200
For the *Pie Charts*, the *Trace legend options* is available and it is displayed as follows:
@@ -210,6 +223,16 @@ Through this section, for each axis, the user is allowed to:
210223

211224
* Choose the **Type** (between `Auto`, `Linear`, `Category`, `Log` or `Date`): the axis type is auto-detected by looking at the data (*Auto* option is automatically managed and selected by the tool and it is usually good as default setting).
212225

226+
!!! Note
227+
If **`Date`** is selected in the *Type* option, the **Show the Current Time** setting becomes available in the *Axes* panel, allowing you to highlight the current date in the chart.
228+
<img src="../img/widgets/show-current-time.jpg" class="ms-docimage" style="max-width:300px;"/>
229+
Once enabled, you can customize the appearance of the current time line using the following options:
230+
<img src="../img/widgets/customize-current-time.jpg" class="ms-docimage" style="max-width:300px;"/>
231+
232+
* **Color**: choose the line color using the *Color Picker*.
233+
* **Size**: set the line thickness in `px`.
234+
* **Style**: select the line style from `Solid`, `Dot`, `Dash`, `LongDash` or `DashDot`
235+
213236
* Change the **Color** through the color picker
214237

215238
* Change the **Font size**

0 commit comments

Comments
 (0)