`parameters` Properties

The parameters key contains a list of properties that control the appearance of the widget. Each widget type, including each chart type, contains a unique set of properties.

You can dynamically set properties for number and chart widgets in CRM Analytics dashboards based on the selection or results of another step. For example, you can change the map type in a chart based on a selection in a toggle widget. For more information, see the Analytics Bindings Developer Guide.

Chart widgets have many properties that vary based on the chart type. For chart-specific properties for CRM Analytics dashboards, see Visualizing Data with Charts.

These sections describe the widget properties that are set in the parameters property.

Type: Boolean

Show absolute dates in the date widget when users view the dashboard. true, by default.

Default is true.

Available for this widget: dateselector

Exposed in the Dashboard Designer’s user interface.

Type: String

Indicates the horizontal alignment of the image in the widget.

Valid values are: left (default), center, and right.

Available for this widget: image

Exposed in the Dashboard Designer’s user interface.

Type: String

Indicates the horizontal alignment of the image in the widget.

Valid values are: left (default), center, and right.

Available for this widget: image

Exposed in the Dashboard Designer’s user interface.

Type: String

Indicates the vertical alignment of the image in the widget.

Valid values are: top (default), center, and bottom.

Available for this widget: image

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the dashboard viewer can switch between the fiscal and calendar year in the date widget.

Default is false.

Available for this widget: dateselector

Exposed in the Dashboard Designer’s user interface.

Type: Array

List of API names of step fields to include in the widget. Use this property to include specific fields in the widget or to change the field order for the widget. This property appears when you reorder or hide a field while editing a widget that’s based an aggregateflex (for a compare table) or a saql step type. To specify the fields or change their order for widgets based on other step types, you have to manually add and set this property in the JSON.

Example: A step returns data in the following fields: Id, Name, Amount, and Profit. To hide the Id and Profit fields from the chart widget (chart_2), set the “columns” property.

Available for this widget:

chart
table

Exposed in the Dashboard Designer’s user interface (for aggregateflex and saql step types only)

Type: Object

An object representation of the column properties. This includes thetype enum with valid values of bar, image, and text.

For each type, the parameters object specifies addtional attributes.

parameters (bar) — A bar column type. This type contains the following parameter:
- width(integer) - The column’s width.
parameters (image) — An image column type. This type contains the following parameters:
- alignment (enum) - The column’s width.
- height (integer) - The image’s height.
- width (integer) - The column’s width.

Available for this widget: table

Exposed in the Dashboard Designer’s user interface.

This example shows the bar type:

This example shows the imagetype.

This example shows the texttype.

Type: Boolean

Indicates whether displayed numbers are abbreviated (true) or not (false).

For example, if true, the number 48,081 appears as 48k. Although the number appears to be rounded, it is not. The value 48,081 is preserved in charts and when performing calculations. If false, then 48,081 appears as 48,081. For number widgets, shortened numbers are rounded to the nearest 10th.

Default is false.

Available for this widget:

listselector
number
pillbox

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether to include the total measure column (true) or not (false).

Default is true.

Available for this widget: chart (only when visualizationType is stackwaterfall and waterfall)

Exposed in the Dashboard Designer’s user interface.

Type: List

A list of all widgets inside the container widget.

Available for this widget: container

Exposed in the Dashboard Designer’s user interface.

This example shows 2 widgets (meafilter_1 and chart_1) included in the container widget (container_1).

Type: Boolean

Specifies these details about custom bulk action.

label — Display label for the button in the table widget’s action menu. The dashboard viewer clicks the button to execute the action.
visualforce — The name and namespace prefix of the Visualforce page that defines the bulk action. Namespace prefix is optional.

Available for this widget: table

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the date widget displays dates using the fiscal year, by default. If not, then it uses the calendar year.

Default is false.

Available for this widget: dateselector

Exposed in the Dashboard Designer’s user interface.

Type: String

The ID of the dashboard, lens, step, or page.

Default is null.

Available for this widget: link

Exposed in the Dashboard Designer’s user interface.

Type: String

The object to which you are linking. One of the following properties identifies the linked object.

name — The ID of the dashboard, lens, step, or page. Default is null.
url — The URL that the link points to.
tooltip — The tooltip that displays when you hover over a link to a URL.

Available for this widget: link

Exposed in the Dashboard Designer’s user interface.

Type: String

The destination type of a link. Possible values are:

dashboard — a dashboard
explore — a step
lens — a lens
page — a page
url — a website

Default is lens.

Available for this widget: link

Exposed in the Dashboard Designer’s user interface.

Type: String

Specifies the string of grouping and measure fields to display in the widget. Fields must be enclosed in square brackets. By default, all groupings are included.

Available for this widget:

listselector
pillbox

Exposed in the Dashboard Designer’s user interface.

This example displays the value for the Account.Type dimension, Account.BillingCountry dimension, and Amount measure.

Type: String

The 15-character document Id of the image file that you want to apply as the background. To ensure security, the image file must be uploaded to Salesforce as a document and the Externally Available Image option must be selected. If this option is not selected or the referenced document is not an image, the image doesn’t show up in the widget. Default is null.

Available for this widget: image

Exposed in the Dashboard Designer’s user interface.

This example image widget (image_1) displays an image with ID 015R0000000DClP.

Type: Boolean

Indicates whether to include an axis for each of the two measures (true) or not (false).

Default is true.

Available for this widget: chart (only when visualizationType is combo)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the widget shows the explore icon that dashboard viewers can click to explore the widget as a lens (true) or not (false). This option only applies to widgets based on steps in compact form. You can’t explore widgets that are built on SAQL form steps.

Default is true.

Mobile devices display the icon, regardless of this setting.

Available for this widget:

chart
comparetable
listselector
number
pillbox
valuestable

Exposed in the Dashboard Designer’s user interface.

Type: List

Details about each global filter shown in the global filter panel widget. You can configure the following details, which are also available in the user interface.

propertyColor — Color of the field name
valueColor — Color of the field value
backgroundColor — Color of the filter background
borderColor — Color of the filter border
borderWidth — Width of the filter border
borderRadius — Radius of the filter border

Available for this widget: filterpanel

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the axis of a chart is in the center of the data (true) or at (0, 0) (false).

Default is false.

Available for this widget: chart (only when visualizationType is scatter)

Exposed in the Dashboard Designer’s user interface.

Type: String

Indicates how to scale the image. Valid values are:

original (default)
stretch
tile
fitwidth
fitheight
image

Available for this widget:

Exposed in the Dashboard Designer’s user interface.

Type: Integer

The font size of a number or of text.

Defaults are:

number: 36
text: 26

Available for this widget:

link
number
text

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the first column in a raw data table—which is simply a count of rows—is hidden (true) or not (false).

Default is false.

This setting doesn’t apply when viewing the widget on mobile devices.

Available for this widget:

chart
valuestable

Not exposed in the Dashboard Designer’s user interface. Only editable via JSON.

Type: Array

Identifies the image using the following properties.

name — Name of the image.
namespace — Optional. Namespace of the image. Default is null.

Available for this widget:

container
image

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

If set to true:

CRM Analytics passes selections in chart, list, toggle, range, and date widgets as selections in the linked asset if they apply. For example, you select North America in a list widget based on the Region dataset field. CRM Analytics applies that same selection to faceted queries in the linked dashboard that have a grouping based on the Region field in the same dataset.
CRM Analytics passes global filters as filters to a linked asset as long as the filters apply. CRM Analytics ignores a global filter if the linked asset doesn’t use the dataset that the global filter is defined on. If the global filter is locked and the incoming filter is defined on the same field, CRM Analytics ignores the incoming filter. If it’s unlocked, the incoming filter overrides the global filter defined in the dashboard.

Default is false.

Available for this widget: link

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether other faceted widgets immediately update (true) or not (false) when a dashboard viewer makes a selection in this widget.

When false, dashboard viewers must click Update for their changes to cascade to faceted widgets. When true, the Update button is hidden.

Defaults are:

dateselector — false
listselector — true
rangeselector — false

For list, range, or date widgets that are expanded in the dashboard designer, this widget property is always enabled. Selections in these widgets instantly update other widgets. While these widgets are expanded, you can’t change this setting.

The Update Instantly property is available when the widget is collapsed, but not when expanded.

Available for this widget:

dateselector
listselector
rangeselector

Exposed in the Dashboard Designer’s user interface.

Type: Integer

Number of global filters to show per row in the global filter panel. Default is 6.

Available for this widget: filterpanel

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether to display a legend (true), or not (false).

Default is false for all chart types, except pivottable.

Mobile devices can only display legends for pie widgets.

Available for this widget: chart (only when visualizationType is hbar, vbar, stackhbar, stackvbar, pie, scatter, time, time-bar, time-combo, hdot, vdot, matrix, calheatmap, heatmap, parallelcoords, stackwaterfall, funnel, or choropleth)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the legend has a title (true) or not (false). The title is always the name of the dimension that the legend describes.

Default is false for all chart types except pivottable.

This setting doesn’t apply when viewing the widget on mobile devices.

Available for this widget: chart (only when visualizationType is hbar, vbar, stackhbar, stackvbar, pie, scatter, time, time-bar, time-combo, hdot, vdot, matrix, calheatmap, heatmap, stackwaterfall, combo, combo, or parallelcoords)

Not exposed in the Dashboard Designer’s user interface. Only editable via JSON.

Type: Integer

The width of the legend area in pixels.

Default is 145 for all chart types except pivottable.

This setting doesn’t apply when viewing the widget on mobile devices.

Not exposed in the Dashboard Designer’s user interface. Only editable via JSON.

Type: String

The mathematical function performed on data.

Specify the measureField in this format: <formula><field>_.

<formula> must match one of the formulas specified in the measures step property. Possible values for <formula> are:

avg — calculate the mathematical average (mean)
max — the maximum value
min — the minimum value
sum — add all the values
unique — count the number of unique values. For example, use to count the number of unique dimensions.

The <field> paired with the <formula> must match the field name that is specified in measures.

For example, if the measures step property is:

Then measureField must be sum_Profit, avg_Discount, or unique_ModelNumber. The measureField can’t be avg_Profit because avg and Profit aren’t paired together in the measures step property.

Unlike for measures, a count on a dimension in the user interface calculates the number of unique dimension values. As a result, measureField in the underlying JSON shows the unique formula, like unique_<dimension_field_name>.

Default is null.

Available for this widget:

listselector
number
pillbox

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether two or more measures are displayed as adjacent bars under each grouping (true) or as individual, adjacent graphs (false).

Default is false (available only for bar charts and column charts).

Available for this widget: chart (only when visualizationType is hbar or vbar)

Exposed in the Dashboard Designer’s user interface.

Type: String

The color of the measure columns that have decreased in value in the chart.

Specify the color in this format: rgb({a}, {b}, {c}, {d}).

Using a number between zero and 255, {a} indicates how much red is in the color, {b} how much green, and {c} how much blue. A value of 0 indicates the absence of a color, and a value of 255 indicates the full expression of a color.

Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.

Alternatively, the color can be set using hexadecimal notation. When using hexadecimal notation, transparency can’t be set. All hexadecimal colors default to opaque. #000000 indicates black in hexadecimal. #ff0000 indicates red.

Available for this widget: chart (only when visualizationType is waterfall)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether charts are displayed using a logarithmic scale (true) or a linear scale (false).

Default is false (available only for stackhbar and stackvbar).

Available for this widget: chart (only when visualizationType is stackhbar or stackvbar)

Exposed in the Dashboard Designer’s user interface.

Type: String

The font color of the number.

Specify the color in this format: rgb({a}, {b}, {c}, {d}).

Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.

Default is #000.

Available for this widget: number

Exposed in the Dashboard Designer’s user interface.

Type: Integer

The font size of the number. Default is 26.

Available for this widget: number

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the table is pivoted. A pivot table requires the underlying step to have at least one grouping. CRM Analytics pivots the table on the last defined grouping. Default is false.

Available for this widget: table

Exposed in the Dashboard Designer’s user interface.

Type: String

The color of the measure columns that have increased in value or remained the same in the chart.

Specify the color in this format: rgb({a}, {b}, {c}, {d}).

Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.

Available for this widget: chart (only when visualizationType is waterfall)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Show preset dates in the date widget when users view the dashboard. true, by default.

Default is true.

Available for this widget: dateselector

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Show relative dates in the date widget when users view the dashboard. true, by default.

Default is true.

Available for this widget: dateselector

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether to display the values of each measure column (true) or not (false).

Default is true.

Available for this widget: chart (only when visualizationType is stackwaterfall or waterfall)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether each dimension in a chart is measured on its own axis (true) or a shared axis (false).

Only applicable when multiMetrics is true.

Default is false (available only for bar charts and column charts).

This setting doesn’t apply when viewing the widget on mobile devices.

Available for this widget: chart

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether charts are displayed using a logarithmic scale (true) or a linear scale (false).

Default is false (available only for bar charts, column charts, line charts, and time series).

This setting doesn’t apply when viewing the widget on mobile devices.

Available for this widget: chart (only when visualizationType is parallelcoords, hdot, vdot, time, time-bar, time-combo, scatter, stackhbar, stackvbar, hbar, stackwaterfall, or vbar)

Exposed in the Dashboard Designer’s user interface.

Type: String

The color of the first measure column in the chart.

Specify the color in this format: rgb({a}, {b}, {c}, {d}).

Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.

Available for this widget: chart (only when visualizationType is waterfall)

Exposed in the Dashboard Designer’s user interface.

Type: String

The name of the step that supplies data for the widget.

Default is null.

Available for this widget:

chart
comparetable
dateselector
globalfilters
listselector
number
pillbox
rangeselector
valuestable

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether an image’s width and height are set to the same values of the widget’s width and height (true) or not (false).

Default is false.

Available for this widget: box

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether an image’s width and height are set to the same values of the widget’s width and height (true) or not (false).

Default is false.

Available for this widget: container

Exposed in the Dashboard Designer’s user interface.

Type: String

The message rendered in a text widget. For example, if text is assigned the value “Hello, World!”, then “Hello, World!” appears in the text widget.

Default is null.

Available for this widget:

link
text

Exposed in the Dashboard Designer’s user interface.

Type: String

The alignment of text. Possible values include left, center, and right. If no value is specified, text alignment defaults to center.

Defaults are:

number: right
text: center

Available for this widget:

link
number
text

Exposed in the Dashboard Designer’s user interface.

Type: String

The font color of text.

Specify the color in this format: rgb({a}, {b}, {c}, {d}).

Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.

Default is #000.

Available for this widget:

link
text

Exposed in the Dashboard Designer’s user interface.

Type: String

The title of a widget.

Default is null.

Available for this widget:

dateselector
listselector
number
pillbox
rangeselector

Exposed in the Dashboard Designer’s user interface.

Type: List

Details about the title of the global filter panel widget. You can configure the following details, which are also available in the user interface.

visible — Indicates whether the title is visible when viewing the dashboard
text — Details about the title: title (label), color of title (color), font size of title (fontSize), and horizontal alignment (align)
separatorColor — Color of the line that separates the widget title from the global filters

Available for this widget: filterpanel

Exposed in the Dashboard Designer’s user interface.

Type: String

The font color of the title.

Specify the color in this format: rgb({a}, {b}, {c}, {d}).

Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.

Default is #000.

Available for this widget: number

Exposed in the Dashboard Designer’s user interface.

Type: Integer

The font size of the title. Default is 26.

Available for this widget: number

Exposed in the Dashboard Designer’s user interface.

Type: String

Text that appears when you hover over the widget while viewing the dashboard. Use a tooltip to add context to the text or image.

Available for this widget:

image
text

Exposed in the Dashboard Designer’s user interface.

Type: String

The color of the total measure column in the chart.

Specify the color in this format: rgb({a}, {b}, {c}, {d}). Using a number between zero and 255, {a} indicates how much red is in the color, {b} how much green, and {c} how much blue. A value of 0 indicates the absence of a color, and a value of 255 indicates the full expression of a color. Using a number between zero and one, {d} indicates the level of transparency. A value of 0 is invisible and 1 is opaque.

For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black. rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red. Alternatively, the color can be set using hexadecimal notation. When using hexadecimal notation, transparency can’t be set. All hexadecimal colors default to opaque. #000000 indicates black in hexadecimal. #ff0000 indicates red.

Available for this widget: chart (only when visualizationType is waterfall)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether to include a row that displays the sum of all the values in each measure column (true) or not (false).

Default for chart is false (available only for pivottable).

This setting doesn’t apply when viewing the widget on mobile devices.

Available for this widget: chart (only when visualizationType is pivottable)

Exposed in the Dashboard Designer’s user interface.

Type: Boolean

Indicates whether the last grouping displays on its own axis (true) if a step has multiple groupings and one measure. If false, it displays all groupings on the same axis.

Default for chart is false (available only for bar charts and column charts).

This setting doesn’t apply when viewing the widget on mobile devices.

Available for this widget: chart

Exposed in the Dashboard Designer’s user interface.

Type: String

The dimensions of a YouTube video. Possible values are:

(4/3) 240 x 180
(4/3) 420 x 315
(4/3) 480 x 360
(4/3) 640 x 480
(4/3) 960 x 720
(16/9) 320 x 180
(16/9) 560 x 315
(16/9) 640 x 360
(16/9) 853 x 480
(16/9) 1280 x 720

Default is (4/3) 240 x 180.

Mobile devices don’t display url widgets.

Available for this widget: url

Exposed in the Dashboard Designer’s user interface.

Type: String

The type of chart used to show data. Possible values are:

calheatmap— calendar heat map
choropleth — choropleth (map)
combo — lines and bars to show multiple metrics
flatgauge — flat gauge
funnel — funnel
hbar — horizontal bar
hdot — horizontal dot plot
heatmap— heat map
matrix— matrix
parallelcoords — parallel coordinates
pie — donut
pivottable — pivot table
polargauge — polar gauge
pyramid — pyramid
rating — rating
scatter — scatter plot
stackhbar — stacked horizontal bar
stackpyramid — stacked pyramid
stackvbar — stacked vertical bar
stackwaterfall — stacked waterfall
time — timeline
time-bar — time bar
time-combo — time bar
vbar — vertical bar
vdot — vertical dot plot
waterfall — waterfall

Available for this widget: chart

Exposed in the Dashboard Designer’s user interface.

Type: ConnectUri

The URL of a YouTube video.

Default is null.

Mobile devices don’t display url widgets.

Available for this widget: url

Exposed in the Dashboard Designer’s user interface.

parameters Properties

`parameters` Properties