Splunk Web Framework Component Reference

LayoutView

Description

The Layout view is used in an HTML dashboard to manage the chrome and layout of the page:

The Splunk bar at the very top of the page provides a link to the Splunk Enterprise home page, a list of apps, and menu options for Splunk Enterprise.
The app bar provides links to the app-specific features and views.
The footer lists Splunk Enterprise links and copyright notice at the foot of the dashboard.

Note

Layout

Header

Footer

Library path

splunkjs/mvc/layoutview

Properties

Name	Default value	Description
id		Required. The unique ID for this control.
hideAppBar	`false`	Hides the app bar.
hideAppsList	`false`	Hides the app list in the Splunk bar.
hideChrome	`false`	Renders only the main content, hiding the app bar, Splunk bar, and footer.
hideFooter	`false`	Hides the footer.
hideSplunkBar	`false`	Hides the Splunk bar.
layout	"scrolling"	The type of page layout ( `fixed` \| `scrolling` ).

Example

        . . .

        //
        // SPLUNK LAYOUT
        //

        $('header').remove();
        new LayoutView({
            "hideAppBar": false, 
            "hideAppsList": true, 
            "hideChrome": false, 
            "hideSplunkBar": false, 
            "hideFooter": true,
            "layout": "fixed"
        })
            .render()
            .getContainerElement()
            .appendChild($('.dashboard-body')[0]);

        . . .

LayoutView

Description

Library path

Properties

Name

Default value

Description

Example