runmat-runtime 0.4.5

Core runtime for RunMat with builtins, BLAS/LAPACK integration, and execution APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

{
  "title": "grid",
  "category": "plotting",
  "keywords": [
    "grid",
    "grid on",
    "grid off",
    "chart grid lines",
    "matlab grid"
  ],
  "summary": "Toggle grid lines for charts, subplots, and MATLAB `grid on` / `grid off` workflows.",
  "requires_feature": null,
  "tested": {
    "unit": "builtins::plotting::cmds"
  },
  "description": "`grid` controls the visibility of axes grid lines on the active subplot or axes selection. It supports the familiar MATLAB command-style forms `grid on`, `grid off`, and bare `grid` toggling, while returning the resulting boolean state in RunMat.",
  "behaviors": [
    "`grid on` enables grid lines on the current axes.",
    "`grid off` disables grid lines on the current axes.",
    "Calling `grid` with no argument toggles the current state.",
    "Grid visibility is subplot-local and does not spill into other axes automatically."
  ],
  "examples": [
    {
      "description": "Enable grid lines on a simple line chart",
      "input": "plot(1:5, [1 4 2 5 3]);\ngrid on;"
    },
    {
      "description": "Toggle grid lines in one subplot only",
      "input": "subplot(1, 2, 1);\nplot(1:5, 1:5);\ngrid off;\nsubplot(1, 2, 2);\nplot(1:5, [5 4 3 2 1]);\ngrid on;"
    }
  ],
  "faqs": [
    {
      "question": "Does RunMat support minor grid lines?",
      "answer": "Not yet — `grid on` enables major grid lines only. Minor grid support (the MATLAB `grid minor` form) is planned. For now, you get the primary tick grid, which covers most use cases."
    },
    {
      "question": "Can I style the grid line color or width?",
      "answer": "Grid styling is tied to axes properties. You can adjust the grid appearance through the axes handle with `set(gca, 'GridColor', [0.5 0.5 0.5])` and related properties when the axes property path supports them. Check `get(gca)` to see what's currently exposed."
    },
    {
      "question": "Does grid state carry across subplots?",
      "answer": "No. Grid visibility is subplot-local. Calling `grid on` in one panel doesn't turn it on in others — you need to enable it explicitly in each subplot where you want grid lines."
    }
  ],
  "links": [
    {
      "label": "axis",
      "url": "./axis"
    },
    {
      "label": "box",
      "url": "./box"
    },
    {
      "label": "subplot",
      "url": "./subplot"
    },
    {
      "label": "Choosing the right plot type",
      "url": "/docs/plotting/choosing-the-right-plot-type"
    },
    {
      "label": "Styling plots and axes",
      "url": "/docs/plotting/styling-plots-and-axes"
    },
    {
      "label": "Plot replay and export",
      "url": "/docs/plotting/plot-replay-and-export"
    },
    {
      "label": "Complete plotting guide",
      "url": "/blog/matlab-plotting-guide"
    }
  ],
  "source": {
    "label": "`crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs`",
    "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs"
  }
}