Class sap.viz.ui5.types.Datatransform_dataSamplingModule: sap/viz/ui5/types/Datatransform_dataSampling

extends BaseStructuredType

Settings for the data sampling algorithm

Deprecated API:Since version 1.32.0. The chart controls in the sap.viz.ui5 package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.

SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.

Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.

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


Since: 1.7.2.
Constructor Summary
new sap.viz.ui5.types.Datatransform_dataSampling(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Datatransform_dataSampling

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.Datatransform_dataSampling.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Datatransform_dataSampling with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Datatransform_dataSampling.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Datatransform_dataSampling.
destroyGrid()Destroys the grid in the aggregation grid.
getEnable()Gets current value of property enable.
getGrid()Gets content of aggregation grid.
getNumberPrecondition()Gets current value of property numberPrecondition.
getSizeFactor()Gets current value of property sizeFactor.
setEnable(bEnable)Sets a new value for property enable.
setGrid(oGrid)Sets the aggregated grid.
setNumberPrecondition(iNumberPrecondition)Sets a new value for property numberPrecondition.
setSizeFactor(iSizeFactor)Sets a new value for property sizeFactor.
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.viz.ui5.types.Datatransform_dataSampling(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Datatransform_dataSampling

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.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.32.0. The chart controls in the sap.viz.ui5 package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.

SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.

Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.

Method Detail
sap.viz.ui5.types.Datatransform_dataSampling.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Datatransform_dataSampling 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.Datatransform_dataSampling.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Datatransform_dataSampling.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyGrid(): sap.viz.ui5.types.Datatransform_dataSampling
Destroys the grid in the aggregation grid.
Returns:
{sap.viz.ui5.types.Datatransform_dataSampling} Reference to this in order to allow method chaining
getEnable(): boolean
Gets current value of property enable.

Set whether data sampling is enabled.

Default value is false.

Returns:
{boolean} Value of property enable
getGrid(): sap.viz.ui5.types.Datatransform_dataSampling_grid
Gets content of aggregation grid.

add documentation for aggregation grid

Returns:
{sap.viz.ui5.types.Datatransform_dataSampling_grid}
getNumberPrecondition(): int
Gets current value of property numberPrecondition.

If the data point is larger than this value, data sampling is triggered.

Default value is 3000.

Returns:
{int} Value of property numberPrecondition
getSizeFactor(): int
Gets current value of property sizeFactor.

Set the data point percentage in the original dataset

Default value is 1.

Returns:
{int} Value of property sizeFactor
setEnable(bEnable): sap.viz.ui5.types.Datatransform_dataSampling
Sets a new value for property enable.

Set whether data sampling is enabled.

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

Default value is false.

Parameters:
{boolean}bEnable New value for property enable
Returns:
{sap.viz.ui5.types.Datatransform_dataSampling} Reference to this in order to allow method chaining
setGrid(oGrid): sap.viz.ui5.types.Datatransform_dataSampling
Sets the aggregated grid.
Parameters:
{sap.viz.ui5.types.Datatransform_dataSampling_grid}oGrid The grid to set
Returns:
{sap.viz.ui5.types.Datatransform_dataSampling} Reference to this in order to allow method chaining
setNumberPrecondition(iNumberPrecondition): sap.viz.ui5.types.Datatransform_dataSampling
Sets a new value for property numberPrecondition.

If the data point is larger than this value, data sampling is triggered.

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

Default value is 3000.

Parameters:
{int}iNumberPrecondition New value for property numberPrecondition
Returns:
{sap.viz.ui5.types.Datatransform_dataSampling} Reference to this in order to allow method chaining
setSizeFactor(iSizeFactor): sap.viz.ui5.types.Datatransform_dataSampling
Sets a new value for property sizeFactor.

Set the data point percentage in the original dataset

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

Default value is 1.

Parameters:
{int}iSizeFactor New value for property sizeFactor
Returns:
{sap.viz.ui5.types.Datatransform_dataSampling} Reference to this in order to allow method chaining