AX1533

Slider refresh variable

Slider refresh variables prompt users to select a value along a defined range of values, using a slider handle. The value is written back to the data source, where it can be used to impact data queries or other aspects of a report.

For example, you can use the slider variable to prompt users to select a number of years to show in the report. The value can then be used to impact the number of columns that are included in the query (or just which years are currently visible).

Axiom Financial Institutions Suite supports two types of variables that use slider handles. If you want users to be able to select a range of values instead of just a single value, use a RangeSlider refresh variable instead.

Variable behavior

The variable displays as a bar with a slider handle. Users can slide the handle along the bar to select a value within the defined range.

Desktop Client: Example Slider refresh variable

Web Client: Example Slider refresh variable

As the handle slides across the bar, the values show in a tooltip so that users can see the available values between the labeled tick marks (if applicable).

Variable properties

This section explains how to complete a variable row in the RefreshVariables data source when defining a Slider variable. Some data source columns do not apply in this case and are not discussed here. If these inapplicable columns are present in the data source, they should be left blank on rows that define Slider variable types. If you are using the Data Source Assistant to complete the variable properties, then only the applicable columns will be shown in the task pane.

For more information on the RefreshVariables data source in general, see Defining refresh variables.

General variable properties

All refresh variables use a common set of general properties such as the variable name, display name, and whether the variable is enabled or required. Any special considerations for Calendar variables are noted.

Column Tag Description

[Name]

(missing or bad snippet)

[DisplayName]

(missing or bad snippet)

[VariableType]

Specifies the variable type. Enter Slider to allow users to select a value from a range of defined values.

[IsEnabled]

(missing or bad snippet)

[SelectedValue]

The user's selected value for the variable will be placed in this cell. For Slider variables, the value is a number.

When setting up the file to use the variable value, point your formulas to this cell.

(missing or bad snippet)

[IsRequired]

This option does not apply to Slider variables and will be ignored. Technically, there is no way to clear the slider, as the slider handle is always on a value within the range. When a user applies the variable, the current value is written back as the selected value, even if the user has not interacted with the slider.

[DependsOn]

(missing or bad snippet)

[DefaultValueonOpen]

(missing or bad snippet)

If no default value is specified, the slider handle starts at the minimum value.

[ClearSelectedValueonSave]

(missing or bad snippet)

[ClearSelectedValueonOpen]

(missing or bad snippet)

[GroupName]

(missing or bad snippet)

[CollapseOnOpen]

(missing or bad snippet)

Variable-specific properties

The following additional properties apply to Slider variable types:

Column Tag Description

[MinValue]

The minimum value for the slider bar. This value defines the smallest number that can be selected on the slider.

The slider handle starts at the minimum value if no default value is specified.

[MaxValue]

The maximum value for the slider bar. This value defines the largest number that can be selected on the slider.

[StepFrequency]

Optional. The frequency of step values within the range. For example, if the range is 0 to 100 and you specify a step frequency of 10, then step values are available at 0, 10, 20, and so on. The slider handle snaps to step values, so the step frequency determines which values the user can select within the range.

The slider bar shows up to seven major tick marks with step values. All other steps are shown using minor tick marks, with the value visible in a tooltip as the user slides the handle.

Example slider tooltip

If the step frequency is not specified, then by default the range is divided evenly into 50 step values.

[DisplayFormat]

(missing or bad snippet)

The following properties do not apply to Slider variables: PlaceHolderText, ListChoices, ColumnName, AdditionalColumns, ColumnFilter, AllowMultiSelect, DataSourceName, Hierarchies, UseAsQuickFilter, TooltipColumn, PrimaryTable, LimitColumn, AutoQuoteString, MinDate, MaxDate.

Example data source

The following screenshot shows example Slider variables: