configure


Purpose

The configure method sets up all configuration options of the Sidebar API and enables the APIs use in Pega Mobile Client. Calling this method is requided for the Sidebar API to work.

Signature

configure( config )

Returns

This method does not return anything.

Parameters

The config object contains the following configuration parameter.

Name Description Type Use
width

Describes the sidebar's width in pixels or percent, for example: "300px" or "42%".

string required
regionId An ID passed to all events defined on the SideBar interface. It is the ID of the left region of the app view. string optional
backgroundColor This parameter sets the color of a placeholder, used until the web app finishes rendering the menu and a screenshot can be mage. It requires a hexadecimal value in RGB format, for example. "#FF00FF". By default, the "#252B2F" is used. string optional

Related topics

Sidebar
Legal notice | Copyright © 2018 and Confidential to Pegasystems Inc. All rights reserved
PDN | Feedback
Advanced...