Pysar 0.1.38

There is a newer version of this package available.
See the version list below for details.
dotnet add package Pysar --version 0.1.38
                    
NuGet\Install-Package Pysar -Version 0.1.38
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Pysar" Version="0.1.38" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Pysar" Version="0.1.38" />
                    
Directory.Packages.props
<PackageReference Include="Pysar" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Pysar --version 0.1.38
                    
#r "nuget: Pysar, 0.1.38"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Pysar@0.1.38
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Pysar&version=0.1.38
                    
Install as a Cake Addin
#tool nuget:?package=Pysar&version=0.1.38
                    
Install as a Cake Tool

Pysar

Pysar is a report engine for .NET: you describe a paginated document once — in XAML markup or with a fluent C# builder — hand it your data, and get back a vector PDF, a set of bitmap pages, or a scrollable, zoomable view inside your application.

This package is the core: the report element tree, data binding, and the SkiaSharp measurement, pagination, rendering and PDF engine. Add Pysar.Xaml for declarative .rxaml markup and one Pysar.<Platform> package for an in-app report view.

var report = ReportBuilder.Create("Hello report")
    .WithPageFormat(new PageFormat { Margin = new Thickness(30) })
    .WithDetail(detail => detail.AddElement(new Text { Content = "Hello from Pysar" }))
    .Build();

await new SkiaReportRenderer().SavePdfAsync(report, "hello.pdf");

What you get

A report is a vertical stack of bands — report header, page header, detail, page footer, report footer — and the detail band is the one that repeats over your data. Inside a band you compose the usual layout primitives: Grid, StackPanel, Frame, Text, Image, plus Repeater for nested master-detail groups.

  • Two authoring styles, one object model. .rxaml markup (package Pysar.Xaml) for reports with a fixed shape, the fluent builder for reports whose structure is computed at runtime. They produce the same tree and can be mixed.
  • Data binding with {Binding}, string formats, value converters and data triggers for conditional formatting. Bindings resolve once, at build time — a report is a document, not a UI.
  • Real pagination. Detail rows are sliced across pages, detail headers can repeat on every page, page bands are re-resolved per page, and PageNumber / PageCount are available to bindings and to an OnPageChangedAsync hook.
  • Vector PDF output — text stays selectable and sharp at any zoom — plus bitmap page rendering at an arbitrary scale.

Everything is measured in points (1/72"). A4 portrait is 595.5 × 842 pt.

Exporting to PDF

SkiaReportRenderer writes the built report as a vector PDF. Build() must run first; a report can only be built once, so build right before you export:

using Pysar.Skia;

report.Build();

// straight to a file
await new SkiaReportRenderer().SavePdfAsync(report, "invoice.pdf");

// or onto any stream, e.g. an HTTP response body
await new SkiaReportRenderer().RenderToPdfAsync(report, httpContext.Response.Body);

// or as an in-memory byte array, e.g. to attach to an email
byte[] pdfBytes = await new SkiaReportRenderer().RenderToPdfBytesAsync(report);

Requirements

  • .NET 10 SDK
  • SkiaSharp native assets for the target platform (the platform packages bring the right ones)
  • A platform implementation of IReportPlatformHandler for file and font access — DefaultReportPlatformHandler reads assets from the application directory, and the platform packages install one for their own asset source

A consumer names at most three packages: Pysar always, Pysar.Xaml for reports written in .rxaml markup, and one platform package for the target UI framework.

Package Responsibility
Pysar.Xaml Declarative report markup: the runtime loader and the code-behind source generator
Pysar.Maui .NET MAUI integration: app-package assets, font registration, PDF export and sharing
Pysar.Avalonia Avalonia integration: avares:// assets, font registration and the report view
Pysar.Blazor Blazor integration: the report viewer component, printing through the browser
Pysar.Wpf WPF integration (Windows only): pack/manifest assets, font registration and the report view

Pysar.Viewer — the framework-neutral viewer logic — is not referenced directly; it arrives transitively with a platform package.

One rule worth knowing up front

Report.Build() mutates the report tree: it resolves bindings, expands repeaters and applies triggers. A Report instance can therefore be built once. Create or load a new instance for each document — building the same one twice throws.

Documentation

License

MIT — see LICENSE.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Pysar:

Package Downloads
Pysar.Viewer

Framework-neutral logic for a paginated report viewer: page geometry, zoom, tile planning and the tile cache.

Pysar.Xaml

Runtime XAML loader for Pysar: parses and constructs report objects from declarative markup.

Pysar.Maui

.NET MAUI integration for Pysar: application-package asset access, font registration, PDF export and sharing.

Pysar.Uno

Uno Platform integration for Pysar: application asset access, font registration, a scrollable, zoomable report view, PDF printing and sharing.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.63 99 10/1/2026
0.1.56 231 9/20/2026
0.1.53 141 9/20/2026
0.1.46 149 9/18/2026
0.1.44 150 9/16/2026
0.1.41 150 9/15/2026
0.1.38 142 9/14/2026
0.1.34 141 9/13/2026
0.1.31 146 9/11/2026
0.1.24 151 9/6/2026
0.1.10 141 8/30/2026
0.1.0 146 8/30/2026

### Added
- `Pysar.Uno`: a new platform package for [Uno Platform](https://platform.uno/). One `net10.0` target covers every Uno Skia host - Desktop, WebAssembly, Android and iOS - and it brings the same `ReportView` the other platform packages do: a scrollable, zoomable viewer that rasterises only the visible region, so memory follows the viewport rather than the zoom level. Built against Uno 6.7.
- `PysarUno.Use(assembly, configure)` / `PysarUno.UseAsync(...)` (`Pysar.Uno`): registration for an Uno application, called from `OnLaunched`. A static entry point rather than a service registration, because an Uno application has no service collection of its own unless it also uses Uno.Extensions. Returns the handler, and exposes the shared `PysarUno.Renderer` and `PysarUno.ExportService`.
- `UnoReportPlatformHandler` and `UnoAssetFileSystem` (`Pysar.Uno`): report assets are read from embedded resources whose `LogicalName` is the path the report asks for. Embedded rather than `ms-appx:///` because font registration, `ResourceDictionary` sources and image loading all read synchronously, and blocking on Uno's asynchronous `StorageFile` deadlocks the single-threaded WebAssembly host. `UnoAssetFileSystem.PreloadAsync` fetches `Content`-packaged assets once at startup for applications that would rather keep them that way.
- `UnoReportPrinter` (`Pysar.Uno`): desktop printing through the same vector PDF pipeline as export - the macOS Print panel via PDFKit, the shell print verb on Windows, the default viewer on Linux. Android, iOS and WebAssembly throw `PlatformNotSupportedException`; produce the bytes through `PysarUno.ExportService` and share or download them from the application.
- `MacPinchMonitor` and `MacMagnifyEventArgs` (`Pysar.Core.Platform`, in `Pysar`): an AppKit local event monitor for `NSEventTypeMagnify`, now public and shared by every host that needs it. No user-interface framework tested surfaces a trackpad pinch as a gesture on macOS - it arrives as plain wheel deltas indistinguishable from a two-finger scroll - so a trackpad zoom has to come from AppKit directly. `Start`/`Stop` are no-ops on every other platform.

### Changed
- `MacPinchMonitor` moved from `Pysar.Avalonia`, where it was internal, into `Pysar`. Behaviour is unchanged for Avalonia applications; the type is simply no longer duplicated per host. It is plain P/Invoke against libobjc with no dependency on any user-interface framework, which is why it belongs beside `MacOsPdfPrint` in the core package.
- HarfBuzzSharp moves from 14.2.0 to 14.2.1.1 across every package, managed wrapper and native assets together. Required by Uno, and applied as a family because a split between the managed wrapper and its native assets is a startup crash rather than a build error.
- Docs: the quick start and README now cover Uno alongside the other platforms, including the two places it deviates - registration is `PysarUno.Use` rather than `UsePysar`/`AddPysar`, and assets are embedded resources rather than package URIs.

### Notes
- `Pysar.Uno 0.1.35-preview`, published earlier to the internal feed, is superseded and should not be used. It required an `Uno.WinUI` prerelease that no released `Uno.Sdk` provides, so no standard Uno application could consume it. This release targets stable Uno 6.7 instead and ships as an ordinary stable package.
- The Uno report view has been exercised on macOS Desktop - loading, pagination, zoom modes, and trackpad pinch. Its other hosts (WebAssembly, Android, iOS) build from the same single target but have not yet been run.