CStatApp

static factory(nameopt)

Factory of child class singleton, to be defined in Customization JS.

static getInstance() → {CStatApp}

Statistics Application's Page singleton accessor.

activate()

Trackers activation (i.e. markers injection), triggered on DOMContentLoaded.
By default: activate search clicks tracking, then other events tracking (Download, Navigation, Exit, Action)
Note: calling it twice or more is useless without reinitialisation of tracker objects.

Example

Super.activate=this.activate;
this.activate=function()
{
   Super.activate.call(this);
   // Raise GTM event 
   window.dataLayer=window.dataLayer||[];
   dataLayer.push({event:'pageActivation'});            
};

activateOnLoad()

Activations to perform once page loaded.
Can be overriden in completion to On Load option, which already recalls CStatApp.activate
By default: does nothing.

Example

this.activateOnLoad=function()
{
   // Wait for lazy loadings
   stat_link.waitRefresh();
};

beginSalesOrder(fp)

Sales order initialization.
By default: does nothing

Parameters:

Example

this.beginSalesOrder = function(fp)
{
    //TODO: Sales order
};

beginSalesProduct(pdt, an)

Product initialization.
By default: does nothing

Parameters:

Example

this.beginSalesProduct = function(pdt, an)
{
    //TODO:  
};

beginSearch(fp)

Search tracking initialization.
By default: does nothing

Parameters:

Example

this.beginSearch = function(fp)
{
    //TODO:
};

beginVideo(fp)

Entry point before videos collection
By default: does nothing.

Parameters:

Example

Super.getVideoTheme = this.getVideoTheme;
this.beginVideo = function(fp)
{
    //TODO:
};

beginVisitor(fp)

Visitor tracking initialization.
By default: does nothing.

Parameters:

Example

this.beginVisitor = function(fp)
{
    //TODO:
};

endSalesOrder(fp)

Sales order completion & checking.
By default: does nothing

Parameters:

Example

this.endSalesOrder = function(fp)
{
    //TODO:  
};

endSalesProduct(pdt, an)

Product completion & checking.
By default: does nothing

Parameters:

Example

this.endSalesProduct = function(pdt, an)
{
    //TODO:  
};

endSearch(fp)

Parameters:

Example

this.endSearch = function(fp)
{
    //TODO:
};

endVideo(fp)

Entry point after videos collection
By default: does nothing.

Parameters:

Example

this.endVideo = function(fp)
{
    //TODO: 
};

endVisitor(fp)

Visitor tracking completion & checking.
By default: does nothing.

Parameters:

Example

Super.getVideoTheme = this.getVideoTheme;
this.endVisitor = function(fp)
{
    //TODO:
};

getAccountPath(p) → {string}

Retrieve the Path to be compared with Production Path Root.
In case of additional leading folders, don't forget to start by /
By default: return unchanged path.

Parameters:

Deprecated:

• Use CStatApp.getProductionPath

getCookie(cookieName) → {string}

Shortcut to retrieve cookie value.
By default: call stat_data.getCookie
Can be overriden to transform the value, for example in case of JSON string.

Parameters:

getExtraChapter() → {string}

Allows changing in Page names the separator used to replace :: when the number of chapter is greater than 3.
It is used only by Page names, so it doesn't impact any click nor event name, except when they embed Page name with %x: in this case the Extra Chapter is used to replace all chapter separators.
By default: "_" in all Page names

Example

// Use | as extra chapter separator
this.getExtraChapter = function()
{
    return '|';
};

getExtraLeaf() → {string}

Declare a value to be removed from an ATI page tag name when found as leaf name (when there are chapters).
It is used only by Page names, so it doesn't impact any click nor event name.
By default: empty string (no removal).

Example

// Remove '::undefined' from Page Names
this.getExtraLeaf = function()
{
    return 'undefined';
};

getLevel2Path(p) → {string}

Retrieve the path name to be compared with Perimeter Path.
By default: return unchanged path.

Parameters:

Deprecated:

• Use CStatApp.getPerimeterPath

getLinkName(href, type) → {string}

Control default click names for links when nothing specified in configuration NAME column.
By default: return stat_link.getLinkNameNc

Parameters:

Example

Super.getLinkName=this.getLinkName;
this.getLinkName=function(href, type)
{
   // By default, return the target path for Navigation links  
   return ((type==='N' && href)? getUrlArray(href)[3]:Super.getLinkName.call(this, href, type);          
};

getLinkNodeName(node, type, eopt) → {string}

Retrieve the click tag name corresponding to a given node.
By default: return stat_link.getLinkNodeNameNc

Parameters:

Example

Super.getLinkNodeName=this.getLinkNodeName;
this.getLinkNodeName=function(node,type,e)
{
    // Use a library function std_doc.getDocName for all Downloads with no name configured, mother call for all other cases
    return (type === 'T' && !stat_link.getNodeNamePattern(node))? std_doc.getDocName(node) : Super.getLinkNodeName.call(this,node,type,e);
};

getName() → {string}

Retrieve application's name (to be implemented in inherited classes), for Multiple Levels of Inheritance.
By default: Throw an error
It can deduct the application name itself, or rely on the previous calls to CStatApp.setPathName

this.name='';
this.getName=function(){return this.name;};

getNodeLabel(node) → {string}

Allows controlling the way a text is retrieved from a node when # is used in an event name
Called by stat_link.getNameChapter. It doesn't change other values extraction.
By default: call stat_dom.getNodeText, then remove all ? and & in text (if any)

Parameters:

Example

Super.getNodeLabel=this.getNodeLabel;
this.getNodeLabel=function(node)
{
   // Always return 'nolabel' if no text  
   return (Super.getNodeLabel.call(this, node) || 'nolabel');          
};

getPerimeterPath(p) → {string}

Retrieve the Path to be compared with Perimiter Path Root, by adding virtual folders or move/remove existing ones.
In case of additional leading folders, don't forget to start by /
By default: return unchanged path.

Parameters:

Example

this.getPerimeterPath=function(p)
{
    // Add app URL parameter value  as a virtual folder, 'other' if not exist
    return '/'+(getPageParam('app')||'other')+p;
};

getProductionPath(p) → {string}

Retrieve the Path to be compared with Production Path Root, by adding virtual folders or move/remove existing ones.
In case of additional leading folders, don't forget to start by /
By default: return unchanged path.

Parameters:

See:

• getCustomPath

Example

this.getProductionPath=function(p)
{
    // Add hostname extension containing country as a virtual folder
    return '/'+window.location.hostname.split('.').slice(-1)[0]+p;
};

getSearchPos(node)

Retrieve result click position.
By default: return stat_search.getSearchPosNc

Parameters:

Example

Super.getSearchPos = this.getSearchPos;
this.getSearchPos = function(fp)
{
    var pos=Super.getSearchPos.call(this, node);
    //TODO: Modify default
};

getVideoPattern(fp)

Allows controlling the pattern used to recognize a YouTube video.
By default: return nothing, so that default pattern 'www.youtube.com/embed/' is used

Parameters:

Example

this.getVideoPattern = function(fp)
{
    return 'www.youtube.com/embed/';
};

getVideoTheme(fp)

Retrieve current video Theme
By default: return stat_video.getThemeNc

Parameters:

Example

Super.getVideoTheme = this.getVideoTheme;
this.getVideoTheme = function(fp)
{
    var defTheme=Super.getVideoTheme.call(this, fp);
    //TODO: Modify default
};

initSalesProducts(fp)

Sales Product initialization (fill stat_sales.Products).
By default: does nothing

Parameters:

Example

this.initSalesProducts = function(fp)
{
    //TODO:  
};

isExcluded(fp) → {boolean}

Ask if current page is not allowed to raise a content tag.
By default: return false (only pages with ! as first character name are excluded)

Parameters:

Example

// Exclude content tag coming from iframe
this.isExcluded = function(fp)
{
    return (window.self !== window.top);
};

isExitLink(u) → {boolean}

Allows custom handling of Outbound links identification.
By default: return stat_link.isExitLink(u, true)

Parameters:

Example

Super.isExitLink=this.isExitLink;
this.isExitLink=function(u)
{
   // Don't consider as exit if subdomains are the same  
   return (Super.isExitLink.call(this, u) && getUrlArray()[1]!==getUrlArray(u)[1]);          
};

onVideoEvent(e)

Video Event handler
By default: does nothing.

Parameters:

Example

this.onVideoEvent = function(fp)
{
    //TODO: Custom handler
};

raiseClickTag(lname, type, node, eopt) → {boolean}

Raise the click tag. Can be override to modify the event or prevent it.
By default: return stat_link.raiseClickTag

Parameters:

Example

Super.raiseClickTag=this.raiseClickTag;
this.raiseClickTag=function(lname,type,node,e)
{
    // Prevent bubbled events
    return (!e || node===e.target)? Super.raiseClickTag.call(this,lname,type,node,e) : false;
};

setParams(fp)

Entry point to complete ATI parameters.
By default: does nothing

Parameters:

Example

this.setParams = function(fp)
{
    // Following migration to text visitor ID, ensure numeric one is no longer cached in a cookie.
    stat_visitor.resetCookieNumeric(); 
};

setParamsGA(ga)

Entry point to complete GA parameters. Don't use with GA Mirroring.
By default: does nothing

Parameters:

Example

this.setParamsGA = function(ga)
{
    // Allow domains linking 
    if (ga) {ga.push(['_setAllowLinker', true]);}
};

setPathName(p)

Set application name from current path name, for Multiple Levels of Inheritance.
By default: does nothing.
Stored name must be returned by CStatApp.getName, so that it can be used by CStatApp.factory

this.setPathName=function(p)
{
    // Use third folder (after /country/language) as application name, "home" by default
    var ap=p.split('/');
    this.name=(ap.length>3 && ap[3])?ap[3]:'home';
};