diff --git a/README.md b/README.md index 679d979..988b37d 100644 --- a/README.md +++ b/README.md @@ -96,5 +96,16 @@ Please read the [Docs](/docs/build/index.html) for further Information * move to `./docs` folder with command line * run `julia --project make.jl` +### Using CairoMakie +CairoMakie is a highest-quality and efficient 2D plotting backend for publications. It uses Cairo.jl to draw vector graphics to SVG,PNG and PDF +#### Activate CairoMakie + +Activate the backend by using CairoMakie and calling CairoMakie.activate!(type = "png") or CairoMakie.activate!(type = "svg") + +### Overview + +This module provides a way to visualize data using parallel coordinates plots. A parallel coordinates plot is a common way of visualizing multivariate data by drawing lines connecting data points across parallel axes. + +The key output is a **Scene**, which is a CairoMakie object that holds the graphical rendering of your plot. The `Scene` serves as the container for all visual components, including axes and plotted lines. \ No newline at end of file diff --git a/src/ParallelPlots.jl b/src/ParallelPlots.jl index 395ebee..56b4012 100644 --- a/src/ParallelPlots.jl +++ b/src/ParallelPlots.jl @@ -39,6 +39,10 @@ end ```julia ParallelPlot(data::DataFrame; normalize::Bool=false) ``` +A `Scene` in CairoMakie is a container for rendering graphical elements. +It serves as the root structure that holds various plot objects, +axes, and decorations. In the context of this module, the scene is used +to render parallel coordinate lines and custom axis layouts. # Arguments @@ -48,6 +52,15 @@ ParallelPlot(data::DataFrame; normalize::Bool=false) - `title::String`: - `ax_label::[String]`: + +# Returns +-`pp`: ParallelPlot with Three values: + *`Figure`: provides a structure for layouts, subplots, and decorations. + *`Axis`: The axis elements representing the parallel dimensions of the plot. + *`Scene`: is the root container for graphical objects in CairoMakie. + + + # Examples ```@example julia> using ParallelPlots