Class actuate.xtabanalyzer.Driller
Description
The Driller class enables an application to drill down or up levels on a member within a dimension.
Constructor
Syntax
actuate.xtabanalyzer.Driller( )
Creates a Driller object.
Function summary
Table 15‑5 lists actuate.xtabanalyzer.Driller functions.
Table 15‑5 actuate.xtabanalyzer.Driller functions
Function | Description |
| Adds a member to the drill condition |
| Retrieves the driller dimension |
| Retrieves the members used by the drill |
| Sets the driller dimension |
| Adds an array of members to the drill condition |
addMember
Syntax
void Driller.addMember(actuate.xtabanalyzer.MemberValue member)
Adds a dimension member to the drill condition. Functional candidates are Dimension members with levels.
Parameter
member
actuate.xtabanalyzer.MemberValue object. A member value to add.
Example
This example adds a member to a Driller object:
function drillDownDimension( ){
var driller = new actuate.xtabanalyzer.Driller( );
driller.setDimension(actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);
var memberValue = new actuate.xtabanalyzer.MemberValue("drillLevelName");
memberValue.setValue("drillLevelValue");
driller.addMember(memberValue);
crosstab.drill( driller );
crosstab.submit( );
}
getDimension
Syntax
string Driller.getDimension( )
Returns the dimension name for the drill condition.
Returns
String. A dimension name.
Example
This example retrieves the dimension of the driller:
function getDrillerAxis(driller){
if (driller){
return driller.getDimension( );
}
return null;
}
getMembers
Syntax
actuate.xtabanalyzer.MemberValue[ ] Driller.getMembers( )
returns the list of members assigned to the driller.
Returns
Array of actuate.xtabanalyzer.MemberValue. A dimension member.
Example
This example retrieves the members that a driller uses:
function getDrillerMembers(driller){
if (driller){
return driller.getMembers( );
}
return null;
}
setDimension
Syntax
void Driller.setDimension(string dimension)
Sets the dimension for the driller by name.
Parameter
dimension
String. A dimension name.
Example
This example sets the dimension name for the driller:
function setRowAxis(driller){
if (driller){
dimension.setDimension("Row");
}
}
setMembers
Syntax
void Driller.setMembers(actuate.xtabanalyzer.MemberValue[ ] member)
Sets an array of members to the drill condition.
Parameter
member
Array of actuate.xtabanalyzer.MemberValue objects. An array of members.
Example
This example sets the axis type for the driller:
function setDrillerMembers(driller,members){
if (driller && members){
driller.setMembers(members);
}
}