Skip to content

TrackIt Options Overview

hikirsch edited this page Sep 14, 2010 · 12 revisions

There are tons of options that are supported within TrackIt. All of the supported options are below. These options are all passed in as an object as the 2nd parameter of the $.TrackIt constructor.

One of the following two options is required.

Options Description Example
XmlUrl The URL in which to load the data, see TrackIt - Data - XML Example. /Assets/xml/TrackIt.xml
data The data always in JSON form. See TrackIt - Data - JSON Example

The following options are available for debugging purposes.

Options Description Default Value
TestMode Whether or not TrackIt will report to the reporting tool. false
TrackKeyAttribute The attribute used to look for on elements when an event is fired. The value of this attribute is the track key. trackKey
ShowMissingHolderWarnings TrackIt can show a warning in console depending on whether or not a holder that was defined is missing. false
ShowDebugInfo TrackIt will log to console during many of its key processing areas to help the developer figure out what is being tracked and what data is being passed. This value is independent of TestMode, meaning you can enable debug info outside of test mode. false
SanityCheckEnabled TrackIt can scan all of the data and its holders to ensure that all of the holders are defined correctly. An object will show in console with a true/false value on a holders for each track key. false
SanityCheckMissingOnly The sanity check will return a true/false value for all holders in all track keys by default. This option will allow you to hide all holders that are valid making it easier to see what holders are missing. false
ShowOnlyReportedData An override for ShowDebugInfo, this will forcefully show all of the data that was passed. false