runmat 0.4.9-dev.0 → 0.4.9-dev.1

package/dist/generated/builtins/suptitle.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=suptitle.d.ts.map

package/dist/generated/builtins/suptitle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suptitle.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/suptitle.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UAyFjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/suptitle.js

@@ -0,0 +1,94 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "suptitle",
+    "category": "plotting",
+    "keywords": [
+        "suptitle",
+        "sgtitle",
+        "super title",
+        "subplot title",
+        "figure title",
+        "matlab suptitle"
+    ],
+    "summary": "Set a title centered above the entire figure, especially for older MATLAB subplot code.",
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::suptitle::tests"
+    },
+    "description": "`suptitle` sets or updates the same figure-level title as `sgtitle`. It exists for compatibility with MATLAB code in the wild that uses the older helper name for subplot layouts. In RunMat, it targets the current figure by default or an explicit figure handle when one is passed, returns a text handle, and participates in `get` and `set` through the shared plotting property system.",
+    "behaviors": [
+        "`suptitle(txt)` updates the current figure and returns the super-title text handle.",
+        "`suptitle(fig, txt, ...)` targets an explicit figure handle when the handle exists.",
+        "String scalars, char arrays, string arrays, and cell arrays can all be used to create multiline super titles.",
+        "Text styling properties such as `FontSize`, `FontWeight`, `FontAngle`, `Color`, `Interpreter`, and `Visible` use the shared plotting text-property system.",
+        "`suptitle` and `sgtitle` update the same figure-level title object."
+    ],
+    "examples": [
+        {
+            "description": "Add a super title above a subplot figure",
+            "input": "subplot(2, 1, 1);\nplot(1:10, rand(1, 10));\nsubplot(2, 1, 2);\nplot(1:10, rand(1, 10));\nsuptitle('Experiment Summary');"
+        },
+        {
+            "description": "Style the figure-level title and inspect the returned handle",
+            "input": "subplot(1, 2, 1);\nimagesc(peaks(20));\nsubplot(1, 2, 2);\nimagesc(peaks(20));\nh = suptitle('Field Comparison', 'FontSize', 18, 'FontWeight', 'bold');\nget(h, 'Type')",
+            "output": "ans =\n    'text'"
+        },
+        {
+            "description": "Target an explicit figure handle",
+            "input": "fig = figure(42);\nsubplot(1, 2, 1);\nplot(0:0.1:1, sin(0:0.1:1));\nsubplot(1, 2, 2);\nplot(0:0.1:1, cos(0:0.1:1));\nsuptitle(fig, 'Sine and Cosine');"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "How is suptitle different from sgtitle?",
+            "answer": "In RunMat, `suptitle` and `sgtitle` update the same figure-level super title. `suptitle` is provided as a compatibility spelling for MATLAB code that uses the older helper name."
+        },
+        {
+            "question": "How is suptitle different from title?",
+            "answer": "`title` attaches text to the current axes, so each subplot can have its own panel title. `suptitle` attaches text to the figure as a whole and is drawn once above all panels."
+        },
+        {
+            "question": "Can I update the super title after creating it?",
+            "answer": "Yes. `suptitle` returns a text handle, so you can inspect or update it with `get` and `set`.\n\n```matlab\nh = suptitle('Initial Title');\nset(h, 'String', 'Updated Title', 'FontWeight', 'bold');\n```"
+        }
+    ],
+    "links": [
+        {
+            "label": "sgtitle",
+            "url": "./sgtitle"
+        },
+        {
+            "label": "subplot",
+            "url": "./subplot"
+        },
+        {
+            "label": "title",
+            "url": "./title"
+        },
+        {
+            "label": "get",
+            "url": "./get"
+        },
+        {
+            "label": "set",
+            "url": "./set"
+        },
+        {
+            "label": "Complete plotting guide",
+            "url": "/blog/matlab-plotting-guide"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/suptitle.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/suptitle.rs"
+    },
+    "key": "suptitle",
+    "slug": "suptitle",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=suptitle.js.map

package/dist/generated/builtins/suptitle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suptitle.js","sourceRoot":"","sources":["../../../src/generated/builtins/suptitle.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,UAAU;QACV,SAAS;QACT,aAAa;QACb,eAAe;QACf,cAAc;QACd,iBAAiB;KAClB;IACD,SAAS,EAAE,yFAAyF;IACpG,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,qCAAqC;KAC9C;IACD,aAAa,EAAE,iYAAiY;IAChZ,WAAW,EAAE;QACX,qFAAqF;QACrF,qFAAqF;QACrF,+GAA+G;QAC/G,4JAA4J;QAC5J,qEAAqE;KACtE;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,2HAA2H;SACrI;QACD;YACE,aAAa,EAAE,8DAA8D;YAC7E,OAAO,EAAE,yKAAyK;YAClL,QAAQ,EAAE,mBAAmB;SAC9B;QACD;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,wJAAwJ;SAClK;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,yCAAyC;YACrD,QAAQ,EAAE,mLAAmL;SAC9L;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,gLAAgL;SAC3L;QACD;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,0MAA0M;SACrN;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,yBAAyB;YAClC,KAAK,EAAE,6BAA6B;SACrC;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,+DAA+D;QACxE,KAAK,EAAE,4GAA4G;KACpH;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins-manifest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builtins-manifest.d.ts","sourceRoot":"","sources":["../../src/generated/builtins-manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,eAAO,MAAM,eAAe,EAAE,oBAAoB,EAk4PjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAgZ9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}
+{"version":3,"file":"builtins-manifest.d.ts","sourceRoot":"","sources":["../../src/generated/builtins-manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,eAAO,MAAM,eAAe,EAAE,oBAAoB,EAs5PjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAiZ9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -7189,6 +7189,26 @@ export const builtinManifest = [
         "summary": "Sum elements of scalars, vectors, matrices, or N-D tensors with MATLAB-compatible options.",
         "exampleCount": 6
     },
+    {
+        "key": "suptitle",
+        "title": "suptitle",
+        "slug": "suptitle",
+        "aliases": [],
+        "category": "plotting",
+        "categoryPath": [
+            "plotting"
+        ],
+        "keywords": [
+            "suptitle",
+            "sgtitle",
+            "super title",
+            "subplot title",
+            "figure title",
+            "matlab suptitle"
+        ],
+        "summary": "Set a title centered above the entire figure, especially for older MATLAB subplot code.",
+        "exampleCount": 3
+    },
     {
         "key": "surf",
         "title": "surf",
@@ -8423,6 +8443,7 @@ export const builtinDocLoaders = {
     "subsasgn": () => import("./builtins/subsasgn.js").then((mod) => mod.default),
     "subsref": () => import("./builtins/subsref.js").then((mod) => mod.default),
     "sum": () => import("./builtins/sum.js").then((mod) => mod.default),
+    "suptitle": () => import("./builtins/suptitle.js").then((mod) => mod.default),
     "surf": () => import("./builtins/surf.js").then((mod) => mod.default),
     "surfc": () => import("./builtins/surfc.js").then((mod) => mod.default),
     "svd": () => import("./builtins/svd.js").then((mod) => mod.default),