class sap.f.Illustration

Control sample: sap.f.Illustration
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/f/Illustration
Application Component: CA-UI5-CTR

A simple control which uses a Symbol ID to visualize an SVG which has already been loaded in the sap.f.IllustrationPool.

To build a Symbol ID, all of the Illustration properties must be populated with data.

This control can be a drag source.

Constructor

Constructor for a new Illustration.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.f.Illustration(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
media string

Defines which media/breakpoint should be used when building the Symbol ID.

Since: 1.88.

Visibility: public
set string

Defines which illustration set should be used when building the Symbol ID.

Since: 1.88.

Visibility: public
type string

Defines which illustration type should be used when building the Symbol ID.

Since: 1.88.

Visibility: public

Methods Overview

Method Description
sap.f.Illustration.extend

Creates a new subclass of class sap.f.Illustration 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.Control.extend.

getMedia

Gets current value of property media.

Defines which media/breakpoint should be used when building the Symbol ID.

sap.f.Illustration.getMetadata

Returns a metadata object for class sap.f.Illustration.

getSet

Gets current value of property set.

Defines which illustration set should be used when building the Symbol ID.

getType

Gets current value of property type.

Defines which illustration type should be used when building the Symbol ID.

setMedia

Sets a new value for property media.

Defines which media/breakpoint should be used when building the Symbol ID.

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

setSet

Sets a new value for property set.

Defines which illustration set should be used when building the Symbol ID.

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

setType

Sets a new value for property type.

Defines which illustration type should be used when building the Symbol ID.

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

sap.f.Illustration.extend

Creates a new subclass of class sap.f.Illustration 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.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getMedia

Gets current value of property media.

Defines which media/breakpoint should be used when building the Symbol ID.

sap.f.Illustration.getMetadata

Returns a metadata object for class sap.f.Illustration.

getSet

Gets current value of property set.

Defines which illustration set should be used when building the Symbol ID.

getType

Gets current value of property type.

Defines which illustration type should be used when building the Symbol ID.

setMedia

Sets a new value for property media.

Defines which media/breakpoint should be used when building the Symbol ID.

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

Param Type DefaultValue Description
sMedia string

New value for property media

setSet

Sets a new value for property set.

Defines which illustration set should be used when building the Symbol ID.

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

Param Type DefaultValue Description
sSet string

New value for property set

setType

Sets a new value for property type.

Defines which illustration type should be used when building the Symbol ID.

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

Param Type DefaultValue Description
sType string

New value for property type