Class GlobalFunctions

Object
   |
   +--GlobalFunctions

class GlobalFunctions

st_addListener

<static>  <private> Object st_addListener(obj,evtName,func,capture)

Adds func as an event listener for the evtName specified to the object indicated. For W3C compliant browsers, capturing (instead of bubbling) can also be indicated.

Parameters:
obj - The object to which the function should be added.
evtName - The short event name for which to listen. This should be specified in lower case. For example, "load" will listen for the load/onload event.
func - The name of the previously defined event handler function which will be called when the event is fired on obj.
capture - Optional parameter which defaults to true. If true, then the event handler will fire in the capturing phase (W3C compliant browsers only), otherwise, the event will fire in the bubbling phase.

Returns:
Returns true if all parameters passed are valid. False is returned if a parameter type does not match what is expected.

st_clct

<static>  <private> Object st_clct(e)

st_clct Collects data from items on the page that have been instrumented for data collection. private

st_debugPrint

<static>  <private> Object st_debugPrint()

st_getVisitorID

<static>  <private> String st_getVisitorID(sC,sV)

This function should not be overridden, as it returns the visitor ID by querying existing cookies for a prior visitor ID, or by creating a new one.

Returns:
the Visitor ID.

st_init

<static> void st_init()

This method loads configuration settings for tagging as well as the SAS, site, and page-defined data elements. It then initializes the tagging code, and collects data for the page from which it is called. This function should be called once per page, at any point after the page tagging code (SASTag.js) has been included.

st_instFrms

<static>  <private> void st_instFrms(i)

private

st_instLnks

<static>  <private> void st_instLnks(i,d)

private

st_onLoad

<static>  <private> void st_onLoad(e)

This function is called each time a page is loaded, or when the user uses the browser's navigation buttons (back/forward) to return to the page. This is NOT called if the user switches tabs.

st_onUnload

<static>  <private> void st_onUnload(e)

This function is called each time a page is unloaded, or when the user uses the browser's navigation buttons (back/forward) to leave a page. This function is an empty function because non-IE browser's will not run onLoad when forward/back-ing to a page if an unload was not registered for the page.

st_pageCfg

<static> void st_pageCfg()

This function can be defined by the user within an individual page to change configuration values related to that specific page.

It is called by st_init() after the default configuration is loaded, and after st_siteCfg() loads the site-specific configuration.

st_pageDats

<static> void st_pageDats()

This function can be defined by the user to change the set of data elements that will be collected for that specific page.

This function is called by st_init() after the default data collection elements are defined, and after site-wide data elements are defined.

st_redoAction

<static>  <private> Object st_redoAction()

Repeats the original user action stored in the request object.

Returns:
Returns false if a non-IE handler called prevent default.

st_sar

<static> boolean st_sar(<String> o)

When tracking actions on an object in a page, this function determines if a stop-and-re-click should occur for the object in question. By default, stop-and-re-click is enabled.

Standard behavior is to collect data on a click, stop the click event, and then re-click after data has been collected. In circumstances where this behavior would not result in the desired result, stop-and-re-click can be controlled by defining st_sar(), and returning true or false to enable or disable, respectively, stop-and-re-click for the object on which the action occured.

To define and enable this functionality:

1. First, ensure that the element is being tracked. See st_cfg.cap and st_trk().
2. Define the tracking stop-and-re-click decision function in SASSiteConfig.js, modifying the function to conditionally return the appropriate value. For example:
   

    function st_sar(o)	{
     switch(o.nodeName.toLowerCase())
     {
        case 'a':  // Link elements
           if ( o.href.indexOf('action=watch')>0  // MediaWiki watch/unwatch button handling
             || o.href.indexOf('action=unwatch')>0)
              return false;
           else
              return true;
           break;
        default:
           return true;
     }
    

Parameters:
o - Object to check

Returns:
Returns true if data should be collected using stop-and-re-click. False, otherwise.

See:
- ST_Cfg.cap
- st_trk()

st_sd

<static>  <private> void st_sd(<String> k,<String> v,<integer> m)

Sets an element's value, defining the element if it is not defined.

Parameters:
k - The key name to set
v - The key value to set
m - The bitmask controlling when this is collected

st_siteCfg

<static> void st_siteCfg()

This function can be defined by the user to change configuration values related to a specific site.

This function is called by st_init() after the default configuration is loaded, and before st_pageCfg() loads the page-specific configuration.

st_siteDats

<static> void st_siteDats()

This function can be defined by the user to change the set of data elements that will be collected for a specific site.

This function is called by st_init() after the default data collection elements are defined, and before st_pageDats() defines page-specific data elements.

st_trk

<static> boolean st_trk(<object> o)

This function defines the condition(s) under which the object o will be tracked, and is called to determine if the specified object should be instrumented for data collection.

Links (HTML element: A)

This function is called for link tracking only if st_cfg.cap['L'] is blank (the default).

The user can define this function to modify the conditions under which links will be tracked.

This function serves as a more flexible replacement for tracking by file extension (provided by the st_cfg.cap['L'] setting.)

If st_cfg.cap['L'] is blank and this function is not defined, all links will be tracked. This is the default behavior.

To define and enable this functionality:

1. Ensure that st_cfg.cap['L'] is blank (the default). Doing so simultaneously turns off tracking by extension and turns on the use of the tracking function.

   NOTE: If you have previously added code to set the value of st_cfg.cap['L'] to something other than blank, either remove/modify this code, or set st_cfg.cap['L'] to blank after the prior code, as follows:
   

    st_cfg.cap['L']='';
    

2. Define the tracking decision function in SASSiteConfig.js, modifying the function to conditionally return the appropriate value:
   

    function st_trk(o)	
    {
       switch(o.nodeName.toLowerCase())
    	  {
          case 'a':  // Link elements
             return true;
             break;
          default:
             return true;
       }
    }
    

Other HTML element types

The st_trk function is only supported for controlling link tracking decisions.
Other HTML element types will be supported by this function in the future.

Parameters:
o - The DOM object for which a tracking decision needs to be made.

Returns:
true if the object should be tracked, false otherwise.

See:
- ST_Cfg.cap
- st_sar()