angulartics2

angulartics2

Version 13.0.0
Published 2 months ago
923 kB
1 dependency
MIT license

Install

npm i angulartics2

yarn add angulartics2

pnpm add angulartics2

Overview

Vendor-agnostic web analytics for Angular2 applications

Index

Variables

variable ANGULARTICS2_TOKEN

const ANGULARTICS2_TOKEN: InjectionToken<Angulartics2Token>;

Classes

class AngularRouterTracking

class AngularRouterTracking implements RouterlessTracking {}

Track Route changes for applications using Angular's default router
https://angular.io/api/router/Router

constructor

constructor(router: Router, location: Location);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<AngularRouterTracking, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<AngularRouterTracking>;

method prepareExternalUrl

prepareExternalUrl: (url: string) => string;

method trackLocation

trackLocation: (settings: any) => Observable<TrackNavigationEnd>;

class Angulartics2

class Angulartics2 {}

constructor

constructor(tracker: RouterlessTracking, setup: Angulartics2Token);

property eventTrack

eventTrack: ReplaySubject<Partial<EventTrack>>;

property exceptionTrack

exceptionTrack: ReplaySubject<any>;

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2>;

property pageTrack

pageTrack: ReplaySubject<Partial<PageTrack>>;

property setAlias

setAlias: ReplaySubject<string>;

property setSuperProperties

setSuperProperties: ReplaySubject<any>;

property setSuperPropertiesOnce

setSuperPropertiesOnce: ReplaySubject<any>;

property settings

settings: Angulartics2Settings;

property setUsername

setUsername: ReplaySubject<string | { userId: string | number }>;

property setUserProperties

setUserProperties: ReplaySubject<any>;

property setUserPropertiesOnce

setUserPropertiesOnce: ReplaySubject<any>;

property userTimings

userTimings: ReplaySubject<UserTimings>;

method clearUrl

protected clearUrl: (url: string) => string;

Removes id's from tracked route. EX: /project/12981/feature becomes /project/feature
Parameter url
current page path

method filterDeveloperMode

filterDeveloperMode: <T>() => MonoTypeOperatorFunction<T>;

filters all events when developer mode is true

method matchesExcludedRoute

protected matchesExcludedRoute: (url: string) => boolean;

Use string literals or regular expressions to exclude routes from automatic pageview tracking.
Parameter url
location

method trackUrlChange

protected trackUrlChange: (url: string) => void;

class Angulartics2AdobeAnalytics

class Angulartics2AdobeAnalytics {}

constructor

constructor(angulartics2: Angulartics2, location: Location);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2AdobeAnalytics, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2AdobeAnalytics>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

Track Event in Adobe Analytics
Parameter action
associated with the event
Parameter properties
action detials
https://marketing.adobe.com/resources/help/en_US/sc/implement/js_implementation.html

method pageTrack

pageTrack: (path: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2Amplitude

class Angulartics2Amplitude {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Amplitude, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Amplitude>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUsername

setUsername: (userId: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2AppInsights

class Angulartics2AppInsights {}

constructor

constructor(angulartics2: Angulartics2, title: Title, router: Router);

property dimensions

dimensions: { [name: string]: string };

property loadStartTime

loadStartTime: number;

property loadTime

loadTime: number;

property measurements

measurements: { [name: string]: number };

property metrics

metrics: { [name: string]: number };

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2AppInsights, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2AppInsights>;

method eventTrack

eventTrack: (name: string, properties: { [name: string]: string }) => void;

Log a user action or other occurrence.
Parameter name
Name to identify this event in the portal.
Parameter properties
Additional data used to filter events and metrics in the portal. Defaults to empty.
https://github.com/Microsoft/ApplicationInsights-JS/blob/master/API-reference.md#trackevent

method exceptionTrack

exceptionTrack: (properties: any) => void;

Exception Track Event in GA
Parameter properties
Comprised of the mandatory fields 'appId' (string), 'appName' (string) and 'appVersion' (string) and optional fields 'fatal' (boolean) and 'description' (string), error
https://github.com/Microsoft/ApplicationInsights-JS/blob/master/API-reference.md#trackexception

method pageTrack

pageTrack: (path: string) => void;

Page Track in Baidu Analytics
Parameter path
Location 'path'
https://github.com/Microsoft/ApplicationInsights-JS/blob/master/API-reference.md#trackpageview

method setUsername

setUsername: (userId: string) => void;

https://github.com/Microsoft/ApplicationInsights-JS/blob/master/API-reference.md#setauthenticatedusercontext

method setUserProperties

setUserProperties: (
    properties: Partial<{ userId: string; accountId: string }>
) => void;

method startTimer

startTimer: () => void;

method startTracking

startTracking: () => void;

method stopTimer

stopTimer: () => void;

class Angulartics2BaiduAnalytics

class Angulartics2BaiduAnalytics {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2BaiduAnalytics, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2BaiduAnalytics>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

Track Event in Baidu Analytics
Parameter action
Name associated with the event
Parameter properties
Comprised of: - 'category' (string) - 'opt_label' (string) - 'opt_value' (string)
http://tongji.baidu.com/open/api/more?p=ref_trackEvent

method pageTrack

pageTrack: (path: string) => void;

Page Track in Baidu Analytics
Parameter path
Required url 'path'
http://tongji.baidu.com/open/api/more?p=ref_trackPageview

method setUsername

setUsername: (userId: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2Clicky

class Angulartics2Clicky {}

constructor

constructor(angulartics2: Angulartics2, titleService: Title);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Clicky, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Clicky>;

method eventOrGoalTrack

eventOrGoalTrack: (
    action: string,
    properties: Partial<ClickyProperties>
) => void;

Track Event Or Goal in Clicky
Parameter action
Action name
Parameter properties
Definition of 'properties.goal' determines goal vs event tracking
https://clicky.com/help/custom/manual#log https://clicky.com/help/custom/manual#goal

method pageTrack

pageTrack: (path: string) => void;

Track Page in Clicky
Parameter path
location
https://clicky.com/help/custom/manual#log

method startTracking

startTracking: () => void;

class Angulartics2Facebook

class Angulartics2Facebook {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Facebook, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Facebook>;

method eventTrack

eventTrack: (action: string, properties?: any) => void;

Send interactions to the Pixel, i.e. for event tracking in Pixel
Parameter action
action associated with the event

method startTracking

startTracking: () => void;

class Angulartics2GoogleAnalytics

class Angulartics2GoogleAnalytics {}

constructor

constructor(angulartics2: Angulartics2);

property dimensionsAndMetrics

dimensionsAndMetrics: any[];

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2GoogleAnalytics, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2GoogleAnalytics>;

property settings

settings: Partial<GoogleAnalyticsSettings>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

Track Event in GA
Parameter action
Associated with the event
Parameter properties
Comprised of: - category (string) and optional - label (string) - value (integer) - noninteraction (boolean)
https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide#SettingUpEventTracking https://developers.google.com/analytics/devguides/collection/analyticsjs/events

method exceptionTrack

exceptionTrack: (properties: any) => void;

Exception Track Event in GA
Parameter properties
Comprised of the optional fields: - fatal (string) - description (string)
@https://developers.google.com/analytics/devguides/collection/analyticsjs/exceptions
https://developers.google.com/analytics/devguides/collection/analyticsjs/events

method pageTrack

pageTrack: (path: string) => void;

method setUsername

setUsername: (userId: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

method userTimings

userTimings: (properties: UserTimings) => void;

User Timings Event in GA
Parameter properties
Comprised of the mandatory fields: - timingCategory (string) - timingVar (string) - timingValue (number) Properties can also have the optional fields: - timingLabel (string)
https://developers.google.com/analytics/devguides/collection/analyticsjs/user-timings

class Angulartics2GoogleAnalyticsEnhancedEcommerce

class Angulartics2GoogleAnalyticsEnhancedEcommerce {}

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<
    Angulartics2GoogleAnalyticsEnhancedEcommerce,
    never
>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2GoogleAnalyticsEnhancedEcommerce>;

method ecAddImpression

ecAddImpression: (
    properties: Partial<GaEnhancedEcomImpressionFieldObject>
) => void;

Add impression in GA enhanced ecommerce tracking https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce#measuring-activities

method ecAddProduct

ecAddProduct: (product: Partial<GaEnhancedEcomProductFieldObject>) => void;

Add product in GA enhanced ecommerce tracking https://developers.google.com/analytics/devguides/collection/analyticsjs/ecommerce

method ecSetAction

ecSetAction: (
    action: GaEnhancedEcomAction,
    properties: Partial<GaEnhancedEcomActionFieldObject>
) => void;

Set action in GA enhanced ecommerce tracking https://developers.google.com/analytics/devguides/collection/analyticsjs/ecommerce

class Angulartics2GoogleGlobalSiteTag

class Angulartics2GoogleGlobalSiteTag {}

constructor

constructor(angulartics2: Angulartics2);

property angulartics2

protected angulartics2: Angulartics2;

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2GoogleGlobalSiteTag, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2GoogleGlobalSiteTag>;

method eventTrack

eventTrack: (action: string, properties?: Partial<EventGst>) => void;

Send interactions to gtag, i.e. for event tracking in Google Analytics. See:
https://developers.google.com/analytics/devguides/collection/gtagjs/events
Parameter action
associated with the event

method exceptionTrack

exceptionTrack: (properties: any) => void;

Exception Track Event in GST. See:
https://developers.google.com/analytics/devguides/collection/gtagjs/exceptions

method pageTrack

pageTrack: (path: string) => void;

Manually track page view, see:
https://developers.google.com/analytics/devguides/collection/gtagjs/single-page-applications#tracking_virtual_pageviews
Parameter path
relative url

method setUsername

setUsername: (userId: string | { userId: string | number }) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

method userTimings

userTimings: (properties: UserTimingsGst) => void;

User Timings Event in GST.
Parameter properties
Comprised of the mandatory fields: - name (string) - value (number - integer) Properties can also have the optional fields: - category (string) - label (string)
https://developers.google.com/analytics/devguides/collection/gtagjs/user-timings

class Angulartics2GoogleTagManager

class Angulartics2GoogleTagManager {}

constructor

constructor(angulartics2: Angulartics2);

property angulartics2

protected angulartics2: Angulartics2;

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2GoogleTagManager, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2GoogleTagManager>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

Send interactions to the dataLayer, i.e. for event tracking in Google Analytics
Parameter action
associated with the event

method exceptionTrack

exceptionTrack: (properties: any) => void;

Exception Track Event in GTM

method pageTrack

pageTrack: (path: string) => void;

method pushLayer

pushLayer: (layer: any) => void;

Send Data Layer
data layer object

method setUsername

setUsername: (userId: string) => void;

Set userId for use with Universal Analytics User ID feature
Parameter userId
used to identify user cross-device in Google Analytics

method startTracking

startTracking: () => void;

class Angulartics2GoSquared

class Angulartics2GoSquared {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2GoSquared, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2GoSquared>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2Hubspot

class Angulartics2Hubspot {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Hubspot, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Hubspot>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2IBMDigitalAnalytics

class Angulartics2IBMDigitalAnalytics {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2IBMDigitalAnalytics, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2IBMDigitalAnalytics>;

method eventTrack

eventTrack: (action: string, properties?: any) => void;

Track an event in IBM Digital Analytics
Parameter action
A string corresponding to the type of event that needs to be tracked.
Parameter properties
The properties that need to be logged with the event.

method pageTrack

pageTrack: (path: string) => void;

Track Page in IBM Digital Analytics
Parameter path
location
https://www.ibm.com/support/knowledgecenter/SSPG9M/Implementation/impl_pageviewtag.html

method startTracking

startTracking: () => void;

class Angulartics2Intercom

class Angulartics2Intercom {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Intercom, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Intercom>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2Kissmetrics

class Angulartics2Kissmetrics {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Kissmetrics, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Kissmetrics>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUsername

setUsername: (userId: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2LaunchByAdobe

class Angulartics2LaunchByAdobe {}

constructor

constructor(angulartics2: Angulartics2);

property angulartics2

protected angulartics2: Angulartics2;

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2LaunchByAdobe, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2LaunchByAdobe>;

property payload

payload: any;

method eventTrack

eventTrack: (action: string, properties: any) => void;

Parameter action
associated with the event
Parameter properties
associated with the event

method pageTrack

pageTrack: (path: string) => void;

method setUsername

setUsername: (userId: string | boolean) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2Matomo

class Angulartics2Matomo {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Matomo, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Matomo>;

method deletedUserProperties

deletedUserProperties: (
    properties: DeleteCustomVariableMatomoProperties
) => void;

If you created a custom variable and then decide to remove this variable from a visit or page view, you can use deleteCustomVariable.
https://developer.matomo.org/guides/tracking-javascript-guide#deleting-a-custom-variable

method eventTrack

eventTrack: {
    (
        action: 'setEcommerceView',
        properties: SetEcommerceViewMatomoProperties
    ): void;
    (action: 'addEcommerceItem', properties: AddEcommerceItemProperties): void;
    (
        action: 'trackEcommerceCartUpdate',
        properties: TrackEcommerceCartUpdateMatomoProperties
    ): void;
    (
        action: 'trackEcommerceOrder',
        properties: TrackEcommerceOrderMatomoProperties
    ): void;
    (action: 'trackLink', properties: TrackLinkMatomoProperties): void;
    (action: 'trackGoal', properties: TrackGoalMatomoProperties): void;
    (
        action: 'trackSiteSearch',
        properties: TrackSiteSearchMatomoProperties
    ): void;
    (action: string, properties: TrackEventMatomoProperties): void;
};

method pageTrack

pageTrack: (path: string, title?: string) => void;

method resetUser

resetUser: () => void;

method setUsername

setUsername: (userId: string | boolean) => void;

method setUserProperties

setUserProperties: (
    properties: SetCustomVariableMatomoProperties | DimensionsMatomoProperties
) => void;

Sets custom dimensions if at least one property has the key "dimension", e.g. dimension10. If there are custom dimensions, any other property is ignored.
If there are no custom dimensions in the given properties object, the properties object is saved as a custom variable.
If in doubt, prefer custom dimensions. https://matomo.org/docs/custom-variables/

method startTracking

startTracking: () => void;

class Angulartics2Mixpanel

class Angulartics2Mixpanel {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Mixpanel, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Mixpanel>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setAlias

setAlias: (alias: any) => void;

method setSuperProperties

setSuperProperties: (properties: any) => void;

method setSuperPropertiesOnce

setSuperPropertiesOnce: (properties: any) => void;

method setUsername

setUsername: (userId: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method setUserPropertiesOnce

setUserPropertiesOnce: (properties: any) => void;

method startTracking

startTracking: () => void;

class Angulartics2Module

class Angulartics2Module {}

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Module, never>;

property ɵinj

static ɵinj: i0.ɵɵInjectorDeclaration<Angulartics2Module>;

property ɵmod

static ɵmod: i0.ɵɵNgModuleDeclaration<
    Angulartics2Module,
    never,
    [typeof i1.Angulartics2OnModule],
    [typeof i1.Angulartics2On]
>;

method forRoot

static forRoot: (
    settings?: Partial<Angulartics2Settings>
) => ModuleWithProviders<Angulartics2Module>;

class Angulartics2On

class Angulartics2On implements AfterContentInit {}

constructor

constructor(elRef: ElementRef, angulartics2: Angulartics2, renderer: Renderer2);

property angulartics2On

angulartics2On: string;

property angularticsAction

angularticsAction: string;

property angularticsCategory

angularticsCategory: string;

property angularticsLabel

angularticsLabel: string;

property angularticsProperties

angularticsProperties: any;

property angularticsValue

angularticsValue: string;

property ɵdir

static ɵdir: i0.ɵɵDirectiveDeclaration<
    Angulartics2On,
    '[angulartics2On]',
    never,
    {
        angulartics2On: 'angulartics2On';
        angularticsAction: 'angularticsAction';
        angularticsCategory: 'angularticsCategory';
        angularticsLabel: 'angularticsLabel';
        angularticsValue: 'angularticsValue';
        angularticsProperties: 'angularticsProperties';
    },
    {},
    never,
    never,
    false
>;

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2On, never>;

method eventTrack

eventTrack: (event: Event) => void;

method ngAfterContentInit

ngAfterContentInit: () => void;

class Angulartics2OnModule

class Angulartics2OnModule {}

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2OnModule, never>;

property ɵinj

static ɵinj: i0.ɵɵInjectorDeclaration<Angulartics2OnModule>;

property ɵmod

static ɵmod: i0.ɵɵNgModuleDeclaration<
    Angulartics2OnModule,
    [typeof Angulartics2On],
    never,
    [typeof Angulartics2On]
>;

class Angulartics2Pyze

class Angulartics2Pyze {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Pyze, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Pyze>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUserProfile

setUserProfile: (userId: string) => void;

method startTracking

startTracking: () => void;

method updateUserProfile

updateUserProfile: (properties: any) => void;

class Angulartics2RouterlessModule

class Angulartics2RouterlessModule {}

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2RouterlessModule, never>;

property ɵinj

static ɵinj: i0.ɵɵInjectorDeclaration<Angulartics2RouterlessModule>;

property ɵmod

static ɵmod: i0.ɵɵNgModuleDeclaration<
    Angulartics2RouterlessModule,
    never,
    [typeof i1.Angulartics2OnModule],
    never
>;

method forRoot

static forRoot: (
    settings?: Partial<Angulartics2Settings>
) => ModuleWithProviders<Angulartics2RouterlessModule>;

class Angulartics2Segment

class Angulartics2Segment {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Segment, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Segment>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

https://segment.com/docs/libraries/analytics.js/#track
analytics.track(event, [properties], [options], [callback]);

method pageTrack

pageTrack: (path: string) => void;

https://segment.com/docs/libraries/analytics.js/#page
analytics.page([category], [name], [properties], [options], [callback]);

method setAlias

setAlias: (alias: any) => void;

https://segment.com/docs/libraries/analytics.js/#alias
analytics.alias(userId, previousId, options, callback);

method setUserProperties

setUserProperties: (properties: any) => void;

https://segment.com/docs/libraries/analytics.js/#identify
analytics.identify([userId], [traits], [options], [callback]);

method startTracking

startTracking: () => void;

method unsetUserProperties

unsetUserProperties: () => void;

https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#reset--logout
analytics.reset();

class Angulartics2Splunk

class Angulartics2Splunk {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Splunk, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Splunk>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method startTracking

startTracking: () => void;

class Angulartics2Woopra

class Angulartics2Woopra {}

constructor

constructor(angulartics2: Angulartics2);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Angulartics2Woopra, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Angulartics2Woopra>;

method eventTrack

eventTrack: (action: string, properties: any) => void;

method pageTrack

pageTrack: (path: string) => void;

method setUserProperties

setUserProperties: (properties: any) => void;

method startTracking

startTracking: () => void;

class AppInsightsDefaults

class AppInsightsDefaults implements AppInsightsSettings {}

property userId

userId: any;

class DefaultConfig

class DefaultConfig implements Angulartics2Settings {}

property appInsights

appInsights: {};

property developerMode

developerMode: boolean;

property ga

ga: {};

property gst

gst: {};

property gtm

gtm: {};

property pageTracking

pageTracking: {
    autoTrackVirtualPages: boolean;
    basePath: string;
    excludedRoutes: any[];
    clearIds: boolean;
    clearHash: boolean;
    clearQueryParams: boolean;
    idsRegExp: RegExp;
};

class GoogleAnalyticsDefaults

class GoogleAnalyticsDefaults implements GoogleAnalyticsSettings {}

property additionalAccountNames

additionalAccountNames: any[];

property anonymizeIp

anonymizeIp: boolean;

property transport

transport: string;

property userId

userId: any;

class GoogleGlobalSiteTagDefaults

class GoogleGlobalSiteTagDefaults implements GoogleGlobalSiteTagSettings {}

constructor

constructor();

property trackingIds

trackingIds: string[];

class GoogleTagManagerDefaults

class GoogleTagManagerDefaults implements GoogleTagManagerSettings {}

property userId

userId: any;

class RouterlessTracking

class RouterlessTracking {}

method prepareExternalUrl

prepareExternalUrl: (url: string) => string;

method trackLocation

trackLocation: (
    settings: Angulartics2Settings
) => Observable<TrackNavigationEnd>;

Interfaces

interface AddEcommerceItemProperties

interface AddEcommerceItemProperties {}

property price

price: string;

AddEcommerceItemProperties

property productCategory

productCategory: string;

AddEcommerceItemProperties

property productName

productName: string;

AddEcommerceItemProperties

property productSKU

productSKU: string;

AddEcommerceItemProperties

property quantity

quantity: string;

AddEcommerceItemProperties

interface Angulartics2Settings

interface Angulartics2Settings {}

property appInsights

appInsights: Partial<AppInsightsSettings>;

property developerMode

developerMode: boolean;

Disable page tracking

property ga

ga: Partial<GoogleAnalyticsSettings>;

property gst

gst: Partial<GoogleGlobalSiteTagSettings>;

property gtm

gtm: Partial<GoogleTagManagerSettings>;

property pageTracking

pageTracking: Partial<PageTrackingSettings>;

interface Angulartics2Token

interface Angulartics2Token {}

property settings

settings: Partial<Angulartics2Settings>;

interface AppInsightsSettings

interface AppInsightsSettings {}

property userId

userId: string;

interface DeleteCustomVariableMatomoProperties

interface DeleteCustomVariableMatomoProperties {}

property index

index: number;

DeleteCustomVariableMatomoProperties

property scope

scope: ScopeMatomo;

DeleteCustomVariableMatomoProperties

interface DimensionsMatomoProperties

interface DimensionsMatomoProperties {}

property dimension1

dimension1?: string;

property dimension10

dimension10?: string;

property dimension11

dimension11?: string;

property dimension12

dimension12?: string;

property dimension13

dimension13?: string;

property dimension14

dimension14?: string;

property dimension15

dimension15?: string;

property dimension2

dimension2?: string;

property dimension3

dimension3?: string;

property dimension4

dimension4?: string;

property dimension5

dimension5?: string;

property dimension6

dimension6?: string;

property dimension7

dimension7?: string;

property dimension8

dimension8?: string;

property dimension9

dimension9?: string;

interface EventTrack

interface EventTrack {}

property action

action: string;

property properties

properties: any;

interface GoogleAnalyticsSettings

interface GoogleAnalyticsSettings {}

property additionalAccountNames

additionalAccountNames: string[];

array of additional account names (only works for analyticsjs)

property anonymizeIp

anonymizeIp: boolean;

property transport

transport: string;

see https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#transport

property userId

userId: any;

interface GoogleGlobalSiteTagSettings

interface GoogleGlobalSiteTagSettings {}

property anonymizeIp

anonymizeIp?: boolean;

property customMap

customMap?: {
    [key: string]: string;
};

property trackingIds

trackingIds: any;

property userId

userId?: any;

interface GoogleTagManagerSettings

interface GoogleTagManagerSettings {}

property userId

userId: any;

interface PageTrack

interface PageTrack {}

property path

path: string;

interface PageTrackingSettings

interface PageTrackingSettings {}

property autoTrackVirtualPages

autoTrackVirtualPages: boolean;

property basePath

basePath: string;

property clearHash

clearHash: boolean;

drop contents of url after hash marker /callback#authcode=1234 -> /callback

property clearIds

clearIds: boolean;

drop ids from url /sections/123/pages/456 -> /sections/pages

property clearQueryParams

clearQueryParams: boolean;

drop query params from url /sections/123/pages?param=456&param2=789 -> /sections/123/pages

property excludedRoutes

excludedRoutes: (string | RegExp)[];

property idsRegExp

idsRegExp: RegExp;

used with clearIds, define the matcher to clear url parts

interface SetCustomVariableMatomoProperties

interface SetCustomVariableMatomoProperties {}

property index

index: number;

SetCustomVariableMatomoProperties

property name

name: string;

SetCustomVariableMatomoProperties

property scope

scope: ScopeMatomo;

SetCustomVariableMatomoProperties

property value

value: string;

SetCustomVariableMatomoProperties

interface SetEcommerceViewMatomoProperties

interface SetEcommerceViewMatomoProperties {}

property categoryName

categoryName: string;

SetEcommerceViewMatomoProperties

property price

price: string;

SetEcommerceViewMatomoProperties

property productName

productName: string;

SetEcommerceViewMatomoProperties

property productSKU

productSKU: string;

SetEcommerceViewMatomoProperties

interface TrackEcommerceCartUpdateMatomoProperties

interface TrackEcommerceCartUpdateMatomoProperties {}

property grandTotal

grandTotal: string;

TrackEcommerceCartUpdateMatomoProperties

interface TrackEcommerceOrderMatomoProperties

interface TrackEcommerceOrderMatomoProperties {}

property discount

discount: string;

TrackEcommerceOrderMatomoProperties

property grandTotal

grandTotal: string;

TrackEcommerceOrderMatomoProperties

property orderId

orderId: string;

TrackEcommerceOrderMatomoProperties

property shipping

shipping: string;

TrackEcommerceOrderMatomoProperties

property subTotal

subTotal: string;

TrackEcommerceOrderMatomoProperties

property tax

tax: string;

TrackEcommerceOrderMatomoProperties

interface TrackEventMatomoProperties

interface TrackEventMatomoProperties {}

property category

category: string;

TrackEventMatomoProperties

property label

label?: string;

TrackEventMatomoProperties

property name

name?: string;

TrackEventMatomoProperties

property value

value?: number | string;

TrackEventMatomoProperties

interface TrackGoalMatomoProperties

interface TrackGoalMatomoProperties {}

property goalId

goalId: string;

TrackGoalMatomoProperties

property value

value: string;

TrackGoalMatomoProperties

interface TrackLinkMatomoProperties

interface TrackLinkMatomoProperties {}

property linkType

linkType: string;

TrackLinkMatomoProperties

property url

url: string;

TrackLinkMatomoProperties

interface TrackNavigationEnd

interface TrackNavigationEnd {}

property url

url: string;

interface TrackSiteSearchMatomoProperties

interface TrackSiteSearchMatomoProperties {}

property category

category: string;

TrackSiteSearchMatomoProperties

property keyword

keyword: string;

TrackSiteSearchMatomoProperties

property searchCount

searchCount: string;

TrackSiteSearchMatomoProperties

interface UserTimings

interface UserTimings {}

https://developers.google.com/analytics/devguides/collection/analyticsjs/user-timings

property timingCategory

timingCategory: string;

A string for categorizing all user timing variables into logical groups (e.g. 'JS Dependencies').

property timingLabel

timingLabel?: string;

A string that can be used to add flexibility in visualizing user timings in the reports (e.g. 'Google CDN').

property timingValue

timingValue: number;

The number of milliseconds in elapsed time to report to Google Analytics (e.g. 20).

property timingVar

timingVar: string;

A string to identify the variable being recorded (e.g. 'load').

Type Aliases

type EventTrackAction

type EventTrackAction =
    | 'setEcommerceView'
    | 'addEcommerceItem'
    | 'trackEcommerceCartUpdate'
    | 'trackEcommerceOrder'
    | 'trackLink'
    | 'trackGoal'
    | 'trackSiteSearch'
    | string;

type EventTrackactionProperties

type EventTrackactionProperties =
    | SetEcommerceViewMatomoProperties
    | AddEcommerceItemProperties
    | TrackEcommerceCartUpdateMatomoProperties
    | TrackEcommerceOrderMatomoProperties
    | TrackLinkMatomoProperties
    | TrackGoalMatomoProperties
    | TrackSiteSearchMatomoProperties
    | TrackEventMatomoProperties;

type ScopeMatomo

type ScopeMatomo = 'visit' | 'page';

Package Files (32)

Dependencies (1)

tslib

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (3)

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/angulartics2.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/angulartics2)

HTML

<a href="https://www.jsdocs.io/package/angulartics2"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 2 months ago.
Package analyzed in 7087 ms.
Missing or incorrect documentation? Open an issue for this package.

angulartics2

Install

Overview

Index

Variables

Classes

Interfaces

Type Aliases

Variables

variable ANGULARTICS2_TOKEN

Classes

class AngularRouterTracking

property ɵfac

property ɵprov

method prepareExternalUrl

method trackLocation

class Angulartics2

property eventTrack

property exceptionTrack

property ɵfac

property ɵprov

property pageTrack

property setAlias

property setSuperProperties

property setSuperPropertiesOnce

property settings

property setUsername

property setUserProperties

property setUserPropertiesOnce

property userTimings

method clearUrl

Parameter url

method filterDeveloperMode

method matchesExcludedRoute

Parameter url

method trackUrlChange

class Angulartics2AdobeAnalytics

property ɵfac

property ɵprov

method eventTrack

Parameter action

Parameter properties

method pageTrack

method setUserProperties

method startTracking

class Angulartics2Amplitude

property ɵfac

property ɵprov

method eventTrack

method pageTrack

method setUsername

method setUserProperties

method startTracking

class Angulartics2AppInsights

property dimensions

property loadStartTime

property loadTime

property measurements

property metrics

property ɵfac

property ɵprov

method eventTrack

Parameter name

Parameter properties

method exceptionTrack

Parameter properties

method pageTrack

Parameter path

method setUsername

method setUserProperties

method startTimer

method startTracking

method stopTimer

class Angulartics2BaiduAnalytics

property ɵfac

property ɵprov

method eventTrack

Parameter action

Parameter properties

method pageTrack