Namespace: component

bcdui. component

Namespaces

chart
cube
docUpload
exports
far
grid
scorecard
scorecardConfigurator
textnavigation
tree
treeView
userCalcEditor

Methods

staticbcdui.component.createCubeConfigurator(args)

component/cube/cubeCreate.js, line 394
Creates a cube configurator, providing the cube:Layout section of the cube configuration, able of 1) Showing the drag and drop area for the dimensions and measures 2) Providing templates to the user 3) Allowing the user to save templates for him/herself 4) Allowing the user to create new measures with the formula editor
Name Type Description
args Object The parameter map contains the following properties:
Name Type Default Description
id string Id of the created object
targetHtml targetHtmlRef The target HTML element for the drag-and-drop matrix.
targetModelXPath writableModelXPath $guiStatus/guiStatus:Status/cube:Layout optional Where to write the result
config string | bcdui.core.DataProvider ./dimensionsAndMeasures.xml optional DataProvider containing the configuration for the cube configurator, per defaulz ./dimensionsAndMeasures.xml is loaded
cubeRenderer string | bcdui.component.cube.Cube Cube we belong to
isRanking boolean false optional Show ranking editor. This is an Enterprise Edition only feature.
isTemplate boolean false optional Show template Editor true/false. This is an Enterprise Edition only feature.
showSummary boolean false optional Show summary of cube settings
rankingTargetHtmlElementId string optional Custom location for ranking editor
templateTargetHtmlElementId string optional Custom location for template editor
summaryTargetHtmlElementId string optional Custom location for summary display
contextMenu boolean | string false optional If true, cube's default context menu is used, otherwise provide the url to your context menu xslt here.
isDefaultHtmlLayout boolean false optional If true, a standard layout for dnd area, ranking, templates and summary is created. Separate targetHtmlElements will be obsolete then. If false, you need to provide containers with classes: bcdCurrentRowDimensionList, bcdCurrentColMeasureList, bcdCurrentColDimensionList, bcdCurrentMeasureList, bcdDimensionList, bcdMeasureList within an outer bcdCubeDndMatrix container. if your targetHtml got classes bcdDndBlindOpen or bcdDndBlindClosed, the actual dnd area is also put in collapsable boxes (either open or closed by default).
hasUserEditRole boolean optional Template Editor also has edit capability. If not given, bcdui.config.clientRights.bcdCubeTemplateEdit is used to determine state (either *(any) or cubeId to enable).
applyFunction string bcdui.core.lifecycle.applyAction optional Function name which is used for the apply button in isDefaultHtmlLayout=true mode.
url string WrsServlet optional The URL the model for the grouping editor is loaded from. If omitted the WrsServlet is taken as default.
expandCollapseCells string optional When specified (with 'expand' or 'collapse' or 'collapse2nd'), cube turns on the expand/collapse mode. collapse2nd initially keeps level one open.
doSortOptions boolean false optional When setting this to true, dimensions and measures lists are sorted by caption.
Returns:
null.
Examples
new bcdui.core.SimpleModel({
   id:  "myDndOptions", // define ID explicitely
   url: "dndOptionsModel.xml"
  );
  bcdui.component.createCubeConfigurator({
      id:                  "cubeConfigurator",
    , config:              "myDndOptions"
    , targetHtml:          "cubeConfiguratorDiv"
    , targetModelId        "guiStatus"
    , isRanking            true
    , cubeRenderer:        "cube"
    , rankingTargetHtmlElementId: "rankingDiv"
  });
Dimensions
Measures