argumentbar Element

 

Content

argumentbar Element

Description

Example

Properties

Description

The argumentbar Element defines arguments, provided via a URL or by the User, for Data Trending charts used in Data Entry Page Types.

The page configuration is divided into multiple elements that together define the page content. In addition to the argumentbar, the datachart Element configures general information about the Charts and the dataprovider Element fetches and organizes data from the database. The charts are plotted according to properties defined in the following Plot Elements:

xyplot Element defines the configuration of x/y chart
categoryplot Element defines the configuration of category chart
pieplot Element defines the configuration of pie chart.
combineddomainxyplot Element defines the configuration of multi-plot x/y chart; links multiple "xyplot" elements together.

Example

See Data Trending.

argumentbar Element Properties

Property Name Description
Width Defines the width of the Argument bar in pixels. This has been deprecated.
Visible Whether or not the Arbument bar is visible.
Show Refresh Button Whether or not the Refresh Button is visible.
Argument Groups A group of inputs with a shared title.
Property NameDescription
Argument Group IDArgument group identifier, must be unique.
titletitle of the Argument Group.
VisibleDetermines if the Argument Group is displayed.
ArgumentsArgument values are passed to chart as input parameters.
Property NameDescription
Argument Id Argument identifier, must be unique.
titletitle of Argument.
TipTool tip of Argument.
WidthWidth of the argument input field in pixels.
Argument Value ScopeScope of the Argument Value. Choose Inherit or Request.
Argument Default ValueDefines initial value (s) for the Argument.
Property IdDescription
Default Value TypeValue type defines how the values of this argument are initially populated. Choose Text or SQL.
Value SeparatorString used to separate multiple values.
Display Value SeparatorString used to separate multiple display values.
TextDefines a simple text value for argument.
SQL ValueValues for this argument are gathered by using a database query.
Property IdDescription
SQLSQL clause to retrieve the value(s) for this Argument.
Value Column IDValue column ID in data set. This column is used to populate argument values(s). If left empty then the first column in the data set is used.
Argument TypeArgument Type. Choose Text, Hidden, Dropdown List, Number or Java Script.
Dropdown ArgumentDropdown list collection configuration.
Property IdDescription
Dropdown TypeChoose Value List, Reference Type, SQL or SDC.
Multi SelectIf Yes, multiple values can be selected.
Add Empty ValueDetermines if the first value of the dropdown list is an empty (blank) value.
TranslateWhether or not display value should be translated.
Reference TypeChoose a Reference Type.
SQL Select ClauseEnter a SQL select clause.
SDC IDChoose an SDC ID.
Extended whereExtra where clause.
SDC value columnSDC value column (usually first key field).
SDC Display Value ColumnSDC display value column (defaults to value column, but can be description etc.)
Value ListSemicolon-separated list of values: value1;value2. You can optionally define different display values with pipe: value1|displayvalue1;value2|displayvalue2.
JavaScript Argument Argument values passed to the chart as input parameters.
Property IdDescription
JavaScriptJavaScript passed to the chart.
TypeDetermines if the field is hidden or input.
Editor style Argument Editor style passed to the chart.
Includes If you want to use your own JavaScript files:
Property NameDescription
IdentifierUnique identifier for this item, rendered as an ID attribute in the HTML tag.
URLURL of the JavaScript (*.js) file containing functions called in the page (choose by clicking the ellipsis).