ajgraph.c

Datatypes: none AjPGraph AjPGraphdata none

Datatype: none

Graphics internals

Sections: modifiers Base colours Queries Drawing Calculations unused exit

Section: modifiers

Controlling the internals

Functions: ajGraphicsClose ajGraphicsCloseWin ajGraphicsPlenv ajGraphicsResetBgcolour ajGraphicsResetFgcolour ajGraphicsSetBgcolourBlack ajGraphicsSetBgcolourWhite ajGraphicsSetCharscale ajGraphicsSetCharsize ajGraphicsSetDefcharsize ajGraphicsSetDevice ajGraphicsSetFgcolour ajGraphicsSetFilename ajGraphicsSetFillpat ajGraphicsSetLabelsC ajGraphicsSetLabelsS ajGraphicsSetLinestyle ajGraphicsSetPagesize ajGraphicsSetPenwidth ajGraphicsSetPortrait ajGraphicsSetRlabelC ajGraphicsSetRlabelS

Function ajGraphicsClose

Close current Plot.

Synopsis

Prototype
void ajGraphicsClose (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Close current Plot.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCloseWin

Close current window Plot

Synopsis

Prototype
void ajGraphicsCloseWin (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Close current window Plot

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsPlenv

Defines a plot environment. i.e. tells plplot whether the graph is boxed, whether it has tick marks, whether it has labels etc. These should already be set in the flags.

Synopsis

Prototype
void ajGraphicsPlenv (
      float xmin,
      float xmax,
      float ymin,
      float ymax,
      ajint flags
);

TypeNameRead/WriteDescription
floatxminInputX axis start
floatxmaxInputX axis end
floatyminInputY axis start
floatymaxInputY axis end
ajintflagsInputflag bit settings
void RETURN

Input
xmin:(Input)X axis start
xmax:(Input)X axis end
ymin:(Input)Y axis start
ymax:(Input)Y axis end
flags:(Input)flag bit settings
Returns
void:No return value

Description

Defines a plot environment. i.e. tells plplot whether the graph is boxed, whether it has tick marks, whether it has labels etc. These should already be set in the flags.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsResetBgcolour

Reset the background colour to either black or white depending on the current settings.

Synopsis

Prototype
void ajGraphicsResetBgcolour (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Reset the background colour to either black or white depending on the current settings.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsResetFgcolour

Reset the foreground plotting colour using current stored colour.

Synopsis

Prototype
void ajGraphicsResetFgcolour (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Reset the foreground plotting colour using current stored colour.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetBgcolourBlack

Set the background colour to black

Synopsis

Prototype
void ajGraphicsSetBgcolourBlack (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Set the background colour to black

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetBgcolourWhite

Set the background colour to white (the default colour)

Synopsis

Prototype
void ajGraphicsSetBgcolourWhite (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Set the background colour to white (the default colour)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetCharscale

Set the character scale factor

Synopsis

Prototype
float ajGraphicsSetCharscale (
      float scale
);

TypeNameRead/WriteDescription
floatscaleInputcharacter scale.
float RETURNthe previous character scale factor.

Input
scale:(Input)character scale.
Returns
float:the previous character scale factor.

Description

Set the character scale factor

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetCharsize

Set the character size factor

Synopsis

Prototype
float ajGraphicsSetCharsize (
      float size
);

TypeNameRead/WriteDescription
floatsizeInputcharacter size.
float RETURNthe previous character size factor.

Input
size:(Input)character size.
Returns
float:the previous character size factor.

Description

Set the character size factor

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetDefcharsize

Set the default character size in mm.

Synopsis

Prototype
float ajGraphicsSetDefcharsize (
      float size
);

TypeNameRead/WriteDescription
floatsizeInputcharacter size in mm.
float RETURNthe previous character size in mm.

Input
size:(Input)character size in mm.
Returns
float:the previous character size in mm.

Description

Set the default character size in mm.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetDevice

Set internal graph device to that selected for a graph object

Synopsis

Prototype
void ajGraphicsSetDevice (
      const AjPGraph graph
);

TypeNameRead/WriteDescription
const AjPGraphgraphInputGraph object with display type set
void RETURN

Input
graph:(Input)Graph object with display type set
Returns
void:No return value

Description

Set internal graph device to that selected for a graph object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetFgcolour

Set the foreground plotting colour

Synopsis

Prototype
ajint ajGraphicsSetFgcolour (
      ajint colour
);

TypeNameRead/WriteDescription
ajintcolourInputcolour to set drawing to.
ajint RETURNthe previous colour.

Input
colour:(Input)colour to set drawing to.
Returns
ajint:the previous colour.

Description

Set the foreground plotting colour

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetFilename

set BaseName and extension.

Synopsis

Prototype
void ajGraphicsSetFilename (
      const AjPGraph graph
);

TypeNameRead/WriteDescription
const AjPGraphgraphInputGraph object.
void RETURN

Input
graph:(Input)Graph object.
Returns
void:No return value

Description

set BaseName and extension.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetFillpat

Set the Fill Pattern type.

Synopsis

Prototype
ajint ajGraphicsSetFillpat (
      ajint patstyle
);

TypeNameRead/WriteDescription
ajintpatstyleInputline style to set drawing to.
ajint RETURNthe previous line style.

Input
patstyle:(Input)line style to set drawing to.
Returns
ajint:the previous line style.

Description

Set the Fill Pattern type.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetLabelsC

Label current Plot.

Synopsis

Prototype
void ajGraphicsSetLabelsC (
      const char* x,
      const char* y,
      const char* title,
      const char* subtitle
);

TypeNameRead/WriteDescription
const char*xInputtext for x axis labelling.
const char*yInputtext for y axis labelling.
const char*titleInputtext for title of plot.
const char*subtitleInputtext for subtitle of plot.
void RETURN

Input
x:(Input)text for x axis labelling.
y:(Input)text for y axis labelling.
title:(Input)text for title of plot.
subtitle:(Input)text for subtitle of plot.
Returns
void:No return value

Description

Label current Plot.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetLabelsS

Label current Plot.

Synopsis

Prototype
void ajGraphicsSetLabelsS (
      const AjPStr strx,
      const AjPStr stry,
      const AjPStr strtitle,
      const AjPStr strsubtitle
);

TypeNameRead/WriteDescription
const AjPStrstrxInputtext for x axis labelling.
const AjPStrstryInputtext for y axis labelling.
const AjPStrstrtitleInputtext for title of plot.
const AjPStrstrsubtitleInputtext for subtitle of plot.
void RETURN

Input
strx:(Input)text for x axis labelling.
stry:(Input)text for y axis labelling.
strtitle:(Input)text for title of plot.
strsubtitle:(Input)text for subtitle of plot.
Returns
void:No return value

Description

Label current Plot.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetLinestyle

Set the line style.

Synopsis

Prototype
ajint ajGraphicsSetLinestyle (
      ajint linestyle
);

TypeNameRead/WriteDescription
ajintlinestyleInputline style to set drawing to.
ajint RETURNthe previous line style.

Input
linestyle:(Input)line style to set drawing to.
Returns
ajint:the previous line style.

Description

Set the line style.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetPagesize

Set the width and height of the plot page.

Ignored by most plplot drivers, but will be used by PNG

Synopsis

Prototype
void ajGraphicsSetPagesize (
      ajuint plotwidth,
      ajuint plotheight
);

TypeNameRead/WriteDescription
ajuintplotwidthInputPage width in pixels or mm
ajuintplotheightInputPage height in pixels or mm
void RETURN

Input
plotwidth:(Input)Page width in pixels or mm
plotheight:(Input)Page height in pixels or mm
Returns
void:No return value

Description

Set the width and height of the plot page.

Ignored by most plplot drivers, but will be used by PNG

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetPenwidth

Set the current pen width.

Synopsis

Prototype
void ajGraphicsSetPenwidth (
      float penwidth
);

TypeNameRead/WriteDescription
floatpenwidthInputwidth for the pen.
void RETURN

Input
penwidth:(Input)width for the pen.
Returns
void:No return value

Description

Set the current pen width.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetPortrait

Set graph orientation

Synopsis

Prototype
void ajGraphicsSetPortrait (
      AjBool set
);

TypeNameRead/WriteDescription
AjBoolsetInputportrait orientation if true, else landscape
void RETURN

Input
set:(Input)portrait orientation if true, else landscape
Returns
void:No return value

Description

Set graph orientation

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetRlabelC

Label the right hand y axis.

Synopsis

Prototype
void ajGraphicsSetRlabelC (
      const char* txt
);

TypeNameRead/WriteDescription
const char*txtInputtext for label of right y axis.
void RETURN

Input
txt:(Input)text for label of right y axis.
Returns
void:No return value

Description

Label the right hand y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsSetRlabelS

Label the right hand y axis.

Synopsis

Prototype
void ajGraphicsSetRlabelS (
      const AjPStr str
);

TypeNameRead/WriteDescription
const AjPStrstrInputtext for label of right y axis.
void RETURN

Input
str:(Input)text for label of right y axis.
Returns
void:No return value

Description

Label the right hand y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Base colours

Generating arrays of valid colour codes

Functions: ajGraphicsBasecolourNewNuc ajGraphicsBasecolourNewProt

Function ajGraphicsBasecolourNewNuc

Initialise a base colours array for a string of nucleotide sequence characters

Synopsis

Prototype
ajint* ajGraphicsBasecolourNewNuc (
      const AjPStr codes
);

TypeNameRead/WriteDescription
const AjPStrcodesInputResidue codes for each numbered position
ajint* RETURNArray of colours (see PLPLOT)

Input
codes:(Input)Residue codes for each numbered position
Returns
ajint*:Array of colours (see PLPLOT)

Description

Initialise a base colours array for a string of nucleotide sequence characters

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsBasecolourNewProt

Initialize a base colours array for a string of protein sequence characters according to the following colour scheme designed by Toby Gibson (EMBL Heidelberg) to show the chemical properties important in sequence and structure alignment and to be clear to those with common forms of colour blindness.

DE: Red (Acidic) HKR: Blue (Basic) NQ: Green (Amide) AILV: Black (Hydrophobic Small) FWY: Wheat (Hydrophobic Large) ST: Cyan (Hydroxyl group) CM: Yellow (Sulphur chemistry) G: Grey (helix breaker I) P: Violet (helix breaker II)

Synopsis

Prototype
ajint* ajGraphicsBasecolourNewProt (
      const AjPStr codes
);

TypeNameRead/WriteDescription
const AjPStrcodesInputResidue codes for each numbered position
ajint* RETURNArray of colours (see PLPLOT)

Input
codes:(Input)Residue codes for each numbered position
Returns
ajint*:Array of colours (see PLPLOT)

Description

Initialize a base colours array for a string of protein sequence characters according to the following colour scheme designed by Toby Gibson (EMBL Heidelberg) to show the chemical properties important in sequence and structure alignment and to be clear to those with common forms of colour blindness.

DE: Red (Acidic) HKR: Blue (Basic) NQ: Green (Amide) AILV: Black (Hydrophobic Small) FWY: Wheat (Hydrophobic Large) ST: Cyan (Hydroxyl group) CM: Yellow (Sulphur chemistry) G: Grey (helix breaker I) P: Violet (helix breaker II)

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Queries

Querying and reporting internal values

Functions: ajGraphicsCheckColourC ajGraphicsCheckColourS ajGraphicsGetCharsize ajGraphicsGetFgcolour ajGraphicsGetParamsPage

Function ajGraphicsCheckColourC

Find if the colour is on the list

Synopsis

Prototype
ajint ajGraphicsCheckColourC (
      const char* txt
);

TypeNameRead/WriteDescription
const char*txtInputcolour name.
ajint RETURNthe colour number if found else -1.

Input
txt:(Input)colour name.
Returns
ajint:the colour number if found else -1.

Description

Find if the colour is on the list

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCheckColourS

Find if the colour is on the list

Synopsis

Prototype
ajint ajGraphicsCheckColourS (
      const AjPStr str
);

TypeNameRead/WriteDescription
const AjPStrstrInputcolour name.
ajint RETURNthe colour number if found else -1.

Input
str:(Input)colour name.
Returns
ajint:the colour number if found else -1.

Description

Find if the colour is on the list

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsGetCharsize

Get the char size.

Synopsis

Prototype
void ajGraphicsGetCharsize (
      float* defheight,
      float* currentscale
);

TypeNameRead/WriteDescription
float*defheightModifywhere to store the default character height
float*currentscaleModifywhere to store the current (scaled) character height
void RETURN

Input & Output
defheight:(Modify)where to store the default character height
currentscale:(Modify)where to store the current (scaled) character height
Returns
void:No return value

Description

Get the char size.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsGetFgcolour

Return current foreground colour

Synopsis

Prototype
ajint ajGraphicsGetFgcolour (
      void
);

TypeNameRead/WriteDescription
ajint RETURNcolour.

Returns
ajint:colour.

Description

Return current foreground colour

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsGetParamsPage

Get the output page parameters for plplot internal use. These can be set by the user and used by some device drivers.

For graph data type, sets to zero as these are not applicable.

Synopsis

Prototype
void ajGraphicsGetParamsPage (
      float* xp,
      float* yp,
      ajint* xleng,
      ajint* yleng,
      ajint* xoff,
      ajint* yoff
);

TypeNameRead/WriteDescription
float*xpModifywhere to store the x pixels/inch
float*ypModifywhere to store the y pixels/inch
ajint*xlengModifywhere to store the x length
ajint*ylengModifywhere to the y length
ajint*xoffModifywhere to store the x offset
ajint*yoffModifywhere to store the y offset
void RETURN

Input & Output
xp:(Modify)where to store the x pixels/inch
yp:(Modify)where to store the y pixels/inch
xleng:(Modify)where to store the x length
yleng:(Modify)where to the y length
xoff:(Modify)where to store the x offset
yoff:(Modify)where to store the y offset
Returns
void:No return value

Description

Get the output page parameters for plplot internal use. These can be set by the user and used by some device drivers.

For graph data type, sets to zero as these are not applicable.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Drawing

Drawing lines and objects

Functions: ajGraphicsDrawarcArc ajGraphicsDrawarcRect ajGraphicsDrawarcRectFill ajGraphicsDrawarcTextJustify ajGraphicsDrawbarsHoriz ajGraphicsDrawbarsVert ajGraphicsDrawposBox ajGraphicsDrawposBoxFill ajGraphicsDrawposCircle ajGraphicsDrawposDia ajGraphicsDrawposDiaFill ajGraphicsDrawposLine ajGraphicsDrawposRect ajGraphicsDrawposRectFill ajGraphicsDrawposTextAtend ajGraphicsDrawposTextAtlineJustify ajGraphicsDrawposTextAtmid ajGraphicsDrawposTextAtstart ajGraphicsDrawposTextJustify ajGraphicsDrawposTri ajGraphicsDrawposTriFill ajGraphicsDrawsetDots ajGraphicsDrawsetLines ajGraphicsDrawsetPoly ajGraphicsDrawsetPolyFill ajGraphicsDrawsetSymbols

Function ajGraphicsDrawarcArc

Draw a portion of a circle (an arc).

Synopsis

Prototype
void ajGraphicsDrawarcArc (
      PLFLT xcentre,
      PLFLT ycentre,
      PLFLT radius,
      PLFLT startangle,
      PLFLT endangle
);

TypeNameRead/WriteDescription
PLFLTxcentreInputx coord for centre.
PLFLTycentreInputy coord for centre.
PLFLTradiusInputradius of the circle.
PLFLTstartangleInputangle of the start of the arc.
PLFLTendangleInputangle of the end of the arc.
void RETURN

Input
xcentre:(Input)x coord for centre.
ycentre:(Input)y coord for centre.
radius:(Input)radius of the circle.
startangle:(Input)angle of the start of the arc.
endangle:(Input)angle of the end of the arc.
Returns
void:No return value

Description

Draw a portion of a circle (an arc).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawarcRect

Draw a rectangle along a curve with the current pen colour/style.

Synopsis

Prototype
void ajGraphicsDrawarcRect (
      PLFLT xcentre,
      PLFLT ycentre,
      PLFLT radius,
      PLFLT startangle,
      PLFLT endangle,
      PLFLT height
);

TypeNameRead/WriteDescription
PLFLTxcentreInputx coord for centre.
PLFLTycentreInputy coord for centre.
PLFLTradiusInputradius of the circle.
PLFLTstartangleInputangle of the start of the rectangle.
PLFLTendangleInputangle of the end of the rectangle.
PLFLTheightInputHeight of the rectangle in user coordinates.
void RETURN

Input
xcentre:(Input)x coord for centre.
ycentre:(Input)y coord for centre.
radius:(Input)radius of the circle.
startangle:(Input)angle of the start of the rectangle.
endangle:(Input)angle of the end of the rectangle.
height:(Input)Height of the rectangle in user coordinates.
Returns
void:No return value

Description

Draw a rectangle along a curve with the current pen colour/style.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawarcRectFill

Draw a rectangle along a curve and fill it with the current pen colour/style.

Synopsis

Prototype
void ajGraphicsDrawarcRectFill (
      PLFLT xcentre,
      PLFLT ycentre,
      PLFLT radius,
      PLFLT startangle,
      PLFLT endangle,
      PLFLT height
);

TypeNameRead/WriteDescription
PLFLTxcentreInputx coord for centre.
PLFLTycentreInputy coord for centre.
PLFLTradiusInputradius of the circle.
PLFLTstartangleInputangle of the start of the rectangle.
PLFLTendangleInputangle of the end of the rectangle.
PLFLTheightInputHeight of the rectangle in user coordinates.
void RETURN

Input
xcentre:(Input)x coord for centre.
ycentre:(Input)y coord for centre.
radius:(Input)radius of the circle.
startangle:(Input)angle of the start of the rectangle.
endangle:(Input)angle of the end of the rectangle.
height:(Input)Height of the rectangle in user coordinates.
Returns
void:No return value

Description

Draw a rectangle along a curve and fill it with the current pen colour/style.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawarcTextJustify

Draw text along a curve (i.e., an arc of a circle). The text is written character by character, forwards or backwards depending on the angle.

Synopsis

Prototype
void ajGraphicsDrawarcTextJustify (
      PLFLT xcentre,
      PLFLT ycentre,
      PLFLT radius,
      PLFLT startangle,
      PLFLT endangle,
      const char* txt,
      PLFLT just
);

TypeNameRead/WriteDescription
PLFLTxcentreInputx coord for centre.
PLFLTycentreInputy coord for centre.
PLFLTradiusInputradius of the circle.
PLFLTstartangleInputangle of the start of the arc (in deg).
PLFLTendangleInputangle of the end of the arc (in deg).
const char*txtInputThe text to be displayed.
PLFLTjustInputjustification of the string. (0=left,1=right,0.5=middle etc)
void RETURN

Input
xcentre:(Input)x coord for centre.
ycentre:(Input)y coord for centre.
radius:(Input)radius of the circle.
startangle:(Input)angle of the start of the arc (in deg).
endangle:(Input)angle of the end of the arc (in deg).
txt:(Input)The text to be displayed.
just:(Input)justification of the string. (0=left,1=right,0.5=middle etc)
Returns
void:No return value

Description

Draw text along a curve (i.e., an arc of a circle). The text is written character by character, forwards or backwards depending on the angle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawbarsHoriz

Draw Horizontal Error Bars.

Synopsis

Prototype
void ajGraphicsDrawbarsHoriz (
      ajuint num,
      PLFLT* y,
      PLFLT* xmin,
      PLFLT* xmax
);

TypeNameRead/WriteDescription
ajuintnumInputnumber of error bars to be drawn.
CONST PLFLT*yInputy positions to draw at.
CONST PLFLT*xminInputx positions to start at.
CONST PLFLT*xmaxInputx positions to end at.
void RETURN

Input
num:(Input)number of error bars to be drawn.
y:(Input)y positions to draw at.
xmin:(Input)x positions to start at.
xmax:(Input)x positions to end at.
Returns
void:No return value

Description

Draw Horizontal Error Bars.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawbarsVert

Draw vertical Error Bars.

Synopsis

Prototype
void ajGraphicsDrawbarsVert (
      ajuint num,
      PLFLT* x,
      PLFLT* ymin,
      PLFLT* ymax
);

TypeNameRead/WriteDescription
ajuintnumInputnumber of error bars to be drawn.
CONST PLFLT*xInputx positions to draw at.
CONST PLFLT*yminInputy positions to start at.
CONST PLFLT*ymaxInputy positions to end at.
void RETURN

Input
num:(Input)number of error bars to be drawn.
x:(Input)x positions to draw at.
ymin:(Input)y positions to start at.
ymax:(Input)y positions to end at.
Returns
void:No return value

Description

Draw vertical Error Bars.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposBox

Draw a box to the plotter device at point xx0,yy0 size big.

Synopsis

Prototype
void ajGraphicsDrawposBox (
      PLFLT x,
      PLFLT y,
      PLFLT size
);

TypeNameRead/WriteDescription
PLFLTxInputx position to draw the box.
PLFLTyInputy position to draw the box.
PLFLTsizeInputhow big to draw the box.
void RETURN

Input
x:(Input)x position to draw the box.
y:(Input)y position to draw the box.
size:(Input)how big to draw the box.
Returns
void:No return value

Description

Draw a box to the plotter device at point xx0,yy0 size big.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposBoxFill

Draw a box to the plotter device at point xx0,yy0 size big and fill it in.

Synopsis

Prototype
void ajGraphicsDrawposBoxFill (
      PLFLT x,
      PLFLT y,
      PLFLT size
);

TypeNameRead/WriteDescription
PLFLTxInputx position to draw the box.
PLFLTyInputy position to draw the box.
PLFLTsizeInputhow big to draw the box.
void RETURN

Input
x:(Input)x position to draw the box.
y:(Input)y position to draw the box.
size:(Input)how big to draw the box.
Returns
void:No return value

Description

Draw a box to the plotter device at point xx0,yy0 size big and fill it in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposCircle

Draw a circle.

Synopsis

Prototype
void ajGraphicsDrawposCircle (
      PLFLT x,
      PLFLT y,
      float radius
);

TypeNameRead/WriteDescription
PLFLTxInputx coord for centre.
PLFLTyInputy coord for centre.
floatradiusInputradius of the circle.
void RETURN

Input
x:(Input)x coord for centre.
y:(Input)y coord for centre.
radius:(Input)radius of the circle.
Returns
void:No return value

Description

Draw a circle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposDia

Draw a diamond to the plotter device at point xx0,yy0 size big.

Synopsis

Prototype
void ajGraphicsDrawposDia (
      PLFLT x,
      PLFLT y,
      PLFLT size
);

TypeNameRead/WriteDescription
PLFLTxInputx position to draw the diamond.
PLFLTyInputy position to draw the diamond.
PLFLTsizeInputhow big to draw the diamond.
void RETURN

Input
x:(Input)x position to draw the diamond.
y:(Input)y position to draw the diamond.
size:(Input)how big to draw the diamond.
Returns
void:No return value

Description

Draw a diamond to the plotter device at point xx0,yy0 size big.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposDiaFill

Draw a diamond to the plotter device at point xx0,yy0 size big and fill it in.

Synopsis

Prototype
void ajGraphicsDrawposDiaFill (
      PLFLT x,
      PLFLT y,
      PLFLT size
);

TypeNameRead/WriteDescription
PLFLTxInputx position to draw the diamond.
PLFLTyInputy position to draw the diamond.
PLFLTsizeInputhow big to draw the diamond.
void RETURN

Input
x:(Input)x position to draw the diamond.
y:(Input)y position to draw the diamond.
size:(Input)how big to draw the diamond.
Returns
void:No return value

Description

Draw a diamond to the plotter device at point xx0,yy0 size big and fill it in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposLine

Draw line between 2 points.

Synopsis

Prototype
void ajGraphicsDrawposLine (
      PLFLT x,
      PLFLT y,
      PLFLT x2,
      PLFLT y2
);

TypeNameRead/WriteDescription
PLFLTxInputx start position.
PLFLTyInputy start position.
PLFLTx2Inputx end position.
PLFLTy2Inputy end position.
void RETURN

Input
x:(Input)x start position.
y:(Input)y start position.
x2:(Input)x end position.
y2:(Input)y end position.
Returns
void:No return value

Description

Draw line between 2 points.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposRect

Draw a rectangle with the current pen colour/style.

Synopsis

Prototype
void ajGraphicsDrawposRect (
      PLFLT x,
      PLFLT y,
      PLFLT x2,
      PLFLT y2
);

TypeNameRead/WriteDescription
PLFLTxInputxx0 coord.
PLFLTyInputyy0 coord.
PLFLTx2Inputxx1 coord.
PLFLTy2Inputyy1 coord.
void RETURN

Input
x:(Input)xx0 coord.
y:(Input)yy0 coord.
x2:(Input)xx1 coord.
y2:(Input)yy1 coord.
Returns
void:No return value

Description

Draw a rectangle with the current pen colour/style.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposRectFill

Draw a rectangle and fill it with the current pen colour/style.

Synopsis

Prototype
void ajGraphicsDrawposRectFill (
      PLFLT x,
      PLFLT y,
      PLFLT x2,
      PLFLT y2
);

TypeNameRead/WriteDescription
PLFLTxInputxx0 coord.
PLFLTyInputyy0 coord.
PLFLTx2Inputxx1 coord.
PLFLTy2Inputyy1 coord.
void RETURN

Input
x:(Input)xx0 coord.
y:(Input)yy0 coord.
x2:(Input)xx1 coord.
y2:(Input)yy1 coord.
Returns
void:No return value

Description

Draw a rectangle and fill it with the current pen colour/style.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTextAtend

Draw text ending at position (xx1,yy1)

Synopsis

Prototype
void ajGraphicsDrawposTextAtend (
      PLFLT x,
      PLFLT y,
      const char* txt
);

TypeNameRead/WriteDescription
PLFLTxInputxx1 coord.
PLFLTyInputyy1 coord.
const char*txtInputThe text to be displayed.
void RETURN

Input
x:(Input)xx1 coord.
y:(Input)yy1 coord.
txt:(Input)The text to be displayed.
Returns
void:No return value

Description

Draw text ending at position (xx1,yy1)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTextAtlineJustify

Draw text along a line.

Synopsis

Prototype
void ajGraphicsDrawposTextAtlineJustify (
      PLFLT x,
      PLFLT y,
      PLFLT x2,
      PLFLT y2,
      const char* txt,
      PLFLT just
);

TypeNameRead/WriteDescription
PLFLTxInputx1 coord.
PLFLTyInputy1 coord.
PLFLTx2Inputx2 coord.
PLFLTy2Inputy2 coord.
const char*txtInputThe text to be displayed.
PLFLTjustInputjustification of the string. (0=left,1=right,0.5=middle etc)
void RETURN

Input
x:(Input)x1 coord.
y:(Input)y1 coord.
x2:(Input)x2 coord.
y2:(Input)y2 coord.
txt:(Input)The text to be displayed.
just:(Input)justification of the string. (0=left,1=right,0.5=middle etc)
Returns
void:No return value

Description

Draw text along a line.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTextAtmid

Draw text with Mid point of text at (xx1,yy1).

For graph data type, writes directly.

Synopsis

Prototype
void ajGraphicsDrawposTextAtmid (
      PLFLT x,
      PLFLT y,
      const char* txt
);

TypeNameRead/WriteDescription
PLFLTxInputxx1 coord.
PLFLTyInputyy1 coord.
const char*txtInputThe text to be displayed.
void RETURN

Input
x:(Input)xx1 coord.
y:(Input)yy1 coord.
txt:(Input)The text to be displayed.
Returns
void:No return value

Description

Draw text with Mid point of text at (xx1,yy1).

For graph data type, writes directly.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTextAtstart

Draw text starting at position (xx1,yy1)

Synopsis

Prototype
void ajGraphicsDrawposTextAtstart (
      PLFLT x,
      PLFLT y,
      const char* txt
);

TypeNameRead/WriteDescription
PLFLTxInputxx1 coordinate
PLFLTyInputyy1 coordinate
const char*txtInputThe text to be displayed.
void RETURN

Input
x:(Input)xx1 coordinate
y:(Input)yy1 coordinate
txt:(Input)The text to be displayed.
Returns
void:No return value

Description

Draw text starting at position (xx1,yy1)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTextJustify

Draw text, positioning with respect to (xx1,yy1) by justified as defined by just.

Synopsis

Prototype
void ajGraphicsDrawposTextJustify (
      PLFLT x,
      PLFLT y,
      const char* txt,
      PLFLT just
);

TypeNameRead/WriteDescription
PLFLTxInputxx1 coord.
PLFLTyInputyy1 coord.
const char*txtInputThe text to be displayed.
PLFLTjustInputjustification of the string. (0=left,1=right,0.5=middle etc)
void RETURN

Input
x:(Input)xx1 coord.
y:(Input)yy1 coord.
txt:(Input)The text to be displayed.
just:(Input)justification of the string. (0=left,1=right,0.5=middle etc)
Returns
void:No return value

Description

Draw text, positioning with respect to (xx1,yy1) by justified as defined by just.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTri

Draw a Triangle.

Synopsis

Prototype
void ajGraphicsDrawposTri (
      PLFLT x,
      PLFLT y,
      PLFLT x2,
      PLFLT y2,
      PLFLT x3,
      PLFLT y3
);

TypeNameRead/WriteDescription
PLFLTxInputxx1 coord of point 1.
PLFLTyInputyy1 coord of point 1.
PLFLTx2Inputxx2 coord of point 2.
PLFLTy2Inputyy2 coord of point 2.
PLFLTx3Inputx3 coord of point 3.
PLFLTy3Inputy3 coord of point 3.
void RETURN

Input
x:(Input)xx1 coord of point 1.
y:(Input)yy1 coord of point 1.
x2:(Input)xx2 coord of point 2.
y2:(Input)yy2 coord of point 2.
x3:(Input)x3 coord of point 3.
y3:(Input)y3 coord of point 3.
Returns
void:No return value

Description

Draw a Triangle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawposTriFill

Draw a Triangle and fill it in.

Synopsis

Prototype
void ajGraphicsDrawposTriFill (
      PLFLT x,
      PLFLT y,
      PLFLT x2,
      PLFLT y2,
      PLFLT x3,
      PLFLT y3
);

TypeNameRead/WriteDescription
PLFLTxInputxx1 coord of point 1.
PLFLTyInputyy1 coord of point 1.
PLFLTx2Inputxx2 coord of point 2.
PLFLTy2Inputyy2 coord of point 2.
PLFLTx3Inputx3 coord of point 3.
PLFLTy3Inputy3 coord of point 3.
void RETURN

Input
x:(Input)xx1 coord of point 1.
y:(Input)yy1 coord of point 1.
x2:(Input)xx2 coord of point 2.
y2:(Input)yy2 coord of point 2.
x3:(Input)x3 coord of point 3.
y3:(Input)y3 coord of point 3.
Returns
void:No return value

Description

Draw a Triangle and fill it in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawsetDots

Draw a set of dots.

Synopsis

Prototype
void ajGraphicsDrawsetDots (
      ajuint num,
      PLFLT* xx,
      PLFLT* yy
);

TypeNameRead/WriteDescription
ajuintnumInputThe number of dots to be drawn.
CONST PLFLT*xxInputxx1 coord.
CONST PLFLT*yyInputyy1 coord.
void RETURN

Input
num:(Input)The number of dots to be drawn.
xx:(Input)xx1 coord.
yy:(Input)yy1 coord.
Returns
void:No return value

Description

Draw a set of dots.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawsetLines

Draw a set of lines.

Synopsis

Prototype
void ajGraphicsDrawsetLines (
      ajuint num,
      PLFLT* xx,
      PLFLT* yy,
      PLFLT* xx2,
      PLFLT* yy2
);

TypeNameRead/WriteDescription
ajuintnumInputThe number of lines to be drawn.
CONST PLFLT*xxModifyx start coordinates
CONST PLFLT*yyModifyy start coordinates
CONST PLFLT*xx2Modifyx end coordinates
CONST PLFLT*yy2Modifyy end coordinates
void RETURN

Input
num:(Input)The number of lines to be drawn.
Input & Output
xx:(Modify)x start coordinates
yy:(Modify)y start coordinates
xx2:(Modify)x end coordinates
yy2:(Modify)y end coordinates
Returns
void:No return value

Description

Draw a set of lines.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawsetPoly

Draw a polygon.

Synopsis

Prototype
void ajGraphicsDrawsetPoly (
      ajuint num,
      PLFLT* xx,
      PLFLT* yy
);

TypeNameRead/WriteDescription
ajuintnumInputnumber of points
CONST PLFLT*xxInputx coord of points
CONST PLFLT*yyInputy coord of points
void RETURN

Input
num:(Input)number of points
xx:(Input)x coord of points
yy:(Input)y coord of points
Returns
void:No return value

Description

Draw a polygon.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawsetPolyFill

Draw a polygon and fill it in.

Synopsis

Prototype
void ajGraphicsDrawsetPolyFill (
      ajuint num,
      PLFLT* xx,
      PLFLT* yy
);

TypeNameRead/WriteDescription
ajuintnumInputnumber of points
CONST PLFLT*xxInputx coord of points
CONST PLFLT*yyInputy coord of points
void RETURN

Input
num:(Input)number of points
xx:(Input)x coord of points
yy:(Input)y coord of points
Returns
void:No return value

Description

Draw a polygon and fill it in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsDrawsetSymbols

Draw a set of dots.

Synopsis

Prototype
void ajGraphicsDrawsetSymbols (
      ajuint num,
      PLFLT* xx,
      PLFLT* yy,
      ajuint symbol
);

TypeNameRead/WriteDescription
ajuintnumInputNumber of coordinates in xx1 and xx2.
CONST PLFLT*xxInputxx1 coord.
CONST PLFLT*yyInputyy1 coord.
ajuintsymbolInputSymbol code.
void RETURN

Input
num:(Input)Number of coordinates in xx1 and xx2.
xx:(Input)xx1 coord.
yy:(Input)yy1 coord.
symbol:(Input)Symbol code.
Returns
void:No return value

Description

Draw a set of dots.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Calculations

Calculations using plot internals

Functions: ajGraphicsCalcCharsize ajGraphicsCalcCoord ajGraphicsCalcDistance ajGraphicsCalcRange ajGraphicsCalcTextheight ajGraphicsCalcTextlengthC ajGraphicsCalcTextlengthS

Function ajGraphicsCalcCharsize

Computes the character size (in mm) needed to write a text string with specified height and length (in user coord). The length of the string is the distance between (xx1,yy1) and (xx2,yy2); its height is TextHeight. If the default size is too large, characters are shrunk. If it is too small, characters are enlarged.

Synopsis

Prototype
PLFLT ajGraphicsCalcCharsize (
      PLFLT xx1,
      PLFLT yy1,
      PLFLT xx2,
      PLFLT yy2,
      const char* text,
      PLFLT TextHeight
);

TypeNameRead/WriteDescription
PLFLTxx1Inputxx1 coord.
PLFLTyy1Inputyy1 coord.
PLFLTxx2Inputxx2 coord.
PLFLTyy2Inputyy2 coord.
const char*textInputThe text to be displayed.
PLFLTTextHeightInputThe height of the text (in user coord).
PLFLT RETURNThe character size (in mm) that fits the specified height and length.

Input
xx1:(Input)xx1 coord.
yy1:(Input)yy1 coord.
xx2:(Input)xx2 coord.
yy2:(Input)yy2 coord.
text:(Input)The text to be displayed.
TextHeight:(Input)The height of the text (in user coord).
Returns
PLFLT:The character size (in mm) that fits the specified height and length.

Description

Computes the character size (in mm) needed to write a text string with specified height and length (in user coord). The length of the string is the distance between (xx1,yy1) and (xx2,yy2); its height is TextHeight. If the default size is too large, characters are shrunk. If it is too small, characters are enlarged.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCalcCoord

compute the coordinates of a point on a circle knowing the angle.

Synopsis

Prototype
PLFLT* ajGraphicsCalcCoord (
      PLFLT x,
      PLFLT y,
      PLFLT radius,
      PLFLT angle
);

TypeNameRead/WriteDescription
PLFLTxInputx coord for centre.
PLFLTyInputy coord for centre.
PLFLTradiusInputRadius of the circle.
PLFLTangleInputangle at which the point is.
PLFLT* RETURNThe x and y coordinates of the point.

Input
x:(Input)x coord for centre.
y:(Input)y coord for centre.
radius:(Input)Radius of the circle.
angle:(Input)angle at which the point is.
Returns
PLFLT*:The x and y coordinates of the point.

Description

compute the coordinates of a point on a circle knowing the angle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCalcDistance

Compute the distance between 2 points in user coordinates.

Synopsis

Prototype
PLFLT ajGraphicsCalcDistance (
      PLFLT xx1,
      PLFLT yy1,
      PLFLT xx2,
      PLFLT yy2
);

TypeNameRead/WriteDescription
PLFLTxx1Inputx coord of point 1
PLFLTyy1Inputy coord of point 1
PLFLTxx2Inputx coord of point 2
PLFLTyy2Inputy coord of point 2
PLFLT RETURNThe distance between the 2 points in user coordinates.

Input
xx1:(Input)x coord of point 1
yy1:(Input)y coord of point 1
xx2:(Input)x coord of point 2
yy2:(Input)y coord of point 2
Returns
PLFLT:The distance between the 2 points in user coordinates.

Description

Compute the distance between 2 points in user coordinates.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCalcRange

Get the max and min of the data points you wish to display.

Synopsis

Prototype
void ajGraphicsCalcRange (
      const float* array,
      ajuint npoints,
      float* min,
      float* max
);

TypeNameRead/WriteDescription
const float*arrayInputarray
ajuintnpointsInputNumber of data points
float*minOutputmin.
float*maxOutputmax.
void RETURN

Input
array:(Input)array
npoints:(Input)Number of data points
Output
min:(Output)min.
max:(Output)max.
Returns
void:No return value

Description

Get the max and min of the data points you wish to display.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCalcTextheight

Compute the height of a character in millimetres.

Synopsis

Prototype
PLFLT ajGraphicsCalcTextheight (
      void
);

TypeNameRead/WriteDescription
PLFLT RETURNThe height of the character in user coordinates.

Returns
PLFLT:The height of the character in user coordinates.

Description

Compute the height of a character in millimetres.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCalcTextlengthC

Compute the length of a string in millimetres.

Synopsis

Prototype
PLFLT ajGraphicsCalcTextlengthC (
      const char* txt
);

TypeNameRead/WriteDescription
const char*txtInputText
PLFLT RETURNThe length of the string in user coordinates.

Input
txt:(Input)Text
Returns
PLFLT:The length of the string in user coordinates.

Description

Compute the length of a string in millimetres.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsCalcTextlengthS

Compute the length of a string in millimetres.

Synopsis

Prototype
PLFLT ajGraphicsCalcTextlengthS (
      const AjPStr str
);

TypeNameRead/WriteDescription
const AjPStrstrInputText
PLFLT RETURNThe length of the string in user coordinates.

Input
str:(Input)Text
Returns
PLFLT:The length of the string in user coordinates.

Description

Compute the length of a string in millimetres.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: unused

Functions: ajGraphicsUnused

Function ajGraphicsUnused

Unused functions to avoid compiler warnings

Synopsis

Prototype
void ajGraphicsUnused (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Unused functions to avoid compiler warnings

See Also

See other functions in this section

Availability

In release 6.4.0

Section: exit

Functions called on exit

Functions: ajGraphicsExit

Function ajGraphicsExit

Cleans up graphics internal memory

Synopsis

Prototype
void ajGraphicsExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up graphics internal memory

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPGraph

Graph object

Sections: Constructors Opening Modifiers Queries Plotting Debugging Graph data management

Section: Constructors

Construct a new graph object to be populated by other functions

Functions: ajGraphNew

Function ajGraphNew

Create a structure to hold a general graph.

Synopsis

Prototype
AjPGraph ajGraphNew (
      void
);

TypeNameRead/WriteDescription
AjPGraph RETURNmultiple graph structure.

Returns
AjPGraph:multiple graph structure.

Description

Create a structure to hold a general graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Opening

Opens a plot page

Functions: ajGraphInitSeq ajGraphNewpage ajGraphOpenFlags ajGraphOpenMm ajGraphOpenPlotset ajGraphOpenWin

Function ajGraphInitSeq

Initialises a graph using default values based on a sequence.

Existing titles and other data are unchanged

Synopsis

Prototype
void ajGraphInitSeq (
      AjPGraph thys,
      const AjPSeq seq
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph
const AjPSeqseqInputSequence
void RETURN

Input
seq:(Input)Sequence
Input & Output
thys:(Modify)Graph
Returns
void:No return value

Description

Initialises a graph using default values based on a sequence.

Existing titles and other data are unchanged

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphNewpage

Clear Screen if (X) or new page if plotter/postscript. Also pass a boolean to state whether you want the current pen colour character sizes, plot title and subtitle, etc to be reset or stay the same for the next page.

Synopsis

Prototype
void ajGraphNewpage (
      AjPGraph thys,
      AjBool resetdefaults
);

TypeNameRead/WriteDescription
AjPGraphthysOutputGraph object
AjBoolresetdefaultsInputreset page setting?
void RETURN

Input
resetdefaults:(Input)reset page setting?
Output
thys:(Output)Graph object
Returns
void:No return value

Description

Clear Screen if (X) or new page if plotter/postscript. Also pass a boolean to state whether you want the current pen colour character sizes, plot title and subtitle, etc to be reset or stay the same for the next page.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphOpenFlags

Open a window whose view is defined by the x's and y's min and max values.

Synopsis

Prototype
void ajGraphOpenFlags (
      AjPGraph thys,
      PLFLT xmin,
      PLFLT xmax,
      PLFLT ymin,
      PLFLT ymax,
      ajint flags
);

TypeNameRead/WriteDescription
AjPGraphthysOutputGraph object
PLFLTxminInputminimum x value.(user coordinates)
PLFLTxmaxInputmaximum x value.
PLFLTyminInputminimum y value.
PLFLTymaxInputmaximum y value.
ajintflagsInputflag bit settings
void RETURN

Input
xmin:(Input)minimum x value.(user coordinates)
xmax:(Input)maximum x value.
ymin:(Input)minimum y value.
ymax:(Input)maximum y value.
flags:(Input)flag bit settings
Output
thys:(Output)Graph object
Returns
void:No return value

Description

Open a window whose view is defined by the x's and y's min and max values.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphOpenMm

Open a window whose view is defined by x and y's size in millimetres to allow easy scaling of characters and strings whose sizes are always in millimetres.

Synopsis

Prototype
void ajGraphOpenMm (
      AjPGraph thys,
      float* xmm,
      float* ymm
);

TypeNameRead/WriteDescription
AjPGraphthysOutputGraph object
float*xmmOutputx length in millimetres
float*ymmOutputy length in millimetres
void RETURN

Output
thys:(Output)Graph object
xmm:(Output)x length in millimetres
ymm:(Output)y length in millimetres
Returns
void:No return value

Description

Open a window whose view is defined by x and y's size in millimetres to allow easy scaling of characters and strings whose sizes are always in millimetres.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphOpenPlotset

Open a window with a set of plots

Synopsis

Prototype
void ajGraphOpenPlotset (
      AjPGraph thys,
      ajuint numofsets
);

TypeNameRead/WriteDescription
AjPGraphthysOutputGraph object.
ajuintnumofsetsInputnumber of plots in set.
void RETURN

Input
numofsets:(Input)number of plots in set.
Output
thys:(Output)Graph object.
Returns
void:No return value

Description

Open a window with a set of plots

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphOpenWin

Open a window whose view is defined by x and y's min and max.

Synopsis

Prototype
void ajGraphOpenWin (
      AjPGraph thys,
      float xmin,
      float xmax,
      float ymin,
      float ymax
);

TypeNameRead/WriteDescription
AjPGraphthysOutputGraph object
floatxminInputminimum x value.(user coordinates)
floatxmaxInputmaximum x value.
floatyminInputminimum y value.
floatymaxInputmaximum y value.
void RETURN

Input
xmin:(Input)minimum x value.(user coordinates)
xmax:(Input)maximum x value.
ymin:(Input)minimum y value.
ymax:(Input)maximum y value.
Output
thys:(Output)Graph object
Returns
void:No return value

Description

Open a window whose view is defined by x and y's min and max.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Modifiers

Modifying a general graph object

Functions: ajGraphAppendTitleC ajGraphAppendTitleS ajGraphClear ajGraphSetDescC ajGraphSetDescS ajGraphSetDevicetype ajGraphSetFlag ajGraphSetMulti ajGraphSetOutdirS ajGraphSetOutfileC ajGraphSetOutfileS ajGraphSetSubtitleC ajGraphSetSubtitleS ajGraphSetTitleC ajGraphSetTitleS ajGraphSetXlabelC ajGraphSetXlabelS ajGraphSetYlabelC ajGraphSetYlabelS ajGraphShowSubtitle ajGraphShowTitle

Function ajGraphAppendTitleC

Set an empty graph title from the description or program name and extra text 'of ...' supplied by the caller.

Synopsis

Prototype
void ajGraphAppendTitleC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const char*txtInputTitle.
void RETURN

Input
txt:(Input)Title.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set an empty graph title from the description or program name and extra text 'of ...' supplied by the caller.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphAppendTitleS

Set an empty graph title from the description or program name and extra text 'of ...' supplied by the caller.

Synopsis

Prototype
void ajGraphAppendTitleS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const AjPStrstrInputTitle.
void RETURN

Input
str:(Input)Title.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set an empty graph title from the description or program name and extra text 'of ...' supplied by the caller.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphClear

Delete all the drawable objects connected to the graph object.

Synopsis

Prototype
void ajGraphClear (
      AjPGraph thys
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
void RETURN

Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Delete all the drawable objects connected to the graph object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetDescC

Set the graph description.

Synopsis

Prototype
void ajGraphSetDescC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const char*txtInputTitle.
void RETURN

Input
txt:(Input)Title.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the graph description.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetDescS

Set the graph description.

Synopsis

Prototype
void ajGraphSetDescS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const AjPStrstrInputTitle.
void RETURN

Input
str:(Input)Title.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the graph description.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetDevicetype

Initialize options for a general graph object

Synopsis

Prototype
AjBool ajGraphSetDevicetype (
      AjPGraph thys,
      const AjPStr devicetype
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
const AjPStrdevicetypeInputGraph type
AjBool RETURNajTrue on success

Input
devicetype:(Input)Graph type
Input & Output
thys:(Modify)Graph object
Returns
AjBool:ajTrue on success

Description

Initialize options for a general graph object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetFlag

Set the flags for the graph to add or subtract "flag" depending on set

Synopsis

Prototype
void ajGraphSetFlag (
      AjPGraph thys,
      ajint flag,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flags altered.
ajintflagInputflag to be set.
AjBoolsetInputwhether to set the flag or remove it.
void RETURN

Input
flag:(Input)flag to be set.
set:(Input)whether to set the flag or remove it.
Input & Output
thys:(Modify)graph to have flags altered.
Returns
void:No return value

Description

Set the flags for the graph to add or subtract "flag" depending on set

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetMulti

Create a structure to hold a number of graphs.

Synopsis

Prototype
void ajGraphSetMulti (
      AjPGraph thys,
      ajuint numsets
);

TypeNameRead/WriteDescription
AjPGraphthysOutputGraph structure to store info in.
ajuintnumsetsInputmaximum number of graphs that can be stored.
void RETURN

Input
numsets:(Input)maximum number of graphs that can be stored.
Output
thys:(Output)Graph structure to store info in.
Returns
void:No return value

Description

Create a structure to hold a number of graphs.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetOutdirS

Set the directory of the output file. Only used later if the device plotter is capable of writing to a file (e.g. postscript or png)

Synopsis

Prototype
void ajGraphSetOutdirS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to update file name
const AjPStrstrInputName of the file.
void RETURN

Input
str:(Input)Name of the file.
Input & Output
thys:(Modify)Graph structure to update file name
Returns
void:No return value

Description

Set the directory of the output file. Only used later if the device plotter is capable of writing to a file (e.g. postscript or png)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetOutfileC

Set the name of the output file. Only used later if the device plotter is capable of postscript output. ps and cps.

Synopsis

Prototype
void ajGraphSetOutfileC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to write file name to.
const char*txtInputName of the file.
void RETURN

Input
txt:(Input)Name of the file.
Input & Output
thys:(Modify)Graph structure to write file name to.
Returns
void:No return value

Description

Set the name of the output file. Only used later if the device plotter is capable of postscript output. ps and cps.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetOutfileS

Set the name of the output file. Only used later if the device plotter is capable of postscript output. ps and cps.

Synopsis

Prototype
void ajGraphSetOutfileS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to write file name to.
const AjPStrstrInputName of the file.
void RETURN

Input
str:(Input)Name of the file.
Input & Output
thys:(Modify)Graph structure to write file name to.
Returns
void:No return value

Description

Set the name of the output file. Only used later if the device plotter is capable of postscript output. ps and cps.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetSubtitleC

Set the graph subtitle.

Synopsis

Prototype
void ajGraphSetSubtitleC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const char*txtInputSubtitle.
void RETURN

Input
txt:(Input)Subtitle.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the graph subtitle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetSubtitleS

Set the title for the Y axis.

Synopsis

Prototype
void ajGraphSetSubtitleS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const AjPStrstrInputSubtitle
void RETURN

Input
str:(Input)Subtitle
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the Y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetTitleC

Set the graph Title.

Synopsis

Prototype
void ajGraphSetTitleC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const char*txtInputtitle.
void RETURN

Input
txt:(Input)title.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the graph Title.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetTitleS

Set the graph title.

Synopsis

Prototype
void ajGraphSetTitleS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const AjPStrstrInputTitle.
void RETURN

Input
str:(Input)Title.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the graph title.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetXlabelC

Set the title for the X axis for multiple plot on one graph.

Synopsis

Prototype
void ajGraphSetXlabelC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const char*txtInputtitle for the x axis.
void RETURN

Input
txt:(Input)title for the x axis.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the X axis for multiple plot on one graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetXlabelS

Set the title for the X axis for multiple plots on one graph.

Synopsis

Prototype
void ajGraphSetXlabelS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const AjPStrstrInputtitle for the x axis.
void RETURN

Input
str:(Input)title for the x axis.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the X axis for multiple plots on one graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetYlabelC

Set the title for the Y axis for multiple plots on one graph.

Synopsis

Prototype
void ajGraphSetYlabelC (
      AjPGraph thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const char*txtInputtitle for the y axis.
void RETURN

Input
txt:(Input)title for the y axis.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the Y axis for multiple plots on one graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphSetYlabelS

Set the title for the Y axis for multiple plots on one graph.

Synopsis

Prototype
void ajGraphSetYlabelS (
      AjPGraph thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
const AjPStrstrInputtitle for the y axis.
void RETURN

Input
str:(Input)title for the y axis.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the Y axis for multiple plots on one graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphShowSubtitle

Set whether the graph is to display the subtitle.

Synopsis

Prototype
void ajGraphShowSubtitle (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the subtitle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphShowTitle

Set whether the graph is to display the title.

Synopsis

Prototype
void ajGraphShowTitle (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the title.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Queries

Querying and reporting internal values

Functions: ajGraphGetParamsPage ajGraphGetSubtitleC ajGraphGetSubtitleS ajGraphGetTitleC ajGraphGetTitleS ajGraphGetXlabelC ajGraphGetXlabelS ajGraphGetYlabelC ajGraphGetYlabelS ajGraphIsData

Function ajGraphGetParamsPage

Get the output page parameters stored in a graph object

For graph data type, sets to zero as these are not applicable.

Synopsis

Prototype
void ajGraphGetParamsPage (
      const AjPGraph thys,
      float* xp,
      float* yp,
      ajint* xleng,
      ajint* yleng,
      ajint* xoff,
      ajint* yoff
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
float*xpModifywhere to store the x position
float*ypModifywhere to store the y position
ajint*xlengModifywhere to store the x length
ajint*ylengModifywhere to the y length
ajint*xoffModifywhere to store the x offset
ajint*yoffModifywhere to store the y offset
void RETURN

Input
thys:(Input)Graph object.
Input & Output
xp:(Modify)where to store the x position
yp:(Modify)where to store the y position
xleng:(Modify)where to store the x length
yleng:(Modify)where to the y length
xoff:(Modify)where to store the x offset
yoff:(Modify)where to store the y offset
Returns
void:No return value

Description

Get the output page parameters stored in a graph object

For graph data type, sets to zero as these are not applicable.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetSubtitleC

Return plot subtitle

Synopsis

Prototype
const char* ajGraphGetSubtitleC (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const char* RETURNSubtitle

Input
thys:(Input)Graph object.
Returns
const char*:Subtitle

Description

Return plot subtitle

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetSubtitleS

Return plot subtitle

Synopsis

Prototype
const AjPStr ajGraphGetSubtitleS (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const AjPStr RETURNSubtitle

Input
thys:(Input)Graph object.
Returns
const AjPStr:Subtitle

Description

Return plot subtitle

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetTitleC

Return plot title

Synopsis

Prototype
const char* ajGraphGetTitleC (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const char* RETURNTitle

Input
thys:(Input)Graph object.
Returns
const char*:Title

Description

Return plot title

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetTitleS

Return plot title

Synopsis

Prototype
const AjPStr ajGraphGetTitleS (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const AjPStr RETURNTitle

Input
thys:(Input)Graph object.
Returns
const AjPStr:Title

Description

Return plot title

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetXlabelC

Return plot x-axis label

Synopsis

Prototype
const char* ajGraphGetXlabelC (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const char* RETURNTitle of x-axis

Input
thys:(Input)Graph object.
Returns
const char*:Title of x-axis

Description

Return plot x-axis label

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetXlabelS

Return plot x-axis label

Synopsis

Prototype
const AjPStr ajGraphGetXlabelS (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const AjPStr RETURNTitle of x-axis

Input
thys:(Input)Graph object.
Returns
const AjPStr:Title of x-axis

Description

Return plot x-axis label

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetYlabelC

Return plot y-axis label

Synopsis

Prototype
const char* ajGraphGetYlabelC (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const char* RETURNTitle of y-axis

Input
thys:(Input)Graph object.
Returns
const char*:Title of y-axis

Description

Return plot y-axis label

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphGetYlabelS

Return plot y-axis label

Synopsis

Prototype
const AjPStr ajGraphGetYlabelS (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object.
const AjPStr RETURNTitle of y-axis

Input
thys:(Input)Graph object.
Returns
const AjPStr:Title of y-axis

Description

Return plot y-axis label

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphIsData

returns ajTrue if the graph is creating a data file

Synopsis

Prototype
AjBool ajGraphIsData (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object
AjBool RETURNajTrue if the graph is of type data

Input
thys:(Input)Graph object
Returns
AjBool:ajTrue if the graph is of type data

Description

returns ajTrue if the graph is creating a data file

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Plotting

Plotting drawable objects

Functions: ajGraphAddLine ajGraphAddRect ajGraphAddTextC ajGraphAddTextS ajGraphAddTextScaleC ajGraphAddTextScaleS

Function ajGraphAddLine

Add a line to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphAddLine (
      AjPGraph thys,
      float x,
      float y,
      float x2,
      float y2,
      ajint colour
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
floatxInputStart x position
floatyInputStart y position
floatx2InputEnd x position
floaty2InputEnd y position
ajintcolourInputColour code (see PLPLOT)
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
x2:(Input)End x position
y2:(Input)End y position
colour:(Input)Colour code (see PLPLOT)
Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Add a line to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphAddRect

Add a Rectangle to be drawn when the graph is plotted, fill states whether the rectangle should be filled in.

Synopsis

Prototype
void ajGraphAddRect (
      AjPGraph thys,
      float x,
      float y,
      float x2,
      float y2,
      ajint colour,
      ajint fill
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
floatxInputStart x coordinate
floatyInputStart y coordinate
floatx2InputEnd x coordinate
floaty2InputEnd y coordinate
ajintcolourInputColour code (see PLPLOT)
ajintfillInputFill code (see PLPLOT)
void RETURN

Input
x:(Input)Start x coordinate
y:(Input)Start y coordinate
x2:(Input)End x coordinate
y2:(Input)End y coordinate
colour:(Input)Colour code (see PLPLOT)
fill:(Input)Fill code (see PLPLOT)
Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Add a Rectangle to be drawn when the graph is plotted, fill states whether the rectangle should be filled in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphAddTextC

Add text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphAddTextC (
      AjPGraph thys,
      float x,
      float y,
      ajint colour,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
const char*txtInputText
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
txt:(Input)Text
Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Add text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphAddTextS

Add text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphAddTextS (
      AjPGraph thys,
      float x,
      float y,
      ajint colour,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
const AjPStrstrInputText
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
str:(Input)Text
Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Add text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphAddTextScaleC

Add text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphAddTextScaleC (
      AjPGraph thys,
      float x,
      float y,
      ajint colour,
      float scale,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
floatscaleInputCharacter scale (0.0 to use the default)
const char*txtInputText
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
scale:(Input)Character scale (0.0 to use the default)
txt:(Input)Text
Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Add text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphAddTextScaleS

Add text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphAddTextScaleS (
      AjPGraph thys,
      float x,
      float y,
      ajint colour,
      float scale,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
floatscaleInputCharacter scale (0.0 to use the default)
const AjPStrstrInputText
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
scale:(Input)Character scale (0.0 to use the default)
str:(Input)Text
Input & Output
thys:(Modify)Graph object
Returns
void:No return value

Description

Add text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Debugging

Tracing the internal values of a graph object

Functions: ajGraphTrace

Function ajGraphTrace

Writes debug messages to trace the contents of a graph object.

Synopsis

Prototype
void ajGraphTrace (
      const AjPGraph thys
);

TypeNameRead/WriteDescription
const AjPGraphthysInputGraph object
void RETURN

Input
thys:(Input)Graph object
Returns
void:No return value

Description

Writes debug messages to trace the contents of a graph object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Graph data management

Functions to manage the graphdata objects associated with a graph object

Functions: ajGraphDataAdd ajGraphDataReplace ajGraphDataReplaceI

Function ajGraphDataAdd

Add another graph structure to the multiple graph structure.

The graphdata now belongs to the graph - do not delete it while the graph is using it.

Synopsis

Prototype
AjBool ajGraphDataAdd (
      AjPGraph thys,
      AjPGraphdata graphdata
);

TypeNameRead/WriteDescription
AjPGraphthysModifymultiple graph structure.
AjPGraphdatagraphdataModifygraph to be added.
AjBool RETURNTrue if graph added successfully

Input & Output
thys:(Modify)multiple graph structure.
graphdata:(Modify)graph to be added.
Returns
AjBool:True if graph added successfully

Description

Add another graph structure to the multiple graph structure.

The graphdata now belongs to the graph - do not delete it while the graph is using it.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphDataReplace

Replace graph structure into the multiple graph structure.

The graphdata now belongs to the graph - do not delete it while the graph is using it.

Synopsis

Prototype
AjBool ajGraphDataReplace (
      AjPGraph thys,
      AjPGraphdata graphdata
);

TypeNameRead/WriteDescription
AjPGraphthysModifymultiple graph structure.
AjPGraphdatagraphdataModifygraph to be added.
AjBool RETURNTrue if graph added successfully

Input & Output
thys:(Modify)multiple graph structure.
graphdata:(Modify)graph to be added.
Returns
AjBool:True if graph added successfully

Description

Replace graph structure into the multiple graph structure.

The graphdata now belongs to the graph - do not delete it while the graph is using it.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphDataReplaceI

Replace one of the graph structures in the multiple graph structure.

The graphdata now belongs to the graph - do not delete it while the graph is using it.

Synopsis

Prototype
AjBool ajGraphDataReplaceI (
      AjPGraph thys,
      AjPGraphdata graphdata,
      ajuint num
);

TypeNameRead/WriteDescription
AjPGraphthysModifymultiple graph structure.
AjPGraphdatagraphdataModifygraph to be added.
ajuintnumInputnumber within multiple graph.
AjBool RETURNTrue if graph added successfully

Input
num:(Input)number within multiple graph.
Input & Output
thys:(Modify)multiple graph structure.
graphdata:(Modify)graph to be added.
Returns
AjBool:True if graph added successfully

Description

Replace one of the graph structures in the multiple graph structure.

The graphdata now belongs to the graph - do not delete it while the graph is using it.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Constructors

Construct a new graph object to be populated by other functions

Functions: ajGraphxyNewI

Function ajGraphxyNewI

Create a structure to hold a number of graphs.

Synopsis

Prototype
AjPGraph ajGraphxyNewI (
      ajuint numsets
);

TypeNameRead/WriteDescription
ajuintnumsetsInputmaximum number of graphs that can be stored.
AjPGraph RETURNmultiple graph structure.

Input
numsets:(Input)maximum number of graphs that can be stored.
Returns
AjPGraph:multiple graph structure.

Description

Create a structure to hold a number of graphs.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Destructors

Destructors for AjGraph XY graph data

Functions: ajGraphxyDel

Function ajGraphxyDel

Destructor for a graph object

Synopsis

Prototype
void ajGraphxyDel (
      AjPGraph* pthis
);

TypeNameRead/WriteDescription
AjPGraph*pthisOutputGraph structure to store info in.
void RETURN

Output
pthis:(Output)Graph structure to store info in.
Returns
void:No return value

Description

Destructor for a graph object

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Display

Functions to display or write the graph

Functions: ajGraphxyDisplay

Function ajGraphxyDisplay

A general routine for drawing graphs.

Synopsis

Prototype
void ajGraphxyDisplay (
      AjPGraph thys,
      AjBool closeit
);

TypeNameRead/WriteDescription
AjPGraphthysModifyMultiple graph pointer.
AjBoolcloseitInputWhether to close graph at the end.
void RETURN

Input
closeit:(Input)Whether to close graph at the end.
Input & Output
thys:(Modify)Multiple graph pointer.
Returns
void:No return value

Description

A general routine for drawing graphs.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Modifiers

Set or modify internal values of an XY graph object

Functions: ajGraphxySetDevicetype ajGraphxySetMinmax ajGraphxySetRanges ajGraphxySetXendF ajGraphxySetXrangeII ajGraphxySetXstartF ajGraphxySetYendF ajGraphxySetYrangeII ajGraphxySetYstartF ajGraphxySetflagGaps ajGraphxySetflagOverlay ajGraphxyShowPointsCircle ajGraphxyShowPointsJoin ajGraphxyShowRaxis ajGraphxyShowUaxis ajGraphxyShowUnum ajGraphxyShowXaxis ajGraphxyShowXgrid ajGraphxyShowXinvert ajGraphxyShowXlabel ajGraphxyShowXtick ajGraphxyShowYaxis ajGraphxyShowYgrid ajGraphxyShowYinvert ajGraphxyShowYlabel ajGraphxyShowYnum ajGraphxyShowYtick

Function ajGraphxySetDevicetype

Initialize options for a graphxy object

Synopsis

Prototype
AjBool ajGraphxySetDevicetype (
      AjPGraph thys,
      const AjPStr devicetype
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph object
const AjPStrdevicetypeInputDevice type
AjBool RETURNajTrue on success

Input
devicetype:(Input)Device type
Input & Output
thys:(Modify)Graph object
Returns
AjBool:ajTrue on success

Description

Initialize options for a graphxy object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetMinmax

Set the max and min of the data points for all graphs.

Synopsis

Prototype
void ajGraphxySetMinmax (
      AjPGraph thys,
      float xmin,
      float xmax,
      float ymin,
      float ymax
);

TypeNameRead/WriteDescription
AjPGraphthysModifymultiple graph structure.
floatxminInputx min.
floatxmaxInputx max.
floatyminInputy min.
floatymaxInputy max.
void RETURN

Input
xmin:(Input)x min.
xmax:(Input)x max.
ymin:(Input)y min.
ymax:(Input)y max.
Input & Output
thys:(Modify)multiple graph structure.
Returns
void:No return value

Description

Set the max and min of the data points for all graphs.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetRanges

Calculate the max and min of the data points and store them.

See ajGraphxySetMaxmin for a function that defines explicit ranges

Synopsis

Prototype
void ajGraphxySetRanges (
      AjPGraph thys
);

TypeNameRead/WriteDescription
AjPGraphthysModifymultiple graph structure.
void RETURN

Input & Output
thys:(Modify)multiple graph structure.
Returns
void:No return value

Description

Calculate the max and min of the data points and store them.

See ajGraphxySetMaxmin for a function that defines explicit ranges

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetXendF

Set the end position for X in the graph.

Synopsis

Prototype
void ajGraphxySetXendF (
      AjPGraph thys,
      float val
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
floatvalInputThe end value for x graph coord
void RETURN

Input
val:(Input)The end value for x graph coord
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the end position for X in the graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetXrangeII

Sets the X axis range with integers

Synopsis

Prototype
void ajGraphxySetXrangeII (
      AjPGraph thys,
      ajint start,
      ajint end
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph
ajintstartInputstart position
ajintendInputend position
void RETURN

Input
start:(Input)start position
end:(Input)end position
Input & Output
thys:(Modify)Graph
Returns
void:No return value

Description

Sets the X axis range with integers

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetXstartF

Set the start position for X in the graph.

Synopsis

Prototype
void ajGraphxySetXstartF (
      AjPGraph thys,
      float val
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
floatvalInputThe start value for x graph coord.
void RETURN

Input
val:(Input)The start value for x graph coord.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the start position for X in the graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetYendF

Set the end position for Y in the graph.

Synopsis

Prototype
void ajGraphxySetYendF (
      AjPGraph thys,
      float val
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
floatvalInputThe start value for y graph coord.
void RETURN

Input
val:(Input)The start value for y graph coord.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the end position for Y in the graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetYrangeII

Sets the Y axis range with integers

Synopsis

Prototype
void ajGraphxySetYrangeII (
      AjPGraph thys,
      ajint start,
      ajint end
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph
ajintstartInputstart position
ajintendInputend position
void RETURN

Input
start:(Input)start position
end:(Input)end position
Input & Output
thys:(Modify)Graph
Returns
void:No return value

Description

Sets the Y axis range with integers

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetYstartF

Set the start position for Y in the graph.

Synopsis

Prototype
void ajGraphxySetYstartF (
      AjPGraph thys,
      float val
);

TypeNameRead/WriteDescription
AjPGraphthysModifyGraph structure to store info in.
floatvalInputThe end value for y graph coord.
void RETURN

Input
val:(Input)The end value for y graph coord.
Input & Output
thys:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the start position for Y in the graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetflagGaps

Set whether the graphs should enable gaps.

Synopsis

Prototype
void ajGraphxySetflagGaps (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifyMultiple graph object
AjBoolsetInputif true allow gaps else do not.
void RETURN

Input
set:(Input)if true allow gaps else do not.
Input & Output
thys:(Modify)Multiple graph object
Returns
void:No return value

Description

Set whether the graphs should enable gaps.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxySetflagOverlay

Set whether the graphs should lay on top of each other.

Synopsis

Prototype
void ajGraphxySetflagOverlay (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifyMultiple graph object
AjBoolsetInputif true overlap else do not.
void RETURN

Input
set:(Input)if true overlap else do not.
Input & Output
thys:(Modify)Multiple graph object
Returns
void:No return value

Description

Set whether the graphs should lay on top of each other.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowPointsCircle

Set the graph to draw circles at the points.

Synopsis

Prototype
void ajGraphxyShowPointsCircle (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set the graph to draw circles at the points.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowPointsJoin

Set the graph to draw lines between the points.

Synopsis

Prototype
void ajGraphxyShowPointsJoin (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set the graph to draw lines between the points.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowRaxis

Set the graph is to display a right hand Y axis.

Synopsis

Prototype
void ajGraphxyShowRaxis (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set the graph is to display a right hand Y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowUaxis

Set whether the graph is to display the left X axis at the top.

Synopsis

Prototype
void ajGraphxyShowUaxis (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the left X axis at the top.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowUnum

Set whether the graph is to display the labels on the upper x axis.

Synopsis

Prototype
void ajGraphxyShowUnum (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the labels on the upper x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowXaxis

Set whether the graph is to display a bottom x axis.

Synopsis

Prototype
void ajGraphxyShowXaxis (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display a bottom x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowXgrid

Set whether the graph is to grid the tick marks on the x axis.

Synopsis

Prototype
void ajGraphxyShowXgrid (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to grid the tick marks on the x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowXinvert

Set whether the graph is to display the tick marks inside the plot on the x axis.

Synopsis

Prototype
void ajGraphxyShowXinvert (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the tick marks inside the plot on the x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowXlabel

Set whether the graph is to label the x axis.

Synopsis

Prototype
void ajGraphxyShowXlabel (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to label the x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowXtick

Set whether the graph is to display tick marks on the x axis.

Synopsis

Prototype
void ajGraphxyShowXtick (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display tick marks on the x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowYaxis

Set whether the graph is to display the left Y axis.

Synopsis

Prototype
void ajGraphxyShowYaxis (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the left Y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowYgrid

Set whether the graph is to grid the tick marks on the x axis.

Synopsis

Prototype
void ajGraphxyShowYgrid (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to grid the tick marks on the x axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowYinvert

Set whether the graph is to display the tick marks inside the plot on the y axis.

Synopsis

Prototype
void ajGraphxyShowYinvert (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the tick marks inside the plot on the y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowYlabel

Set whether the graph is to label the y axis.

Synopsis

Prototype
void ajGraphxyShowYlabel (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to label the y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowYnum

Set whether the graph is to display the numbers on the left Y axis.

Synopsis

Prototype
void ajGraphxyShowYnum (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set whether the graph is to display the numbers on the left Y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphxyShowYtick

Set the graph is to display tick marks on the y axis.

Synopsis

Prototype
void ajGraphxyShowYtick (
      AjPGraph thys,
      AjBool set
);

TypeNameRead/WriteDescription
AjPGraphthysModifygraph to have flag altered
AjBoolsetInputwhether to set or turn off.
void RETURN

Input
set:(Input)whether to set or turn off.
Input & Output
thys:(Modify)graph to have flag altered
Returns
void:No return value

Description

Set the graph is to display tick marks on the y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPGraphdata

Graph data object

Sections: Constructors Destructors Modifiers Plotting Debugging

Section: Constructors

Constructors for AjGraphdata plot data

Functions: ajGraphdataNew ajGraphdataNewI

Function ajGraphdataNew

Creates a new empty graph

Synopsis

Prototype
AjPGraphdata ajGraphdataNew (
      void
);

TypeNameRead/WriteDescription
AjPGraphdata RETURNNew empty graph

Returns
AjPGraphdata:New empty graph

Description

Creates a new empty graph

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataNewI

Create and initialise the data structure for the graph with a defined number of data points.

Synopsis

Prototype
AjPGraphdata ajGraphdataNewI (
      ajuint numofpoints
);

TypeNameRead/WriteDescription
ajuintnumofpointsInputNumber of points
AjPGraphdata RETURNPointer to new graph structure.

Input
numofpoints:(Input)Number of points
Returns
AjPGraphdata:Pointer to new graph structure.

Description

Create and initialise the data structure for the graph with a defined number of data points.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Destructors

Destructors for AjGraphdata plot data

Functions: ajGraphdataDel

Function ajGraphdataDel

Destructor for a graph data object

Synopsis

Prototype
void ajGraphdataDel (
      AjPGraphdata* pthys
);

TypeNameRead/WriteDescription
AjPGraphdata*pthysDeleteGraph data object
void RETURN

Output
pthys:(Delete)Graph data object
Returns
void:No return value

Description

Destructor for a graph data object

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Modifiers

Set or modify the internals of a graph data object

Functions: ajGraphdataSetColour ajGraphdataSetLinetype ajGraphdataSetMinmax ajGraphdataSetSubtitleC ajGraphdataSetSubtitleS ajGraphdataSetTitleC ajGraphdataSetTitleS ajGraphdataSetTruescale ajGraphdataSetTypeC ajGraphdataSetTypeS ajGraphdataSetXlabelC ajGraphdataSetXlabelS ajGraphdataSetYlabelC ajGraphdataSetYlabelS

Function ajGraphdataSetColour

Set the colour for the plot on one graph.

Synopsis

Prototype
void ajGraphdataSetColour (
      AjPGraphdata graphdata,
      ajint colour
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
ajintcolourInputcolour for this plot.
void RETURN

Input
colour:(Input)colour for this plot.
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the colour for the plot on one graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetLinetype

Set the line type for this graph.

Synopsis

Prototype
void ajGraphdataSetLinetype (
      AjPGraphdata graphdata,
      ajint type
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
ajinttypeInputSet the line type.
void RETURN

Input
type:(Input)Set the line type.
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the line type for this graph.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetMinmax

Set the max and min of the data points you wish to display.

Synopsis

Prototype
void ajGraphdataSetMinmax (
      AjPGraphdata graphdata,
      float xmin,
      float xmax,
      float ymin,
      float ymax
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifymultiple graph structure.
floatxminInputx min.
floatxmaxInputx max.
floatyminInputy min.
floatymaxInputy max.
void RETURN

Input
xmin:(Input)x min.
xmax:(Input)x max.
ymin:(Input)y min.
ymax:(Input)y max.
Input & Output
graphdata:(Modify)multiple graph structure.
Returns
void:No return value

Description

Set the max and min of the data points you wish to display.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetSubtitleC

Set the subtitle.

Synopsis

Prototype
void ajGraphdataSetSubtitleC (
      AjPGraphdata graphdata,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const char*txtInputSub Title
void RETURN

Input
txt:(Input)Sub Title
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the subtitle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetSubtitleS

Set the Subtitle.

Synopsis

Prototype
void ajGraphdataSetSubtitleS (
      AjPGraphdata graphdata,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const AjPStrstrInputSub Title
void RETURN

Input
str:(Input)Sub Title
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the Subtitle.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetTitleC

Set the title.

Synopsis

Prototype
void ajGraphdataSetTitleC (
      AjPGraphdata graphdata,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const char*txtInputTitle
void RETURN

Input
txt:(Input)Title
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetTitleS

Set the title.

Synopsis

Prototype
void ajGraphdataSetTitleS (
      AjPGraphdata graphdata,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const AjPStrstrInputTitle
void RETURN

Input
str:(Input)Title
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetTruescale

Set the scale max and min of the data points you wish to display.

Synopsis

Prototype
void ajGraphdataSetTruescale (
      AjPGraphdata graphdata,
      float xmin,
      float xmax,
      float ymin,
      float ymax
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifymultiple graph structure.
floatxminInputtrue x min.
floatxmaxInputtrue x max.
floatyminInputtrue y min.
floatymaxInputtrue y max.
void RETURN

Input
xmin:(Input)true x min.
xmax:(Input)true x max.
ymin:(Input)true y min.
ymax:(Input)true y max.
Input & Output
graphdata:(Modify)multiple graph structure.
Returns
void:No return value

Description

Set the scale max and min of the data points you wish to display.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetTypeC

Set the type of the graph for data output.

Synopsis

Prototype
void ajGraphdataSetTypeC (
      AjPGraphdata graphdata,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifymultiple graph structure.
const char*txtInputType e.g. "2D Plot", "Histogram".
void RETURN

Input
txt:(Input)Type e.g. "2D Plot", "Histogram".
Input & Output
graphdata:(Modify)multiple graph structure.
Returns
void:No return value

Description

Set the type of the graph for data output.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetTypeS

Set the type of the graph for data output.

Synopsis

Prototype
void ajGraphdataSetTypeS (
      AjPGraphdata graphdata,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifymultiple graph structure.
const AjPStrstrInputType e.g. "2D Plot", "Histogram".
void RETURN

Input
str:(Input)Type e.g. "2D Plot", "Histogram".
Input & Output
graphdata:(Modify)multiple graph structure.
Returns
void:No return value

Description

Set the type of the graph for data output.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetXlabelC

Set the title for the X axis.

Synopsis

Prototype
void ajGraphdataSetXlabelC (
      AjPGraphdata graphdata,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const char*txtInputtitle for the X axis.
void RETURN

Input
txt:(Input)title for the X axis.
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the X axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetXlabelS

Set the title for the X axis.

Synopsis

Prototype
void ajGraphdataSetXlabelS (
      AjPGraphdata graphdata,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const AjPStrstrInputtitle for the X axis.
void RETURN

Input
str:(Input)title for the X axis.
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the X axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetYlabelC

Set the title for the Y axis.

Synopsis

Prototype
void ajGraphdataSetYlabelC (
      AjPGraphdata graphdata,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const char*txtInputtitle for the Y axis.
void RETURN

Input
txt:(Input)title for the Y axis.
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the Y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataSetYlabelS

Set the title for the Y axis.

Synopsis

Prototype
void ajGraphdataSetYlabelS (
      AjPGraphdata graphdata,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph structure to store info in.
const AjPStrstrInputtitle for the Y axis.
void RETURN

Input
str:(Input)title for the Y axis.
Input & Output
graphdata:(Modify)Graph structure to store info in.
Returns
void:No return value

Description

Set the title for the Y axis.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Plotting

Plotting drawable objects

Functions: ajGraphdataAddXY ajGraphdataAddposLine ajGraphdataAddposRect ajGraphdataAddposTextC ajGraphdataAddposTextS ajGraphdataAddposTextScaleC ajGraphdataAddposTextScaleS ajGraphdataCalcXY

Function ajGraphdataAddXY

Adds (x,y) data points defined in two floating point arrays

Synopsis

Prototype
void ajGraphdataAddXY (
      AjPGraphdata graphdata,
      const float* xx,
      const float* yy
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph object
const float*xxInputX coordinates
const float*yyInputY coordinates
void RETURN

Input
xx:(Input)X coordinates
yy:(Input)Y coordinates
Input & Output
graphdata:(Modify)Graph object
Returns
void:No return value

Description

Adds (x,y) data points defined in two floating point arrays

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataAddposLine

Add a line to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphdataAddposLine (
      AjPGraphdata graphdata,
      float x,
      float y,
      float x2,
      float y2,
      ajint colour
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph data object
floatxInputStart x position
floatyInputStart y position
floatx2InputEnd x position
floaty2InputEnd y position
ajintcolourInputColour code (see PLPLOT)
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
x2:(Input)End x position
y2:(Input)End y position
colour:(Input)Colour code (see PLPLOT)
Input & Output
graphdata:(Modify)Graph data object
Returns
void:No return value

Description

Add a line to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataAddposRect

Add a Rectangle to be drawn when the graph is plotted, fill states whether the rectangle should be filled in.

Synopsis

Prototype
void ajGraphdataAddposRect (
      AjPGraphdata graphdata,
      float x,
      float y,
      float x2,
      float y2,
      ajint colour,
      ajint fill
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph data object
floatxInputStart x position
floatyInputStart y position
floatx2InputEnd x position
floaty2InputEnd y position
ajintcolourInputColour code (see PLPLOT)
ajintfillInputFill code (see PLPLOT)
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
x2:(Input)End x position
y2:(Input)End y position
colour:(Input)Colour code (see PLPLOT)
fill:(Input)Fill code (see PLPLOT)
Input & Output
graphdata:(Modify)Graph data object
Returns
void:No return value

Description

Add a Rectangle to be drawn when the graph is plotted, fill states whether the rectangle should be filled in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataAddposTextC

Add Text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphdataAddposTextC (
      AjPGraphdata graphdata,
      float x,
      float y,
      ajint colour,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph data object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
const char*txtInputText to add 1
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
txt:(Input)Text to add 1
Input & Output
graphdata:(Modify)Graph data object
Returns
void:No return value

Description

Add Text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataAddposTextS

Add Text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphdataAddposTextS (
      AjPGraphdata graphdata,
      float x,
      float y,
      ajint colour,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph data object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
const AjPStrstrInputText to add
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
str:(Input)Text to add
Input & Output
graphdata:(Modify)Graph data object
Returns
void:No return value

Description

Add Text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataAddposTextScaleC

Add Text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphdataAddposTextScaleC (
      AjPGraphdata graphdata,
      float x,
      float y,
      ajint colour,
      float scale,
      const char* txt
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph data object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
floatscaleInputCharacter scale (0.0 to use the default)
const char*txtInputText to add
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
scale:(Input)Character scale (0.0 to use the default)
txt:(Input)Text to add
Input & Output
graphdata:(Modify)Graph data object
Returns
void:No return value

Description

Add Text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataAddposTextScaleS

Add Text to be drawn when the graph is plotted.

Synopsis

Prototype
void ajGraphdataAddposTextScaleS (
      AjPGraphdata graphdata,
      float x,
      float y,
      ajint colour,
      float scale,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph data object
floatxInputStart x position
floatyInputStart y position
ajintcolourInputColour code (see PLPLOT)
floatscaleInputCharacter scale (0.0 to use the default)
const AjPStrstrInputText to add
void RETURN

Input
x:(Input)Start x position
y:(Input)Start y position
colour:(Input)Colour code (see PLPLOT)
scale:(Input)Character scale (0.0 to use the default)
str:(Input)Text to add
Input & Output
graphdata:(Modify)Graph data object
Returns
void:No return value

Description

Add Text to be drawn when the graph is plotted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphdataCalcXY

Adds (x,y) data points defined by an x-axis start and increment and a floating point array of y-axis values.

Synopsis

Prototype
void ajGraphdataCalcXY (
      AjPGraphdata graphdata,
      ajuint numofpoints,
      float start,
      float incr,
      const float* y
);

TypeNameRead/WriteDescription
AjPGraphdatagraphdataModifyGraph object
ajuintnumofpointsInputNumber of points in array
floatstartInputStart position
floatincrInputIncrement
const float*yInputY coordinates
void RETURN

Input
numofpoints:(Input)Number of points in array
start:(Input)Start position
incr:(Input)Increment
y:(Input)Y coordinates
Input & Output
graphdata:(Modify)Graph object
Returns
void:No return value

Description

Adds (x,y) data points defined by an x-axis start and increment and a floating point array of y-axis values.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Debugging

Tracing the internal values of a graph data object

Functions: ajGraphdataTrace

Function ajGraphdataTrace

Writes debug messages to trace the contents of a graphdata object.

Synopsis

Prototype
void ajGraphdataTrace (
      const AjPGraphdata thys
);

TypeNameRead/WriteDescription
const AjPGraphdatathysInputGraphdata object
void RETURN

Input
thys:(Input)Graphdata object
Returns
void:No return value

Description

Writes debug messages to trace the contents of a graphdata object.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Reporting internals

Sections: Reporting internals

Section: Reporting internals

Functions: ajGraphicsDumpDevices ajGraphicsGetOutfiles ajGraphicsListDevices ajGraphicsPrintType

Function ajGraphicsDumpDevices

Dump device options for a graph object

Synopsis

Prototype
void ajGraphicsDumpDevices (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Dump device options for a graph object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsGetOutfiles

Information on files created for graph output

Synopsis

Prototype
ajuint ajGraphicsGetOutfiles (
      AjPList* files
);

TypeNameRead/WriteDescription
AjPList*filesOutputList of graph files
ajuint RETURNNumber of files (will match length of list)

Output
files:(Output)List of graph files
Returns
ajuint:Number of files (will match length of list)

Description

Information on files created for graph output

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsListDevices

Store device names for a graph object in a list

Synopsis

Prototype
void ajGraphicsListDevices (
      AjPList list
);

TypeNameRead/WriteDescription
AjPListlistOutputList to write device names to.
void RETURN

Output
list:(Output)List to write device names to.
Returns
void:No return value

Description

Store device names for a graph object in a list

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsPrintType

Print graph types

Synopsis

Prototype
void ajGraphicsPrintType (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull report (usually ajFalse)
void RETURN

Input
full:(Input)Full report (usually ajFalse)
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Print graph types

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsxyDumpDevices

Dump device options for a graph object

Synopsis

Prototype
void ajGraphicsxyDumpDevices (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Dump device options for a graph object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajGraphicsxyListDevices

Store device names for a graph object in a list

Synopsis

Prototype
void ajGraphicsxyListDevices (
      AjPList list
);

TypeNameRead/WriteDescription
AjPListlistOutputList to write device names to.
void RETURN

Output
list:(Output)List to write device names to.
Returns
void:No return value

Description

Store device names for a graph object in a list

See Also

See other functions in this section

Availability

In release 6.4.0