PDF Atelier Logo

PDF Atelier

disableAnalytics

Flag to enable or disable telemetry collection and usage tracking.

Prop

Type

By default, minimal telemetry is collected to help improve the product. Enabling this flag ensures no data is sent to the telemetry server for general usage.

How it Works

The disableAnalytics property controls the internal PdfTelemetry service. This service reports usage patterns and technical health metrics to help us maintain and improve the library.

What is Tracked?

When telemetry is active (default), the component collects:

  • Usage Patterns: Tracks which tools (draw, highlight, text) are used most frequently.
  • Success Rates: Records successful vs. failed PDF exports to monitor engine reliability.
  • Performance: Measures document loading times and rendering performance across different browsers.

Privacy & Security

We prioritize your privacy and the security of your documents:

  • No Document Content: The telemetry service never reads or transmits the actual content, text, or images within your PDF files.
  • Anonymized Data: All usage data is not tied to user-identifiable information (PII) like names or IP addresses is stored.
  • Local Control: All tracking logic happens client-side and is immediately terminated if disableAnalytics is set to true.

Critical Error Reporting

To ensure the stability of the core engine, critical system crashes and fatal exceptions may still be reported even when disableAnalytics is enabled. This "Force Send" mechanism is used exclusively for debugging breaking bugs that prevent the component from functioning.

Implementation

<pdf-atelier
  disable-analytics="true"
  src="/document.pdf"
></pdf-atelier>
<PDFAtelier
  src="/document.pdf"
  disableAnalytics={true}
/>
@Component({
  standalone: true,
  selector: 'app-pdf',
  imports: [PdfAtelierWrapper],
  template: `
    <pdf-atelier-wrapper
      [src]="'/document.pdf'"
      [disableAnalytics]="true"
    ></pdf-atelier-wrapper>
  `,
})
export class MyComponent {}
<template>
  <PdfAtelierWrapper
    :src="'/document.pdf'"
    :disableAnalytics="true"
  />
</template>

On this page