Class: DisplayProductInfo

timapi.DisplayProductInfo()

Holds a product picture and related information for display. For use by value added services. The image is stored as byte array containing the image data.

Overview

Members-Overview

backgroundColor	:timapi.Color
imageData	:Uint8Array
imageFileFormat	:timapi.constants.ImageFileFormat
imageFileHeight	:Number
imageFileWidth	:Number
productDisplayName	:String

Methods-Overview

toString() → {String}
copy(DisplayProductInfo) → {timapi.DisplayProductInfo}

Constructor

new DisplayProductInfo()

Create empty display product info.

Member-List

backgroundColor :timapi.Color

Background color.

Default Value:

White -> ( new timapi.Color(255,255,255) )

imageData :Uint8Array

Image data.

imageFileFormat :timapi.constants.ImageFileFormat

Image file format of image data.

imageFileHeight :Number

Image height in pixels.

imageFileWidth :Number

Image width in pixels.

productDisplayName :String

Name of a product for display purposes.

Methods

toString() → {String}

String representation for debugging purpose.

Returns:

String representation

Type: String

(static) copy(DisplayProductInfo) → {timapi.DisplayProductInfo}

Creates a copy of a timapi.DisplayProductInfo object.

Parameters:

Name	Type	Description
`DisplayProductInfo`	timapi.DisplayProductInfo	Original

Returns:

Copy of original

Type: timapi.DisplayProductInfo