dundas.views.HierarchyViewService Class

 

Inheritance Hierarchy

 
Class
   dundas.Component
      dundas.Service
         dundas.views.BaseViewService
            dundas.views.HierarchyViewService
 

Constructors

 
  Name Description
init Initializes the HierarchyViewService. Called during construction. Inherited from dundas.Component.
 
 

Properties

 
  Name Description
commandService Gets the command service. Inherited from dundas.views.BaseViewService.
currentHierarchyId Gets the current hierarchy ID or null if no hierarchy has been set.
currentItemId Gets the current ID of the item being worked with. This might be the ID of the View (Dashboard, etc.), or the ID of the MetricSet, or the ID of the DataCube, or etc. Inherited from dundas.views.BaseViewService.
currentPage Gets the current page. This is a convenience shortcut to bootstrap.currentPage. Inherited from dundas.views.BaseViewService.
dockableAreas Gets or sets a value that holds a reference to the dockable areas in the application. The object looks like: { right: dundas.controls.DockableArea, bottom: dundas.controls.DockableArea } Inherited from dundas.views.BaseViewService.
dockables Gets or sets an array holding the dockables currently on the screen. Inherited from dundas.views.BaseViewService.
eventsManager Inherited from dundas.Service.
fileExplorer Gets or sets a value that holds a reference to the file explorer in the application. Inherited from dundas.views.BaseViewService.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
isEditMode Gets or sets a value indicating whether the view is currently in edit mode. Inherited from dundas.views.BaseViewService.
site Gets or sets the site that this component is a part of. Inherited from dundas.Component.
uniqueId Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
 
 

Methods

 
  Name Description
addFontFamilyOption Lists the specified text as an option when setting Font Family properties through the UI. Inherited from dundas.views.BaseViewService.
autoSave Performs the auto-save. This will be resolved even if auto-save isn't required. Rejection if a save was required, and it failed, or if this was called at an inappropriate time (i.e. when edit mode is false). Inherited from dundas.views.BaseViewService.
autoSaveCheck If auto-save functionality is used, this must be overridden by a deriving view service to return the current state (whether to auto-save or not). Inherited from dundas.views.BaseViewService.
bind Subscribe a handler for an event. Inherited from dundas.Service.
closeAllViewInlinePopups Closes all the inline popups which are registered. Inherited from dundas.views.BaseViewService.
createDelegate Helper for creating delegate functions. Inherited from dundas.Component.
createTimeout Creates a timeout. Inherited from dundas.Component.
dispatch Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
dispose Disposes the component. Inherited from dundas.Component.
disposeAllViewInlinePopups Close and destroy all inline popups. Inherited from dundas.views.BaseViewService.
findDockableByType Finds the dockable with the given type. Inherited from dundas.views.BaseViewService.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getAllViewInlinePopups Returns a copy of the list of all view inline popups that are currently registered. Inherited from dundas.views.BaseViewService.
getFontFamilyOptions Gets the font family options added using addFontFamilyOption. Inherited from dundas.views.BaseViewService.
getService Gets the requested service. Inherited from dundas.Component.
initializeDragDrop
load Load a view. To be overridden by deriving view services. Inherited from dundas.views.BaseViewService.
onLoaded Called when the service is loaded. Inherited from dundas.Service.
onMetricSetChanged Takes actions required in response to a metric set change. This may result in modifications to this and other metric sets. Inherited from dundas.views.BaseViewService.
openAllViewInlinePopups Opens all the inline popups which are registered. Inherited from dundas.views.BaseViewService.
refreshAllViewInlinePopupContent Called when outside entities require the view inline panel to re-draw its contents from scratch. This may be a heavy call. Inherited from dundas.views.BaseViewService.
registerViewInlinePopup Registers a popup with the view. Inherited from dundas.views.BaseViewService.
removeViewInlinePopup Removes the given view inline popup from the tracked list. Inherited from dundas.views.BaseViewService.
resizeDockableAreas Called to tell the dockable areas to re-size. Inherited from dundas.views.BaseViewService.
save Saves the current entity that is being worked on. Inherited from dundas.views.BaseViewService.
selectDockableByType Finds the dockable with the given type, and selects it (expands it, or shows it if already expanded). If the dockable is on the taskbar, it will be moved to a dockable area. Inherited from dundas.views.BaseViewService.
setupMainMenuEvents Should be called to have the dashboard view service listen to various main menu events. Inherited from dundas.views.BaseViewService.
startAutoSave When called, will start a timer to constantly auto-save the backing object of the current view. Inherited from dundas.views.BaseViewService.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.Service.
subscribeOnce Subscribe a one time handler for an event. Inherited from dundas.Service.
takeAdaptersSnapshot Take a snapshot of the adapter specified as the key of . Inherited from dundas.views.BaseViewService.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trigger Triggers an event. Inherited from dundas.Service.
unbind Unsubscribe an event. Inherited from dundas.Service.
updateHistoryState Updates the current history state, entity URL and optionally pushes into the history. Inherited from dundas.views.BaseViewService.