Class: LabeledGraphics

Extends

• PIXI.Graphics

Classes

exports.LabeledGraphics

Methods

clear ()

labeledgraphics.js:341

Ensures that labels are hidden on clear.

debugInfos ()

labeledgraphics.js:353

Logs debugging infos

ensureLabel (key, label, attrs, fontInfo)PIXI.Text

labeledgraphics.js:204

Main additional method. Ensures that a text object is created that is cached under the given key.

Name	Type	Default	Description
key	*		The cache key
label	*		The label to show
attrs	*	{}	optional Defines attributes of the text object. align: 'right', 'left', or 'center' justify: 'top', 'bottom', or 'center' maxLines: {integer} truncates the text and adds ellipsis maxHeight: {number} truncates text that needs more space and adds ellipsis maxWidth: {number} word wraps text using hyphenation if possible
fontInfo	*	FontInfo.normal	optional Defines PIXI.TextStyle attributes

Returns:

Type	Description
PIXI.Text	instance

getLabel (key)Object

labeledgraphics.js:309

Returns the label for the given key.

Name	Type	Description
key	*

Returns:

Type	Description
Object

hideLabel (key)

labeledgraphics.js:318

Hides the label with the given key.

Name	Type	Description
key	*

removeLabel (key)

labeledgraphics.js:330

Removes the label with the given key.

Name	Type	Description
key	*

truncateLabel (text, style, maxLines)string

labeledgraphics.js:270

Private method that truncates the text and adds an ellipsis if there are more lines than wanted

Name	Type	Default	Description
text	*
style	*
maxLines	*	Infinity	optional

Returns:

Type	Description
string