IRISLIB database
pivotLevel Class Reference

Defines an axis, measure, or filter level within a <class>DeepSee.Component.pivotTable</class> component. More...

Inheritance diagram for pivotLevel:
Collaboration diagram for pivotLevel:

Public Attributes

 advanced
 If true, then <property>spec</property> contains an "advanced" specification. More...
 
 aggEnabled
 If true, apply the Aggregate function to this level. More...
 
 aggFunction
 Aggregate function. More...
 
 aggFunctionParm
 Parameter for aggregate function (if any) More...
 
 caption
 Optional caption for this level. More...
 
 childLevels
 Children of this level. More...
 
 drillLevel
 Drill-level at which this level was defined. More...
 
 drilldownSpec
 Drilldown spec. More...
 
 enabled
 For filters, indicates if a filter is enabled. More...
 
 filterEnabled
 If true, apply the FILTER function to this level. More...
 
 filterExpression
 Filter expression for FILTER function. More...
 
 headCount
 Count argument for HEAD function. More...
 
 headEnabled
 If true, apply the HEAD function to this level. More...
 
 key
 Key value of the current dimension level. More...
 
 levelCaption
 Optional caption to apply to this element. More...
 
 levelFormat
 Optional format to apply to this element. More...
 
 levelHeaderStyle
 Optional CSS style to apply to header's for this element. More...
 
 levelStyle
 Optional CSS style to apply to this element. More...
 
 levelSummary
 Optional pivot table summary to use for this element. More...
 
 levelType
 For row/column options, indicates the type of member defined. More...
 
 orderDirection
 Direction argument for ORDER function. More...
 
 orderEnabled
 If true, apply the ORDER function to this level. More...
 
 orderExpression
 Sort expression for ORDER function. More...
 
 spec
 This specifies the dimension level displayed for this level. More...
 
 suppress8020
 If true, apply the 80/20 suppression to this level. More...
 
 text
 Optional display name for this level. More...
 
 transient
 If true, then is a filter that was passed in from a widget and should. More...
 
 value
 Name value of the current dimension level. More...
 
- Public Attributes inherited from object
 aux
 @qualifier final This is an auxiliary property that is provided More...
 
 composite
 @qualifier final For components that are created as part of a composite component, More...
 
 id
 @qualifier final This is a unique identifier that is used to distinguish this object More...
 
 index
 @qualifier final System-assigned index number used internally to identify this component. More...
 
 name
 @qualifier final Name of this object. More...
 
 onupdate
 onupdate event handler: More...
 
 parent
 @qualifier final Link to the component that contains this object More...
 
 tuple
 @qualifier final Special property indicating which tuple of a More...
 
 visible
 This property indicates whether a component is visible and thus layed out. More...
 
 window
 @qualifier final This is a client-only property that refers to the JavaScript More...
 

Additional Inherited Members

- Public Member Functions inherited from object
_.Library.Status OnNew (_.Library.RawString initvalue)
 Constructor for Zen objects. More...
 
 findElement (subid)
 Client-side utility method that finds an HTML element with a. More...
 
 fireOnUpdateEvent ()
 This is called when an object is updated from the server. More...
 
_.Library.String getProperty (property, key)
 Return the value of a named property (i.e. More...
 
 getSettings (settings)
 Client-side method that returns a list of this component's. More...
 
 getType ()
 Returns the component type of this object. More...
 
 invokeSuper (method, args)
 Invoke the superclass method method of the current. More...
 
 isOfType (type)
 Returns true if this object is of the given component type. More...
 
 makeId (subid)
 client-side utility method that constructs a component-specific id More...
 
 onCreate ()
 This client method, if present, is called when this component is. More...
 
 onDelete ()
 This client method, if present, is called when this component is. More...
 
 onSerialize ()
 This client event, if present, is fired before a component. More...
 
 onloadHandler ()
 This client event, if present, is fired when the page is loaded.
 
 onunloadHandler ()
 This client event, if present, is fired when the page is unloaded. More...
 
 onupdateHandler ()
 This client method, if present, is fired when the object is updated from the server.
 
 render ()
 This causes a component that draws its contents dynamically. More...
 
 renderContents ()
 This method, if present, is called when this component. More...
 
 renderSVG (document, parent)
 This method is only needed for SVG components. More...
 
 setProperty (property, value, value2)
 Set the value of a named property (i.e., a setting). More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from object
 DEFAULTVISIBLE = None
 Subclasses can set this to change default visibilty for a component.
 
 INCLUDEFILES = None
 CSV list of additional include files (either .js or .css) that. More...
 
 MODULE = None
 If set, this indicates that this system component should be. More...
 
 NAMESPACE = None
 This is the XML namespace used for library components.
 
 POSTCOMPILEACTIONS = None
 This is a comma-delimited list of which post-compile actions this component. More...
 
 USECOMMONDIRECTORY = None
 If true, then the include files generated for this component, are placed in the. More...
 
 XMLFORMAT = None
 If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

Defines an axis, measure, or filter level within a <class>DeepSee.Component.pivotTable</class> component.

Member Data Documentation

◆ advanced

advanced

If true, then <property>spec</property> contains an "advanced" specification.

(such as an advanced filter).  

◆ aggEnabled

aggEnabled

If true, apply the Aggregate function to this level.

 

◆ aggFunction

aggFunction

Aggregate function.

 

◆ aggFunctionParm

aggFunctionParm

Parameter for aggregate function (if any)

 

◆ caption

caption

Optional caption for this level.

This is used to hold the level caption when this level is used a filter.  

◆ childLevels

childLevels

Children of this level.

 

◆ drillLevel

drillLevel

Drill-level at which this level was defined.

 

◆ drilldownSpec

drilldownSpec

Drilldown spec.

 

◆ enabled

enabled

For filters, indicates if a filter is enabled.

 

◆ filterEnabled

filterEnabled

If true, apply the FILTER function to this level.

 

◆ filterExpression

filterExpression

Filter expression for FILTER function.

 

◆ headCount

headCount

Count argument for HEAD function.

 

◆ headEnabled

headEnabled

If true, apply the HEAD function to this level.

 

◆ key

key

Key value of the current dimension level.


This can be a comma-delimited list of keys:
"14,25"
If there are multiple keys, they may be encoded as an MDX set. "{A,B}"  

◆ levelCaption

levelCaption

Optional caption to apply to this element.

 

◆ levelFormat

levelFormat

Optional format to apply to this element.

 

◆ levelHeaderStyle

levelHeaderStyle

Optional CSS style to apply to header's for this element.

 

◆ levelStyle

levelStyle

Optional CSS style to apply to this element.

 

◆ levelSummary

levelSummary

Optional pivot table summary to use for this element.

If the pivotTable displays rowTotals or columnTotals, then this will override the summary aggregate used.
The value can be sum,min,max,count,avg,pct.  

◆ levelType

levelType

For row/column options, indicates the type of member defined.

 

◆ orderDirection

orderDirection

Direction argument for ORDER function.

 

◆ orderEnabled

orderEnabled

If true, apply the ORDER function to this level.

 

◆ orderExpression

orderExpression

Sort expression for ORDER function.

 

◆ spec

spec

This specifies the dimension level displayed for this level.

of the pivot table.
For example, "[Product]" or "[Time].[Year]"  

◆ suppress8020

suppress8020

If true, apply the 80/20 suppression to this level.

 

◆ text

text

Optional display name for this level.

This is the text displayed by the pivot table

when a level is used a filter.  

◆ transient

transient

If true, then is a filter that was passed in from a widget and should.

not be saved as part of the pivot state.  

◆ value

value

Name value of the current dimension level.


This can be a comma-delimited list of delimited values: "[2005],[2006]"