Class sap.ui.vk.LegendItemModule: sap/ui/vk/LegendItem

extends StandardListItem

Legend item control

Experimental API:Since 1.38.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary
new sap.ui.vk.LegendItem(sId?, mSettings?)Constructor for a new LegendItem.
Fields borrowed from class sap.m.ListItemBase
isSelected
Events borrowed from class sap.m.ListItemBase
detailPress, detailTap, press, tap
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.ui.vk.LegendItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.LegendItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.LegendItem.getMetadata()Returns a metadata object for class sap.ui.vk.LegendItem.
getColor()Gets current value of property color.
getSemanticSpotType()Gets current value of property semanticSpotType.
setColor(sColor)Sets a new value for property color.
setSemanticSpotType(sSemanticSpotType)Sets a new value for property semanticSpotType.
Methods borrowed from class sap.m.StandardListItem
getActiveIcon, getAdaptTitleSize, getDescription, getIcon, getIconDensityAware, getIconInset, getInfo, getInfoState, getInfoTextDirection, getTitle, getTitleTextDirection, setActiveIcon, setAdaptTitleSize, setDescription, setIcon, setIconDensityAware, setIconInset, setInfo, setInfoState, setInfoTextDirection, setTitle, setTitleTextDirection
Methods borrowed from class sap.m.ListItemBase
addAriaLabelledBy, attachDetailPress, attachDetailTap, attachPress, attachTap, detachDetailPress, detachDetailTap, detachPress, detachTap, fireDetailPress, fireDetailTap, firePress, fireTap, getAriaLabelledBy, getCounter, getSelected, getTabbables, getType, getUnread, getVisible, removeAllAriaLabelledBy, removeAriaLabelledBy, setCounter, setSelected, setType, setUnread, setVisible
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, 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.ui.vk.LegendItem(sId?, mSettings?)
Constructor for a new LegendItem.

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.m.StandardListItem 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.ui.vk.LegendItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.LegendItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.StandardListItem.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.vk.LegendItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.LegendItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getColor(): sap.ui.core.CSSColor
Gets current value of property color.

show color square

Returns:
{sap.ui.core.CSSColor} Value of property color
getSemanticSpotType(): sap.ui.vbm.SemanticType
Gets current value of property semanticSpotType.

The semantic spot type for the legend marker.

Returns:
{sap.ui.vbm.SemanticType} Value of property semanticSpotType
setColor(sColor): sap.ui.vk.LegendItem
Sets a new value for property color.

show color square

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

Parameters:
{sap.ui.core.CSSColor}sColor New value for property color
Returns:
{sap.ui.vk.LegendItem} Reference to this in order to allow method chaining
setSemanticSpotType(sSemanticSpotType): sap.ui.vk.LegendItem
Sets a new value for property semanticSpotType.

The semantic spot type for the legend marker.

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

Parameters:
{sap.ui.vbm.SemanticType}sSemanticSpotType New value for property semanticSpotType
Returns:
{sap.ui.vk.LegendItem} Reference to this in order to allow method chaining