Displaying and Hiding the Shell Header

Use the methods of the Renderer API to specify when the shell header is displayed or hidden.

Syntax

setHeaderVisibility(bVisible, bCurrentState, aStates)

These methods are part of the SAPUI5 sap.ushell.renderers.fiori2 namespace. For more information, go to SAPUI5 Demo Kit: Controls and then navigate to Start of the navigation path API REFERENCE Next navigation step sap.ushell.renderers.fiori2 Renderer End of the navigation path .

Parameters

Parameter	Type	Description
bVisible	Boolean	The visibility of the shell header.
bCurrentState	Boolean	If `true`, the visibility is set according to the current rendered shell state. When the user navigates away from the current app (or home page), the visibility is reset. If `false`, visibility is determined according to the values of the aState parameter.
aStates	String	Valid only if bCurrentState is set to `false` A list of the launchpad states in which the header visibility flag is set.

Parameter

Type

Description

bVisible

Boolean

The visibility of the shell header.

bCurrentState

Boolean

If true, the visibility is set according to the current rendered shell state. When the user navigates away from the current app (or home page), the visibility is reset.

If false, visibility is determined according to the values of the aState parameter.

aStates

String

Valid only if bCurrentState is set to false

A list of the launchpad states in which the header visibility flag is set.

To determine when the shell header is displayed, the launchpad state parameters can have the following values of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState enum:

Launchpadstate.App: The launchpad state when running a Fiori app.
Launchpadstate.Home: The launchpad state when the home page is open.

If no launchpad state is provided, the flag is set for all states.

Example

<pre>
var oRenderer = sap.ushell.Container.getRenderer("fiori2");
oRenderer.setHeaderVisibility(false, false, ["home", "app"]);
</pre>