2.2.3.28 updateSparklines

Brief Information

Update sparlines of selected columns

Command Line Usage

1. updateSparklines plottype:=his;

2. updateSparklines plottype:=his keepAspect:=1;

3. updateSparklines template:="String As Input" keepAspect:=1 label:=0;

4. updateSparklines endpts:=0;

X-Function Execution Options

Please refer to the page for additional option switches when accessing the x-function from script

Variables

Display
Name
Variable
Name
I/O
and
Type
Default
Value
Description
Plot Type plottype

Input

string

0

Specifies the plot type of sparkline.

Option list:

  • line:Line
    Line
  • his:Histogram
    Histogram
  • box:Box
    Box chart
Graph Template template

Input

string

sparkline_label

Specifies the template used to generate the sparkline.

Keep Aspect Ratio keepAspect

Input

int

0

Specifies whether to keep aspect ratio of the sparkline. If it is set to True, the x and y axes will be changed with same ratio, if it is set to False, then they will be changed respectively. By default it is set to False.

Hide Annotations label

Input

int

1

If this variable is set to True, then any annotation in the graph will not show in the Sparkline, if it is set to False, the annotation will show. By default it is set to True.

Show First and Last Points endpts

Input

int

1

If this variable is set to True, the first and last points will be marked in the sparkline, if it is set to False, they will not be marked.

Output orng

Input/Output

Range

<active>

Specifies the column(s) to which the Sparkline is added or updated. It is set to the active column by default.

Description

This X-Function is used to updates sparklines for all selected columns.

Related X-Functions

insertSparklines, sparklines