%DeepSee.Dashboard.Utils
Class %DeepSee.Dashboard.Utils Extends %RegisteredObject [ System = 4 ]
Utility methods for DeepSee Dashboards.
Methods
%OpenDashboard
ClassMethod %OpenDashboard(pFullName As %String, Output pStatus As %Status) As Definition
Open the dashboard definition with the given full name.
%DashboardExists
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.
%DeleteDashboard
ClassMethod %DeleteDashboard(pFullName As %String) As %Boolean
Delete the dashboard definition with the given full name.
%GetDashboardActionList
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.
%GetKpiFilterCaption
ClassMethod %GetKpiFilterCaption(pKPIName, pSpec) As %String [ ZenMethod ]
Lookup a filter caption for a KPI
%GetFiltersForDataSource
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.
%GetPivotVariablesForDataSource
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)
%GetPropertiesForDataSource
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
%GetListingsForDataSource
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)
%GetCaptionForTargetProperty
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.
%GetMembersForFilter
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.
%DoesFilterSupportRange
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).
%GetMemberDimensionType
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.
%GetWidgetClasses
ClassMethod %GetWidgetClasses(Output pInfo As %String) As %Status
Return an array of all available widget types pInfo(n) = $LB(name,caption,class,icon)
%GetWidgetClass
ClassMethod %GetWidgetClass(pWidgetType As %String) As %String
Find the class name for the given widget type.
%GetWidgetTemplateList
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
EnumerateFiltersExecute
ClassMethod EnumerateFiltersExecute(ByRef qHandle As %Binary, pSearchKey As %String = "", pDataSource As %String = "") As %Status
Returns a list of filters for a data source.
EnumerateFiltersFetch
ClassMethod EnumerateFiltersFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = EnumerateFiltersExecute ]
EnumerateFiltersClose
ClassMethod EnumerateFiltersClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = EnumerateFiltersExecute ]
%GetThemeList
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)
%SaveTheme
ClassMethod %SaveTheme(pThemeName As %String, pOverrides As %ZEN.proxyObject) As %Status
Save a set of style overrides to the given "theme".
%DeleteTheme
ClassMethod %DeleteTheme(pThemeName As %String) As %Status
Delete the given "theme".
%GetChartTypeInfo
ClassMethod %GetChartTypeInfo(pParentWidgetClass As %String, Output pList As %String)