Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [Documatic] >  [CubeInfo]
Private  Storage   

class %CSP.Documatic.CubeInfo extends %CSP.Documatic

This class contains methods used for displaying DeepSee cube information.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
17


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %GetSubjectAreaModel
%IsA %New %OriginalNamespace %PackageName
%SetModified CheckSession ConvertParameter Decrypt
DefaultNS DefinedByClose DefinedByExecute DefinedByFetch
DrawHier DrawItemLine DrawLevel DrawPivot
DrawProp DrawSumCal DrawSumDim DrawSumList
DrawSumListField DrawSumMea DrawSumNamed DrawSumPivot
DrawSumRel DrawUsername Encrypt EscapeHTML
EscapeURL HyperEventCall HyperEventHead ImplementedByClose
ImplementedByExecute ImplementedByFetch Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
ReferencedByClose ReferencedByExecute ReferencedByFetch RenderClassPage
RenderCode RenderDefaultStorageDef RenderDescription RenderIndexPage
RenderNameSpaceList RenderNameSpacePage RenderPackageInfo RenderPackagePage
RenderSQLStorageDef RenderStorageDef RenderStoragePage RewriteURL
ShowError StartTimer StopTimer SwapNS
ThrowError UnescapeHTML UnescapeURL


Methods

• classmethod %GetSubjectAreaModel(pClassName As %String, Output pStatus As %Status) as %DeepSee.Model.SubjectArea.subjectArea
Given the DeepSee class name (subject area), return an instance of the %DeepSee.Model.SubjectArea.subjectArea meta-data object that describes the subject area.
Return "" if the given cube does not exist.
This method does not work on base cubes; use %GetModel.
• classmethod DrawHier(pClass, pDim, pIsSub, pBaseModelDim)
Draw cube element Hierarchies (pDim passed in is the Dimension object)
pBaseModelDim is the base model object for this dimension or null.
• classmethod DrawItemLine(pItemType, pItem, pClass)
This method draws some common stuff of an item.
pItemType is a string, such as "dimension", "named set";
pItem is the item's object
pClass is the current cube class name.
• classmethod DrawLevel(pClass, pLevel, dimType, pHierPath, pIsSub, pBaseModelHier)
Draw cube element Levels (pLevel is passed is the objec of tHier.levels pBaseModelHier is the base model object for this subject area's hierarch or null for cube.
• classmethod DrawPivot(pClass, pPivotList, cubeName)
• classmethod DrawProp(pClass, pProp, pLevPath)
Draw cube element Properties (pProp passed in is the object of tLevel.properties)
• classmethod DrawSumCal(%model, Output tCalList) as %Integer
• classmethod DrawSumDim(%model, Output tDimList) as %Integer
• classmethod DrawSumList(%model, Output tListList) as %Integer
• classmethod DrawSumListField(%model, Output tListFieldList) as %Integer
• classmethod DrawSumMea(%model, Output tMeaList) as %Integer
• classmethod DrawSumNamed(%model, Output tNamedList) as %Integer
• classmethod DrawSumPivot(%model, Output tPivotList) as %Integer
• classmethod DrawSumRel(%model, Output tRelList) as %Integer
• classmethod RenderDescription(pClass As %String, pDescription As %String, starttag As %String, endtag As %String)
Pre-process the string provided in pDescription to HTML escape everything that is not a recognized documatic token.


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