PictureCollection

PictureCollection class

Encapsulates a collection of Picture objects.

class PictureCollection;

Methods

Method	Description
get(number)	Gets the Picture element at the specified index.
add(number, number, number, number, Uint8Array)	Adds a picture to the collection.
add(number, number, number, number, string)	Adds a picture to the collection.
add(number, number, Uint8Array)	Adds a picture to the collection.
add(number, number, string)	Adds a picture to the collection.
add(number, number, Uint8Array, number, number)	Adds a picture to the collection.
add(number, number, string, number, number)	Adds a picture to the collection.
clear()	Clear all pictures.
removeAt(number)	Remove shapes at the specific index
getCount()	Gets the number of elements contained in.

get(number)

Gets the Picture element at the specified index.

get(index: number) : Picture;

Parameters:

Parameter	Type	Description
index	number	The zero based index of the element.

Returns

The element at the specified index.

add(number, number, number, number, Uint8Array)

Adds a picture to the collection.

add(upperLeftRow: number, upperLeftColumn: number, lowerRightRow: number, lowerRightColumn: number, stream: Uint8Array) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
lowerRightRow	number	Lower right row index
lowerRightColumn	number	Lower right column index
stream	Uint8Array	Stream object which contains the image data.

Returns

Picture object index.

add(number, number, number, number, string)

Adds a picture to the collection.

add(upperLeftRow: number, upperLeftColumn: number, lowerRightRow: number, lowerRightColumn: number, fileName: string) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
lowerRightRow	number	Lower right row index
lowerRightColumn	number	Lower right column index
fileName	string	Image filename.

Returns

Picture object index.

add(number, number, Uint8Array)

Adds a picture to the collection.

add(upperLeftRow: number, upperLeftColumn: number, stream: Uint8Array) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
stream	Uint8Array	Stream object which contains the image data.

Returns

Picture object index.

add(number, number, string)

Adds a picture to the collection.

add(upperLeftRow: number, upperLeftColumn: number, fileName: string) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
fileName	string	Image filename.

Returns

Picture object index.

add(number, number, Uint8Array, number, number)

Adds a picture to the collection.

add(upperLeftRow: number, upperLeftColumn: number, stream: Uint8Array, widthScale: number, heightScale: number) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
stream	Uint8Array	Stream object which contains the image data.
widthScale	number	Scale of image width, a percentage.
heightScale	number	Scale of image height, a percentage.

Returns

Picture object index.

add(number, number, string, number, number)

Adds a picture to the collection.

add(upperLeftRow: number, upperLeftColumn: number, fileName: string, widthScale: number, heightScale: number) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
fileName	string	Image filename.
widthScale	number	Scale of image width, a percentage.
heightScale	number	Scale of image height, a percentage.

Returns

Picture object index.

clear()

Clear all pictures.

clear() : void;

removeAt(number)

Remove shapes at the specific index

removeAt(index: number) : void;

Parameters:

Parameter	Type	Description
index	number

getCount()

Gets the number of elements contained in.

getCount() : number;