Class: TextBox

visual.TextBox(options)

new TextBox(options)

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
name String the name used when logging messages from this stimulus
win module:core.Window the associated Window
text string <optional>
 "" the text to be rendered
font string <optional>
 "Arial" the font family
pos Array.<number> <optional>
 [0, 0] the position of the center of the text
color Color <optional>
 Color('white') color of the text
opacity number <optional>
 1.0 the opacity
depth number <optional>
 0 the depth (i.e. the z order)
contrast number <optional>
 1.0 the contrast
units string <optional>
 "norm" the units of the text size and position
ori number <optional>
 0.0 the orientation (in degrees)
height number <optional>
 0.1 the height of the text
bold boolean <optional>
 false whether or not the text is bold
italic boolean <optional>
 false whether or not the text is italic
anchor string <optional>
 'left' horizontal alignment
multiline boolean <optional>
 false whether or not a multiline element is used
autofocus boolean <optional>
 true whether or not the first input should receive focus by default
flipHoriz boolean <optional>
 false whether or not to flip the text horizontally
flipVert boolean <optional>
 false whether or not to flip the text vertically
fillColor Color <optional>
 fill color of the text-box
borderColor Color <optional>
 border color of the text-box
clipMask PIXI.Graphics <optional>
 null the clip mask
autoDraw boolean <optional>
 false whether or not the stimulus should be automatically drawn on every frame flip
autoLog boolean <optional>
 false whether or not to log
fitToContent boolean <optional>
 false whether or not to resize itself automaitcally to fit to the text content
Mixes In:
  • ColorMixin
Source:

Extends

  • VisualStim

Members

(protected) _addEventListeners

Add event listeners to text-box object. Method is called internally upon object construction.
Source:

(protected) _getDefaultLetterHeight

Get the default letter height given the stimulus' units.
Source:

clear

Clears the current text value.
Source:

getText

For accessing the underlying input value.
Source:

reset

Clears the current text value or sets it back to match the placeholder.
Source:

setAlignment

Setter for the alignment attribute.
Source:

setAnchor

Setter for the anchor attribute.
Source:

setBorderColor

Setter for the borderColor attribute.
Source:

setColor

Setter for the color attribute.
Source:

setFillColor

Setter for the fillColor attribute.
Source:

setFitToContent

Setter for the fitToContent attribute.
Source:

setFont

Set the font for textbox.
Source:

setLetterHeight

Set letterHeight (font size) for textbox.
Source:

setSize

Setter for the size attribute.
Source:

setText

For tweaking the underlying input value.
Source:

Methods

(protected) _estimateBoundingBox()

Estimate the bounding box.
Source:

(protected) _getAnchor() → {Array.<number>}

Convert the anchor attribute into numerical values.
Source:
Returns:
- the anchor, as an array of numbers in [0,1]
Type
Array.<number>