Class CardHeader

CardHeader

The header of a Card.

var cardHeader = CardService.newCardHeader()
    .setTitle("Card header title")
    .setSubtitle("Card header subtitle")
    .setImageStyle(CardService.ImageStyle.CIRCLE)
    .setImageUrl("https://image.png");

Methods

MethodReturn typeBrief description
setImageAltText(imageAltText)CardHeaderSets the alternative text for the header image.
setImageStyle(imageStyle)CardHeaderSets the cropping of the icon in then card header.
setImageUrl(imageUrl)CardHeaderSets the image to use in the header by providing its URL or data string.
setSubtitle(subtitle)CardHeaderSets the subtitle of the card header.
setTitle(title)CardHeaderSets the title of the card header.

Detailed documentation

setImageAltText(imageAltText)

Sets the alternative text for the header image.

Parameters

NameTypeDescription
imageAltTextStringThe alternative text for the header image.

Return

CardHeader — This object, for chaining.


setImageStyle(imageStyle)

Sets the cropping of the icon in then card header. Defaults to no crop. Optional.

Parameters

NameTypeDescription
imageStyleImageStyleThe style setting.

Return

CardHeader — This object, for chaining.


setImageUrl(imageUrl)

Sets the image to use in the header by providing its URL or data string.

The provided URL can either be a publicly accessible URL or a base64 encoded image string. To obtain the latter, you can use the following code to create an encoded image string from an image in your Google Drive, then store that string for later use with setImageUrl(imageUrl). This method prevents the need for your add-on to access a publicly available image URL:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

// You can store encodeImageURL and use it as a parameter to CardHeader.setImageUrl(imageUrl).

Parameters

NameTypeDescription
imageUrlStringThe URL address of a hosted image to use, or an encoded image string.

Return

CardHeader — This object, for chaining.


setSubtitle(subtitle)

Sets the subtitle of the card header. Optional.

Parameters

NameTypeDescription
subtitleStringThe header subtitle text.

Return

CardHeader — This object, for chaining.


setTitle(title)

Sets the title of the card header. Required.

Parameters

NameTypeDescription
titleStringThe header text.

Return

CardHeader — This object, for chaining.

Send feedback about...

Apps Script
Apps Script
Need help? Visit our support page.