Component: Chart

 Show all Hide all

A component that draws charts.

File mode: Download

The user downloads the file.
Supported modes: Download | Save | Save and download | Batch

SQL

SQL Call: Get chart (mandatory)

Gets information about a chart that should be drawn.

The chart supports all numeric and date/time data types for its value-columns, not just decimal data.
Supports custom errors: No
May modify database: No

Parameters:

@xxx mandatory string
In batch mode each column from the get batch call is passed as a parameter with the same name.

Resultset: Chart info

Information about the chart to draw. The value in the ChartType column determines which other columns and result sets are used.

If width and height are omitted a suitable size is picked for the chart.
Repeat mode: repeated exactly once
Row count: exactly one row

Columns:

ChartType mandatory string
Type of chart to draw.
Possible value Description
Column Column chart. Also known as vertical bar.
ColumnStacked A column chart (vertical bar) with all bars stacked.
HorizontalBar Horizontal bar chart.
HorizontalBarStacked A horizontal bar chart with all bars stacked.
Line Line chart.
Pie Pie chart.
Width optional int
Width in pixels.
Height optional int
Height in pixels.
ShowLegend optional bit
If the chart should show a legend describing its series. Default is 1.
CollectedLabel optional string
The label used for the "Other" slice. Mandatory if CollectedThreshold or CollectedThresholdPercent is specified.
CollectedThreshold optional decimal
Sets a threshold for where small values should be grouped together into a "Other" slice. Only used by pie charts.
CollectedThresholdPercent optional decimal
Sets a threshold, as a value between 1 and 99, for where small values should be grouped together into a "Other" slice. Only used by pie charts.
UseFake3d optional bit
If the chart should be drawn with a 3d-ish effect. Not used by line charts.
XLogBase optional decimal
Makes the x-axis logarithmic with the given base. Not used by pie.
XTitle optional string
The title on the x-axis. Not used by pie.
YLogBase optional decimal
Makes the y-axis logarithmic with the given base. Not used by pie.
YTitle optional string
The title on the y-axis. Not used by pie.

Resultset: Custom palette

Declares a custom palette to use for the chart's data.

The colors in the table will be used in the order they are declared.
Repeat mode: repeated zero or one time
Row count: one or more rows

Columns:

PaletteColor mandatory string
A color on the hex format "#rrggbb".

Resultset: X-axis (not used by pie)

Describes custom labels for the x-axis.

The XValue column must have the same data type as the XValue column of the chart data.

If a custom axis is specified then the chart's values must fit inside the range described by the axis.
Repeat mode: repeated zero or one time
Row count: one or more rows

Columns:

XValue mandatory decimal
Position of label.
XLabel optional string
Label.

Resultset: Y-axis (not used by pie)

Describes custom labels for the y-axis.

The YValue column must have the same data type as the YValue column of the chart data.

If a custom axis is specified then the chart's values must fit inside the range described by the axis.
Repeat mode: repeated zero or one time
Row count: one or more rows

Columns:

YValue mandatory decimal
Position of label.
YLabel optional string
Label.

Resultset: Series (not used by pie)

Declares and customizes the series in the chart.

If this table is omitted then series are derived from the SeriesName column in the chart values. If this table is present then it must declare all series used by the chart values.

If this table is omitted and the SeriesName column is omitted from the chart values then all values are treated as belonging to the same default series and no legend is shown.

Series are drawn and are listed in the legend in the order they occur in this table.
Repeat mode: repeated zero or one time
Row count: one or more rows

Columns:

SeriesName mandatory string
Name of the series. Must be unique.
Color optional string
Custom color for this series. A color on the hex format "#rrggbb".
LineType optional string
Line chart only. Type of line drawn.

Possible value Description
Line A normal line chart. Default.
Point Disconnected data points.
Range A line that uses two y-values and colors the area between them.
StepLine A step line.
MarkerType optional string
Line chart only. How data points are drawn.
Possible value Description
None Data points are not marked, only lines are drawn. Default.
Round The data points are indicated by circles.
Square The data points are indicated by squares.
ShowInLegend optional bit
If the series should be shown in the legend.
ShowValuesAsLabel optional bit
Whether the datapoints in the series should have its values diplayed as a label.
Default behavior is to not include values as labels.
ValueLabelBackgroundColor optional string
The background of the datapoints labels. Only applicable if ShowValuesAsLabel is true.
Default is a transparent background.

Resultset: Pie values (pie)

Pie chart values.
Repeat mode: repeated exactly once
Row count: zero or more rows

Columns:

Value mandatory decimal
Value.
Label mandatory string
Label.
Color optional string
A color on the hex format "#rrggbb". Overrides the palette.

Resultset: Bar values (columns and horizontal bar)

Columns and vertical bar chart values.
Repeat mode: repeated exactly once
Row count: zero or more rows

Columns:

XValue mandatory decimal
Value on the x-axis.
YValue mandatory decimal
Value on the y-axis.
SeriesName optional string
Name of the series the value belongs to. See the documentation for the Series table for more information.

Resultset: Line values (line)

Line chart values.
Repeat mode:
Row count:

Columns:

XValue mandatory decimal
Value on the x-axis.
YValue mandatory decimal
Value on the y-axis.
Y2Value optional decimal
The second value on the y-axis. Mandatory for range series, not used by other series.
SeriesName optional string
Name of the series the value belongs to. See the documentation for the Series table for more information.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and 'Validate parameters' is checked.
Supports custom errors: No
May modify database: No

Parameters:

@force optional bit
@validateparams mandatory bit
This parameter is set to 1 by Softadmin® when this call is made.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.
Supports custom errors: No
May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Repeat mode: repeated exactly once
Row count: exactly one row

Columns:

GrantAccess mandatory bit
1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.