Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Option #1 – auto bootstrapping

...

Eventgiven in the example is a test one and it uses default configuration (colors, fonts and other visual components) which cannot be changed by passing another configuration id. Final (production) configuration could be customized according to customer expectations.

Option#2 – manual initialization and tracker management

...


Example 1

trackerGenerator.create('#trak', 'tracker1', 1653325, 169, {
useMappedId:'1',
})

To switch between yours ids or ours ids on the fly, you can use following methods on tracker object:

  • useRegularEventId()

  • useMappedEventId()

After using those methods remember to change event id and call refresh method.


Example 2 

var tracker = trackerGenerator.get({string} identifyingName);
tracker.useRegularEventId().setEvent({number} new event id).refresh();

...

Example 1:
trackerGenerator.create('#trak', 'tracker1', 1653325, 169, {
lang:'pl',
timezone:'Local',
configuration:{
showHeader: true
}
});

Available configuration options

Option

Description

showHeader


Type: "default" {string}

Possible values:

  • true
  • false

     bool

    This option decide about tracker header visibility

    showTimeline


    Type:  "default" {string}

    Possible values:

    • true
    • false

    bool

    This option decide about tracker timeline visibility

    showAds


    Type:  "default" {string}

    Possible values:

    • true
    • false

    bool

    This option decide about tracker advertisment visibility

    mainMenu


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table separated by comma

    Here you can specify which tabs should be shown in main box

    additionalMenu


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table separated by comma

    Here you can specify which tabs should be shown in additional box (this is right box in horizontal mode or lower box in vertical mode) This configuration is available only when your template has 2 boxes.

    basicRelationMainMenu


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table separated by comma

    This option is the same as mainMenu but its considered only in basic relation mode. By default basic relation uses BasicEvent instead of Event tab.

    basicRelationAdditionalMenu


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table separated by comma

    This option is same as additionalMenu but its considered only in basic relation mode.

    mainBoxInitializationTab


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table

    This configuration decide which tab should be loaded as first on tracker initialization

    additionalBoxInitializationTab


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table

    This configuration decide which tab should be loaded as first  in additional box on tracker initialization

    mainBoxBasicRelationInitializationTab


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table

    This option is same as mainBoxInitializationTab but its considered only in basic relation mode.

    additionalBoxBasicRelationInitializationTab


    Type: "default" {string}

    Possible values: 
    Tab names from TabList table

    This option is same as additionalBoxInitializationTab but its considered only in basic relation mode.

    leftBannerImg


    Type: string

    Url to image which should be used as left banner on Live tab. It should be valid url to image resource hosted under https protocol. Note that not every configuration supports ads on Live tab and showAds option should be enabled for this to work.

    Image Added

    leftBannerLink


    Type: string

    Url which user is redirected to after he clicks on left banner

    rightBannerImg


    Type: string

    Url to image which should be used as right banner on Live tab. It should be valid url to image resource hosted under https protocol. Note that not every configuration supports ads on Live tab and showAds option should be enabled for this to work.

    Image Added

    rightBannerLink


    Type: string

    Url which user is redirected to after he clicks on right banner


    Example 2 - change visability

    trackerGenerator.create('#trak', 'tracker1', 1653325, 169, {
    configuration:{
    showHeader: false,
    showAds: false
    }
    })

    BEFORE:

    ...