Provides Plugin.ConsoleFilters plugin class.
This plugin adds the ability to control which Console entries display by filtering on category and source. Two groups of checkboxes are added to the Console footer, one for categories and the other for sources. Only those messages that match a checked category or source are displayed.
_afterCacheLimitChangee
Trims the cache of entries to the appropriate new length.
e
Event
the attribute change event object
_afterCategoryChangee
Triggers the Console to update if a known category filter changes value (e.g. visible => hidden). Updates the appropriate checkbox's checked state if necessary.
e
Event
the attribute change event object
_afterClearConsoleFlushes the cached entries after a call to the Console's clearConsole().
_afterSourceChangee
Triggers the Console to update if a known source filter changes value (e.g. visible => hidden). Updates the appropriate checkbox's checked state if necessary.
e
Event
the attribute change event object
_createCheckboxcontainer
name
Creates a checkbox and label from the ConsoleFilters.FILTER_TEMPLATE for the provided type and name. The checkbox and label are appended to the container node passes as the first arg.
_filterBufferFlushes the Console's print buffer of any entries that have a category or source that is currently being excluded.
_onCategoryCheckboxClicke
Passes checkbox clicks on to the category attribute.
e
Event
the DOM event
_onEntrye
Ensures a filter is set up for any new categories or sources and collects the messages in _entries. If the message is stamped with a category or source that is currently being filtered out, the message will not pass to the Console's print buffer.
e
Event
the custom event object
_onSourceCheckboxClicke
Passes checkbox clicks on to the source attribute.
e
Event
the DOM event
_setCacheLimitv
Setter method for cacheLimit attribute. Basically a validator to ensure numeric input.
v
Number
Maximum number of entries
_uiSetCheckboxtype
item
checked
Updates the checked property of a filter checkbox of the specified type. If no checkbox is found for the input params, one is created.
_validateCategorycat
v
Validates category updates are objects and the subattribute is not too deep.
Boolean
_validateSourcecat
v
Validates source updates are objects and the subattribute is not too deep.
Boolean
bindUIBinds to checkbox click events and internal attribute change events to maintain the UI state.
destructorRemoves the plugin UI and unwires events.
hideCategorycat
Hides any number of categories from the UI. Convenience method for myConsole.filter.set('category.foo', false); set('category.bar', false); and so on.
cat
String
multiple
1..n categories to filter out of the UI
hideSourcesrc
Hides any number of sources from the UI. Convenience method for myConsole.filter.set('source.foo', false); set('source.bar', false); and so on.
src
String
multiple
1..n sources to filter out of the UI
initializerInitialize entries collection and attach listeners to host events and methods.
refreshConsoleRepopulates the Console with entries appropriate to the current filter settings.
renderUIAdds the category and source filter sections to the Console footer.
showCategorycat
Shows any number of categories in the UI. Convenience method for myConsole.filter.set('category.foo', true); set('category.bar', true); and so on.
cat
String
multiple
1..n categories to allow to display in the UI
showSourcesrc
Shows any number of sources in the UI. Convenience method for myConsole.filter.set('source.foo', true); set('source.bar', true); and so on.
src
String
multiple
1..n sources to allow to display in the UI
syncUIUpdates the UI to be in accordance with the current state of the plugin.
_cacheLimitMaximum number of entries to store in the message cache.
Default: Infinity
_entriesCollection of all log messages passed through since the plugin's instantiation. This holds all messages regardless of filter status. Used as a single source of truth for repopulating the Console body when filters are changed.
CATEGORIES_TEMPLATEMarkup template used to create the container for the category filters.
FILTER_TEMPLATEMarkup template used to create the category and source filter checkboxes.
NSThe namespace hung off the host object that this plugin will inhabit.
Default: 'filter'
cacheLimitMaximum number of entries to store in the message cache. Use this to limit the memory footprint in environments with heavy log usage. By default, there is no limit (Number.POSITIVE_INFINITY).
Default: Number.POSITIVE_INFINITY
cacheLimitChange
Fires when the value for the configuration attribute cacheLimit 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.
e
EventFacade
categoryMap of entry categories to their visibility status. Update a particular category's visibility by setting the subattribute to true (visible) or false (hidden).
For example, yconsole.filter.set('category.info', false) to hide log entries with the category/logLevel of 'info'.
Similarly, yconsole.filter.get('category.warn') will return a boolean indicating whether that category is currently being included in the UI.
Unlike the YUI instance configuration's logInclude and logExclude properties, filtered entries are only hidden from the UI, but can be made visible again.
categoryChange
Fires when the value for the configuration attribute category 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.
e
EventFacade
defaultVisibilityDefault visibility applied to new categories and sources.
Default: true
defaultVisibilityChange
Fires when the value for the configuration attribute defaultVisibility 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.
e
EventFacade
sourceMap of entry sources to their visibility status. Update a particular sources's visibility by setting the subattribute to true (visible) or false (hidden).
For example, yconsole.filter.set('sources.slider', false) to hide log entries originating from Y.Slider.
sourceChange
Fires when the value for the configuration attribute source 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.
e
EventFacade