# @embedpdf/angular — ./render EpdfRender [ClassDeclaration] (from packages/framework/angular/render/src/render.ts): @Injectable({ providedIn: 'root'} ) export class EpdfRender extends pluginService({ name: 'EpdfRender', feature: 'withRender()', token: RenderToken, methods: [ 'canRender', 'renderPage', 'renderThumbnail', 'renderPages', 'getRenderPolicy', 'getRenderEpoch', 'invalidate', 'getPictureState', 'canSnapshot', 'getSnapshot', 'clearSnapshot', ], events: ['onInvalidated', 'onPictureStateChanged', 'onSnapshotChanged'], } ){ } EpdfRenderLayer [ClassDeclaration] (from packages/framework/angular/render/src/render-layer.ts): @Component({ selector: 'epdf-render-layer', imports: [EpdfPainterBox, EpdfTilePlane], changeDetection: ChangeDetectionStrategy.OnPush, template: ` @if (painting(); as painter){ } @else{ @if (tiles() && !thumbnail() && paintSettings().tiles && layers(); as drawn){ } } `, } ) export class EpdfRenderLayer{ readonly annotations = input(undefined); readonly formFields = input(undefined); readonly tiles = input(true); readonly thumbnail = input(false, { transform: booleanAttribute} ); private readonly page = injectPage(''); private readonly render = renderOf(this.page, ''); private readonly painter = this.render.select( (render) => render.getPicturePainter(), null, Object.is, ); protected readonly painting = computed(() =>{ const painter = this.painter(); return painter?.paints(this.page.view) ? (painter as PicturePainter) : null; } ); protected readonly paintSettings = this.render.select( (render) => render.getPaintSettings(), NO_PAINT_SETTINGS, Object.is, ); private readonly parts = computed(() => ({ annotations: this.annotations(), formFields: this.formFields(), } )); private readonly painted = injectPaintedParts(() => this.page.ref); private readonly may = this.render.select((render) => render.getLayerRights(), null, Object.is); protected readonly layers = computed(() =>{ if (this.painting()) return null; const painted = this.painted(); const may = this.may(); return painted && may ? pictureLayerOptionsOf(painted, this.parts(), may) : null; } ); private readonly sourceKey = this.render.select( (render) =>{ const layers = this.layers(); return layers ? render.getSourceKey(this.page.ref, { scale: this.page.transform().renderScale, ...(this.thumbnail() ?{ thumbnail: true} :{ } ), ...layers, } ) : null; } , null, Object.is, ); private readonly picture = viewChild>('picture'); private report: OpenPictureReport | null = null; constructor(){ effect(() =>{ const painted = this.painted(); if (this.painting()) return; if (painted && partsDrawnTwice(painted, this.parts()).length > 0){ devWarn( 'render-layer-draws-what-a-layer-paints', ' or [formFields] draws what an ' + ' or an on the page paints too, so it shows ' + 'twice. Leave the input out: the picture leaves out what a layer paints.', ); } } ); if (!isPlatformBrowser(inject(PLATFORM_ID))) return; effect((onCleanup) =>{ const render = this.render.capability(); const element = this.picture()?.nativeElement; const page = this.page.ref; const view = this.page.view; if (!render || !element) return; const report = untracked(() => render.reportPicture(view, page)); this.report = report; const stop = whenPresented(element, () => report.shown()); onCleanup(() =>{ stop(); report.close(); if (this.report === report) this.report = null; } ); } ); effect((onCleanup) =>{ const render = this.render.capability(); const key = this.sourceKey(); const layers = this.layers(); if (!render || key === null || !layers) return; const controller = new AbortController(); let revoke: (() => void) | undefined; onCleanup(() =>{ controller.abort(); revoke?.(); } ); const scale = untracked(() => this.page.transform().renderScale); const asked = untracked(() => (this.thumbnail() ?{ thumbnail: true} :{ } )); void (async () =>{ try{ const image = await render.renderSource(this.page.ref, { scale, ...asked, ...layers, view: this.page.view, signal: controller.signal, } ); const objectUrl = await image.objectUrl().abortWith(controller.signal); if (controller.signal.aborted){ objectUrl.revoke(); return; } const element = this.picture()?.nativeElement; if (!element){ objectUrl.revoke(); return; } revoke = objectUrl.revoke; element.src = objectUrl.url; } catch (error){ if (!controller.signal.aborted) this.report?.failed(error); } } )(); } ); } } EpdfSnapshotLayer [ClassDeclaration] (from packages/framework/angular/render/src/snapshot-layer.ts): @Component({ selector: 'epdf-snapshot-layer', changeDetection: ChangeDetectionStrategy.OnPush, template: ` @if (pixels(); as box){ } `, } ) export class EpdfSnapshotLayer{ private readonly page = injectPage(''); private readonly host = injectKernelHost(''); private readonly render = new CapabilityBinding( this.host, () => RenderToken, () => this.page.documentId, ); private readonly box = this.render.select((render) => render.getSnapshotBox(this.page.ref), null); private readonly colors = this.render.select( (render) => render.getSettings().snapshot.box, RENDER_DEFAULTS.snapshot.box, ); protected readonly dash = SNAPSHOT_BOX_DASH; protected readonly pixels = computed(() =>{ const box = this.box(); return box && rectInPixels(box, this.page.transform()); } ); protected readonly boxStyle = computed(() => snapshotBoxPaint(this.colors(), this.host.viewerSettings().accent), ); } EpdfSnapshotMenu [ClassDeclaration] (from packages/framework/angular/render/src/snapshot-menu.ts): @Component({ selector: 'epdf-snapshot-menu', imports: [EpdfAnchored], changeDetection: ChangeDetectionStrategy.OnPush, template: ` `, } ) export class EpdfSnapshotMenu{ readonly placement = input('bottom'); readonly gap = input(8); private readonly render = new CapabilityBinding( injectKernelHost(''), () => RenderToken, injectDocumentScope(), ); private readonly snapshot = this.render.select((render) => render.getSnapshot(), null); protected readonly anchor = computed(() =>{ const snapshot = this.snapshot(); return snapshot &&{ page: snapshot.page, bounds: snapshot.rect} ; } ); } FullPageSettings [InterfaceDeclaration] (from packages/plugin/render/src/paint-plan.ts): export interface FullPageSettings{ maxWidth?: number; quantize?: 'exact' | readonly number[]; } InvalidateOptions [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface InvalidateOptions{ pages?: readonly (PageRef | number)[]; scope?: InvalidateScope; } InvalidateScope [TypeAliasDeclaration] (from packages/plugin/render/src/contract.ts): export type InvalidateScope = 'content' | 'annotations' | 'fields'; PageImage [TypeAliasDeclaration] (from packages/plugin/render/src/contract.ts): export type PageImage = PageImageHandle; PageLayerOptions [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PageLayerOptions{ includeAnnotations?: boolean; includeFormFields?: boolean; } PageRender [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PageRender{ readonly page: PageRef; readonly image: PageImage; } PageViewDemand [InterfaceDeclaration] (from packages/plugin/render/src/paint-plan.ts): export interface PageViewDemand{ desiredDeviceWidth: number; visibleRect?: Rect; velocity?:{ dx: number; dy: number} ; } PaintedPicture [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PaintedPicture{ update(page: PicturePage): void; destroy(): void; } PicturePage [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PicturePage{ readonly ref: PageRef; readonly pageIndex: number; readonly view: string; readonly transform: PageTransform; readonly getViewDemand?: () => PageViewDemand; } PicturePainter [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PicturePainter{ paints(view: string): boolean; paint(host: Host, page: PicturePage, report: PictureReport): PaintedPicture; } PictureReport [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PictureReport{ shown(): void; failed(error: unknown): void; } PictureState [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PictureState{ readonly status: ResourceStatus; readonly slow: boolean; } PictureStateChangedEvent [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface PictureStateChangedEvent extends PictureState{ readonly page: PageRef; readonly view: string; } RENDER_DEFAULTS [VariableDeclaration] (from packages/plugin/render/src/contract.ts): RENDER_DEFAULTS: RenderSettings ={ fullPage:{ maxWidth: 640, quantize: 'exact'} , tiles:{ size: 512, quantize: 'exact', maxScale: 128, bleedPx: 1, prefetch:{ margin: 0.5, velocityBias: true} , settleMs: 150, } , format: null, quality: null, slowAfterMs: 400, debug: false, snapshot:{ scale: 2, box:{ fill: null, stroke: null} } , } RenderCapability [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface RenderCapability extends SettingsApi{ canRender(): boolean; canRenderThumbnail(): boolean; renderPage(page: PageRef | number, options?: RenderPageOptions): Promise; renderThumbnail(page: PageRef | number, options?: RenderThumbnailOptions): Promise; renderPages( pages: readonly (PageRef | number)[], options?: RenderPagesOptions, ): Promise>; getRenderPolicy(): EngineRenderPolicy; getRenderEpoch(page: PageRef | number, layers?: PageLayerOptions): number; invalidate(options?: InvalidateOptions): void; readonly onInvalidated: EventHook; getPictureState(page: PageRef | number, view: string): PictureState; readonly onPictureStateChanged: EventHook; handOverPictures(painter: PicturePainter): () => void; getPicturePainter(): PicturePainter | null; canSnapshot(): boolean; getSnapshot(): Snapshot | null; clearSnapshot(): void; readonly onSnapshotChanged: EventHook; } RenderConfig [TypeAliasDeclaration] (from packages/plugin/render/src/contract.ts): export type RenderConfig = DeepPartial; RenderFormat [TypeAliasDeclaration] (from packages/plugin/render/src/contract.ts): export type RenderFormat = NonNullable; RenderInvalidatedEvent [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface RenderInvalidatedEvent{ readonly pages: readonly PageRef[]; readonly scope: InvalidateScope; readonly origin: EventOrigin | null; } RenderPageOptions [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface RenderPageOptions extends OperationOptions, PageLayerOptions{ width?: number; scale?: number; rect?: Rect; rotation?: Rotation; format?: RenderFormat; quality?: number; } RenderPagesOptions [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface RenderPagesOptions extends Omit{ concurrency?: number; } RenderSettings [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface RenderSettings{ readonly fullPage: FullPageSettings; readonly tiles: TilesSettings | false; readonly format: RenderFormat | null; readonly quality: number | null; readonly slowAfterMs: number; readonly debug: boolean; readonly snapshot: SnapshotSettings; } RenderThumbnailOptions [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface RenderThumbnailOptions extends OperationOptions, PageLayerOptions{ format?: RenderFormat; quality?: number; } RenderToken [VariableDeclaration] (from packages/plugin/render/src/token.ts): RenderToken = createCapabilityToken('render', { hint: `add renderPlugin() from '@embedpdf/plugin-render' to your plugins list`, promises:{ renderPage: true, renderThumbnail: true, renderPages: true, } , } ) SNAPSHOT_MAX_PIXELS [VariableDeclaration] (from packages/plugin/render/src/contract.ts): SNAPSHOT_MAX_PIXELS = 16_000_000 SNAPSHOT_TOOL [VariableDeclaration] (from packages/plugin/render/src/contract.ts): SNAPSHOT_TOOL = 'snapshot' Snapshot [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface Snapshot{ readonly page: PageRef; readonly rect: Rect; readonly image: Promise; } SnapshotBoxLook [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface SnapshotBoxLook{ readonly fill: string | null; readonly stroke: string | null; } SnapshotChangedEvent [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface SnapshotChangedEvent{ readonly snapshot: Snapshot | null; } SnapshotSettings [InterfaceDeclaration] (from packages/plugin/render/src/contract.ts): export interface SnapshotSettings{ readonly scale: number; readonly box: SnapshotBoxLook; } TilesSettings [InterfaceDeclaration] (from packages/plugin/render/src/paint-plan.ts): export interface TilesSettings{ size?: number; quantize?: 'exact' | readonly number[]; maxScale?: number; bleedPx?: number; engageRatio?: number; prefetch?:{ margin?: number; velocityBias?: boolean; } ; settleMs?: number; } ViewDemandInput [InterfaceDeclaration] (from packages/plugin/render/src/paint-plan.ts): export interface PageViewDemand{ desiredDeviceWidth: number; visibleRect?: Rect; velocity?:{ dx: number; dy: number} ; } injectPictureState [FunctionDeclaration] (from packages/framework/angular/render/src/render.ts): export function injectPictureState(): Signal{ const page = injectPage('A component that calls injectPictureState()'); return new CapabilityBinding( injectKernelHost('injectPictureState()'), () => RenderToken, () => page.documentId, ).select((render) => render.getPictureState(page.ref, page.view), NO_PICTURE, Object.is); } renderCommands [VariableDeclaration] (from packages/framework/angular/render/src/commands.ts): renderCommands = createRenderCommands(standardCommandsBrowser) renderPlugin [VariableDeclaration] (from packages/plugin/render/src/render.plugin.ts): renderPlugin = (config?: RenderConfig) => definePlugin({ id: 'render', scope: 'document', token: RenderToken, optional: [InteractionToken], state: initialRenderState, settings:{ defaults: RENDER_DEFAULTS, registered: config, whole: ['snapshot.box']} , create: createRenderController, } ) samePageViewDemand [FunctionDeclaration] (from packages/plugin/render/src/paint-plan.ts): export function samePageViewDemand(left: PageViewDemand, right: PageViewDemand): boolean{ return ( left.desiredDeviceWidth === right.desiredDeviceWidth && left.velocity?.dx === right.velocity?.dx && left.velocity?.dy === right.velocity?.dy && (left.visibleRect === right.visibleRect || (left.visibleRect !== undefined && right.visibleRect !== undefined && left.visibleRect.x === right.visibleRect.x && left.visibleRect.y === right.visibleRect.y && left.visibleRect.width === right.visibleRect.width && left.visibleRect.height === right.visibleRect.height)) ); } withRender [FunctionDeclaration] (from packages/framework/angular/render/src/render.ts): export function withRender(options?: RenderConfig): EmbedPdfFeature{ return{ plugins: [renderPlugin(options)], services: [EpdfRender]} ; }