Excel.LocalImage class

注意

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

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

扩展

注解

[ API 集:ExcelApi BETA (仅预览版) ]

属性

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;

属性值

方法详细信息

getBase64EncodedImageData(cacheUid)

注意

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

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

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

参数

cacheUid

string

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

返回

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; }