Class sap.gantt.def.filter.MorphologyFilterModule: sap/gantt/def/filter/MorphologyFilter

extends DefBase

This filter is a combination of several filters. The main one is morphology.

The purpose of this filter is to generate a white outline of a target shape when the target is overlapping with other shapes. In general this filter is recommended to be used only on 'text' and 'image' whose outline is very hard to determine. For regular SVG tags like 'rect', 'circle' etc, use the 'stroke' attribute instead if possible. This is because filters in general have worse performance.
See Filter Effects in SVG 1.1 specification for detail.
Tags used in this filter are:

Effect of this filter is:
Can you see me?How about now?

Constructor Summary
new sap.gantt.def.filter.MorphologyFilter(sId?, mSettings?)Creates and initializes a morphology filter defined for later reuse.
Method Summary
sap.gantt.def.filter.MorphologyFilter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.def.filter.MorphologyFilter with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.def.filter.MorphologyFilter.getMetadata()Returns a metadata object for class sap.gantt.def.filter.MorphologyFilter.
getColorMatrix()Gets current value of property colorMatrix.
getOperator()Gets current value of property operator.
getRadius()Gets current value of property radius.
setColorMatrix(sColorMatrix)Sets a new value for property colorMatrix.
setOperator(sOperator)Sets a new value for property operator.
setRadius(sRadius)Sets a new value for property radius.
Constructor Detail
new sap.gantt.def.filter.MorphologyFilter(sId?, mSettings?)
Creates and initializes a morphology filter defined for later reuse.

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
    • operator : string (default: sap.gantt.def.filter.MorphologyOperator.Dilate)
    • radius : string (default: 2,1)
    • colorMatrix : string (default: sap.gantt.def.filter.ColorMatrixValue.AllToWhite)

In addition, all settings applicable to the base type sap.gantt.def.DefBase can be used as well.

Parameters:
{string}sId? ID of the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Method Detail
sap.gantt.def.filter.MorphologyFilter.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.def.filter.MorphologyFilter with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.gantt.def.DefBase.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.gantt.def.filter.MorphologyFilter.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.def.filter.MorphologyFilter.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getColorMatrix(): string
Gets current value of property colorMatrix.

Attribute of SVG tag 'feColorMatrix'. See 'value' attribute for detail. Predefined values are in sap.gantt.def.filter.ColorMatrixValue. Advanced users can provide a customized matrix in string.

Default value is sap.gantt.def.filter.ColorMatrixValue.AllToWhite.

Returns:
{string} Value of property colorMatrix
getOperator(): string
Gets current value of property operator.

Atrribute of SVG tag 'feMorphology'. See 'operator' attribute for detail. Possible values are in sap.gantt.def.filter.MorphologyOperator.

Default value is sap.gantt.def.filter.MorphologyOperator.Dilate.

Returns:
{string} Value of property operator
getRadius(): string
Gets current value of property radius.

Attribute of SVG tag 'feMorphology'. See 'radius' attribute for detail.

Default value is 2,1.

Returns:
{string} Value of property radius
setColorMatrix(sColorMatrix): sap.gantt.def.filter.MorphologyFilter
Sets a new value for property colorMatrix.

Attribute of SVG tag 'feColorMatrix'. See 'value' attribute for detail. Predefined values are in sap.gantt.def.filter.ColorMatrixValue. Advanced users can provide a customized matrix in string.

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

Default value is sap.gantt.def.filter.ColorMatrixValue.AllToWhite.

Parameters:
{string}sColorMatrix New value for property colorMatrix
Returns:
{sap.gantt.def.filter.MorphologyFilter} Reference to this in order to allow method chaining
setOperator(sOperator): sap.gantt.def.filter.MorphologyFilter
Sets a new value for property operator.

Atrribute of SVG tag 'feMorphology'. See 'operator' attribute for detail. Possible values are in sap.gantt.def.filter.MorphologyOperator.

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

Default value is sap.gantt.def.filter.MorphologyOperator.Dilate.

Parameters:
{string}sOperator New value for property operator
Returns:
{sap.gantt.def.filter.MorphologyFilter} Reference to this in order to allow method chaining
Sets a new value for property radius.

Attribute of SVG tag 'feMorphology'. See 'radius' attribute for detail.

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

Default value is 2,1.

Parameters:
{string}sRadius New value for property radius
Returns:
{sap.gantt.def.filter.MorphologyFilter} Reference to this in order to allow method chaining