# @embedpdf/react — ./render 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; } RenderLayer [FunctionDeclaration]: export function RenderLayer(props: RenderLayerProps ={ } ){ const page = usePage(); const painter = useSelector(RenderToken, (render) => render.getPicturePainter()); if (painter?.paints(page.view)){ return } />; } return ; } RenderLayerProps [InterfaceDeclaration]: export interface RenderLayerProps{ annotations?: boolean; formFields?: boolean; tiles?: boolean; thumbnail?: boolean; } 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; } SnapshotLayer [FunctionDeclaration]: export function SnapshotLayer(){ const page = usePage(); const box = useOptionalSelector(RenderToken, (render) => render.getSnapshotBox(page.ref), null); const colors = useRenderSettings((settings) => settings.snapshot.box); const accent = useViewerSettings((settings) => settings.accent); if (!box) return null; const{ left, top, width, height} = rectInPixels(box, page.transform); return ( ); } SnapshotMenu [FunctionDeclaration]: export function SnapshotMenu({ children, gap = 8, placement = 'bottom'} : SnapshotMenuProps){ const snapshot = useSnapshot(); const anchor = useMemo( () => snapshot &&{ page: snapshot.page, bounds: snapshot.rect} , [snapshot], ); if (!anchor) return null; return ( { children} ); } SnapshotMenuProps [InterfaceDeclaration]: export interface SnapshotMenuProps{ children: React.ReactNode; gap?: number; placement?: AnchoredPlacement; } 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} ; } renderCommands [VariableDeclaration] (from packages/framework/react/src/command-lists.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)) ); } usePictureState [FunctionDeclaration]: export function usePictureState(): PictureState{ const page = usePage(); return useOptionalSelector( RenderPublicToken, (render) => render.getPictureState(page.ref, page.view), NO_PICTURE, ); } useRender [FunctionDeclaration]: export function useRender(): RenderCapability{ return useCapability(RenderPublicToken); } useRenderEvent [FunctionDeclaration]: export function useRenderEvent( select: (render: RenderCapability) => EventHook, handler: (event: T) => void, ): void{ useCapabilityEvent(RenderPublicToken, select, handler); } useRenderSettings [VariableDeclaration]: useRenderSettings = settingsHook(RenderPublicToken) useSnapshot [FunctionDeclaration]: export function useSnapshot(): Snapshot | null{ return useOptionalSelector(RenderPublicToken, (render) => render.getSnapshot(), null); }