cetz-package · johannes-wolf · Oct 12, 2024 · Oct 10, 2024 · Oct 10, 2024 · Oct 10, 2024
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,10 +19,6 @@ jobs:
         with:
           packages: imagemagick cargo parallel
           version: 1.0
-      - name: Install typos-cli from crates.io
-        uses: baptiste0928/cargo-install@v2.2.0
-        with:
-          crate: typos-cli
       - name: Install just from crates.io
         uses: baptiste0928/cargo-install@v2.2.0
         with:
@@ -33,9 +29,12 @@ jobs:
           crate: typst-test
           git: https://github.com/tingerrr/typst-test.git
           tag: ci-semi-stable
+      - run: |
+          mkdir -p ~/.local/share/typst/packages/preview/cetz
+          git clone --depth 1 --branch v0.3.0 https://github.com/cetz-package/cetz.git ~/.local/share/typst/packages/preview/cetz/0.3.0
       - uses: typst-community/setup-typst@v3
         with:
-          typst-version: '0.11.1'
+          typst-version: '0.12.0-rc1'
           cache-dependency-path: src/cetz.typ
       - run: |
           just install @local

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-**Note: cetz-plot has not been released yet! Use cetz 0.2.2 's internal plotting module.**
-
 # CeTZ-Plot
 
 CeTZ-Plot is a library that adds plots and charts to [CeTZ](https://github.com/cetz-package/cetz), a library for drawing with [Typst](https://typst.app).
 
+CeTZ-Plot requires CeTZ version ≥ 0.3.0.
+
 ## Examples
 <!-- img width is set so the table gets evenly spaced by GitHubs css -->
 <table>
@@ -39,7 +39,7 @@ For information, see the [manual (stable)](https://github.com/cetz-package/cetz-
 
 To use this package, simply add the following code to your document:
 ```
-#import "@preview/cetz:0.2.2"
+#import "@preview/cetz:0.3.0"
 #import "@preview/cetz-plot:0.1.0": plot, chart
 
 #cetz.canvas({

diff --git a/gallery/barchart.png b/gallery/barchart.png
diff --git a/gallery/barchart.typ b/gallery/barchart.typ
@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": canvas, draw
+#import "@preview/cetz:0.3.0": canvas, draw
 #import "@preview/cetz-plot:0.1.0": chart
 
 #set page(width: auto, height: auto, margin: .5cm)
@@ -22,5 +22,5 @@
                  x-tick-step: 2.5,
                  data2,
                  labels: ([Low], [Medium], [High], [Very high]),
-                 legend: "legend.inner-north-east",)
+                 legend: "inner-north-east",)
 })
diff --git a/gallery/line.pdf b/gallery/line.pdf
diff --git a/gallery/line.png b/gallery/line.png
diff --git a/gallery/line.typ b/gallery/line.typ
@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": canvas, draw
+#import "@preview/cetz:0.3.0": canvas, draw
 #import "@preview/cetz-plot:0.1.0": plot
 
 #set page(width: auto, height: auto, margin: .5cm)

diff --git a/gallery/piechart.pdf b/gallery/piechart.pdf
diff --git a/gallery/piechart.png b/gallery/piechart.png
diff --git a/gallery/piechart.typ b/gallery/piechart.typ
@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2"
+#import "@preview/cetz:0.3.0"
 #import "@preview/cetz-plot:0.1.0": chart
 
 #set page(width: auto, height: auto, margin: .5cm)
@@ -22,7 +22,7 @@
   chart.piechart(
     data,
     value-key: 1,
-    label-key: 0,
+    label-key: none,
     radius: 4,
     slice-style: colors,
     inner-radius: 1,

diff --git a/manual.pdf b/manual.pdf
diff --git a/manual.typ b/manual.typ
@@ -1,8 +1,8 @@
+#import "/src/cetz.typ"
 #import "/doc/util.typ": *
 #import "/doc/example.typ": example
 #import "/doc/style.typ" as doc-style
 #import "/src/lib.typ": *
-#import "/src/cetz.typ": *
 #import "@preview/tidy:0.2.0"
 
 
@@ -39,7 +39,7 @@ CeTZ-Plot is a simple plotting library for use with CeTZ.
 
 This is the minimal starting point:
 #pad(left: 1em)[```typ
-#import "@preview/cetz:0.2.2"
+#import "@preview/cetz:0.3.0"
 #import "@preview/cetz-plot:0.1.0"
 #cetz.canvas({
   import cetz.draw: *

diff --git a/src/axes.typ b/src/axes.typ
@@ -86,6 +86,7 @@
   padding: 0,
 ))
 
+// Default Schoolbook Style
 #let default-style-schoolbook = util.merge-dictionary(default-style, (
   x: (stroke: auto, fill: none, mark: (start: none, end: "straight"),
     tick: (label: (anchor: "north"))),
@@ -223,14 +224,13 @@
 // - ticks (dictionary): Tick settings:
 //     - step (number): Major tic step
 //     - minor-step (number): Minor tic step
-//     - unit (content): Tick label suffix
 //     - decimals (int): Tick float decimal length
 // - label (content): Axis label
 // - mode (string): Axis scaling function. Takes `lin` or `log`
 // - base (number): Base for tick labels when logarithmically scaled.
 #let axis(min: -1, max: 1, label: none,
           ticks: (step: auto, minor-step: none,
-                  unit: none, decimals: 2, grid: false,
+                  decimals: 2, grid: false,
                   format: "float"
                   ),
           mode: auto, base: auto) = (
@@ -243,14 +243,6 @@
   // to content! Typst has negative zero floats.
   if value == 0 { value = 0 }
 
-  let round(value, digits) = {
-    calc.round(value, digits: digits)
-  }
-
-  let format-float(value, digits) = {
-    $#round(value, digits)$
-  }
-
   if type(value) != typst-content {
     let format = tic-options.at("format", default: "float")
     if format == none {
@@ -262,15 +254,12 @@
     } else if format == "sci" {
       value = formats.sci(value, digits: tic-options.at("decimals", default: 2))
     } else {
-      value = format-float(value, tic-options.at("decimals", default: 2))
+      value = formats.decimal(value, digits: tic-options.at("decimals", default: 2))
     }
   } else if type(value) != typst-content {
     value = str(value)
   }
 
-  if tic-options.at("unit", default: none) != none {
-    value += tic-options.unit
-  }
   return value
 }
 

diff --git a/src/cetz.typ b/src/cetz.typ
@@ -1,2 +1,2 @@
 // Import cetz into the root scope. Import cetz by importing this file only!
-#import "@preview/cetz:0.2.2": *
+#import "@preview/cetz:0.3.0": *
diff --git a/src/chart/barchart.typ b/src/chart/barchart.typ
@@ -54,7 +54,6 @@
 ///                 width can be set to `auto`.
 /// - bar-style (style,function): Style or function (idx => style) to use for
 ///                               each bar, accepts a palette function.
-/// - x-unit (content,auto): Tick suffix added to each tick label
 /// - y-label (content,none): Y axis label
 /// - x-label (content,none): x axis label
 /// - labels (none,content): Legend labels per x value group
@@ -67,7 +66,7 @@
               size: (auto, 1),
               bar-style: palette.red,
               x-label: none,
-              x-unit: auto,
+              x-format: auto,
               y-label: none,
               labels: none,
               ..plot-args
@@ -100,9 +99,9 @@
     (data.len() - i - 1, t.at(label-key))
   })
 
-  let x-unit = x-unit
-  if x-unit == auto {
-    x-unit = if mode == "stacked100" {[%]} else []
+  let x-format = x-format
+  if x-format == auto {
+    x-format = if mode == "stacked100" {plot.formats.decimal.with(suffix: [%])} else {auto}
   }
 
   data = data.enumerate().map(((i, d)) => {
@@ -119,6 +118,7 @@
               axis-style: "scientific-auto",
               x-label: x-label,
               x-grid: true,
+              x-format: x-format,
               y-label: y-label,
               y-min: -y-inset,
               y-max: data.len() + y-inset - 1,

diff --git a/src/chart/boxwhisker.typ b/src/chart/boxwhisker.typ
@@ -12,7 +12,7 @@
 /// Add one or more box or whisker plots.
 ///
 /// #example(```
-/// cetz.chart.boxwhisker(size: (2,2), label-key: none,
+/// chart.boxwhisker(size: (2,2), label-key: none,
 ///   y-min: 0, y-max: 70, y-tick-step: 20,
 ///   (x: 1, min: 15, max: 60,
 ///    q1: 25, q2: 35, q3: 50))

diff --git a/src/chart/columnchart.typ b/src/chart/columnchart.typ
@@ -54,7 +54,6 @@
 ///                 width can be set to `auto`.
 /// - bar-style (style,function): Style or function (idx => style) to use for
 ///   each bar, accepts a palette function.
-/// - y-unit (content,auto): Tick suffix added to each tick label
 /// - y-label (content,none): Y axis label
 /// - x-label (content,none): x axis label
 /// - labels (none,content): Legend labels per y value group
@@ -67,7 +66,7 @@
                  size: (auto, 1),
                  bar-style: palette.red,
                  x-label: none,
-                 y-unit: auto,
+                 y-format: auto,
                  y-label: none,
                  labels: none,
                  ..plot-args
@@ -98,9 +97,9 @@
     (i, t.at(label-key))
   })
 
-  let y-unit = y-unit
-  if y-unit == auto {
-    y-unit = if mode == "stacked100" {[%]} else []
+  let y-format = y-format
+  if y-format == auto {
+    y-format = if mode == "stacked100" {plot.formats.decimal.with(suffix: [%])} else {auto}
   }
 
   data = data.enumerate().map(((i, d)) => {
@@ -117,6 +116,7 @@
               axis-style: "scientific-auto",
               y-grid: true,
               y-label: y-label,
+              y-format: y-format,
               x-min: -x-inset,
               x-max: data.len() + x-inset - 1,
               x-tick-step: none,

diff --git a/src/chart/piechart.typ b/src/chart/piechart.typ
@@ -90,7 +90,6 @@
 /// Draw a pie- or donut-chart
 ///
 /// #example(```
-/// import cetz.chart
 /// let data = (24, 31, 18, 21, 23, 18, 27, 17, 26, 13)
 /// let colors = gradient.linear(red, blue, green, yellow)
 ///

diff --git a/src/plot.typ b/src/plot.typ
@@ -115,9 +115,6 @@
 ///   Number of decimals digits to display for tick labels, if the format is set
 ///   to `"float"`.
 /// ])
-/// #show-parameter-block("unit", ("none", "content"), default: "none", [
-///   Suffix to append to all tick labels.
-/// ])
 /// #show-parameter-block("mode", ("none", "string"), default: "none", [
 ///   The scaling function of the axis. Takes `lin` (default) for linear scaling,
 ///   and `log` for logarithmic scaling.])
@@ -160,7 +157,7 @@
 ///
 ///   #example(```
 ///   let opts = (x-tick-step: none, y-tick-step: none, size: (2,1))
-///   let data = cetz.plot.add(((-1,-1), (1,1),), mark: "o")
+///   let data = plot.add(((-1,-1), (1,1),), mark: "o")
 ///
 ///   for name in (none, "school-book", "left", "scientific") {
 ///     plot.plot(axis-style: name, ..opts, data, name: "plot")
@@ -207,7 +204,7 @@
           legend-style: (:),
           ..options
           ) = draw.group(name: name, ctx => {
-  // TODO: Assert cetz min version here!
+  draw.assert-version(version(0, 3, 0))
 
   // Create plot context object
   let make-ctx(x, y, size) = {
@@ -523,8 +520,6 @@
 /// axis tuple to specify which axis coordinate system to use.
 ///
 /// #example(```
-/// import cetz.plot
-/// import cetz.draw: *
 /// plot.plot(size: (2,2), name: "plot",
 ///           x-tick-step: none, y-tick-step: none, {
 ///   plot.add(((0,0), (1,1), (2,.5), (4,3)))

diff --git a/src/plot/annotation.typ b/src/plot/annotation.typ
@@ -9,7 +9,6 @@
 /// by its x and y axis.
 ///
 /// #example(```
-/// import cetz.plot
 /// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
 ///   plot.add(domain: (0, 2*calc.pi), calc.sin)
 ///   plot.annotate({

diff --git a/src/plot/boxwhisker.typ b/src/plot/boxwhisker.typ
@@ -3,8 +3,8 @@
 /// Add one or more box or whisker plots
 ///
 /// #example(```
-/// cetz.plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
-///   cetz.plot.add-boxwhisker((x: 1, // Location on x-axis
+/// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
+///   plot.add-boxwhisker((x: 1, // Location on x-axis
 ///     outliers: (7, 65, 69),        // Optional outlier values
 ///     min: 15, max: 60,             // Minimum and maximum
 ///     q1: 25,                       // Quartiles: Lower

diff --git a/src/plot/contour.typ b/src/plot/contour.typ
@@ -242,8 +242,8 @@
 /// Add a contour plot of a sampled function or a matrix.
 ///
 /// #example(```
-/// cetz.plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
-///   cetz.plot.add-contour(x-domain: (-3, 3), y-domain: (-3, 3),
+/// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
+///   plot.add-contour(x-domain: (-3, 3), y-domain: (-3, 3),
 ///     style: (fill: rgb(50,50,250,50)),
 ///     fill: true,
 ///     op: "<",        // Find contours where data < z