API Reference
As mentioned before, by making use of the features of C++ API, a user can simply load the SBML document of an SBML file, automatically add Layout and Render features to it, straightforwardly make any change to these features, and finally write the added/modified features to the SBML file. In this regard, instructions on how to effectively use each component of C++ API, including its Enumeration, Classes, Structs, and Functions, are provided here:
Enumerations
The enumeration related to Layout extension:
The enumeration related to Render extension:
Classes and Structs
The classes and structs related to Layout extension:
The classes and structs related to Render extension:
- RenderInfo
- VeneerElement
- Veneer
- VColorDefinition
- VGradientBase
- VLinearGradient
- VRadialGradient
- VGradientStop
- VGlobalStyle
- VLocalStyle
- VLineEnding
- VTransformation2D
- VGraphicalPrimitive1D
- VGraphicalPrimitive2D
- VRenderGroup
- VImage
- RCurve
- VText
- VRectangle
- VEllipse
- VPolygon
- RenPoint
- RCubicBezier
- RAVector
- RPoint
Functions
The Get and Set functions:
The functions related to SBMLDocument:
The functions related to LayoutInfo:
The functions related to NetworkElement:
The functions related to Network:
The functions related to NGraphicalObject:
The functions related to NCompartment:
The functions related to NSpecies:
The functions related to NReaction:
The functions related to NSpeciesReference:
The functions related to NText:
The functions related to LCurve:
The functions related to LLineSegment:
The functions related to LCubicBezier:
The functions related to LBox:
The functions related to LPoint:
The functions related to RenderInfo:
The functions related to VeneerElement:
The functions related to Veneer:
- ne_ven_get
- ne_ven_get
- ne_ven_set
- ne_ven_set
- ne_ven_isRenderSpecified
- ne_ven_isSetBackgroundColor
- ne_ven_getBackgroundColor
- ne_ven_setBackgroundColor
- ne_ven_getNumColors
- ne_ven_getColor
- ne_ven_getColors
- ne_ven_addNewColor
- ne_ven_getNumGradients
- ne_ven_getGradient
- ne_ven_getGradients
- ne_ven_getNumLineEndings
- ne_ven_getLineEnding
- ne_ven_getLineEndings
- ne_ven_addNewLineEnding
- ne_ven_getLocalLineEndingFromGlobalLineEnding
- ne_ven_getNumStyles
- ne_ven_getStyle
- ne_ven_getStyles
- ne_ven_addNewGlobalStyle
- ne_ven_addNewLocalStyle
- ne_ven_findStyle
- ne_ven_getLocalStyleFromGlobalStyle
The functions related to VColorDefinition:
The functions related to VGradientBase:
The functions related to VLinearGradient:
The functions related to VRadialGradient:
The functions related to VGradientStop:
The functions related to VLineEnding:
The functions related to VGlobalStyle:
The functions related to VLocalStyle:
The functions related to VRenderGroup:
- ne_grp_get
- ne_grp_set
- ne_grp_isSetStrokeColor
- ne_grp_getStrokeColor
- ne_grp_setStrokeColor
- ne_grp_isSetStrokeWidth
- ne_grp_getStrokeWidth
- ne_grp_setStrokeWidth
- ne_grp_isSetStrokeDashArray
- ne_grp_getNumStrokeDashes
- ne_grp_getStrokeDash
- ne_grp_getStrokeDashArray
- ne_grp_setStrokeDashArray
- ne_grp_isSetFillColor
- ne_grp_getFillColor
- ne_grp_setFillColor
- ne_grp_isSetFillRule
- ne_grp_getFillRule
- ne_grp_setFillRule
- ne_grp_isSetFontFamily
- ne_grp_getFontFamily
- ne_grp_setFontFamily
- ne_grp_isSetFontSize
- ne_grp_getFontSize
- ne_grp_setFontSize
- ne_grp_isSetFontStyle
- ne_grp_getFontStyle
- ne_grp_setFontStyle
- ne_grp_isSetFontWeight
- ne_grp_getFontWeight
- ne_grp_setFontWeight
- ne_grp_isSetHTextAnchor
- ne_grp_getHTextAnchor
- ne_grp_setHTextAnchor
- ne_grp_isSetVTextAnchor
- ne_grp_getVTextAnchor
- ne_grp_setVTextAnchor
- ne_grp_isSetStartHead
- ne_grp_getStartHead
- ne_grp_setStartHead
- ne_grp_isSetEndHead
- ne_grp_getEndHead
- ne_grp_setEndHead
- ne_grp_getNumGeometricShapes
- ne_grp_getGeometricShape
- ne_grp_removeGeometricShapes
- ne_grp_addGeometricShape
The functions related to VTransformation2D:
- ne_gs_get
- ne_gs_set
- ne_gs_getShape
- ne_gs_setShapeFeatures
- ne_gs_isSetStrokeColor
- ne_gs_getStrokeColor
- ne_gs_setStrokeColor
- ne_gs_isSetStrokeWidth
- ne_gs_getStrokeWidth
- ne_gs_setStrokeWidth
- ne_gs_isSetStrokeDashArray
- ne_gs_getNumStrokeDashes
- ne_gs_getStrokeDash
- ne_gs_getStrokeDashArray
- ne_gs_setStrokeDashArray
- ne_gs_isSetFillColor
- ne_gs_getFillColor
- ne_gs_setFillColor
- ne_gs_isSetFillRule
- ne_gs_getFillRule
- ne_gs_setFillRule
The functions related to VImage:
- ne_img_get
- ne_img_set
- ne_img_isSetPositionX
- ne_img_getPositionX
- ne_img_setPositionX
- ne_img_isSetPositionY
- ne_img_getPositionY
- ne_img_setPositionY
- ne_img_isSetDimensionWidth
- ne_img_getDimensionWidth
- ne_img_setDimensionWidth
- ne_img_isSetDimensionHeight
- ne_img_getDimensionHeight
- ne_img_setDimensionHeight
- ne_img_isSetHref
- ne_img_getHref
- ne_img_setHref
The functions related to RCurve:
The functions related to VText:
- ne_txt_get
- ne_txt_set
- ne_txt_isSetPositionX
- ne_txt_getPositionX
- ne_txt_setPositionX
- ne_txt_isSetPositionY
- ne_txt_getPositionY
- ne_txt_setPositionY
- ne_txt_isSetFontFamily
- ne_txt_getFontFamily
- ne_txt_setFontFamily
- ne_txt_isSetFontSize
- ne_txt_getFontSize
- ne_txt_setFontSize
- ne_txt_isSetFontStyle
- ne_txt_getFontStyle
- ne_txt_setFontStyle
- ne_txt_isSetFontWeight
- ne_txt_getFontWeight
- ne_txt_setFontWeight
- ne_txt_isSetHTextAnchor
- ne_txt_getHTextAnchor
- ne_txt_setHTextAnchor
- ne_txt_isSetVTextAnchor
- ne_txt_getVTextAnchor
- ne_txt_setVTextAnchor
The functions related to VRectangle:
- ne_rec_get
- ne_rec_set
- ne_rec_isSetPositionX
- ne_rec_getPositionX
- ne_rec_setPositionX
- ne_rec_isSetPositionY
- ne_rec_getPositionY
- ne_rec_setPositionY
- ne_rec_isSetDimensionWidth
- ne_rec_getDimensionWidth
- ne_rec_setDimensionWidth
- ne_rec_isSetDimensionHeight
- ne_rec_getDimensionHeight
- ne_rec_setDimensionHeight
- ne_rec_isSetCornerCurvatureRX
- ne_rec_getCornerCurvatureRX
- ne_rec_setCornerCurvatureRX
- ne_rec_isSetCornerCurvatureRY
- ne_rec_getCornerCurvatureRY
- ne_rec_setCornerCurvatureRY
- ne_rec_isSetRatio
- ne_rec_getRatio
- ne_rec_setRatio
The functions related to VEllipse:
- ne_elp_get
- ne_elp_set
- ne_elp_isSetPositionCX
- ne_elp_getPositionCX
- ne_elp_setPositionCX
- ne_elp_isSetPositionCY
- ne_elp_getPositionCY
- ne_elp_setPositionCY
- ne_elp_isSetDimensionRX
- ne_elp_getDimensionRX
- ne_elp_setDimensionRX
- ne_elp_isSetDimensionRY
- ne_elp_getDimensionRY
- ne_elp_setDimensionRY
- ne_elp_isSetRatio
- ne_elp_getRatio
- ne_elp_setRatio
The functions related to VPolygon:
The functions related to RenPoint:
The functions related to RPoint:
The functions related to RAVector: