Browser Tracker API Reference
High level overview of all the APIs available in the Browser Tracker.
General
Public interfaces and APIs.
Low-level
Location Taggers
APIs to factor and bind the appropriate LocationContext instance to the target TaggableElement via Tagging Attributes.
- tagChildren
- tagContent
- tagExpandable
- tagInput
- tagLink
- tagMediaPlayer
- tagNavigation
- tagOverlay
- tagPressable
- tagRootLocation
Low-level
Event Trackers
Events are triggered automatically based on the Location Context bound to the Tagged Element, as summarised in this table.
Nonetheless, sometimes it may be preferable, or necessary, to trigger Events programmatically.
Interactive
- trackPressEvent
- trackHiddenEvent
- trackInputChangeEvent
- trackMediaEvent
- trackMediaLoadEvent
- trackMediaPauseEvent
- trackMediaStartEvent
- trackMediaStopEvent
- trackVisibility
- trackVisibleEvent
Non-interactive
Low-level
Mutation Observer
Mutation Observer and auto-tracking related functions. All of these APIs are internal.
- AutoTrackingState
- makeBlurEventHandler
- makeClickEventHandler
- makeMutationCallback
- processTagChildrenElement
- trackNewElement
- trackNewElements
- trackRemovedElement
- trackRemovedElements
- trackVisibilityHiddenEvent
- trackVisibilityVisibleEvent
Common
Common modules and helper functions used across the whole Browser Tracker. All of these APIs are internal.
Factories
- makeBrowserTrackerDefaultPluginsList
- makeBrowserTrackerDefaultQueue
- makeBrowserTrackerDefaultTransport
Guards
- isClickableContext
- isFlushQueueOptions
- isLocationContext
- isLocationTaggerParameters
- isParentTaggedElement
- isShowableContext
- isTagChildrenElement
- isTaggableElement
- isTaggedElement
- isTagLocationAttributes
- isTagLocationOptions
- isTagLocationParameters.md
- isTrackBlursAttribute
- isTrackClicksAttribute
- isTrackVisibilityAttribute
- isValidateAttribute
- isValidChildrenTaggingQuery
- isWaitUntilTrackedOptions
Parsers
- parseJson
- parseLocationContext
- parseTagChildren
- parseTrackBlurs
- parseTrackClicks
- parseTrackVisibility
- parseValidate
Stringifiers
- stringifyJson
- stringifyLocationContext
- stringifyTagChildren
- stringifyTrackBlurs
- stringifyTrackClicks
- stringifyTrackVisibility
- stringifyValidate
Miscellaneous
- compareTrackerConfigs
- findParentTaggedElements
- getElementLocationStack
- getLocationHref
- objectivWindowInterface
- runIfValueIsNotUndefined
- trackerErrorHandler
Definitions
Common TypeScript definitions.
- BrowserTrackerConfig
- ChildrenTaggingQueries
- ChildrenTaggingQuery
- FlushQueueOptions
- GuardableElement
- LocationContext
- LocationTaggerParameters
- ParentTaggedElement
- TagLocationAttributes
- TagChildrenAttributes
- TagChildrenElement
- TagChildrenReturnValue
- TaggableElement
- TaggedElement
- TaggingAttribute
- TagLinkParameters
- TagLocationOptions
- TagLocationReturnValue
- TrackBlursAttribute
- TrackBlursOptions
- TrackClicksAttribute
- TrackClicksOptions
- TrackedElement
- TrackerErrorHandlerCallback
- TrackVisibilityAttribute
- ValidateAttribute
- WaitForQueueOptions
- WaitUntilTrackedOptions
Queues
Tracker Queues and related modules
Transports
Tracker Transports
Core
Core Tracker modules and functions.
This documentation section is a work-in-progress. Not all the Core Tracker functionality is fully described here, yet.