Excel.LocalImage class

包:

excel

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

提供有关本地映像的信息。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApi BETA (仅预览版)

使用方

• Excel.Workbook： localImage

属性

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

方法

getBase64EncodedImageData(cacheUid)	获取存储在共享图像缓存中的 Base64 编码图像数据，其中包含缓存唯一标识符 (UID) 。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.LocalImage 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.LocalImageData) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

context

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

方法详细信息

getBase64EncodedImageData(cacheUid)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取存储在共享图像缓存中的 Base64 编码图像数据，其中包含缓存唯一标识符 (UID) 。

getBase64EncodedImageData(cacheUid: string): OfficeExtension.ClientResult<string>;

参数

cacheUid

string

表示图像在缓存中显示 (唯一标识符 UID) 。 可以从单元格中值的 JSON 表示形式获取缓存 UID。

返回

OfficeExtension.ClientResult<string>

Base64 编码的图像数据。

注解

API 集：ExcelApi BETA (仅预览版)

toJSON()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.LocalImage 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.LocalImageData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): {
            [key: string]: string;
        };

返回

{ [key: string]: string; }