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 NameTypeDetails
alignmentXString

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

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

Included in the Dashboard Designer’s user interface.

alignmentYString

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

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

Included in the Dashboard Designer’s user interface.

backgroundColorString

Background color of the dashboard, specified in hex color code. The default is #FFFFFF. Included in the Dashboard Designer’s user interface.

cellSpacingXInteger

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

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

Included in the Dashboard Designer’s user interface.

cellSpacingYInteger

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

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

Included in the Dashboard Designer’s user interface.

documentIdStringThe 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. Included in the Dashboard Designer’s user interface.
fitStringIndicates how to scale the image.

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

Included in the Dashboard Designer’s user interface.

imageArray

Identifies the image using the following properties.

  • name: Name of the image.

  • namespace: Optional. Namespace of the image. Default is null.

Included in the Dashboard Designer’s user interface.