Plot API Doc

You will find the API Doc for each module in Plums plot below.

User API:

• Plot
• Descriptor API
  • Specific descriptors
  • Generic descriptors

The User API exposes a set of pre-defined high level constructors and utils aimed at allowing easy and fast visualisation generation at the expense of possible customisations. It should be the preferred API for normal day-to-day use.

Developer API:

• Orchestrator
• Descriptor developer API
• Compositor
• Legend painter
• Painter
• Color and ColorMap
  • The Color class
  • Color Maps

The Developer API exposes the inner workings of the User API. As such, it is easy to customize to a surprising extend although it is significantly less trivial to use. Nonetheless, it offers powerful capabilities and it might come handy for iconoclast visualisation which fall outside the User API intended purpose.