Interface Engagement

interface Engagement {
    engagementDurationTillTrigger: number;
    engagementType: EngagementType;
    selectionDistanceTraveled?: {
        selectedText?: string;
        x: number;
        y: number;
    };
    totalMouseDistanceTraveled: {
        x: number;
        y: number;
    };
}

Properties

engagementDurationTillTrigger engagementType selectionDistanceTraveled? totalMouseDistanceTraveled

Properties

engagementDurationTillTrigger

engagementDurationTillTrigger: number

Total duration in ms till the engagement triggered.

engagementType

engagementType: EngagementType

Engagement type

Optional selectionDistanceTraveled

selectionDistanceTraveled?: {
    selectedText?: string;
    x: number;
    y: number;
}

If the engagementType is "interaction" and this object has a value, you can assume it as a text selection. If the engagementType is "interaction" but this object is not defined, you can assume it as a click

Type declaration

  • Optional selectedText?: string
  • x: number
  • y: number

totalMouseDistanceTraveled

totalMouseDistanceTraveled: {
    x: number;
    y: number;
}

Total mouse movement in x and y directions till the engagement triggered. To avoid confusion: this is not the distance between start and end points, this is the total traveled distance.

Type declaration

  • x: number
  • y: number

Settings

Member Visibility

Theme

On This Page

engagementDurationTillTriggerengagementTypeselectionDistanceTraveledtotalMouseDistanceTraveled