IThemeAsset
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Externally hosted image the theme offers to documents.
export interface IThemeAsset
Remarks
The id is also the document variable the asset resolves: document content references it as {id}. It must match ^[a-zA-Z][a-zA-Z0-9_]*$.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Accessible name of the image; also shown when the image cannot be loaded. | ||
string | (ALPHA) | ||
string | (ALPHA) (Optional) Label the asset is offered under in the editor. | ||
string | (ALPHA) Absolute http(s) URL. The organization CSP must allow the host; for exports the host must also serve CORS headers. |
Property details
IThemeAsset.altTextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Accessible name of the image; also shown when the image cannot be loaded.
altText?: string;
IThemeAsset.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
id: string;
IThemeAsset.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Label the asset is offered under in the editor.
title?: string;
IThemeAsset.urlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Absolute http(s) URL. The organization CSP must allow the host; for exports the host must also serve CORS headers.
url: string;