PLBOX3(3plplot)

📦
version 5.15.0 · 12 versions
, in ubuntu stonking

💅 PLBOX3 — a Gen Z field guide to plbox3

ok so this page is straight out of the PLplot API ✨ (yes, the 3-D plotting one, we're fancy now). Welcome to plbox3, akshually the full name up top is PLBOX3(3plplot) — iykyk. 🎀

🌸 SYNOPSIS 🌸

plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt,
zlabel, ztick, nzsub)

like, twelve arguments bestie. twelve. but we're gonna get through it together 🫶

✨ DESCRIPTION ✨

It draws axes, numeric labels and text labels for a three-dimensional surface plot. iconic behavior honestly 💅. For a fuller, more complete description of three-dimensional plotting, go read the PLplot documentation (it's giving "the rest of the lore").

Redacted form — General: plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub) — same thing, just laid out cuter.

This function shows up in examples 8, 11, 18, and 21. main character energy in all four fr fr ⭐

👑 ARGUMENTS 👑

okay buckle up, we're doing all twelve, no skips, no cap.

  • xopt (PLCHAR_VECTOR(3plplot), input) — an ascii character string that sets the options for the x axis. It can include any combination of the following letters, upper or lower case, in any order:
    • b — draws the axis at base, at height z=zmin where zmin is defined by a call to plw3d(3plplot). ⚠️ You must include this character to use any of the other options. it's the VIP pass basically.
    • d — plot labels as date / time. Values are assumed to be seconds since the epoch (as used by gmtime).
    • f — always use fixed point numeric labels.
    • i — inverts tick marks, so they're drawn downwards rather than upwards.
    • l — labels the axis logarithmically. bestie listen: this only affects the labels, not the data, so you gotta compute the logarithms of your data points before passing them to any of the drawing routines. no shortcuts 😭.
    • n — writes numeric labels at major tick intervals.
    • o — use a custom labelling function to generate the axis label text. That custom labelling function can be defined with the plslabelfunc(3plplot) command. 🧚
    • s — enables subticks between major ticks, only valid if t is also specified.
    • t — draws major ticks.
    • u — if specified, the text label for the axis is written under the axis.
  • xlabel (PLCHAR_VECTOR(3plplot), input) — a UTF-8 character string with the text label for the x axis. It's only drawn if u is in the xopt string 🙈.
  • xtick (PLFLT(3plplot), input) — world coordinate interval between major ticks on the x axis. If it's set to zero, PLplot automatically generates a suitable tick interval for you (slay, it's got you).
  • nxsub (PLINT(3plplot), input) — number of subintervals between major x axis ticks, for minor ticks. If it's set to zero, PLplot automatically generates a suitable minor tick interval. ✨
  • yopt (PLCHAR_VECTOR(3plplot), input) — an ascii character string setting options for the y axis. The string is interpreted the same way as xopt (so like, go reread that list, it's the exact same vibe).
  • ylabel (PLCHAR_VECTOR(3plplot), input) — a UTF-8 character string with the text label for the y axis. Only drawn if u is in the yopt string 💜.
  • ytick (PLFLT(3plplot), input) — world coordinate interval between major ticks on the y axis. Zero → PLplot automatically generates a suitable tick interval.
  • nysub (PLINT(3plplot), input) — number of subintervals between major y axis ticks, for minor ticks. Zero → PLplot automatically generates a suitable minor tick interval.
  • zopt (PLCHAR_VECTOR(3plplot), input) — an ascii character string setting options for the z axis. It can include any combination of the following letters, upper or lower case, in any order:
    • b — draws the z axis to the left of the surface plot.
    • c — draws the z axis to the right of the surface plot.
    • d — draws grid lines parallel to the x-y plane behind the figure. ⚠️ These lines are not drawn until after plot3d(3plplot) or plmesh(3plplot) are called, because of the need for hidden line removal. patience, babe.
    • e — plot labels as date / time. Values are assumed to be seconds since the epoch (as used by gmtime). Note: this suboption is interpreted the same as the d suboption for xopt and yopt, but it has to be identified as e for zopt since d has already been used for the different purpose up above. naming collision moment 💀.
    • f — always use fixed point numeric labels.
    • i — inverts tick marks, so they're drawn away from the center.
    • l — labels the axis logarithmically. Again: only affects the labels, not the data, so compute the logarithms of data points before passing them to any of the drawing routines. 😭
    • m — writes numeric labels at major tick intervals on the right-hand z axis.
    • n — writes numeric labels at major tick intervals on the left-hand z axis.
    • o — use a custom labelling function to generate the axis label text. That custom labelling function can be defined with the plslabelfunc(3plplot) command. 🦋
    • s — enables subticks between major ticks, only valid if t is also specified.
    • t — draws major ticks.
    • u — if specified, the text label is written beside the left-hand axis.
    • v — if specified, the text label is written beside the right-hand axis.
  • zlabel (PLCHAR_VECTOR(3plplot), input) — a UTF-8 character string with the text label for the z axis. Only drawn if u or v are in the zopt string 🍓.
  • ztick (PLFLT(3plplot), input) — world coordinate interval between major ticks on the z axis. Zero → PLplot automatically generates a suitable tick interval.
  • nzsub (PLINT(3plplot), input) — number of subintervals between major z axis ticks, for minor ticks. Zero → PLplot automatically generates a suitable minor tick interval.

🌈 AUTHORS 🌈

So many developers — and they're all credited at http://plplot.sourceforge.net/credits.php — have contributed to PLplot over its long history. literal legends, all of them 👑💖

⭐ SEE ALSO ⭐

and that's the page!! 💅 thanks for coming to my ted talk bestie, mwah 🫶

sign-off tea ☕: this lil masterpiece is part of the PLplot API and it's dated August, 2026 — PLBOX3(3plplot), periodt. 🎀✨
📦 where this page comes from