Developer’s Manual

This section provides some resources for developers interested in using Ginga as a visualization solution for their own software.

• Image Data Wrappers
  • AstroImage
  • RGBImage
• Ginga Image Viewer Operations
  • Manipulating the view programatically
  • Loading the Viewer
  • Scaling
    • Scaling Limits
  • Zooming
    • Zoom Algorithms
  • Panning
  • Transforms
  • Rotation
  • Cut Levels
    • Auto cut levels
  • Color Distribution
  • Color Map
  • Intensity Map
  • Auto configuration
  • Miscellaneous Operations
• Ginga Canvas Graphics
  • Canvases and Canvas Objects
  • Viewers
  • Using Canvases
    • Creating a Ginga Canvas
    • Enabling User Interaction on a Canvas
    • User Drawing on a Canvas
    • Set Drawing Parameters
    • Editing Objects on a Canvas
    • “Pick” Callbacks
  • Support for Astropy regions
• Plots
  • Plot objects
    • Support for autoscaling axes
  • Interactive Viewer Operations on Graphs
    • Zooming Graphs
    • Panning Graphs
    • Flipping and swapping
  • Time Series Plots
• Developing Modes
  • Writing a mode
    • Methods of a mode
  • Bindings DSL and Event Callbacks
    • Method names
    • Triggers
    • Examples
    • Event handler method signatures
• Developing with Ginga
  • Writing plugins for the reference viewer
    • Anatomy of a Local Ginga Plugin
    • A little more fleshed out example: MyLocalPlugin
    • Launching and Debugging Your Plugin
    • A more complex example: The Ruler Plugin
    • Writing a Global Plugin
    • A template: MyGlobalPlugin
    • Writing Separately Installable Plugins
• Using the Basic Ginga Viewer Object in Python Programs
  • Using the basic rendering class in new programs
    • Graphics plotting with Ginga
    • Rendering into Matplotlib Figures
    • Rendering into HTML5 canvases
    • Writing widget toolkit independent code
• Using Ginga with Jupyter
• Ginga Internals
  • Introduction
    • The Model
    • The View
    • The Controller
  • Graphics on Ginga
  • Miscellaneous Topics
    • I want to use my own World Coordinate System!
    • I want to use my own file storage format, not FITS!
    • Adding a new kind of file opener
    • Changes to Ginga API in v4.0.0
    • Porting Ginga to a New Widget Set
• Internationalization
  • Internationalizing New Code
    • Short UI strings
    • build_info captions
    • Strings defined before the language is set
    • Combo boxes that carry values
    • Long help text
    • Regenerating the message template
    • Reuse in applications built on Ginga
    • Selecting and locking the UI language
  • Preparing a New Translation
  • Updating Translation Files
  • Submitting a Translation