Class sap.ui.vbm.LegendModule: sap/ui/vbm/Legend

extends Element

The Legend is a window in the GeoMap or AnalyticMap control wich can be used to display color/icon-text pairs on a map.

Constructor Summary
new sap.ui.vbm.Legend(sId?, mSettings?)Constructor for a new Legend.
Event Summary
click(oControlEvent)The event is raised when there is a click action on a legend.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Legend.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Legend with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Legend.getMetadata()Returns a metadata object for class sap.ui.vbm.Legend.
addItem(oItem)Adds some item to the aggregation items.
attachClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the click event of this sap.ui.vbm.Legend.
destroyItems()Destroys all the items in the aggregation items.
detachClick(fnFunction, oListener)Detaches event handler fnFunction from the click event of this sap.ui.vbm.Legend.
fireClick(mArguments?)Fires event click to attached listeners.
getCaption()Gets current value of property caption.
getItems()Gets content of aggregation items.
indexOfItem(oItem)Checks for the provided sap.ui.vbm.LegendItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setCaption(sCaption)Sets a new value for property caption.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.ui.vbm.Legend(sId?, mSettings?)
Constructor for a new Legend.

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:

  • Properties
  • Aggregations
    • items : sap.ui.vbm.LegendItem[] (default)
  • Events
    • click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element 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
Event Detail
click(oControlEvent)
The event is raised when there is a click action on a legend.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.data Event data object
{int}oControlEvent.getParameters.row The row number where the click occurred
{boolean}oControlEvent.getParameters.ctrlKey key modifier Ctrl pressed
{boolean}oControlEvent.getParameters.shiftKey key modifier Shift pressed
{boolean}oControlEvent.getParameters.metaKey key modifier Meta pressed
{boolean}oControlEvent.getParameters.altKey key modifier Alt pressed
Method Detail
sap.ui.vbm.Legend.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Legend with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.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.ui.vbm.Legend.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Legend.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.vbm.Legend
Adds some item to the aggregation items.
Parameters:
{sap.ui.vbm.LegendItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining
attachClick(oData?, fnFunction, oListener?): sap.ui.vbm.Legend
Attaches event handler fnFunction to the click event of this sap.ui.vbm.Legend.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.Legend itself.

The event is raised when there is a click action on a legend.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.Legend itself
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining
destroyItems(): sap.ui.vbm.Legend
Destroys all the items in the aggregation items.
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining
detachClick(fnFunction, oListener): sap.ui.vbm.Legend
Detaches event handler fnFunction from the click event of this sap.ui.vbm.Legend.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining
fireClick(mArguments?): sap.ui.vbm.Legend
Fires event click to attached listeners.

Expects the following event parameters:

  • data of type objectEvent data object
  • row of type intThe row number where the click occurred
  • ctrlKey of type booleankey modifier Ctrl pressed
  • shiftKey of type booleankey modifier Shift pressed
  • metaKey of type booleankey modifier Meta pressed
  • altKey of type booleankey modifier Alt pressed
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining
getCaption(): string
Gets current value of property caption.

The caption of the legend.

Default value is ???.

Returns:
{string} Value of property caption
getItems(): sap.ui.vbm.LegendItem[]
Gets content of aggregation items.

LegendItem object aggregation

Returns:
{sap.ui.vbm.LegendItem[]}
indexOfItem(oItem): int
Checks for the provided sap.ui.vbm.LegendItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.LegendItem}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.vbm.Legend
Inserts a item into the aggregation items.
Parameters:
{sap.ui.vbm.LegendItem}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.vbm.LegendItem[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.LegendItem[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.vbm.LegendItem
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.vbm.LegendItem}vItem The itemto remove or its index or id
Returns:
{sap.ui.vbm.LegendItem} The removed item or null
setCaption(sCaption): sap.ui.vbm.Legend
Sets a new value for property caption.

The caption of the legend.

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

Default value is ???.

Parameters:
{string}sCaption New value for property caption
Returns:
{sap.ui.vbm.Legend} Reference to this in order to allow method chaining