Class IconImage

IconImage

Une icône prédéfinie, une icône Material Design ou une icône à partir d'une URL avec un style de recadrage personnalisable.

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)IconImageDéfinit le texte alternatif de l'URL utilisé pour l'accessibilité.
setIcon(icon)IconImageDéfinit l'icône prédéfinie si l'URL n'est pas définie.
setIconUrl(url)IconImageDéfinit l'URL de l'icône si elle n'est pas définie.
setImageCropType(imageCropType)IconImageDéfinit le style de recadrage de l'image.
setMaterialIcon(icon)IconImageDéfinit l'icône Material Design.

Documentation détaillée

setAltText(altText)

Définit le texte alternatif de l'URL, qui est utilisé pour l'accessibilité.

Paramètres

NomTypeDescription
altTextStringTexte alternatif.

Renvois

IconImage : cet objet, pour le chaînage.


setIcon(icon)

Définit l'icône prédéfinie si l'URL n'est pas définie. La valeur par défaut est "AUCUN".

Paramètres

NomTypeDescription
iconIconUne des valeurs Icon prédéfinies.

Renvois

IconImage : objet utilisé pour le chaînage.


setIconUrl(url)

Définit l'URL de l'icône si elle n'est pas définie.

Paramètres

NomTypeDescription
urlStringURL d'une image hébergée à utiliser comme icône.

Renvois

IconImage : objet utilisé pour le chaînage.


setImageCropType(imageCropType)

Définit le style de recadrage de l'image. Les types de recadrage que vous pouvez utiliser pour les icônes sont SQUARE et CIRCLE. La valeur par défaut est SQUARE.

Paramètres

NomTypeDescription
imageCropTypeImageCropTypeOption ImageCropType à appliquer.

Renvois

IconImage : cet objet, pour le chaînage.


setMaterialIcon(icon)

Définit l'icône Material Design.

const iconImage = CardService.newIconImage().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Paramètres

NomTypeDescription
iconMaterialIconIcône Material.

Renvois

IconImage : cet objet, pour le chaînage.