Show contents

Working with Graphic Elements > Classes > CanvasLabel

CanvasLabel

Namespace: PP.Ui

Inheritance hierarchy

Object

CanvasLabel

Description

The CanvasLabel class is used to work with a canvas label.

Syntax

PP.initClass(PP.Ui.CanvasLabel, PP.Object, "PP.Ui.CanvasLabel");

Comments

Canvas (canvas) is a HTML5 element used to create a raster 2D image by means of programming (as usual in the JavaScript language).

Constructor

	Constructor name	Brief description
	CanvasLabel	The CanvasLabel constructor creates a canvas label object.

Properties

	Property name	Brief description
	Alignment	The Alignment property determines canvas label text alignment.
	AutoOrientation	The AutoOrientation property controls ability of autoorientation for canvas label.
	Background	The Background property sets canvas label fill color.
	CanvasContext	The CanvasContext property determines canvas settings.
	Circular	The Circular property determines whether canvas label is displayed as a circle.
	Direction	The Direction property canvas label text direction.
	Margin	The Margin property determines external margins for canvas label.
	MaskText	The MaskText property determines text mask for canvas label.
	MaxSize	The MaxSize property determines maximum size of canvas label text.
	MinSize	The MinSize property determines minimum size of canvas label text.
	NoDataText	The NoDataText property determines canvas label text if it is not determined in the CanvasLabel.Values property.
	Opacity	The Opacity property determines level of transparency for canvas label.
	Padding	The Padding property determines internal margins for canvas label.
	Position	The Position property determines canvas label position and size.
	ShowHandCursor	The ShowHandCursor property determines whether the mouse cursor of the pointer type is displayed on pointing a canvas label.
	Style	The Style property determines canvas label style.
	TextWrapping	The TextWrapping property determines canvas label text wrap mode.
	Values	The Values property determines canvas label text.
	Vertical	The Vertical property determines whether canvas label is aligned vertically.

Methods

	Method name	Brief description
	draw	The draw method renders canvas label.
	getTooltipOffset	The getTooltipOffset method calculates tooltip offset for canvas label.
	setBorderColor	The setBorderColor method sets canvas label border color.
	setFontColor	The setFontColor method sets canvas label font color.
	updateContent	The updateContent method refreshes canvas label text.

Properties inherited from the class Object

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

Methods inherited from the class Object

	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.

PP.Ui