Merge pull request #1352 from beto-rodriguez/dev

rc2

Author: beto-rodriguez

LiveCharts.sln

@@ -9,15 +9,15 @@ param([string]$configuration = "Debug", [string]$nupkgOutputPath = "./nupkg")
     [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharp.Xamarin.Forms/LiveChartsCore.SkiaSharpView.Xamarin.Forms.csproj")
     [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharpView.Blazor/LiveChartsCore.SkiaSharpView.Blazor.csproj")
     [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharpView.Eto/LiveChartsCore.SkiaSharpView.Eto.csproj")
-    [Project]::new("./src/LiveChartsCore.Behaviours/LiveChartsCore.Behaviours.csproj", $true)
     [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharpView.Maui/LiveChartsCore.SkiaSharpView.Maui.csproj", $true)
     [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharpView.Uno/LiveChartsCore.SkiaSharpView.Uno.csproj", $true)
-    [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharpView.Uno.WinUI/LiveChartsCore.SkiaSharpView.Uno.WinUI.csproj", $true)
+    [Project]::new("./src/skiasharp/LiveChartsCore.SkiaSharpView.Uno.WinUI/LiveChartsCore.SkiaSharpView.Uno.WinUI.csproj", $true),
     [Project]::new(
-        "./src/skiasharp/LiveChartsCore.SkiaSharpView.WinUI/LiveChartsCore.SkiaSharpView.WinUI.csproj", 
-        $true,
-        "nuget",
-        "./src/skiasharp/LiveChartsCore.SkiaSharpView.WinUI/LiveChartsCore.SkiaSharpView.WinUI.nuspec"
+        "./src/LiveChartsCore.Behaviours/LiveChartsCore.Behaviours.csproj", $true,
+        "nuget", "./src/LiveChartsCore.Behaviours/LiveChartsCore.Behaviours.nuspec")
+    [Project]::new(
+        "./src/skiasharp/LiveChartsCore.SkiaSharpView.WinUI/LiveChartsCore.SkiaSharpView.WinUI.csproj", $true,
+        "nuget", "./src/skiasharp/LiveChartsCore.SkiaSharpView.WinUI/LiveChartsCore.SkiaSharpView.WinUI.nuspec"
     )
 )
 

build/pack.ps1

@@ -68,9 +68,9 @@ the `TempSample` class by setting a Mapper or implementing `IChartEntity` in our
 
 ## Mappers
 
-Mappers are the easiest way but has a performance cost, a mapper is a method that takes both the `instance` 
-(each `TempSample` in our data collection) and the `point` (that LiveCharts assigned) as parameters, inside this function we must 
-specify the X and Y coordinates in our chart.
+Mappers are the easiest way but has a performance cost, a mapper is a function that takes both: the `instance` 
+(each `TempSample` in our data collection) and the `index` of the instance in the collection as parameters,
+and returns a `Coordinate` in the chart.
 
 ```c#
 using var streamReader = new StreamReader("data.json");
@@ -86,15 +86,9 @@ var chart = new SKCartesianChart
         new LineSeries<TempSample>
         {
             Values = samples,
-            Mapping = (sample, chartPoint) => // mark
-            { // mark
-                // use the Temperature property in the Y axis // mark
-                // and the Time property in the X axis // mark
-                chartPoint.Coordinate = new(sample.Time, sample.Temperature);
-                
-                // sometimes it is useful to use the index of the instance in the array as the X coordinate: // mark
-                // chartPoint.SecondaryValue = chartPoint.Index; // mark
-            } // mark
+            // use the Temperature property in the Y axis // mark
+            // and the Time property in the X axis // mark
+            Mapping = (sample, index) => new(sample.Time, sample.Temperature) // mark
         }
     },
     XAxes = new[] { new Axis { Labeler = value => $"{value} seconds" } },
@@ -108,19 +102,14 @@ Now it works! You can also register the mapper globally, this means that every t
 chart all over our application, the library will use the mapper we indicated.
 
 ``` c#
-// ideally this code must be placed where your application or view starts
+// ideally this code must be placed where your application starts
 LiveCharts.Configure(config =>
-    config
-        .HasMap<TempSample>(
-            (sample, chartPoint) =>
-            {
-                chartPoint.PrimaryValue = sample.Temperature;
-                chartPoint.SecondaryValue = sample.Time;
-            }));
+    config.HasMap<TempSample>(
+        (sample, index) => new(sample.Time, sample.Temperature));
 ```
 
 Global mappers are unique for a type, this means that every time a `TempSample` instance is in a chart, LiveCharts will use this mapper,
-if You register again a global mapper for the `TempSample` class, then the previous will be replaced by the new one.
+if you register again a global mapper for the `TempSample` class, then the previous will be replaced by the new one.
 If the series specifies the `Mapping` property, then the global mapper will be ignored and instead it will use the series instance mapper.
 
 <a href="https://github.com/beto-rodriguez/LiveCharts2/blob/master/samples/MappersSamples/Program.cs" class="btn btn-light btn-lg text-primary shadow-sm mb-3">
@@ -129,8 +118,9 @@ If the series specifies the `Mapping` property, then the global mapper will be i
 
 ## IChartEntity
 
-The `IChartEntity` interface force our points to have a [Coordinate](https://lvcharts.com/api/2.0.0-beta.710/LiveChartsCore.Kernel.Coordinate),  LiveCharts will use this property to build the plot, when the interface is implemented correctly, you will notice a considerable 
-performance improvement, specially in large data sets.
+The `IChartEntity` interface forces our points to have a [Coordinate](https://lvcharts.com/api/2.0.0-beta.710/LiveChartsCore.Kernel.Coordinate),
+LiveCharts will use this property to build the plot, when the interface is implemented correctly, you will notice a considerable 
+performance improvement, specially on large data sets.
 
 Imagine the same case we used in the previous sample where we have a json file that contains the temperature of a CPU at a given time, 
 we want to build a chart with that data.

docs/overview/1.5.mappers.md

@@ -0,0 +1 @@
+For Uno, open ./samples/UnoPlatform_v5/UnoPlatform_v5.sln

readme.txt

@@ -31,11 +31,9 @@ public override void Initialize()
                 // finally register your own mappers
                 // you can learn more about mappers at:
                 // https://livecharts.dev/docs/{{ platform }}/{{ version }}/Overview.Mappers
-                .HasMap<City>((city, point) => // mark
-                { // mark
-                    // here we use the index as X, and the population as Y // mark
-                    point.Coordinate = new(point.Index, city.Population); // mark
-                }) // mark
+
+                // here we use the index as X, and the population as Y // mark
+                .HasMap<City>((city, index) => new(index, city.Population)) // mark
             // .HasMap<Foo>( .... ) // mark
             // .HasMap<Bar>( .... ) // mark
             ); // mark

samples/AvaloniaSample/App.axaml.cs

@@ -0,0 +1,13 @@
+<UserControl x:Class="AvaloniaSample.General.DrawOnCanvas.View"
+             xmlns="https://github.com/avaloniaui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:lvc="using:LiveChartsCore.SkiaSharpView.Avalonia"
+             xmlns:vms="using:ViewModelsSamples.General.DrawOnCanvas">
+    <UserControl.DataContext>
+        <vms:ViewModel/>
+    </UserControl.DataContext>
+
+    <Grid>
+        <lvc:CartesianChart UpdateStartedCommand="{Binding ChartUpdatedCommand}"/>
+    </Grid>
+</UserControl>

samples/AvaloniaSample/General/DrawOnCanvas/View.axaml

@@ -0,0 +1,17 @@
+using Avalonia.Controls;
+using Avalonia.Markup.Xaml;
+
+namespace AvaloniaSample.General.DrawOnCanvas;
+
+public partial class View : UserControl
+{
+    public View()
+    {
+        InitializeComponent();
+    }
+
+    private void InitializeComponent()
+    {
+        AvaloniaXamlLoader.Load(this);
+    }
+}

samples/AvaloniaSample/General/DrawOnCanvas/View.axaml.cs

@@ -28,11 +28,9 @@
                 // finally register your own mappers
                 // you can learn more about mappers at:
                 // https://livecharts.dev/docs/{{ platform }}/{{ version }}/Overview.Mappers
-                .HasMap<City>((city, point) => // mark
-                { // mark
-                  // here we use the index as X, and the population as Y // mark
-                    point.Coordinate = new(point.Index, city.Population); // mark
-                }) // mark
+
+                // here we use the index as X, and the population as Y // mark
+                .HasMap<City>((city, index) => new(index, city.Population)) // mark
             // .HasMap<Foo>( .... ) // mark
             // .HasMap<Bar>( .... ) // mark
             ); // mark

samples/BlazorSample/App.razor

@@ -0,0 +1,22 @@
+@page "/General/DrawOnCanvas"
+@using LiveChartsCore.SkiaSharpView.Blazor
+@using ViewModelsSamples.General.DrawOnCanvas
+
+<CartesianChart
+    @ref="chart">
+</CartesianChart>
+
+@code {
+    public CartesianChart chart = null!;
+    public ViewModel ViewModel { get; set; } = new();
+
+    protected override void OnAfterRender(bool firstRender)
+    {
+        base.OnAfterRender(firstRender);
+
+        chart.UpdateStarted += chart =>
+        {
+            ViewModel.ChartUpdated(new(chart));
+        };
+    }
+}

samples/BlazorSample/Pages/General/DrawOnCanvas.razor

@@ -60,8 +60,7 @@
                 <p class="text-center text-muted">
                     LiveCharts provides controls for any UI framework (console and server-side is also supported). <br />
                     <small class="text-center text-muted">
-                        The minimum requirement for .Net framework is .Net 4.6.2 and is compatible with is compatible
-                        with .NET standard 2.0.
+                        The minimum requirement for .Net framework is .Net 4.6.2 and is compatible with .NET standard 2.0.
                     </small>
                 </p>