XLCubed is now FluenceXL. The new wiki can be found here: https://help.fluencexl.com/

Difference between revisions of "XL3SetProperty"

(Grid)
(Grid)
Line 42: Line 42:
  
 
==Grid==
 
==Grid==
 +
 +
===Grid Display===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 71: Line 73:
 
| Sets the selection type of the members, e.g. children, parent, descendants etc.
 
| Sets the selection type of the members, e.g. children, parent, descendants etc.
 
| See the [[#Member Selection Type|Member Selection Type]] section for more details.
 
| See the [[#Member Selection Type|Member Selection Type]] section for more details.
 +
|}
 +
 +
 +
===Grid Permissions===
 +
 +
{| class="wikitable"
 +
! Property
 +
! Description
 +
! Value
 +
|-
 +
| "ColumnMembers"
 +
| Allow picking members on column hierarchies.
 +
| TRUE or FALSE
 +
|-
 +
| "ColumnNavigation"
 +
| Allow drilling, keeponly etc column hierarchies.
 +
| TRUE or FALSE
 +
|-
 +
| "RowMembers"
 +
| Allow picking members on row hierarchies.
 +
| TRUE or FALSE
 +
|-
 +
| "RowNavigation"
 +
| Allow drilling, keeponly etc row hierarchies.
 +
| TRUE or FALSE
 
|}
 
|}
  

Revision as of 10:43, 24 March 2011

This function updates XLCubed objects in the workbook such as grids, slicers and small multiples.

You can use this to update some setting from the properties screen or move hierarchies.

Syntax

XL3SetProperty( ObjectType, ObjectName, Property, Arg1, [Arg2],…, [Arg27] )

Parameters

Parameter Description
ObjectType Object Type to update. Valid values are "Workbook", "Grid", "Slicer" and "SmallMultiple".
ObjectName Name of the object to update. You can not update an object unless you have given it a name in its properties screen.
Property Name of the property to update. Valid names depend on the object type. Details for each are below.
Arg1, [Arg2],…, [Arg27] Value or values to set the property to. Valid values depend on the object type. Details for each are below.

Workbook

For workbook level properties the object name refers to the area of the product being updated.

Object Name Property Description Value
"Writeback" "SpreadMethod" Sets the formula spread method. Valid values are "USE_EQUAL_ALLOCATION", "USE_EQUAL_INCREMENT", "USE_WEIGHTED_ALLOCATION", "USE_WEIGHTED_INCREMENT"

Grid

Grid Display

Property Description Value
"RemoveEmptyColumns" Sets the columns to hide or show members with no data. TRUE or FALSE
"RemoveEmptyRows" Sets the rows to hide or show members with no data. TRUE or FALSE
"HierarchiesOnColumns" Sets hierarchies on columns. Will move hierarchies as required. Hierarchy name or names.
"HierarchiesOnRows" Sets hierarchies on rows. Works as HierarchiesOnColumns. Hierarchy name or names.
"MergeRepeatingCells" Merge cells containing the same member in cross-joins. TRUE or FALSE
"MemberSelectionType" Sets the selection type of the members, e.g. children, parent, descendants etc. See the Member Selection Type section for more details.


Grid Permissions

Property Description Value
"ColumnMembers" Allow picking members on column hierarchies. TRUE or FALSE
"ColumnNavigation" Allow drilling, keeponly etc column hierarchies. TRUE or FALSE
"RowMembers" Allow picking members on row hierarchies. TRUE or FALSE
"RowNavigation" Allow drilling, keeponly etc row hierarchies. TRUE or FALSE

Member Selection Type

something here

See Also