report : chart
 
chart
Use the following command to configure a chart or widget. You can edit the settings of existing widgets or you can add new widgets. To add a new widget you need to have a dataset for it as well as a title. You can also configure the widget to be a graph in various formats or a table and you can also optionally configure details about the appearance of the graph or table.
As you change chart format settings you can go to the Executive Summary page of the web‑based manager and view the chart. Refresh your browser to see format changes. You must use the end command to exit from the config report chart command to view your changes in the widget.
 
Charts are called widgets in the Executive Summary on the web‑based manager. In the web‑based manager each widget has a name which is set using the comments field of the config report chart command. When you edit a chart you specify a chart name that is only used in the CLI. To determine the widget name of a chart you must edit it and view the comments setting.
Syntax
 
Due to the complexity and duplication in the chart command, the set commands are listed in simple alphabetical order.
config report chart
edit <chart_name>
config category-series
config column
edit <column_number>
config mapping
edit <id>
config value-series
config x-series
config y-series
end
set background <color_hex>
set caption <caption_str>
set caption-font-size <size_int>
set color-palette <palette_hex>
set comments <comment_str>
set databind <value_expr_str>
set dataset <dataset_name>
set detail-unit <unit_str>
set detail-value <value‑str>
set dimension {2D | 3D}
set displayname <name_str>
set drill-down-chart <chart-name>
set extra-databind <value_expr_str>
set extra-y {disable |enable)
set extra-y-legend <legend_string>
set font-size <size_int>
set footer-unit <string>
set footer-value <value‑str>
set graph-type {bar | flow | line | none | pie}
set group <group_str>
set header-value <string>
set is-category {no | yes}
set label-angle {45‑degree | vertical | horizontal}
set legend {enable | disable}
set legend-font-size <size_int>
set op {equal | greater | greater-equal | less | less-equal | none}
set period {last24 | last7d}
set scale-format {YYYY‑MM‑DD‑HH‑MM | YYYY-MM-DD | HH | YYYY-MM-DD | YYYY‑MM | YYYY | HH‑MM | MM‑DD}
set scale-number-of-step <steps_int>
set scale-origin {max | min}
set scale-start {now | hh:mm yyyy/mm/dd}
set scale-step <step_int>
set scale-type datetime
set scale-unit {day | hour | minute | month | year}
set style {auto | manual}
set title <title_str>
set title-font-size <size_int>
set type {graph | table}
set unit <unit_str>
set value-type {integer | string}
set value1 {<value_int> | <value_str>}
set value2 {<value_int> | <value_str>}
set y-legend <legend_str>
end
Variable
Description
Default
config category-series
Configure the category settings required for a pie chart.
 
config column
Configure columns for a table. To configure these settings style must be manual and type must be table. You can add multiple columns to the table and configure settings for each column.
 
config mapping
Configure mapping for a table.
 
config value-series
Configure the value settings required for a pie chart.
 
config x-series
Configure settings for the x axis of a bar or line graph. To configure these settings style must be manual and type must be graph.
 
config y-series
Configure settings for the y axis of a bar or line graph. To configure these settings style must be manual and type must be graph.
 
<chart_name>
Enter the name of a new or existing chart. The <chart_name> only appears in the CLI. The web‑based manager includes widget names that are set using the comments field.
 
<column_number>
Enter the number of the column to configure. Columns are numbered from the left starting at 1.
 
<id>
Identifies a mapping instance.
 
background <color_hex>
Enter the hexidecimal value for an HTML color to set the background color for a graph. The color value should begin with 0x. For example, the color 0xff0000 results in a red background.
 
caption <caption_str>
Add a caption text string.
 
caption-font-size <size_int>
Set the size of the font used to display a caption. 0 means the font size is set automatically. The font size range is 5 to 20.
0
color-palette <palette_hex>
Enter the hexidecimal value for an HTML color palette. The color palette value should begin with 0x.
 
comments <comment_str>
Enter the name of the widget. You use this name to select the widget when adding it to the Executive Summary from the web‑based manager. This name appears at the top of the widget when it is displayed in the Executive Summary.
 
databind <value_expr_str>
Enter an SQL databind value expression for binding data to the series being configured.
 
dataset <dataset_name>
Enter the name of the dataset that provides the data for this chart. Use the config report dataset command to add or edit data sets. The default configuration includes a number of pre-configured data sets.
No default.
detail-unit <unit_str>
Enter an abbreviation to display for the measurement unit, “MB”, for example.
 
detail-value <value‑str>
Define the value to appear in each column of a table.
 
dimension {2D | 3D}
Define whether bar and pie graphs will have a 2D or 3D display.
3D
displayname <name_str>
Set the name to be displayed for a mapping.
 
drill-down-chart <chart-name>
Enter the chart name to drill down into.
 
extra-databind <value_expr_str>
Enter an SQL databind value expression for binding extra data to the series being configured.
 
extra-y {disable |enable)
Enable or disable adding a second or extra set of data to the y-axis of a graph.
disable
extra-y-legend <legend_string>
Add a name to a second or extra set of data added to the y-axis of a graph.
 
font-size <size_int>
Set the size of the font used to display a title. 0 means the font size is set automatically. The font size range is 5 to 20.
0
footer-unit <string>
Enter an abbreviation to display for the footer unit, “MB”, for example.
 
footer-value <value‑str>
Define the value to appear in the footer of a table.
 
graph-type {bar | flow | line | none | pie}
If type is set to graph select the type of graph used to display information in the widget.
none
group <group_str>
Enter a group string.
 
header-value <string>
Define the value to appear in the header of a table.
 
is-category {no | yes}
Specify whether an x axis of a graph displays categories or a series of values.
no
label-angle {45‑degree | vertical | horizontal}
Select the angle for displaying the x or y axis label.
Varies depending on the chart and series.
legend {enable | disable}
Enable or disable the generation and display of a data legend.
enable
legend-font-size <size_int>
Set the size of the font used to display a legend. 0 means the font size is set automatically. The font size range is 5 to 20.
0
op {equal | greater | greater-equal | less | less-equal | none}
Set the mapping option
none
period {last24 | last7d}
Select the chart report period: last 24 hours or last seven days.
last7d
scale-format {YYYY‑MM‑DD‑HH‑MM | YYYY-MM-DD | HH | YYYY-MM-DD | YYYY‑MM | YYYY | HH‑MM | MM‑DD}
Set the format for displaying the date and time on the x-axis of a graph.
YYYY‑MM‑DD-HH-MM
scale-number-of-step <steps_int>
Set the number of steps on the horizontal axis of the graph. The range is 1 to 31.
0
scale-origin {max | min}
Set the time start point and direction of time on the x-axis of the graph:
max along the x-axis time is displayed in reverse starting at the origin of the graph with the scale-start time.
min along the x-axis time is displayed in the forward direction starting at the origin of the graph with the scale-start time.
max
scale-start {now | hh:mm yyyy/mm/dd}
Set the start time for the x-axis. now sets the start time to the time that the graph was generated. You can also specify a time and date. The year range is 2001-2050.
now
scale-step <step_int>
The number of scale-units in each x-axis scale step.
0
scale-type datetime
Only the datetime scale type is supported. Sets the x-axis to display dates and times.
datetime
scale-unit {day | hour | minute | month | year}
The units of the scale-step on the x-axis.
day
style {auto | manual}
By default style is set to auto which means the appearance of the graph or chart in the widget is configured automatically. You can set style to manual to manually configure details about the appearance of the chart or graph in the widget.
auto
title <title_str>
Enter the title of the graph or table. The title is optional and appears inside the widget above the graph or chart. This is not the name of the widget. Use the comments field to add the title or name of the widget.
 
title-font-size <size_int>
Set the size of the font used to display the title. 0 means the font size is set automatically. The font size range is 5 to 20.
0
type {graph | table}
Configure whether this widget presents information in a graphical form as a graph or as a table of values. If you select graph use the graph-type field to configure the type of graph.
graph
unit <unit_str>
Enter the name of the units to be displayed on the x-axis.
 
value-type {integer | string}
Configure the mapping value to be an integer or a text string.
integer
value1 {<value_int> | <value_str>}
Set the first mapping value.
 
value2 {<value_int> | <value_str>}
Set a second mapping value if required.
 
y-legend <legend_str>
Add a name for the data included on the y-axis of a graph.