#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# Console Class

Defined in: `console/js/console.js:1`
Module: console

Console creates a visualization for messages logged through calls to a YUI instance's `Y.log( message, category, source )` method. The debug versions of YUI modules will include logging statements to offer some insight into the steps executed during that module's operation. Including log statements in your code will cause those messages to also appear in the Console. Use Console to aid in developing your page or application.

Entry categories "info", "warn", and "error" are also referred to as the log level, and entries are filtered against the configured logLevel.

- Index
- Methods
- Properties
- Attributes
- Events

## Item Index

### Methods

- _afterCollapsedChange
- _afterConsoleLimitChange
- _afterPausedChange
- _afterStringsChange
- _afterVisibleChange
- _cancelPrintLoop
- _createEntryHTML
- _defEntryFn
- _defResetFn
- _encodeHTML
- _getUseBrowserConsole
- _htmlEscapeMessage
- _initBody
- _initFoot
- _initHead
- _isInLogLevel
- _normalizeMessage
- _onClearClick
- _onCollapseClick
- _onLogEvent
- _onPauseClick
- _schedulePrint
- _setLogLevel
- _setUseBrowserConsole
- _trimOldEntries
- _uiSetHeight
- _uiSizeCB
- _uiUpdateCollapsed
- _uiUpdateFromHideShow
- _uiUpdatePaused
- _validateLogSource
- _validateStyle
- bindUI
- clearConsole
- collapse
- destructor
- expand
- initializer
- log
- printBuffer
- renderUI
- reset
- scrollToLatest
- syncUI

### Properties

- _body
- _evtCat
- _foot
- _head
- _printLoop
- ATTRS static
- BODY_TEMPLATE static
- buffer
- CHROME_CLASSES static
- ENTRY_CLASSES static
- ENTRY_TEMPLATE static
- FOOTER_TEMPLATE static
- HEADER_TEMPLATE static
- LOG_LEVEL_ERROR static
- LOG_LEVEL_INFO static
- LOG_LEVEL_WARN static
- NAME static

### Attributes

- collapsed
- consoleLimit
- defaultCategory
- defaultSource
- entryTemplate
- height
- lastTime
- logEvent
- logLevel
- logSource
- newestOnTop
- paused
- printLimit
- printTimeout
- scrollIntoView
- startTime
- strings
- style
- useBrowserConsole
- width

### Events

- entry
- reset

## Methods

### `_afterCollapsedChange`

(

- `e`

)
protected

Defined in `console/js/console.js:900`

Updates the className of the contentBox, which should trigger CSS to hide or show the body and footer sections depending on the new value.

#### Parameters:

- `e` Event

  Custom event for the attribute change

### `_afterConsoleLimitChange`

(

- `e`

)
protected

Defined in `console/js/console.js:887`

Calls this._trimOldEntries() in response to changes in the configured consoleLimit attribute.

#### Parameters:

- `e` Event

  Custom event for the attribute change

### `_afterPausedChange`

(

- `e`

)
protected

Defined in `console/js/console.js:851`

Updates the UI and schedules or cancels the print loop.

#### Parameters:

- `e` Event

  Custom event for the attribute change

### `_afterStringsChange`

(

- `e`

)
protected

Defined in `console/js/console.js:824`

Updates the UI if changes are made to any of the strings in the strings attribute.

#### Parameters:

- `e` Event

  Custom event for the attribute change

### `_afterVisibleChange`

(

- `e`

)
protected

Defined in `console/js/console.js:934`

Makes adjustments to the UI if needed when the Console is hidden or shown

#### Parameters:

- `e` Event

  the visibleChange event

### `_cancelPrintLoop`

() protected

Defined in `console/js/console.js:659`

Clears the timeout for printing buffered messages.

### `_createEntryHTML`

(

- `m`

)
protected

Defined in `console/js/console.js:542`

Translates message meta into the markup for a console entry.

#### Parameters:

- `m` Object

  object literal containing normalized message metadata

#### Returns:

String

### `_defEntryFn`

(

- `e`

)
protected

Defined in `console/js/console.js:1001`

Buffers incoming message objects and schedules the printing.

#### Parameters:

- `e` Event

  The Custom event carrying the message in its payload

### `_defResetFn`

() protected

Defined in `console/js/console.js:987`

Clears the console, resets the startTime attribute, enables and unpauses the widget.

### `_encodeHTML`

(

- `s`

)
protected

Defined in `console/js/console.js:642`

Returns the input string with ampersands (&), &lt, and > encoded as HTML entities.

#### Parameters:

- `s` String

  the raw string

#### Returns:

String the encoded string

### `_getUseBrowserConsole`

() Boolean protected

Defined in `console/js/console.js:753`

Getter method for useBrowserConsole attribute. Just a pass through to the YUI instance configuration setting.

#### Returns:

Boolean: or null if logSource is not a YUI instance

### `_htmlEscapeMessage`

(

- `m`

)
protected

Defined in `console/js/console.js:579`

Performs HTML escaping on strings in the message object.

#### Parameters:

- `m` Object

  the normalized message object

#### Returns:

Object the message object with proper escapement

### `_initBody`

() protected

Defined in `console/js/console.js:420`

Create the DOM structure for the console body—where messages are rendered.

### `_initFoot`

() protected

Defined in `console/js/console.js:435`

Create the DOM structure for the footer elements.

### `_initHead`

() protected

Defined in `console/js/console.js:402`

Create the DOM structure for the header elements.

### `_isInLogLevel`

() protected

Defined in `console/js/console.js:453`

Determine if incoming log messages are within the configured logLevel to be buffered for printing.

### `_normalizeMessage`

(

- `e`

)
protected

Defined in `console/js/console.js:479`

Create a log entry message from the inputs including the following keys:

- time - this moment
- message - leg message
- category - logLevel or custom category for the message
- source - when provided, the widget or util calling Y.log
- sourceAndDetail - same as source but can include instance info
- localTime - readable version of time
- elapsedTime - ms since last entry
- totalTime - ms since Console was instantiated or reset

#### Parameters:

- `e` Event

  custom event containing the log message

#### Returns:

Object the message object

### `_onClearClick`

(

- `e`

)
protected

Defined in `console/js/console.js:697`

Event handler for clicking on the Clear button. Pass-through to `this.clearConsole()`.

#### Parameters:

- `e` Event

  DOM event facade for the click event

### `_onCollapseClick`

(

- `e`

)
protected

Defined in `console/js/console.js:709`

Event handler for clicking on the Collapse/Expand button. Sets the "collapsed" attribute accordingly.

#### Parameters:

- `e` Event

  DOM event facade for the click event

### `_onLogEvent`

(

- `msg`
- `cat`
- `src`

)
protected

Defined in `console/js/console.js:960`

Responds to log events by normalizing qualifying messages and passing them along through the entry event for buffering etc.

#### Parameters:

- `msg` String

  the log message

- `cat` String

  OPTIONAL the category or logLevel of the message

- `src` String

  OPTIONAL the source of the message (e.g. widget name)

### `_onPauseClick`

(

- `e`

)
protected

Defined in `console/js/console.js:685`

Event handler for clicking on the Pause checkbox to update the paused attribute.

#### Parameters:

- `e` Event

  DOM event facade for the click event

### `_schedulePrint`

() protected

Defined in `console/js/console.js:527`

Sets an interval for buffered messages to be output to the console.

### `_setLogLevel`

(

- `v`

)
protected

Defined in `console/js/console.js:735`

Setter method for logLevel attribute. Acceptable values are "error&quot, "warn&quot, and "info&quot (case insensitive). Other values are treated as "info".

#### Parameters:

- `v` String

  the desired log level

#### Returns:

String One of Console.LOGLEVELINFO, _WARN, or _ERROR

### `_setUseBrowserConsole`

(

- `v`

)
Boolean protected

Defined in `console/js/console.js:767`

Setter method for useBrowserConsole attributes. Only functional if the logSource attribute points to a YUI instance. Passes the value down to the YUI instance. NOTE: multiple Console instances cannot maintain independent useBrowserConsole values, since it is just a pass through to the YUI instance configuration.

#### Parameters:

- `v` Boolean

  false to disable browser console printing (default)

#### Returns:

Boolean: true|false if logSource is a YUI instance

### `_trimOldEntries`

() protected

Defined in `console/js/console.js:596`

Removes the oldest message entries from the UI to maintain the limit specified in the consoleLimit configuration.

### `_uiSetHeight`

(

- `v`

)
protected

Defined in `console/js/console.js:790`

Set the height of the Console container. Set the body height to the difference between the configured height and the calculated heights of the header and footer. Overrides Widget.prototype._uiSetHeight.

#### Parameters:

- `v` String | Number

  the new height

### `_uiSizeCB`

() protected

Defined in `console/js/console.js:812`

Over-ride default content box sizing to do nothing, since we're sizing the body section to fill out height ourselves.

### `_uiUpdateCollapsed`

(

- `v`

)
protected

Defined in `console/js/console.js:912`

Updates the UI to reflect the new Collapsed state

#### Parameters:

- `v` Boolean

  true for collapsed, false for expanded

### `_uiUpdateFromHideShow`

(

- `v`

)
protected

Defined in `console/js/console.js:947`

Recalculates dimensions and updates appropriately when shown

#### Parameters:

- `v` Boolean

  true for visible, false for hidden

### `_uiUpdatePaused`

(

- `on`

)
protected

Defined in `console/js/console.js:872`

Checks or unchecks the paused checkbox

#### Parameters:

- `on` Boolean

  the new checked state

### `_validateLogSource`

(

- `v`

)
Boolean protected

Defined in `console/js/console.js:722`

Validator for logSource attribute.

#### Parameters:

- `v` Object

  the desired logSource

#### Returns:

Boolean: true if the input is an object with an `on` method

### `_validateStyle`

(

- `style`

)
Boolean protected

Defined in `console/js/console.js:672`

Validates input value for style attribute. Accepts only values 'inline', 'block', and 'separate'.

#### Parameters:

- `style` String

  the proposed value

#### Returns:

Boolean: pass/fail

### `bindUI`

() protected

Defined in `console/js/console.js:374`

Set up event listeners to wire up the UI to the internal state.

### `clearConsole`

() chainable

Defined in `console/js/console.js:174`

Clear the console of messages and flush the buffer of pending messages.

### `collapse`

() chainable

Defined in `console/js/console.js:203`

Collapses the body and footer.

### `destructor`

() protected

Defined in `console/js/console.js:329`

Tears down the instance, flushing event subscriptions and purging the UI.

### `expand`

() chainable

Defined in `console/js/console.js:215`

Expands the body and footer if collapsed.

### `initializer`

() protected

Defined in `console/js/console.js:288`

Constructor code. Set up the buffer and entry template, publish internal events, and subscribe to the configured logEvent.

### `log`

(

- `arg`

)
chainable

Defined in `console/js/console.js:161`

Wrapper for `Y.log`.

#### Parameters:

- `arg` MIXED multiple

  (all arguments passed through to `Y.log`)

### `printBuffer`

(

- `limit`

)
chainable

Defined in `console/js/console.js:227`

Outputs buffered messages to the console UI. This is typically called from a scheduled interval until the buffer is empty (referred to as the print loop). The number of buffered messages output to the Console is limited to the number provided as an argument. If no limit is passed, all buffered messages are rendered.

#### Parameters:

- `limit` Number

  (optional) max number of buffered entries to write

### `renderUI`

() protected

Defined in `console/js/console.js:345`

Generate the Console UI.

### `reset`

() chainable

Defined in `console/js/console.js:191`

Clears the console and resets internal timers.

### `scrollToLatest`

() chainable

Defined in `console/js/console.js:565`

Scrolls to the most recent entry

### `syncUI`

()

Defined in `console/js/console.js:363`

Sync the UI state to the current attribute state.

## Properties

### `_body`

Node protected

Defined in `console/js/console.js:120`

Reference to the Node instance that will house the console messages.

Default: null

### `_evtCat`

String protected

Defined in `console/js/console.js:100`

Category to prefix all event subscriptions to allow for ease of detach during destroy.

### `_foot`

Node protected

Defined in `console/js/console.js:130`

Reference to the Node instance containing the footer contents.

Default: null

### `_head`

Node protected

Defined in `console/js/console.js:110`

Reference to the Node instance containing the header contents.

Default: null

### `_printLoop`

Object protected

Defined in `console/js/console.js:140`

Holds the object API returned from `Y.later` for the print loop interval.

Default: null

### `ATTRS`

Object static

Defined in `console/js/console.js:1211`

Static property used to define the default attribute configuration of the Widget.

### `BODY_TEMPLATE`

String static

Defined in `console/js/console.js:1151`

Markup template used to generate the DOM structure for the Console body (where the messages are inserted) when it is rendered. The template includes only the {placeholder} "consolebdclass", which is constributed by Console.CHROME_CLASSES.

### `buffer`

Array protected

Defined in `console/js/console.js:151`

Array of normalized message objects awaiting printing.

Default: null

### `CHROME_CLASSES`

Object static

Defined in `console/js/console.js:1087`

Map (object) of classNames used to populate the placeholders in the Console.HEADERTEMPLATE, Console.BODYTEMPLATE, and Console.FOOTER_TEMPLATE markup when rendering the Console UI.

By default, the keys contained in the object are:

- console_hd_class
- console_bd_class
- console_ft_class
- console_controls_class
- console_checkbox_class
- console_pause_class
- console_pause_label_class
- console_button_class
- console_clear_class
- console_collapse_class
- console_title_class

### `ENTRY_CLASSES`

Object static

Defined in `console/js/console.js:1060`

Map (object) of classNames used to populate the placeholders in the Console.ENTRY_TEMPLATE markup when rendering a new Console entry.

By default, the keys contained in the object are:

- entry_class
- entry_meta_class
- entry_cat_class
- entry_src_class
- entry_time_class
- entry_content_class

### `ENTRY_TEMPLATE`

String static

Defined in `console/js/console.js:1188`

Default markup template used to create the DOM structure for Console entries. The markup contains {placeholder}s for content and classes that are replaced via Y.Lang.sub. The default template contains the {placeholder}s identified in Console.ENTRY_CLASSES as well as the following placeholders that will be populated by the log entry data:

- cat_class
- src_class
- totalTime
- elapsedTime
- localTime
- sourceAndDetail
- message

### `HEADER_TEMPLATE`

String static

Defined in `console/js/console.js:1125`

Markup template used to generate the DOM structure for the header section of the Console when it is rendered. The template includes these {placeholder}s:

- console_button_class - contributed by Console.CHROME_CLASSES
- console_collapse_class - contributed by Console.CHROME_CLASSES
- console_hd_class - contributed by Console.CHROME_CLASSES
- console_title_class - contributed by Console.CHROME_CLASSES
- str_collapse - pulled from attribute strings.collapse
- str_title - pulled from attribute strings.title

### `LOG_LEVEL_ERROR`

String static

Defined in `console/js/console.js:1049`

Static identifier for logLevel configuration setting to allow only incoming messages of logLevel "error" to generate Console entries.

### `LOG_LEVEL_INFO`

String static

Defined in `console/js/console.js:1028`

Static identifier for logLevel configuration setting to allow all incoming messages to generate Console entries.

### `LOG_LEVEL_WARN`

String static

Defined in `console/js/console.js:1038`

Static identifier for logLevel configuration setting to allow only incoming messages of logLevel "warn" or "error" to generate Console entries.

### `NAME`

String static

Defined in `console/js/console.js:1019`

The identity of the widget.

## Attributes

### `collapsed`

Boolean

Defined in `console/js/console.js:1434`

Controls the collapsed state of the Console

Default: false

#### Fires event `collapsedChange`

Fires when the value for the configuration attribute `collapsed` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `consoleLimit`

Number

Defined in `console/js/console.js:1369`

Maximum number of Console entries allowed in the Console body at one time. This is used to keep acquired messages from exploding the DOM tree and impacting page performance.

Default: 300

#### Fires event `consoleLimitChange`

Fires when the value for the configuration attribute `consoleLimit` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `defaultCategory`

String

Defined in `console/js/console.js:1283`

If a category is not specified in the Y.log(..) statement, this category will be used. Categories "info", "warn", and "error" are also called log level.

Default: "info"

#### Fires event `defaultCategoryChange`

Fires when the value for the configuration attribute `defaultCategory` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `defaultSource`

String

Defined in `console/js/console.js:1297`

If a source is not specified in the Y.log(..) statement, this source will be used.

Default: "global"

#### Fires event `defaultSourceChange`

Fires when the value for the configuration attribute `defaultSource` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `entryTemplate`

String

Defined in `console/js/console.js:1310`

Markup template used to create the DOM structure for Console entries.

Default: Console.ENTRY_TEMPLATE

#### Fires event `entryTemplateChange`

Fires when the value for the configuration attribute `entryTemplate` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `height`

String | Number

Defined in `console/js/console.js:1445`

String with units, or number, representing the height of the Console, inclusive of header and footer. If a number is provided, the default unit, defined by Widget's DEF_UNIT, property is used.

Default: "300px"

#### Fires event `heightChange`

Fires when the value for the configuration attribute `height` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `lastTime`

Date

Defined in `console/js/console.js:1421`

The precise time the last entry was logged. Used to measure elapsed time between log messages.

Default: The moment the console module is <code>use</code>d

#### Fires event `lastTimeChange`

Fires when the value for the configuration attribute `lastTime` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `logEvent`

String

Defined in `console/js/console.js:1221`

Name of the custom event that will communicate log messages.

Default: "yui:log"

#### Fires event `logEventChange`

Fires when the value for the configuration attribute `logEvent` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `logLevel`

String

Defined in `console/js/console.js:1322`

Minimum entry log level to render into the Console. The initial logLevel value for all Console instances defaults from the Y.config.logLevel YUI configuration, or Console.LOGLEVELINFO if that configuration is not set.

Possible values are "info", "warn", "error" (case insensitive), or their corresponding statics Console.LOGLEVELINFO and so on.

Default: Y.config.logLevel or Console.LOG_LEVEL_INFO

#### Fires event `logLevelChange`

Fires when the value for the configuration attribute `logLevel` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `logSource`

EventTarget

Defined in `console/js/console.js:1234`

Object that will emit the log events. By default the YUI instance. To have a single Console capture events from all YUI instances, set this to the Y.Global object.

Default: Y

#### Fires event `logSourceChange`

Fires when the value for the configuration attribute `logSource` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `newestOnTop`

Boolean

Defined in `console/js/console.js:1383`

New entries should display at the top of the Console or the bottom?

Default: true

#### Fires event `newestOnTopChange`

Fires when the value for the configuration attribute `newestOnTop` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `paused`

Boolean

Defined in `console/js/console.js:1270`

Boolean to pause the outputting of new messages to the console. When paused, messages will accumulate in the buffer.

Default: false

#### Fires event `pausedChange`

Fires when the value for the configuration attribute `paused` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `printLimit`

Number

Defined in `console/js/console.js:1356`

Maximum number of entries printed in each iteration of the print loop. This is used to prevent excessive logging locking the page UI.

Default: 50

#### Fires event `printLimitChange`

Fires when the value for the configuration attribute `printLimit` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `printTimeout`

Number

Defined in `console/js/console.js:1343`

Millisecond timeout between iterations of the print loop, moving entries from the buffer to the UI.

Default: 100

#### Fires event `printTimeoutChange`

Fires when the value for the configuration attribute `printTimeout` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `scrollIntoView`

Boolean

Defined in `console/js/console.js:1394`

When new entries are added to the Console UI, should they be scrolled into view?

Default: true

#### Fires event `scrollIntoViewChange`

Fires when the value for the configuration attribute `scrollIntoView` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `startTime`

Date

Defined in `console/js/console.js:1406`

The baseline time for this Console instance, used to measure elapsed time from the moment the console module is `use`d to the moment each new entry is logged (not rendered).

This value is reset by the instance method myConsole.reset().

Default: The moment the console module is <code>use</code>d

#### Fires event `startTimeChange`

Fires when the value for the configuration attribute `startTime` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `strings`

Object

Defined in `console/js/console.js:1251`

Collection of strings used to label elements in the Console UI. Default collection contains the following name:value pairs:

- title : "Log Console"
- pause : "Pause"
- clear : "Clear"
- collapse : "Collapse"
- expand : "Expand"

#### Fires event `stringsChange`

Fires when the value for the configuration attribute `strings` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `style`

String

Defined in `console/js/console.js:1492`

Allows the Console to flow in the document. Available values are 'inline', 'block', and 'separate' (the default).

Default: 'separate'

#### Fires event `styleChange`

Fires when the value for the configuration attribute `style` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `useBrowserConsole`

Boolean

Defined in `console/js/console.js:1471`

Pass through to the YUI instance useBrowserConsole configuration. By default this is set to false, which will disable logging to the browser console when a Console instance is created. If the logSource is not a YUI instance, this has no effect.

Default: false

#### Fires event `useBrowserConsoleChange`

Fires when the value for the configuration attribute `useBrowserConsole` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `width`

String | Number

Defined in `console/js/console.js:1458`

String with units, or number, representing the width of the Console. If a number is provided, the default unit, defined by Widget's DEF_UNIT, property is used.

Default: "300px"

#### Fires event `widthChange`

Fires when the value for the configuration attribute `width` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

## Events

### `entry`

Defined in `console/js/console.js:303`

Transfers a received message to the print loop buffer. Default behavior defined in _defEntryFn.

#### Event Payload:

- `event` Event.Facade

  An Event Facade object with the following attribute specific properties added:

  message
    The message data normalized into an object literal (see _normalizeMessage)

### `reset`

Defined in `console/js/console.js:317`

Triggers the reset behavior via the default logic in _defResetFn.

#### Event Payload:

- `event` Event.Facade

  Event Facade object