Show contents

Working with Common Classes > Classes > ImageList

ImageList

Namespace: PP;

Inheritance hierarchy

Object

ImageList

Description

The ImageList class implements the ImageListnon-visual component, which contains a link to the sprite (or a set of images in one file) and image size in the sprite.

Syntax

PP.initClass(PP.ImageList, PP.Object, "ImageList");

Constructor

	Constructor name	Brief description
	ImageList	The ImageList constructor creates an instance of the ImageList component.

Properties

	Property name	Brief description
	IconHeight	The IconHeight property sets icon height.
	IconWidth	The IconWidth property sets icon width.
	IsRetinaAvailable	The IsRetinaAvailable property returns whether it is possible to work on a device with retina display.
	Source	The Source property determines the path to the icons set.

Methods

	Method name	Brief description
	applyToBackground	The applyToBackground method sets the specified sprite image as a DOM element background.
	applyToCanvas	The applyToCanvas method renders the loaded image on the canvas.
	getIcon	The getIcon method returns icon by column or row index of list.
	getLeft	The getLeft method returns horizontal offset.
	getTop	The getTop method returns vertical offset.
	isImageLoaded	The isImageLoaded method returns image loading status.
	loadImage	The loadImage method loads an image for further rendering on the canvas.

Events

	Event name	Brief description
	ImageLoaded	The ImageLoaded event occurs after an image is loaded.
	ImageLoading	The ImageLoading event occurs at the beginning of image loading.

Properties inherited from the Object class

	Property name	Brief description
	Id	The Id property determines a repository object identifier.

Methods inherited from the Object class

	Method name	Brief description
	clone	The clone method creates an object copy.
	dispose	The dispose method deletes the component.
	getHashCode	The getHashCode method returns hash code of repository object.
	getSettings	The getSettings method returns repository object settings.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.
	isEqual	The isEqual method determines whether the specified object is equal to the current repository object.
	isLive	The isLive method determines validity of repository object.
	removeAllEvents	The removeAllEvents method removes all object event handlers by the specified context.
	setSettings	The setSettings method determines repository object settings.
	defineProps	The defineProps method creates get and set methods from name array for the specified class.
	keys	The keys method returns array of methods and properties names for the specified object.

See also:

PP