Render

The libSBML “render” extension implements support for the SBML Level 3 Graphical Rendering ("render") package. It can be used in SBML Level 3 Version 1 and Version 2 documents.

Introduction

The graphical depiction of a reaction network diagram should be described as graphical representations of species and reactions, and not as arbitrary drawing or graph. While it may seem unnecessary to invent a new language when an existing one like SVG could in principle be used to describe the layout of a reaction network, there are good reasons to have a language tailored specifically for the layout of SBML models. For example, most programs that will use this SBML extension are primarily programs dealing with biochemical models. Internally, they will have data structures for species and reactions, so it will also be natural for them to depict the reaction network in terms of species and reactions (and not in terms of, e.g., polygons or splines).

The Graphical Rendering ("render") package for SBML Level 3 is a companion to the Graphical Layout ("layout") package. Together, they provide a complete format for describing the layout of a diagram and the visual rendition of the entities within it.

Authors

The primary authors of the SBML Level 3 Render specification are Frank T. Bergmann, Sarah M. Keating, Ralph Gauges, Sven Sahle and Katja Wengler.

The specification for this SBML package

This API documentation for libSBML does not provide a complete explanation of the SBML Level 3 “render” package. If you are developing software that uses “render”, you are strongly urged to read the actual specification for the package. A link to the specification document current is provided below, along with a link to the page of known issues (if any).

Specification for SBML Level 3 Render, current at the time of this libSBML release (5.18.0). Note: an Internet connection is required to access these documents.

Specification (in PDF format)	Known issues
Render package, Version 1 Release 1	Errata page

More...

Classes
class	ColorDefinition
	render Definition of an identifier for an RGBA color value. More...
class	DefaultValues
	render Encoding of default values. More...
class	Ellipse
	render Graphical representation of an ellipse. More...
class	GlobalRenderInformation
	render Render information stored in a ListOfLayouts. More...
class	GlobalStyle
	render A style that can be associated with a layout. More...
class	GradientBase
	render Abstract base class for linear and radial gradients. More...
class	GradientStop
	render A color at a certain location in a color gradient. More...
class	GraphicalPrimitive1D
	render Base class for graphical primitives implementing 1D attributes. More...
class	GraphicalPrimitive2D
	render Base class for graphical primitives implementing 2D attributes. More...
class	Image
	render Representation of images. More...
class	LinearGradient
	render Representation of a linear gradient. More...
class	LineEnding
	render Decoration element for the start and/or end of curves. More...
class	ListOfColorDefinitions
	render A list of ColorDefinition objects. More...
class	ListOfCurveElements
	render A list of curve elements. More...
class	ListOfDrawables
	render A list of Transformation2D objects. More...
class	ListOfGlobalRenderInformation
	render A list of GlobalRenderInformation objects. More...
class	ListOfGlobalStyles
	render A list of GlobalStyle objects. More...
class	ListOfGradientDefinitions
	render A list of GradientBase objects. More...
class	ListOfGradientStops
	render A list of one or more GradientStop objects. More...
class	ListOfLineEndings
	render A list of LineEnding objects. More...
class	ListOfLocalRenderInformation
	render A list of LocalRenderInformation objects. More...
class	ListOfLocalStyles
	render A list of LocalStyle objects. More...
class	LocalRenderInformation
	render Rendering information stored in Layouts. More...
class	LocalStyle
	render Style information object used in LocalRenderInformation. More...
class	Polygon
	render Representation of a Polygon More...
class	RadialGradient
	render Representation of a radial gradient. More...
class	Rectangle
	render Representation of a rectangle. More...
class	RelAbsVector
	render Vectors with an absolute value and a relative value. More...
class	RenderCubicBezier
	render Representation of cubic Bezier curves. More...
class	RenderCurve
	render Representation of curves. More...
class	RenderExtension
	render Base extension class for the package. More...
class	RenderGraphicalObjectPlugin
	render The Render extension of the layout GraphicalObject class. More...
class	RenderGroup
	render A group of graphical primitives creating a composite. More...
class	RenderInformationBase
	render Abstract base class for local and global rendering information. More...
class	RenderLayoutPlugin
	render LibSBML implementation for the extension to the Layout class by the Render extension. More...
class	RenderListOfLayoutsPlugin
	render A list of layout objects used by the "render" extension. More...
class	RenderPkgNamespaces
	render SBMLNamespaces extension for the package. More...
class	RenderPoint
	render A point with both absolute and relative values More...
class	RenderSBMLDocumentPlugin
	render Extension of SBMLDocument. More...
class	RenderValidator
	render Entry point for “render” package validation. More...
class	Style
	render Abstract base class for local and global styles. More...
class	Text
	render Representation of text elements. More...
class	Transformation
	render Implementation of a 3D transformation matrix. More...
class	Transformation2D
	render Implementation of a 2D transformation matrix. More...

Detailed Description

The libSBML “render” extension implements support for the SBML Level 3 Graphical Rendering ("render") package. It can be used in SBML Level 3 Version 1 and Version 2 documents.

Introduction

The graphical depiction of a reaction network diagram should be described as graphical representations of species and reactions, and not as arbitrary drawing or graph. While it may seem unnecessary to invent a new language when an existing one like SVG could in principle be used to describe the layout of a reaction network, there are good reasons to have a language tailored specifically for the layout of SBML models. For example, most programs that will use this SBML extension are primarily programs dealing with biochemical models. Internally, they will have data structures for species and reactions, so it will also be natural for them to depict the reaction network in terms of species and reactions (and not in terms of, e.g., polygons or splines).

The Graphical Rendering ("render") package for SBML Level 3 is a companion to the Graphical Layout ("layout") package. Together, they provide a complete format for describing the layout of a diagram and the visual rendition of the entities within it.

Authors

The primary authors of the SBML Level 3 Render specification are Frank T. Bergmann, Sarah M. Keating, Ralph Gauges, Sven Sahle and Katja Wengler.

The specification for this SBML package

This API documentation for libSBML does not provide a complete explanation of the SBML Level 3 “render” package. If you are developing software that uses “render”, you are strongly urged to read the actual specification for the package. A link to the specification document current is provided below, along with a link to the page of known issues (if any).

Specification for SBML Level 3 Render, current at the time of this libSBML release (5.18.0). Note: an Internet connection is required to access these documents.

Specification (in PDF format)	Known issues
Render package, Version 1 Release 1	Errata page