Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [Dashboard] >  [Utils]
Private  Storage   

class %DeepSee.Dashboard.Utils extends %RegisteredObject

Utility methods for DeepSee Dashboards.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
23 1


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DashboardExists %DeleteDashboard
%DeleteTheme %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DoesFilterSupportRange
%Extends %GetCaptionForTargetProperty %GetChartTypeInfo
%GetDashboardActionList %GetFiltersForDataSource %GetListingsForDataSource
%GetMemberDimensionType %GetMembersForFilter %GetParameter
%GetPivotVariablesForDataSource %GetPropertiesForDataSource %GetStyleFromTheme
%GetThemeList %GetWidgetClass %GetWidgetClasses
%GetWidgetTemplateList %IsA %IsModified
%New %NormalizeObject %ObjectModified
%OpenDashboard %OriginalNamespace %PackageName
%RemoveFromSaveSet %SaveTheme %SerializeObject
%SetModified %ValidateObject EnumerateFiltersClose
EnumerateFiltersExecute EnumerateFiltersFetch


Methods

• classmethod %DashboardExists(pFullName As %String, Output pID As %String) as %Integer
Check if a there is a dashboard definition with the given name. Returns 0 if the item does not exist; returns 1 if it exists and is visible to the current user; returns 2 if it exists but is not visible to the current user.
• classmethod %DeleteDashboard(pFullName As %String) as %Boolean
Delete the dashboard definition with the given full name.
• classmethod %DeleteTheme(pThemeName As %String) as %Status
Delete the given "theme".
• classmethod %DoesFilterSupportRange(pDataSource As %String, pFilter As %String, Output pSupportsRange As %Boolean) as %Status
Tests if a given filter supports range selection (used by the searchBox control).
• classmethod %GetCaptionForTargetProperty(pDataSource As %String, pTarget As %String, Output pCaption As %String) as %Status
Return the caption for the given target property within the given data source. This is used to translate the logical name for a filter to its display value.
• classmethod %GetChartTypeInfo(pParentWidgetClass As %String, Output pList As %String)
• classmethod %GetDashboardActionList(Output pAction As %String, pDataSource As %String = "") as %Status
Return list of possible dashboard actions. This takes the form:
pAction(n)=$LB(name,caption,tooltip,type)
type specifies the data associated with the action (if any). This value is passed along as the targetProperty of the action.
"filter", the action controls the given filter.
"url", the action requires a url.
"dashboard", the action requires a dashboard.

The control for each action is determined by the %CreateControls method in the DashboardViewer class.
The actions are dispatched to widget by the dashboardEventHandler method in the DashboardViewer class.
• classmethod %GetFiltersForDataSource(pDataSource As %String, Output pFilters As %List, ByRef pVisited, pParent As %String = "", pSearchKey As %String = "", pMaxDepth As %Integer = 3, pLevel As %Integer = 1) as %Status
Return list of possible filters for a given dashboard data source. This takes the form:
pFilters(n)=$LB(caption,value,type)
type is the dimension type: "" (data),"year","month","day", etc.
pVisited is used to prevent cycles when visiting related cubes.
pMaxDepth is maximum depth of relations to follow. A value of 0 means there is no limit to the depth of relationships.
• classmethod %GetListingsForDataSource(pDataSource As %String, Output pListings As %List, pType As %String = "") as %Status
Return list of possible listings for a given dashboard data source. This takes the form:
pListings(n)=$LB(caption,value,type)
• classmethod %GetMemberDimensionType(pDataSource As %String, pFilter As %String, Output pType As %String, Output pMemberClass As %String, Output pOtherInfo As %String) as %Status
Find the dimension type for a given dashboard data source and filter. Also returns the member class.
• classmethod %GetMembersForFilter(pDataSource As %String, pFilter As %String, Output pMembers As %List, Output pDefaultValue As %String, pSearchKey As %String = "", ByRef pRelatedFilters, pCalcOnly As %Boolean = 0, pRangeMode As %Boolean = 0, ByRef pPreSelected As %String) as %Status
Return list of possible filter member values for a given dashboard data source and filter. This takes the form:
pMembers(n)=$LB(text,value,[description])
If pSearchKey is provided, then only return members that match the search key. If pRelatedFilters is provided, it is an array of other filter values to use to restrict the set of members. It takes the form:
pRelatedFilters(spec) = key
If pCalcOnly is true, then only return calculated members.
If pRangeMode is true, then only return members that are valid for range selection (used by searchBox).
If pPreSelected is a list of selected values; always display these items.
• classmethod %GetPivotVariablesForDataSource(pDataSource As %String, Output pVariables As %List) as %Status
Return list of possible pivot variables for a given dashboard data source. This takes the form:
pVariables(n) = $LB(name,caption,defValue,context)
• classmethod %GetPropertiesForDataSource(pDataSource As %String, Output pProperties As %List) as %Status
Return list of possible data properties for a given dashboard data source. This takes the form:
pProperties(n)=name
• classmethod %GetStyleFromTheme(pThemeID As %String, pOverrideName As %String, Output pStyle As %String) as %Status
Load a named style override from the given "theme".
• classmethod %GetThemeList(Output pList As %String, Output pCount As %Integer, pMaxItems As %Integer = "") as %Status
Return an array of saved themes visible to the current user. This list is in the form:
pList(n) = $LG(id,fullName,name)
• classmethod %GetWidgetClass(pWidgetType As %String) as %String
Find the class name for the given widget type.
• classmethod %GetWidgetClasses(Output pInfo As %String) as %Status
Return an array of all available widget types pInfo(n) = $LB(name,caption,class,icon)
• classmethod %GetWidgetTemplateList(Output pList As %String, Output pCount As %Integer, pMaxItems As %Integer = "") as %Status
Return an array of widget templates visible to the current user. This list is in the form:
pList(n) = id
• classmethod %OpenDashboard(pFullName As %String, Output pStatus As %Status) as Definition
Open the dashboard definition with the given full name.
• classmethod %SaveTheme(pThemeName As %String, pOverrides As %ZEN.proxyObject) as %Status
Save a set of style overrides to the given "theme".
• classmethod EnumerateFiltersClose(ByRef qHandle As %Binary) as %Status
• classmethod EnumerateFiltersExecute(ByRef qHandle As %Binary, pSearchKey As %String = "", pDataSource As %String = "") as %Status
• classmethod EnumerateFiltersFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries

• query EnumerateFilters(pSearchKey As %String, pDataSource As %String = "")
Selects Value As %String, Caption As %String, Type As %String
Returns a list of filters for a data source.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.