Dashboards & Visualizations

What are the possible attributes for the view tag in advanced XML?

lguinn2
Legend

I have seen a number of attributes used with <view>, especially when I generate advanced XML from simple XML.
What is the complete list - and what do they mean?

Tags (2)
0 Karma
1 Solution

lguinn2
Legend

Here is the list that I have - please comment or answer if you have additions / corrections / explanations!

Note that all of these attributes are optional

  • refresh="n" (where n is an integer number of seconds)
    How often to rerun HiddenSearches or get any new HiddenSavedSearch results
  • onunloadCancelJobs= "True" | "False"
    Whether or not to cancel running searches when navigating away from this view
  • autoCancelInterval = "n" (where n is an integer number of seconds)
    Cancels searches that run too long when loading the dashboard
  • isVisible = "True" | "False"
    Controls whether a view appears in the navigation for the app
  • autoRun = "True"
    Automatically run searches when the view loads.
    Do not use .autoRun = False - just leave it out; false is the default. This is the practice of the best XML developers (Like Nick @sideview)
  • template = search.html | dashboard.html
    Identifies the Mako template to use for the view; the template sets a variety of module defaults for the view
  • displayView= charting | flashtimeline | viewName (where viewName is the name of any view you like)
    Identifies the view where subsequent interaction will occur
  • stylesheet="stylesheetName.css" (where stylesheetName.css names your stylesheet file)
    Uses the CSS stylesheet for the view (default directory is appserver/static in the same app)
  • objectMode = SimpleDashboard
    This attribute is "left over" when a view is converted from Simple XML using showsource. This attribute also loads splFormSearch CSS class (you probably don't care and can load it explicitly if needed)

View solution in original post

lguinn2
Legend

Here is the list that I have - please comment or answer if you have additions / corrections / explanations!

Note that all of these attributes are optional

  • refresh="n" (where n is an integer number of seconds)
    How often to rerun HiddenSearches or get any new HiddenSavedSearch results
  • onunloadCancelJobs= "True" | "False"
    Whether or not to cancel running searches when navigating away from this view
  • autoCancelInterval = "n" (where n is an integer number of seconds)
    Cancels searches that run too long when loading the dashboard
  • isVisible = "True" | "False"
    Controls whether a view appears in the navigation for the app
  • autoRun = "True"
    Automatically run searches when the view loads.
    Do not use .autoRun = False - just leave it out; false is the default. This is the practice of the best XML developers (Like Nick @sideview)
  • template = search.html | dashboard.html
    Identifies the Mako template to use for the view; the template sets a variety of module defaults for the view
  • displayView= charting | flashtimeline | viewName (where viewName is the name of any view you like)
    Identifies the view where subsequent interaction will occur
  • stylesheet="stylesheetName.css" (where stylesheetName.css names your stylesheet file)
    Uses the CSS stylesheet for the view (default directory is appserver/static in the same app)
  • objectMode = SimpleDashboard
    This attribute is "left over" when a view is converted from Simple XML using showsource. This attribute also loads splFormSearch CSS class (you probably don't care and can load it explicitly if needed)

lguinn2
Legend

Nick Mealy's answer to this question on another post is quite good and has a few more details: http://splunk-base.splunk.com/answers/95177/view-tag-parameters-list

0 Karma

chinmayc469
Explorer

Can we add hideSplunkBar attibute to the view tag? I want to add this tag for the datasets view

0 Karma
Get Updates on the Splunk Community!

Welcome to the Splunk Community!

(view in My Videos) We're so glad you're here! The Splunk Community is place to connect, learn, give back, and ...

Tech Talk | Elevating Digital Service Excellence: The Synergy of Splunk RUM & APM

Elevating Digital Service Excellence: The Synergy of Real User Monitoring and Application Performance ...

Adoption of RUM and APM at Splunk

    Unleash the power of Splunk Observability   Watch Now In this can't miss Tech Talk! The Splunk Growth ...