C

Media

Show Usages

A container class that stores all media objects and provides factory methods for them.

Inheritance Hierarchy

Members

Show:

Properties

parent

: VsdxObject

Methods

createImage

(
format: string
data: string
key?: string
): VsdxImage

Creates a new VsdxImage. Such an image can be added to an ForeignShape through the ForeignShape.foreignData property. The required data and format can be retrieved through ImageUtils.fetchImageData.

Parameters

format: string

The image format. Supported are "png", "jp(e)g", "tiff", "gif", "dib".

data: string

Binary data encoded as string (not base64).

key?: string

Return Value

VsdxImage
A new image.

getImage

(key: string): VsdxImage

Returns the image with the given key if a key was provided in createImage for the image.

Parameters

key: string

The key of the image.

Return Value

VsdxImage
The image or null if no image with the given key exists.