namespace sap.f.IllustrationPool

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

IllustrationPool loads the illustration assets (SVGs) via XMLHttpRequest requests.

The successfully loaded data is kept in the DOM (div with ID sap-illustration-pool) in the sap-ui-static DOM element.

To load a given asset, register its illustration set through the registerIllustrationSet API of IllustrationPool. The exception being the sapIllus, which is the default illustration set that is registered by default.

The default behavior of IllustrationPool is to load/require an asset only when it's needed by using the sap.f.IllustrationPool.loadAsset API. When registering the new illustration set, you are given the option to load all of its assets.

If some of the assets are not loaded initially, you can load the rest of them on a later state with the sap.f.IllustrationPool.loadRestOfTheAssets API.


Nodes Overview

Node Description

Methods Overview

Method Description
sap.f.IllustrationPool.loadAsset

Loads an SVG asset depending on the input asset ID.

sap.f.IllustrationPool.loadRestOfTheAssets

Loads the rest of the SVG assets for a given illustration set.

sap.f.IllustrationPool.registerIllustrationSet

Registers an illustration set, which is needed before loading any of its assets.

sap.f.IllustrationPool.loadAsset

Loads an SVG asset depending on the input asset ID.

Param Type DefaultValue Description
sAssetId string

The string ID of the asset being loaded

sInstanceId string

the ID of the Illustration instance which is requiring the asset

sap.f.IllustrationPool.loadRestOfTheAssets

Loads the rest of the SVG assets for a given illustration set.

Param Type DefaultValue Description
sIllustrationSet string

The illustration set, the rest of the assets should be loaded for

sap.f.IllustrationPool.registerIllustrationSet

Registers an illustration set, which is needed before loading any of its assets.

Param Type DefaultValue Description
oConfig object

object containing the name and the path of the Illustration Set

setFamily string

Name of the Illustration Set

setURI string

URL Path of the Illustration Set

bLoadAllResources boolean

whether or not all of the assets for the Illustration Set should be loaded once the metadata is loaded