BCD-UI

Namespace: scorecard

bcdui.component. scorecard

The implementation of the Scorecard class.

Classes

Scorecard
ScorecardModel

Methods

staticbcdui.component.scorecard.createScorecardConfigurator(args)

widgetNg/widgetPackage.js, line 442
Creates a scorecard configurator, providing the scc:Layout section of the scorecard configuration, able of showing the drag and drop area for the dimensions and kpis and aspects.
Name Type Description
args Object The parameter map contains the following properties.
Name Type Default Description
applyFunction string optional Function name which is used for the apply button in isDefaultHtmlLayout=true mode. Default is bcdui.core.lifecycle.applyAction.
autofocus boolean optional requests the widget to set the focus once it is rendered or enabled for the first time. Only one widget can have a focus, so in case the focus is requested by many widgets it is undefined which one will win.
config dataProvider optional Model containing the configuration for the scorecard configurator. By default this is taken from dimensionsAndKpis.xml.
disabled boolean false optional All input widgets can be set to be disabled. If disabled, a widget cannot receive a focus, also a style cannot be changed in many browsers. There is no read-only. Also consult read-only vs disabled: http://www.w3.org/TR/html4/interact/forms.html#h-17.12
displayBalloon boolean false optional hints and validation messages are displayed in a fly-over if user moves the mouse over the widget. Additionally, they are also displayed in a balloon in bottom-left corner of a browser window in a balloon, which is static and appears as long as the widget has focus.
enableNavPath boolean false optional Set to true if widget should be added to navpath handling.
hasUserEditRole boolean false optional Template Editor also has edit capability. If not given, bcdui.config.clientRights.bcdScorecardTemplateEdit is used to determine state (either *(any) or scorecardId to enable).
hint i18nToken optional A general feature is the hint indicator on the widget so user can hover it with a mouse to reveal information about it. image aus theme intern handled by tooltip.
id string optional Id of the widget, if not provided this id will be auto-generated. Must be unique. The id must not be used from jQuery UI API, the id should be used within declarative scope only, i.e. X-API / JSP. If provided, this id will overwrite targetHtml element's id.
isDefaultHtmlLayout boolean false optional If true, a standard layout for dnd area is created. If false, you need to provide containers with classes: bcdCurrentKpiList, bcdCurrentScRowDimensionList, bcdCurrentAspectList, bcdKpiList, bcdScDimensionList, bcdAspectList within an outer bcdScorecardDndMatrix 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).
isRanking boolean false optional Enable the ranking feature. This is an Enterprise Edition only feature.
isTemplate boolean false optional Enable the template feature. This is an Enterprise Edition only feature.
rankingTargetHtmlElementId string optional If isRanking is true then this attribute can be used to control the div where the ranking editor is placed.
reportName string optional Name of the report is used to access the persistent layouts.
rowAspect boolean false optional Enables another drag'n drop box for aspects (marked with rowAspect='true') which are put in front of all aspects. KPI dimensions needs to be a row dimension in this case.
scorecard dataProvider optional Id of the scorecardRenderer the configurator belongs to. If not given, the surrounding renderer is assumed to be a cmp:scorecard.
showSummary boolean false optional Enable the summary feature.
summaryTargetHtmlElementId string optional If showSummary is true then this attribute can be used to control the div where the summary is placed.
tabindex integer optional the HTML compliant tabIndex
targetHtml targetHtmlRef optional An existing HTML element this widget should be attached to, provide a dom element, a jQuery element or selector, or an element id.
targetModel dataProvider optional The configuration is written to $guiStatus/guiStatus:Status/scc:Layout[scorecardId='scorecardId'] by default. While the xpath /RootNode/scc:Layout[scorecardId='scorecardId'] is fixed, you can specify an own targetModel if needed.
templateTargetHtmlElementId string optional If isTemplate is true then this attribute can be used to control the div where the template editor is placed.
widgetCaption string optional A caption which is used as prefix for navPath generation for this widget.