Version: 6.0.1-1031-g90a71dd517
This is doxygen generated documentation for the C++ API for developers of ParaView as well as those writing plugins and custom applications based on ParaView.
| Page | Description |
|---|---|
| Environment Variables | Environment variables that affect application behavior. |
| Major API Changes | Descriptions for major API changes. |
| ParaView and Offscreen Rendering | Configuring and using ParaView in offscreen and/or headless environments. |
| String Formatting Arguments | String formatting arguments that are used for formatting formattable strings. |
| Page | Description |
|---|---|
| Adding and removing proxies | Guideline to correctly adding and removing proxies. |
| Plugin Howto | Tutorial on using and creating Plugins. |
| Proxy Hints And Annotations | ServerManager XML hints for Proxies. |
| Property Hints | ServerManager XML hints for Properties. |
| Proxy Documentation Formatting | Formatting options for proxy documentation. |
These pages includes documentation for ParaView Catalyst library, the Catalyst API implementation introduced with ParaView 5.9.
| Page | Description |
|---|---|
| ParaView-Catalyst | Design/Implementation details |
| ParaView-Catalyst Blueprint | Blueprint for ParaView Catalyst |
| Anatomy of Catalyst Python Module (Version 2.0) | Understanding Catalyst Python modules. |
| Community Atmosphere Model (CAM5) Catalyst Adaptor | Analyze Cam5 output with ParaView Catalyst. |
| Page | Description |
|---|---|
| Slice View | Implementing the Slice View |
| String Encoding | How to encode string when developing for ParaView |
| Localization Howto | Description of the translation workflow and how comply to it. |
| Restart and File Series Readers | How to implement restart and file series readers. |
This file is available in the ParaView source repository as Utilities/Doxygen/pages/index.md.in. All other pages to document the code are also available under that directory. As new pages are added, please ensure that the Navigation table above it kept up-to-date to make it easier to navigate the documentation.
1.8.13 on Sat Dec 6 2025