Pysar.Xaml
0.1.53
See the version list below for details.
dotnet add package Pysar.Xaml --version 0.1.53
NuGet\Install-Package Pysar.Xaml -Version 0.1.53
<PackageReference Include="Pysar.Xaml" Version="0.1.53" />
<PackageVersion Include="Pysar.Xaml" Version="0.1.53" />
<PackageReference Include="Pysar.Xaml" />
paket add Pysar.Xaml --version 0.1.53
#r "nuget: Pysar.Xaml, 0.1.53"
#:package Pysar.Xaml@0.1.53
#addin nuget:?package=Pysar.Xaml&version=0.1.53
#tool nuget:?package=Pysar.Xaml&version=0.1.53
Pysar.Xaml
Declarative report markup for Pysar, a cross-platform report
engine for .NET: this package contains the runtime .rxaml loader and the code-behind source
generator. It depends on the core Pysar package, which carries the element tree, data binding and
the SkiaSharp rendering and PDF engine.
.rxaml is Pysar's markup dialect: an XML document that describes a report the same way the fluent
builder does, using the same elements (Grid, StackPanel, Frame, Text, Image, Repeater)
and the same bands. It is the better fit for a report with a fixed shape — an invoice, a statement, a
certificate — because the layout stays readable as a tree instead of a chain of method calls, and it
is what makes a report editable by someone who is not writing C#: a template stored in a database, or
edited through the design-time preview in Rider and VS Code.
<Report xmlns="https://mriyalab.com/pysar" x:DataType="local:Invoice">
<PageFormat Size="A4" Margin="30" />
<ReportHeaderBand>
<Text Content="{Binding Company.Name}" FontSize="18" FontStyle="Bold" />
</ReportHeaderBand>
<DetailBand DataSource="{Binding Items}">
<DetailBand.DetailHeader>
<Text Content="Product" FontStyle="Bold" />
</DetailBand.DetailHeader>
<Grid ColumnDefinitions="*, 80, 80">
<Text Grid.Column="0" Content="{Binding Product}" />
<Text Grid.Column="1" Content="{Binding Quantity}" />
<Text Grid.Column="2" Content="{Binding Total, StringFormat='{0:C}'}">
<Text.Triggers>
<DataTrigger Binding="{Binding Total}" CompareType="GreaterThan" Value="1000">
<Setter Member="FontColor" Value="Chocolate" />
</DataTrigger>
</Text.Triggers>
</Text>
</Grid>
</DetailBand>
</Report>
An .rxaml report supports the same binding system as the object model: {Binding Path} against the
element's data context, string formats, value converters, and DataTrigger for conditional
formatting. A DataSource on DetailBand (or any Repeater) puts its children in a per-item scope
over the bound collection, with an optional DetailHeader and DetailFooter that stay in the outer
scope.
Loading at runtime
Reports can be loaded at runtime, which is what a template stored in a database or edited by a user needs:
using Pysar.Xaml;
var report = ReportXaml.Load("""
<Report xmlns="https://mriyalab.com/pysar">
<PageFormat Size="A4" Margin="30" />
<DetailBand>
<Text Content="Hello from XAML" />
</DetailBand>
</Report>
""");
report.Build();
Code-behind source generator
For application projects, the source generator uses the standard x:Class directive to provide
generated InitializeComponent(), strongly typed x:Name fields, and compiled object construction.
The generator ships inside this package as an analyzer and is wired up automatically through
build/Pysar.Xaml.props — no separate analyzer reference is needed. Every .rxaml file in the
project is picked up automatically; set <EnableDefaultReportItems>false</EnableDefaultReportItems>
to list them yourself. Resources, styles, and triggers currently use the runtime-loader fallback.
Compile-time binding validation
Any element accepts the MAUI-style directive x:DataType="local:Invoice" to declare the
data-context type of a scope. The hint is design-time only — it is ignored when the report is
loaded — and is inherited by child elements until another element declares its own;
x:DataType="" clears it for that subtree. The source generator validates {Binding ...} paths —
and DataTrigger.Binding — against the hint at build time (PQX010 error for an unknown member,
PQX011 warning for a type it cannot resolve). Where the scope cannot be known, nothing is reported
rather than guessed: styles and resource dictionaries are reused across scopes, so their bindings are
never validated. The XAML designer idiom d:DataContext="{d:DesignInstance Type=local:Invoice}" is
an accepted alternative spelling of the same hint, used when no x:DataType is present on the
element.
Documentation
License
MIT — see LICENSE.
| Product | Versions 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. |
-
net10.0
- HarfBuzzSharp (>= 14.2.1.1)
- HarfBuzzSharp.NativeAssets.Linux (>= 14.2.1.1)
- HarfBuzzSharp.NativeAssets.macOS (>= 14.2.1.1)
- HarfBuzzSharp.NativeAssets.Win32 (>= 14.2.1.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.11)
- Pysar (>= 0.1.53)
- SkiaSharp (>= 4.151.2)
- SkiaSharp.NativeAssets.Linux (>= 4.151.2)
- SkiaSharp.NativeAssets.macOS (>= 4.151.2)
- SkiaSharp.NativeAssets.Win32 (>= 4.151.2)
- Svg.Skia (>= 5.2.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
## Highlights
### `ReportAsset` — a single way to ship report assets
Fonts, images and other report resources can now be declared once as a
`ReportAsset` MSBuild item. The build translates it into each host framework's
own item type (`MauiAsset`, `AvaloniaResource`, `EmbeddedResource`, …), and a new
`EmbeddedAssetFileSystem` reads assets straight from the manifest resources of
assemblies marked with `[PysarAssetSource]`. This means a shared report library
can carry its own fonts and images, and every host can see them.
A new `FallbackFileSystem` chains the platform's own asset source ahead of the
embedded one. All five UI platforms (MAUI, WPF, Avalonia, Uno, Blazor) and both
disk-backed `DefaultReportPlatformHandler` constructors install this chain, so
console apps, workers, server-side rendering and the design-time preview resolve
embedded assets too.
> An `IFileSystem` you pass explicitly is **not** widened — it stays the caller's
> whole answer.
### Trimming support
`Pysar.dll` now embeds an `ILLink.Descriptors.xml`, and `Pysar.Xaml` ships a
`build/Pysar.Xaml.targets` that auto-generates an embedded trimmer descriptor for
any project containing `.rxaml` reports (opt out with `PysarDisableTrimmerRoots`).
See `docs/trimming.md` for WebAssembly trimming behaviour.
### Avalonia: shared renderer and export
New `PysarAvalonia` entry point with a shared renderer/export service and proper
reset logic behind `AppBuilderExtensions`, plus headless Avalonia tests.
### Platform layer refactor
Platform-specific handlers are replaced by `DefaultReportPlatformHandler` backed
by per-platform `IFileSystem` implementations. Desktop/macOS printing and the
macOS pinch monitor moved into `Pysar.Viewer.Platform`, and desktop print logic is
centralised in `DesktopPdfPrint`. Obsolete platform shims were removed.
## Performance
- **`ImageRenderCache`** — a session-scoped cache for image bytes, bitmaps and
SVGs, wired into both the prefetch and draw paths, with failure tracking and
deterministic disposal.
- **Faster layout** — `GridLayoutMeasurer`, `StackLayoutMeasurer`, `TextMeasurer`
and `LayoutEngine` were reworked; `BindingEngine` and `PropertyPathResolver`
were optimised.
- Removed the `#if DEBUG` `[Pysar.Perf]` zoom instrumentation that logged to the
console in every consumer's Debug build.
## Fixes
- **Stale pinch-zoom tiles** — rapid pinch commits could leave superseded zoom
generations in the tile cache, keeping cells from older scales on screen. Only
the active generation and one bridge generation are kept now.
- **Touch axis lock** — `ReportView` locks a swipe to its dominant axis, so
scrolling no longer drifts sideways.
- **WPF printing** — the printer now imports the viewer platform namespace it
needs for the print flow.
## Authoring and tooling
- XAML source generation: richer binding validation with namespace/name
collection and real diagnostics.
- New API surface: `StyleExtensions.WithStyle`, `AddElements` overloads on
`ReportContainer`, `PysarBuilder.AddFonts`, and a default `Band` height.
- Quick start and the MAUI/Uno/Avalonia READMEs now document `ReportAsset`
instead of hand-declared asset items.
## Breaking changes
- **`MeasureAsync` / `ProbeAsync` are now synchronous `Measure` / `Probe`**
throughout the layout and rendering pipeline. Custom element measurers and any
code calling the measure API must drop `await` and the `Task` return type.
- **Platform handler types removed** — `MauiReportPlatformHandler`,
`WpfReportPlatformHandler` and `AvaloniaReportPlatformHandler` are gone; use
`DefaultReportPlatformHandler` (installed for you by `UsePysar` /
`AddPysar` / `UsePysar()` on the app builder).
- `IImageCache` / `LocalImageCache` lost members superseded by `ImageRenderCache`.
- `PysarWpf` and `Pysar.Avalonia.ReportView` helper shims were removed.
## Tests
~2,000 lines of new test coverage: embedded-asset and fallback file systems,
per-platform asset chains, pinch-commit placement, image-render caching, PDF
print on desktop, trimmer roots and package layout, and binding validation.