Area_marker

Settings for marker and data point graphics

Deprecated API:Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Since: 1.7.2.

Constructor Summary

new sap.viz.ui5.types.Area_marker(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Area_marker

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.viz.ui5.types.Area_marker.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Area_marker with name sClassName and enriches it with the information contained in oClassInfo.

sap.viz.ui5.types.Area_marker.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Area_marker.

getShape()Gets current value of property shape.

getSize()Gets current value of property size.

setShape(sShape)Sets a new value for property shape.

setSize(iSize)Sets a new value for property size.

getNumber()Gets current value of property number.

getVisible()Gets current value of property visible.

setNumber(iNumber)Sets a new value for property number.

setVisible(bVisible)Sets a new value for property visible.

Methods borrowed from class sap.ui.core.Element

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.viz.ui5.types.Area_marker(sId?, mSettings?)

Constructor for a new sap.viz.ui5.types.Area_marker

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
- visible : boolean (default: true)
- shape : sap.viz.ui5.types.Area_marker_shape (default: circle)
- size : int (default: 8)
- number : int

In addition, all settings applicable to the base type sap.viz.ui5.core.BaseStructuredType 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

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Method Detail

sap.viz.ui5.types.Area_marker.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.viz.ui5.types.Area_marker 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.core.BaseStructuredType.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.types.Area_marker.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.viz.ui5.types.Area_marker.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getShape(): sap.viz.ui5.types.Area_marker_shape

Gets current value of property shape.

Set the shape of the markers

Default value is circle.

Returns:

{sap.viz.ui5.types.Area_marker_shape} Value of property shape

getSize(): int

Gets current value of property size.

Set the marker size for data points, ranging from '4' and '32'. If you enter a value outside that range, the marker size defaults to '4'.

Default value is 8.

Returns:

{int} Value of property size

setShape(sShape): sap.viz.ui5.types.Area_marker

Sets a new value for property shape.

Set the shape of the markers

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

Default value is circle.

Parameters:

{sap.viz.ui5.types.Area_marker_shape} sShape New value for property shape

Returns:

{sap.viz.ui5.types.Area_marker} Reference to this in order to allow method chaining

setSize(iSize): sap.viz.ui5.types.Area_marker

Sets a new value for property size.

Set the marker size for data points, ranging from '4' and '32'. If you enter a value outside that range, the marker size defaults to '4'.

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

Default value is 8.

Parameters:

{int} iSize New value for property size

Returns:

{sap.viz.ui5.types.Area_marker} Reference to this in order to allow method chaining

getNumber(): int

Gets current value of property number.

Set the number to enable events for markers when they are invisible. If the total amount of markers is bigger than this value, markers will remain hidden when selected or hovered over. The default value is Number.POSITIVE_INFINITY, which is the largest possible value.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{int} Value of property number

getVisible(): boolean

Gets current value of property visible.

Set the visibility of the markers

Default value is true.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{boolean} Value of property visible

setNumber(iNumber): sap.viz.ui5.types.Area_marker

Sets a new value for property number.

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

Parameters:

{int} iNumber New value for property number

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.Area_marker} Reference to this in order to allow method chaining

setVisible(bVisible): sap.viz.ui5.types.Area_marker

Sets a new value for property visible.

Set the visibility of the markers

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

Default value is true.

Parameters:

{boolean} bVisible New value for property visible

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.Area_marker} Reference to this in order to allow method chaining