Interface IClickAnalyticsConfiguration

ClickAnalytics Configuration

interface IClickAnalyticsConfiguration {
    autoCapture?: boolean;
    behaviorValidator?: ((value: string | number) => string | number);
    callback?: IValueCallback;
    coreData?: ICoreData;
    dataTags?: ICustomDataTags;
    defaultRightClickBhvr?: string | number;
    dropInvalidEvents?: boolean;
    pageTags?: {
        [name: string]:
            | string
            | number
            | boolean
            | string[]
            | number[]
            | boolean[]
            | object;
    };
    trackElementTypes?: string;
    urlCollectHash?: boolean;
    urlCollectQuery?: boolean;
}

Properties

autoCapture? behaviorValidator? callback? coreData? dataTags? defaultRightClickBhvr? dropInvalidEvents? pageTags? trackElementTypes? urlCollectHash? urlCollectQuery?

Properties

OptionalautoCapture

autoCapture?: boolean

Automatic capture configuration. Default is true

OptionalbehaviorValidator

behaviorValidator?: ((value: string | number) => string | number)

Validator to use for the data-bhvr value

Optionalcallback

callback?: IValueCallback

Callbacks configuration

OptionalcoreData

coreData?: ICoreData

Core data configuration

OptionaldataTags

dataTags?: ICustomDataTags

Custom Data Tags provided to ovverride default tags used to capture click data.

OptionaldefaultRightClickBhvr

defaultRightClickBhvr?: string | number

Default Behavior value when Right Click event has occured. This value will be ovverriden if the element has the data-*-bhvr attribute present.

OptionaldropInvalidEvents

dropInvalidEvents?: boolean

Flag to drop events that do not have custom event names, no parentId and no data in content (basically no useful click data). Default will be false

OptionalpageTags

pageTags?: {
    [name: string]:
        | string
        | number
        | boolean
        | string[]
        | number[]
        | boolean[]
        | object;
}

Page tags

OptionaltrackElementTypes

trackElementTypes?: string

A list of element types to track. Default is "undefined" which means default elements ["a", "button", "area", "input"] are tracked. If set, it will combine with the default element types.

OptionalurlCollectHash

urlCollectHash?: boolean

Enables the logging of values after a "#" character of the URL. Default is "false."

OptionalurlCollectQuery

urlCollectQuery?: boolean

Enables the logging of the query string of the URL. Default is "false."

Settings

Member Visibility

On This Page

Properties