OpenParable
Skip to content
← Back to skills

Adding Pane

Development
adding-pane

Adding Pane is an Agent Skill for development published in the fossasia/visdom repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Step-by-step guide for adding a new visualization pane type to Visdom (client, server, frontend, tests)

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/fossasia/visdom/blob/HEAD/.agents/skills/adding-pane/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/adding-pane, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Adding a New Pane Type

When to Use

Use this skill when adding a new visualization type (e.g., a new chart, widget, or media pane) to Visdom.

Core Workflow

  1. Python Client (py/visdom/__init__.py):

    • Add a new method to the Visdom class with @pytorch_wrap
    • Format data as {"data": [{"type": "my_type", "content": ...}], ...}
    • Call self._send(msg) to POST to /events
  2. Server (py/visdom/utils/server_utils.py):

    • Add a new elif ptype == "my_type": branch in the window() function (around line 202)
    • Define what fields are stored in the window dict
  3. Frontend (js/panes/):

    • Create MyPane.js following the pattern in TextPane.js or ImagePane.js
    • Use forwardRef + React.memo pattern from Pane.js
  4. Registration (js/settings.js):

    • Add my_type: MyPane to the PANES object
    • Add default size to PANE_SIZE: my_type: [width, height]
  5. Type stubs (py/visdom/__init__.pyi):

    • Add the method signature for type checking
  6. Demo (example/components/):

    • Create a demo script exercising the new pane type
    • Import it in example/demo.py
  7. Tests (cypress/integration/):

    • Add a Cypress test file for the new pane type

Guardrails

  • Always use the @pytorch_wrap decorator on new client methods
  • Follow the forwardRef + React.memo pattern for pane components
  • Import and register new panes in js/settings.js
  • Never manually edit compiled files in py/visdom/static/

Documentation

  • Skill reference
  • py/visdom/__init__.py
  • py/visdom/utils/server_utils.py
  • js/settings.js
  • js/panes/
  • AGENTS.md
  • CONTRIBUTING.md

Assets

  • See assets/README.md and store templates/resources in assets/.

Tests

  • Follow the default flow in references/TESTS.md.