style Properties

The style key contains the dashboard properties, like cell spacing in the grid, as well as the dashboard’s background color or image.
Property Name Details
alignmentX
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description

The horizontal alignment of the background image applied to the dashboard.

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

alignmentY
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description

The vertical alignment of the background image applied to the dashboard.

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

backgroundColor
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description

Background color of the dashboard, specified in hex color code. The default is #FFFFFF.

cellSpacingX
Type
Integer
Exposed in the Dashboard Designer's User Interface
Yes
Description

Horizontal spacing (in pixels) between cells in the dashboard grid.

Valid values are 0, 4, 8 (default), and 16.

cellSpacingY
Type
Integer
Exposed in the Dashboard Designer's User Interface
Yes
Description

Vertical spacing (in pixels) between cells in the dashboard grid.

Valid values are 0, 4, 8 (default), and 16.

documentId
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description
The 15-character document ID of the image to apply as the dashboard’s background. To ensure security, upload the image file to Salesforce as a document, and select the Externally Available Image option. If this option is not selected or the referenced document is not an image, the image doesn’t show up.
fit
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description
Indicates how to scale the image.

Valid values are: original (default), stretch, tile, fitwidth, and fitheight.

image
Type
Array
Exposed in the Dashboard Designer's User Interface
Yes
Description
Identifies the image using the following properties.
name
Name of the image.
namespace
Optional. Namespace of the image. Default is null.
Example
"image": {
    "name": "My_Corporate_Logo",
    "namespace": ""
}