Application Framework Reference

Module API

getRootAncestor()

The getRootAncestor() method gets the root module in the module tree.

Synopsis

resp = getRootAncestor()

Return Value

Object

Splunk.Module object representing the module at the module tree root .

Example 

getModulesInTree: function() {
    var root = this.getRootAncestor();
    return [root].concat(root.getDescendants());
},

See Also

getModulesInTree()
 getAncestors()
 getDescendants()

Programming Reference


Extension point dictionary

class Splunk.Context
class Splunk.Job
class Splunk.Search
class Splunk.TimeRange
Splunk Utilities
class Splunk.Module
   constructor
   abortGetResults()
   addChild()
   applyContext()
   displayInlineErrorMessage()
   ensureFreshContexts()
   getAncestors()
   getContext()
   getDescendants()
   getGroupName()
   getLoadState()
   getModifiedContext()
   getModulesInTree()
   getParam()
   getResultParams()
   getResults()
   getResultsCompleteHandler()
   getResultsErrorHandler()
   getResultURL()
   getRootAncestor()
   haveResultParamsChanged()
   hide()
   hideDescendants()
   importParams()
   isPageLoadComplete()
   isReadyForContextPush()
   markPageLoadComplete()
   mergeLoadParamsIntoContext()
   onBeforeJobDispatched()
   onContextChange()
   onLoadStatusChange()
   onResultsRendered()
   onViewDataChange()
   passContextToParent()
   pushContextToChildren()
   pushViewDataChange()
   removeChild()
   renderResults()
   requiresAsynchronousLoading()
   requiresDispatch()
   reset()
   resetContext()
   resetUI()
   resizeWidthToParent()
   setChildContextFreshness()
   setLoadState()
   setParam()
   show()
   showDescendants()
   snapshotParamset()
   someChildrenRequireDispatch()
   validateHierarchy()
   withEachAncestor()
   withEachChild()
   withEachDescendant()
class Splunk.Module.DispatchingModule
class ModuleController
class ModuleHandler
class BaseController
class SplunkRESTModel
class SplunkAppObjModel
class ObjectMetadataModel
class SplunkRESTManager
class SplunkQuerySet
Decorators
Template Utilities
App Server Utilities
 

Questions?

Splunk and our developer community are here to help.