Class sap.viz.ui5.controls.PopoverModule: sap/viz/ui5/controls/Popover

extends BaseControl

Viz Chart Popover

Experimental API:Since version 1.22.0. API is not finished yet and might change completely


Since: 1.22.0.
Constructor Summary
new sap.viz.ui5.controls.Popover(sId?, mSettings?)Constructor for a new ui5/controls/Popover.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.viz.ui5.controls.Popover.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.controls.Popover with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.controls.Popover.getMetadata()Returns a metadata object for class sap.viz.ui5.controls.Popover.
close()Close Chart's Popover.
connect(uid)Connect chart Popover with VizFrame.
getActionItems()Gets current value of property actionItems.
getCustomDataControl()Gets current value of property customDataControl.
getFormatString()Gets current value of property formatString.
getShowLine()Gets current value of property showLine.
setActionItems(sActionItems)Sets a new value for property actionItems.
setCustomDataControl(oCustomDataControl)Sets a new value for property customDataControl.
setFormatString(oFormatString)Sets a new value for property formatString.
setShowLine(bShowLine)Sets a new value for property showLine.
Methods borrowed from class sap.viz.ui5.controls.common.BaseControl
getHeight, getUiConfig, getWidth, setHeight, setUiConfig, setWidth
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.viz.ui5.controls.Popover(sId?, mSettings?)
Constructor for a new ui5/controls/Popover.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.viz.ui5.controls.common.BaseControl can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.viz.ui5.controls.Popover.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.controls.Popover with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.viz.ui5.controls.common.BaseControl.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.viz.ui5.controls.Popover.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.controls.Popover.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
close(): void
Close Chart's Popover.
connect(uid)
Connect chart Popover with VizFrame. Chart Popover is only supported for VizFrame with 'fiori' type. It must be called by application.

Example: 

var vizFrame = new sap.viz.ui5.controls.VizFrame({
	'vizType' : 'bar',
 'uiConfig' : {
    'applicationSet': 'fiori'
  }
});
var vizPopover = new sap.viz.ui5.controls.Popover({});
vizPopover.connect(vizFrame.getVizUid());
Parameters:
{string}uid
getActionItems(): object[]
Gets current value of property actionItems.

The items of this list or rows of Action List in Home Page inside the Popover.

Returns:
{object[]} Value of property actionItems
getCustomDataControl(): any
Gets current value of property customDataControl.

A callback function let user customize Popover's content panel.

Returns:
{any} Value of property customDataControl
getFormatString(): any
Gets current value of property formatString.

The pattern is used to format the measures displayed in Popover. If value type of format string is String, the format string will be used to format all measures. If value type is Object, each format string in the Object will be used to format the specified measure or time dimension.

Returns:
{any} Value of property formatString
getShowLine(): boolean
Gets current value of property showLine.

Show line with popover marker in line/combination charts.

Default value is true.

Returns:
{boolean} Value of property showLine
setActionItems(sActionItems): sap.viz.ui5.controls.Popover
Sets a new value for property actionItems.

The items of this list or rows of Action List in Home Page inside the Popover.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{object[]}sActionItems New value for property actionItems
Returns:
{sap.viz.ui5.controls.Popover} Reference to this in order to allow method chaining
setCustomDataControl(oCustomDataControl): sap.viz.ui5.controls.Popover
Sets a new value for property customDataControl.

A callback function let user customize Popover's content panel.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{any}oCustomDataControl New value for property customDataControl
Returns:
{sap.viz.ui5.controls.Popover} Reference to this in order to allow method chaining
setFormatString(oFormatString): sap.viz.ui5.controls.Popover
Sets a new value for property formatString.

The pattern is used to format the measures displayed in Popover. If value type of format string is String, the format string will be used to format all measures. If value type is Object, each format string in the Object will be used to format the specified measure or time dimension.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{any}oFormatString New value for property formatString
Returns:
{sap.viz.ui5.controls.Popover} Reference to this in order to allow method chaining
setShowLine(bShowLine): sap.viz.ui5.controls.Popover
Sets a new value for property showLine.

Show line with popover marker in line/combination charts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowLine New value for property showLine
Returns:
{sap.viz.ui5.controls.Popover} Reference to this in order to allow method chaining