Back to docs index

# Name

MochiKit.LoggingPane - Interactive MochiKit.Logging pane

# Synopsis

    // open a pop-up window
    createLoggingPane()
    // use a div at the bottom of the document
    createLoggingPane(true);

# Description

MochiKit.Logging does not have any browser dependencies and is completely unobtrusive. MochiKit.LoggingPane is a browser-based colored viewing pane for your MochiKit.Logging output that can be used as a pop-up or inline.

It also allows for regex and level filtering! MochiKit.LoggingPane is used as the default MochiKit.Logging.debuggingBookmarklet() if it is loaded.

# Dependencies

- MochiKit.Base
- MochiKit.Logging

# API Reference

## Constructors

LoggingPane(inline=false, logger=MochiKit.Logging.logger):

> A listener for a MochiKit.Logging logger with an interactive DOM representation.

> If `inline` is `true`, then the `LoggingPane` will be a `DIV` at the bottom of the document. Otherwise, it will be in a pop-up window with a name based on the calling page's URL. If there is an element in the document with an id of `_MochiKit_LoggingPane`, it will be used instead of appending a new `DIV` to the body.

> `logger` is the reference to the MochiKit.Logging.Logger to listen to. If not specified, the global default logger is used.

> Properties:

> > `win`:
> >   Reference to the pop-up window (`undefined` if `inline`)
> > `inline`:
> >   `true` if the `LoggingPane` is inline
> > `colorTable`:

> >   An object with property->value mappings for each log level and its color. May also be mutated on `LoggingPane.prototype` to affect all instances. For example:

> >       MochiKit.LoggingPane.LoggingPane.prototype.colorTable = {
> >           DEBUG: "green",
> >           INFO: "black",
> >           WARNING: "blue",
> >           ERROR: "red",
> >           FATAL: "darkred"
> >       };

> Availability:
>   Available in MochiKit 1.3.1+

LoggingPane.prototype.closePane():

> Close the LoggingPane (close the child window, or remove the `_MochiKit_LoggingPane` `DIV` from the document).

> Availability:
>   Available in MochiKit 1.3.1+

## Functions

createLoggingPane(inline=false):

> Create or return an existing LoggingPane for this document with the given inline setting. This is preferred over using LoggingPane directly, as only one LoggingPane should be present in a given document.

> Availability:
>   Available in MochiKit 1.3.1+

# Authors

- Bob Ippolito <bob@redivi.com>

# Copyright

Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.