ajgraph.c

Synopsis

Prototype

void ajGraphSetDevice (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object with displaytype set

void RETURN

Type	Name	Read/Write	Description
const AjPGraph	thys	Input	Graph object with displaytype set
void		RETURN

Input

thys:

(Input)

Graph object with displaytype set

Returns

void:

No return value

Description

Set graph device

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Synopsis

Prototype

void ajGraphSetName (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

void RETURN

Type	Name	Read/Write	Description
const AjPGraph	thys	Input	Graph object.
void		RETURN

Input

thys:

(Input)

Graph object.

Returns

void:

No return value

Description

set BaseName and extension.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Synopsis

Prototype

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

Type Name Read/Write Description

const char* x Input text for x axis labelling.

const char* y Input text for y axis labelling.

const char* title Input text for title of plot.

const char* subtitle Input text for subtitle of plot.

void RETURN

Type	Name	Read/Write	Description
const char*	x	Input	text for x axis labelling.
const char*	y	Input	text for y axis labelling.
const char*	title	Input	text for title of plot.
const char*	subtitle	Input	text 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetPenWidth

Set the current pen width.

Synopsis

Prototype

void ajGraphSetPenWidth (
      float width
);

Type Name Read/Write Description

float width Input width for the pen.

void RETURN

Type	Name	Read/Write	Description
float	width	Input	width for the pen.
void		RETURN

Input

width:

(Input)

width for the pen.

Returns

void:

No return value

Description

Set the current pen width.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphOpenPlot

Open a window.

Synopsis

Prototype

void ajGraphOpenPlot (
      AjPGraph thys,
      ajint numofsets
);

Type Name Read/Write Description

AjPGraph thys Output Graph object.

ajint numofsets Input number of plots in set.

void RETURN

Type	Name	Read/Write	Description
AjPGraph	thys	Output	Graph object.
ajint	numofsets	Input	number 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.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
);

Type Name Read/Write Description

AjPGraph thys Output Graph object

float xmin Input minimum x value.(user coordinates)

float xmax Input maximum x value.

float ymin Input minimum y value.

float ymax Input maximum y value.

void RETURN

Type	Name	Read/Write	Description
AjPGraph	thys	Output	Graph object
float	xmin	Input	minimum x value.(user coordinates)
float	xmax	Input	maximum x value.
float	ymin	Input	minimum y value.
float	ymax	Input	maximum 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.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
);

Type Name Read/Write Description

AjPGraph thys Output Graph object

AjBool resetdefaults Input reset page setting?

void RETURN

Type	Name	Read/Write	Description
AjPGraph	thys	Output	Graph object
AjBool	resetdefaults	Input	reset page setting?
void		RETURN

Input

resetdefaults:

(Input)

reset page setting?

Output

thys:

(Output)

Graph object

Returns

void:

No return value

Description

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphCloseWin

Close current window.

Synopsis

Prototype

void ajGraphCloseWin (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
void		RETURN

Returns

void:

No return value

Description

Close current window.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphOpen

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

Synopsis

Prototype

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

Type Name Read/Write Description

AjPGraph thys Output Graph object

PLFLT xmin Input minimum x value.(user coordinates)

PLFLT xmax Input maximum x value.

PLFLT ymin Input minimum y value.

PLFLT ymax Input maximum y value.

ajint flags Input flag bit settings

void RETURN

Type	Name	Read/Write	Description
AjPGraph	thys	Output	Graph object
PLFLT	xmin	Input	minimum x value.(user coordinates)
PLFLT	xmax	Input	maximum x value.
PLFLT	ymin	Input	minimum y value.
PLFLT	ymax	Input	maximum y value.
ajint	flags	Input	flag 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphLabelYRight

Label the right hand y axis.

Synopsis

Prototype

void ajGraphLabelYRight (
      const char* text
);

Type Name Read/Write Description

const char* text Input text for label of right y axis.

void RETURN

Type	Name	Read/Write	Description
const char*	text	Input	text for label of right y axis.
void		RETURN

Input

text:

(Input)

text for label of right y axis.

Returns

void:

No return value

Description

Label the right hand y axis.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphClose

Close current Plot.

Synopsis

Prototype

void ajGraphClose (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
void		RETURN

Returns

void:

No return value

Description

Close current Plot.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSet

Initialize options for a graph object

Synopsis

Prototype

AjBool ajGraphSet (
      AjPGraph thys,
      const AjPStr type
);

Type Name Read/Write Description

AjPGraph thys Modify Graph object

const AjPStr type Input Graph type

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
AjPGraph	thys	Modify	Graph object
const AjPStr	type	Input	Graph type
AjBool		RETURN	ajTrue on success

Input

type:

(Input)

Graph type

Input & Output

thys:

(Modify)

Graph object

Returns

AjBool:

ajTrue on success

Description

Initialize options for a graph object

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySet

Initialize options for a graphxy object

Synopsis

Prototype

AjBool ajGraphxySet (
      AjPGraph thys,
      const AjPStr type
);

Type Name Read/Write Description

AjPGraph thys Modify Graph object

const AjPStr type Input Graph type

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
AjPGraph	thys	Modify	Graph object
const AjPStr	type	Input	Graph type
AjBool		RETURN	ajTrue on success

Input

type:

(Input)

Graph type

Input & Output

thys:

(Modify)

Graph object

Returns

AjBool:

ajTrue on success

Description

Initialize options for a graphxy object

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphDumpDevices

Dump device options for a graph object

Synopsis

Prototype

void ajGraphDumpDevices (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
void		RETURN

Returns

void:

No return value

Description

Dump device options for a graph object

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTrace

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

Synopsis

Prototype

void ajGraphTrace (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object

void RETURN

Type	Name	Read/Write	Description
const AjPGraph	thys	Input	Graph 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataTrace

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

Synopsis

Prototype

void ajGraphPlpDataTrace (
      const AjPGraphPlpData thys
);

Type Name Read/Write Description

const AjPGraphPlpData thys Input Graphdata object

void RETURN

Type	Name	Read/Write	Description
const AjPGraphPlpData	thys	Input	Graphdata 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphCircle

Draw a circle.

Synopsis

Prototype

void ajGraphCircle (
      PLFLT xcentre,
      PLFLT ycentre,
      float radius
);

Type Name Read/Write Description

PLFLT xcentre Input x coor for centre.

PLFLT ycentre Input y coor for centre.

float radius Input radius of the circle.

void RETURN

Input

xcentre:	(Input)	x coor for centre.
ycentre:	(Input)	y coor for centre.
radius:	(Input)	radius of the circle.

Returns

void:

No return value

Description

Draw a circle.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPolyFill

Draw a polygon and fill it in.

Synopsis

Prototype

void ajGraphPolyFill (
      ajint n,
      PLFLT* x,
      PLFLT* y
);

Type Name Read/Write Description

ajint n Input number of points

CONST PLFLT* x Input x coord of points

CONST PLFLT* y Input y coord of points

void RETURN

Input

n:	(Input)	number of points
x:	(Input)	x coord of points
y:	(Input)	y coord of points

Returns

void:

No return value

Description

Draw a polygon and fill it in.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPoly

Draw a polygon.

Synopsis

Prototype

void ajGraphPoly (
      ajint n,
      PLFLT* x,
      PLFLT* y
);

Type Name Read/Write Description

ajint n Input number of points

CONST PLFLT* x Input x coord of points

CONST PLFLT* y Input y coord of points

void RETURN

Input

n:	(Input)	number of points
x:	(Input)	x coord of points
y:	(Input)	y coord of points

Returns

void:

No return value

Description

Draw a polygon.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTriFill

Draw a Triangle and fill it in.

Synopsis

Prototype

void ajGraphTriFill (
      PLFLT xx1,
      PLFLT yy1,
      PLFLT xx2,
      PLFLT yy2,
      PLFLT x3,
      PLFLT y3
);

Type Name Read/Write Description

PLFLT xx1 Input xx1 coord of point 1.

PLFLT yy1 Input yy1 coord of point 1.

PLFLT xx2 Input xx2 coord of point 2.

PLFLT yy2 Input yy2 coord of point 2.

PLFLT x3 Input x3 coord of point 3.

PLFLT y3 Input y3 coord of point 3.

void RETURN

Input

xx1:	(Input)	xx1 coord of point 1.
yy1:	(Input)	yy1 coord of point 1.
xx2:	(Input)	xx2 coord of point 2.
yy2:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTri

Draw a Triangle.

Synopsis

Prototype

void ajGraphTri (
      PLFLT xx1,
      PLFLT yy1,
      PLFLT xx2,
      PLFLT yy2,
      PLFLT x3,
      PLFLT y3
);

Input

xx1:	(Input)	xx1 coord of point 1.
yy1:	(Input)	yy1 coord of point 1.
xx2:	(Input)	xx2 coord of point 2.
yy2:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphDiaFill

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

Synopsis

Prototype

void ajGraphDiaFill (
      PLFLT xx0,
      PLFLT yy0,
      PLFLT size
);

Type Name Read/Write Description

PLFLT xx0 Input x position to draw the diamond.

PLFLT yy0 Input y position to draw the diamond.

PLFLT size Input how big to draw the diamond.

void RETURN

Input

xx0:	(Input)	x position to draw the diamond.
yy0:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphDia

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

Synopsis

Prototype

void ajGraphDia (
      PLFLT xx0,
      PLFLT yy0,
      PLFLT size
);

Type Name Read/Write Description

PLFLT xx0 Input x position to draw the diamond.

PLFLT yy0 Input y position to draw the diamond.

PLFLT size Input how big to draw the diamond.

void RETURN

Input

xx0:	(Input)	x position to draw the diamond.
yy0:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphBoxFill

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

Synopsis

Prototype

void ajGraphBoxFill (
      PLFLT xx0,
      PLFLT yy0,
      PLFLT size
);

Type Name Read/Write Description

PLFLT xx0 Input x position to draw the box.

PLFLT yy0 Input y position to draw the box.

PLFLT size Input how big to draw the box.

void RETURN

Input

xx0:	(Input)	x position to draw the box.
yy0:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphBox

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

Synopsis

Prototype

void ajGraphBox (
      PLFLT xx0,
      PLFLT yy0,
      PLFLT size
);

Type Name Read/Write Description

PLFLT xx0 Input x position to draw the box.

PLFLT yy0 Input y position to draw the box.

PLFLT size Input how big to draw the box.

void RETURN

Input

xx0:	(Input)	x position to draw the box.
yy0:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphRectFill

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

Synopsis

Prototype

void ajGraphRectFill (
      PLFLT xx0,
      PLFLT yy0,
      PLFLT xx1,
      PLFLT yy1
);

Type Name Read/Write Description

PLFLT xx0 Input xx0 coor.

PLFLT yy0 Input yy0 coor.

PLFLT xx1 Input xx1 coor.

PLFLT yy1 Input yy1 coor.

void RETURN

Input

xx0:	(Input)	xx0 coor.
yy0:	(Input)	yy0 coor.
xx1:	(Input)	xx1 coor.
yy1:	(Input)	yy1 coor.

Returns

void:

No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphRect

Draw a rectangle with the current pen colour/style.

Synopsis

Prototype

void ajGraphRect (
      PLFLT xx0,
      PLFLT yy0,
      PLFLT xx1,
      PLFLT yy1
);

Type Name Read/Write Description

PLFLT xx0 Input xx0 coor.

PLFLT yy0 Input yy0 coor.

PLFLT xx1 Input xx1 coor.

PLFLT yy1 Input yy1 coor.

void RETURN

Input

xx0:	(Input)	xx0 coor.
yy0:	(Input)	yy0 coor.
xx1:	(Input)	xx1 coor.
yy1:	(Input)	yy1 coor.

Returns

void:

No return value

Description

Draw a rectangle with the current pen colour/style.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetBackWhite

Set the background colour to White.

Synopsis

Prototype

void ajGraphSetBackWhite (
      void
);

Type Name Read/Write Description

void RETURN

Returns

void:

No return value

Description

Set the background colour to White.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetBackBlack

Set the background colour to black if it is currently white

Synopsis

Prototype

void ajGraphSetBackBlack (
      void
);

Type Name Read/Write Description

void RETURN

Returns

void:

No return value

Description

Set the background colour to black if it is currently white

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphColourBack

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

Synopsis

Prototype

void ajGraphColourBack (
      void
);

Type Name Read/Write Description

void RETURN

Returns

void:

No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphColourFore

Set the foreground plotting colour using current stored colour.

Synopsis

Prototype

void ajGraphColourFore (
      void
);

Type Name Read/Write Description

void RETURN

Returns

void:

No return value

Description

Set the foreground plotting colour using current stored colour.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetFore

Set the foreground plotting colour

Synopsis

Prototype

ajint ajGraphSetFore (
      ajint colour
);

Type Name Read/Write Description

ajint colour Input colour to set drawing to.

ajint RETURN the previous colour.

Input

colour:

(Input)

colour to set drawing to.

Returns

ajint:

the previous colour.

Description

Set the foreground plotting colour

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphCheckColour

Find if the colour is on the list

Synopsis

Prototype

ajint ajGraphCheckColour (
      const AjPStr colour
);

Type Name Read/Write Description

const AjPStr colour Input colour to set drawing to.

ajint RETURN the colour number if found else -1.

Input

colour:

(Input)

colour to set drawing to.

Returns

ajint:

the colour number if found else -1.

Description

Find if the colour is on the list

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetBaseColour

Initialize a base colours array for sequence characters

Synopsis

Prototype

ajint* ajGraphGetBaseColour (
      void
);

Type Name Read/Write Description

ajint* RETURN Array of colours (see PLPLOT)

Returns

ajint*:

Array of colours (see PLPLOT)

Description

Initialize a base colours array for sequence characters

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetBaseColourProt

Initialize a base colours array for a string of protein sequence characters according to the following colour scheme designed by Toby Giibson (EMBL Heidelberg) to show the chemical propoerties 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* ajGraphGetBaseColourProt (
      const AjPStr codes
);

Type Name Read/Write Description

const AjPStr codes Input Residue codes for each numbered position

ajint* RETURN Array of colours (see PLPLOT)

Input

codes:

(Input)

Residue codes for each numbered position

Returns

ajint*:

Array of colours (see PLPLOT)

Description

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetBaseColourNuc

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

Synopsis

Prototype

ajint* ajGraphGetBaseColourNuc (
      const AjPStr codes
);

Type Name Read/Write Description

const AjPStr codes Input Residue codes for each numbered position

ajint* RETURN Array 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 nucleotide sequence characters

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetCharSize

Get the char size.

Synopsis

Prototype

void ajGraphGetCharSize (
      float* defheight,
      float* currentheight
);

Type Name Read/Write Description

float* defheight Modify where to store the default char height

float* currentheight Modify where to store the current char height

void RETURN

Input & Output

defheight:	(Modify)	where to store the default char height
currentheight:	(Modify)	where to store the current char height

Returns

void:

No return value

Description

Get the char size.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetOut

Get the Output Device Parameters

For graph data type, sets to zero.

Synopsis

Prototype

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

Type Name Read/Write Description

float* xp Modify where to store the default char height

float* yp Modify where to the current char height

ajint* xleng Modify where to store the default char height

ajint* yleng Modify where to the current char height

ajint* xoff Modify where to store the default char height

ajint* yoff Modify where to the current char height

void RETURN

Input & Output

xp:	(Modify)	where to store the default char height
yp:	(Modify)	where to the current char height
xleng:	(Modify)	where to store the default char height
yleng:	(Modify)	where to the current char height
xoff:	(Modify)	where to store the default char height
yoff:	(Modify)	where to the current char height

Returns

void:

No return value

Description

Get the Output Device Parameters

For graph data type, sets to zero.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetOri

Set graph orientation

Synopsis

Prototype

void ajGraphSetOri (
      ajint ori
);

Type Name Read/Write Description

ajint ori Input orientation (landscape is zero, portrait is any other value).

void RETURN

Input

ori:

(Input)

orientation (landscape is zero, portrait is any other value).

Returns

void:

No return value

Description

Set graph orientation

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlenv

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 ajGraphPlenv (
      float xmin,
      float xmax,
      float ymin,
      float ymax,
      ajint flags
);

Type Name Read/Write Description

float xmin Input X axis start

float xmax Input X axis end

float ymin Input Y axis start

float ymax Input Y axis end

ajint flags Input flag 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetColour

Return current foreground colour

Synopsis

Prototype

ajint ajGraphGetColour (
      void
);

Type Name Read/Write Description

ajint RETURN colour.

Returns

ajint:

colour.

Description

Return current foreground colour

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetSubTitle

Return plot subtitle

Synopsis

Prototype

const AjPStr ajGraphGetSubTitle (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const AjPStr RETURN Subtitle

Input

thys:

(Input)

Graph object.

Returns

const AjPStr:

Subtitle

Description

Return plot subtitle

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetSubTitleC

Return plot subtitle

Synopsis

Prototype

const char* ajGraphGetSubTitleC (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const char* RETURN Subtitle

Input

thys:

(Input)

Graph object.

Returns

const char*:

Subtitle

Description

Return plot subtitle

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetTitle

Return plot title

Synopsis

Prototype

const AjPStr ajGraphGetTitle (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const AjPStr RETURN Title

Input

thys:

(Input)

Graph object.

Returns

const AjPStr:

Title

Description

Return plot title

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetTitleC

Return plot title

Synopsis

Prototype

const char* ajGraphGetTitleC (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const char* RETURN Title

Input

thys:

(Input)

Graph object.

Returns

const char*:

Title

Description

Return plot title

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetXTitle

Return plot x-axis title

Synopsis

Prototype

const AjPStr ajGraphGetXTitle (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const AjPStr RETURN Title of x-axis

Input

thys:

(Input)

Graph object.

Returns

const AjPStr:

Title of x-axis

Description

Return plot x-axis title

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetXTitleC

Return plot x-axis title

Synopsis

Prototype

const char* ajGraphGetXTitleC (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const char* RETURN Title of x-axis

Input

thys:

(Input)

Graph object.

Returns

const char*:

Title of x-axis

Description

Return plot x-axis title

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetYTitle

Return plot y-axis title

Synopsis

Prototype

const AjPStr ajGraphGetYTitle (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const AjPStr RETURN Title of y-axis

Input

thys:

(Input)

Graph object.

Returns

const AjPStr:

Title of y-axis

Description

Return plot y-axis title

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphGetYTitleC

Return plot y-axis title

Synopsis

Prototype

const char* ajGraphGetYTitleC (
      const AjPGraph thys
);

Type Name Read/Write Description

const AjPGraph thys Input Graph object.

const char* RETURN Title of y-axis

Input

thys:

(Input)

Graph object.

Returns

const char*:

Title of y-axis

Description

Return plot y-axis title

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetLineStyle

Set the line style.

Synopsis

Prototype

ajint ajGraphSetLineStyle (
      ajint style
);

Type Name Read/Write Description

ajint style Input line style to set drawing to.

ajint RETURN the previous line style.

Input

style:

(Input)

line style to set drawing to.

Returns

ajint:

the previous line style.

Description

Set the line style.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetFillPat

Set the Fill Pattern type.

Synopsis

Prototype

ajint ajGraphSetFillPat (
      ajint style
);

Type Name Read/Write Description

ajint style Input line style to set drawing to.

ajint RETURN the previous line style.

Input

style:

(Input)

line style to set drawing to.

Returns

ajint:

the previous line style.

Description

Set the Fill Pattern type.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetCharScale

Set the character scale factor

Synopsis

Prototype

float ajGraphSetCharScale (
      float scale
);

Type Name Read/Write Description

float scale Input character scale.

float RETURN the previous character scale factor.

Input

scale:

(Input)

character scale.

Returns

float:

the previous character scale factor.

Description

Set the character scale factor

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetCharSize

Set the character size factor

Synopsis

Prototype

float ajGraphSetCharSize (
      float size
);

Type Name Read/Write Description

float size Input character size.

float RETURN the previous character size factor.

Input

size:

(Input)

character size.

Returns

float:

the previous character size factor.

Description

Set the character size factor

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphLine

Draw line between 2 points.

Synopsis

Prototype

void ajGraphLine (
      PLFLT xx1,
      PLFLT yy1,
      PLFLT xx2,
      PLFLT yy2
);

Type Name Read/Write Description

PLFLT xx1 Input x start position.

PLFLT yy1 Input y start position.

PLFLT xx2 Input x end position.

PLFLT yy2 Input y end position.

void RETURN

Input

xx1:	(Input)	x start position.
yy1:	(Input)	y start position.
xx2:	(Input)	x end position.
yy2:	(Input)	y end position.

Returns

void:

No return value

Description

Draw line between 2 points.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphLines

Draw a set of lines.

Synopsis

Prototype

void ajGraphLines (
      PLFLT* xx1,
      PLFLT* yy1,
      PLFLT* xx2,
      PLFLT* yy2,
      ajint numoflines
);

Type Name Read/Write Description

PLFLT* xx1 Modify xx1 coord.

PLFLT* yy1 Modify yy1 coord.

PLFLT* xx2 Modify xx2 coord.

PLFLT* yy2 Modify yy2 coord.

ajint numoflines Input The number of lines to be drawn.

void RETURN

Input

numoflines:

(Input)

The number of lines to be drawn.

Input & Output

xx1:	(Modify)	xx1 coord.
yy1:	(Modify)	yy1 coord.
xx2:	(Modify)	xx2 coord.
yy2:	(Modify)	yy2 coord.

Returns

void:

No return value

Description

Draw a set of lines.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphDots

Draw a set of dots.

Synopsis

Prototype

void ajGraphDots (
      PLFLT* xx1,
      PLFLT* yy1,
      ajint numofdots
);

Type Name Read/Write Description

CONST PLFLT* xx1 Input xx1 coord.

CONST PLFLT* yy1 Input yy1 coord.

ajint numofdots Input The number of dots to be drawn.

void RETURN

Input

xx1:	(Input)	xx1 coord.
yy1:	(Input)	yy1 coord.
numofdots:	(Input)	The number of dots to be drawn.

Returns

void:

No return value

Description

Draw a set of dots.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSymbols

Draw a set of dots.

Synopsis

Prototype

void ajGraphSymbols (
      ajint numofdots,
      PLFLT* xx1,
      PLFLT* yy1,
      ajint symbol
);

Type Name Read/Write Description

ajint numofdots Input Number of coordinates in xx1 and xx2.

CONST PLFLT* xx1 Input xx1 coord.

CONST PLFLT* yy1 Input yy1 coord.

ajint symbol Input Symbol code.

void RETURN

Input

numofdots:	(Input)	Number of coordinates in xx1 and xx2.
xx1:	(Input)	xx1 coord.
yy1:	(Input)	yy1 coord.
symbol:	(Input)	Symbol code.

Returns

void:

No return value

Description

Draw a set of dots.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTextLine

Draw text along a line.

Synopsis

Prototype

void ajGraphTextLine (
      PLFLT xx1,
      PLFLT yy1,
      PLFLT xx2,
      PLFLT yy2,
      const char* text,
      PLFLT just
);

Type Name Read/Write Description

PLFLT xx1 Input xx1 coor.

PLFLT yy1 Input yy1 coor.

PLFLT xx2 Input xx2 coor.

PLFLT yy2 Input yy2 coor.

const char* text Input The text to be displayed.

PLFLT just Input justification of the string. (0=left,1=right,0.5=middle etc)

void RETURN

Input

xx1:	(Input)	xx1 coor.
yy1:	(Input)	yy1 coor.
xx2:	(Input)	xx2 coor.
yy2:	(Input)	yy2 coor.
text:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphText

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

Synopsis

Prototype

void ajGraphText (
      PLFLT xx1,
      PLFLT yy1,
      const char* text,
      PLFLT just
);

Type Name Read/Write Description

PLFLT xx1 Input xx1 coor.

PLFLT yy1 Input yy1 coor.

const char* text Input The text to be displayed.

PLFLT just Input justification of the string. (0=left,1=right,0.5=middle etc)

void RETURN

Input

xx1:	(Input)	xx1 coor.
yy1:	(Input)	yy1 coor.
text:	(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 just.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTextStart

Draw text starting at position (xx1,yy1)

Synopsis

Prototype

void ajGraphTextStart (
      PLFLT xx1,
      PLFLT yy1,
      const char* text
);

Type Name Read/Write Description

PLFLT xx1 Input xx1 coordinate

PLFLT yy1 Input yy1 coordinate

const char* text Input The text to be displayed.

void RETURN

Input

xx1:	(Input)	xx1 coordinate
yy1:	(Input)	yy1 coordinate
text:	(Input)	The text to be displayed.

Returns

void:

No return value

Description

Draw text starting at position (xx1,yy1)

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTextEnd

Draw text ending at position (xx1,yy1)

Synopsis

Prototype

void ajGraphTextEnd (
      PLFLT xx1,
      PLFLT yy1,
      const char* text
);

Type Name Read/Write Description

PLFLT xx1 Input xx1 coor.

PLFLT yy1 Input yy1 coor.

const char* text Input The text to be displayed.

void RETURN

Input

xx1:	(Input)	xx1 coor.
yy1:	(Input)	yy1 coor.
text:	(Input)	The text to be displayed.

Returns

void:

No return value

Description

Draw text ending at position (xx1,yy1)

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphTextMid

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

For graph data type, writes directly.

Synopsis

Prototype

void ajGraphTextMid (
      PLFLT xx1,
      PLFLT yy1,
      const char* text
);

Type Name Read/Write Description

PLFLT xx1 Input xx1 coor.

PLFLT yy1 Input yy1 coor.

const char* text Input The text to be displayed.

void RETURN

Input

xx1:	(Input)	xx1 coor.
yy1:	(Input)	yy1 coor.
text:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphVertBars

Draw vertical Error Bars.

Synopsis

Prototype

void ajGraphVertBars (
      ajint numofpoints,
      PLFLT* x,
      PLFLT* ymin,
      PLFLT* ymax
);

Type Name Read/Write Description

ajint numofpoints Input number of error bars to be drawn.

CONST PLFLT* x Input x positions to draw at.

CONST PLFLT* ymin Input y positions to start at.

CONST PLFLT* ymax Input y positions to end at.

void RETURN

Input

numofpoints:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphHoriBars

Draw Horizontal Error Bars.

Synopsis

Prototype

void ajGraphHoriBars (
      ajint numofpoints,
      PLFLT* y,
      PLFLT* xmin,
      PLFLT* xmax
);

Type Name Read/Write Description

ajint numofpoints Input number of error bars to be drawn.

CONST PLFLT* y Input y positions to draw at.

CONST PLFLT* xmin Input x positions to start at.

CONST PLFLT* xmax Input x positions to end at.

void RETURN

Input

numofpoints:	(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphInitSeq

Creates a graph and define default values based on a sequence.

Existing titles and other data are unchanged

Synopsis

Prototype

void ajGraphInitSeq (
      AjPGraph thys,
      const AjPSeq seq
);

Type Name Read/Write Description

AjPGraph thys Modify Graph

const AjPSeq seq Input Sequence

void RETURN

Input

seq:

(Input)

Sequence

Input & Output

thys:

(Modify)

Graph

Returns

void:

No return value

Description

Creates a graph and define default values based on a sequence.

Existing titles and other data are unchanged

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetOut

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 ajGraphSetOut (
      AjPGraph thys,
      const AjPStr txt
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to write file name too.

const AjPStr txt Input Name of the file.

void RETURN

Input

txt:

(Input)

Name of the file.

Input & Output

thys:

(Modify)

Graph structure to write file name too.

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetOutC

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 ajGraphSetOutC (
      AjPGraph thys,
      const char* txt
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to write file name to.

const char* txt Input Name 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetDir

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

Synopsis

Prototype

void ajGraphSetDir (
      AjPGraph thys,
      const AjPStr txt
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to write file name too.

const AjPStr txt Input Name of the file.

void RETURN

Input

txt:

(Input)

Name of the file.

Input & Output

thys:

(Modify)

Graph structure to write file name too.

Returns

void:

No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetLineType

Set the line type for this graph.

Synopsis

Prototype

void ajGraphPlpDataSetLineType (
      AjPGraphPlpData graphdata,
      ajint type
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph structure to store info in.

ajint type Input Set 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySetXStart

Set the start position for X in the graph.

Synopsis

Prototype

void ajGraphxySetXStart (
      AjPGraph thys,
      float val
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

float val Input The 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySetXEnd

Set the end position for X in the graph.

Synopsis

Prototype

void ajGraphxySetXEnd (
      AjPGraph thys,
      float val
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

float val Input The 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySetYStart

Set the start position for Y in the graph.

Synopsis

Prototype

void ajGraphxySetYStart (
      AjPGraph thys,
      float val
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

float val Input The 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySetYEnd

Set the end position for Y in the graph.

Synopsis

Prototype

void ajGraphxySetYEnd (
      AjPGraph thys,
      float val
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

float val Input The 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetColour

Set the colour for the plot on one graph.

Synopsis

Prototype

void ajGraphPlpDataSetColour (
      AjPGraphPlpData graphdata,
      ajint colour
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph structure to store info in.

ajint colour Input colour 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetDesc

Set the graph description.

Synopsis

Prototype

void ajGraphSetDesc (
      AjPGraph thys,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const AjPStr title Input Title.

void RETURN

Input

title:

(Input)

Title.

Input & Output

thys:

(Modify)

Graph structure to store info in.

Returns

void:

No return value

Description

Set the graph description.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetYTitle

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

Synopsis

Prototype

void ajGraphSetYTitle (
      AjPGraph thys,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const AjPStr title Input title for the y axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetYTitleC

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

Synopsis

Prototype

void ajGraphSetYTitleC (
      AjPGraph thys,
      const char* title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const char* title Input title for the y axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetXTitle

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

Synopsis

Prototype

void ajGraphSetXTitle (
      AjPGraph thys,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const AjPStr title Input title for the x axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetXTitleC

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

Synopsis

Prototype

void ajGraphSetXTitleC (
      AjPGraph thys,
      const char* title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const char* title Input title for the x axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetTitle

Set the graph title.

Synopsis

Prototype

void ajGraphSetTitle (
      AjPGraph thys,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const AjPStr title Input Title.

void RETURN

Input

title:

(Input)

Title.

Input & Output

thys:

(Modify)

Graph structure to store info in.

Returns

void:

No return value

Description

Set the graph title.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetTitleC

Set the graph Title.

Synopsis

Prototype

void ajGraphSetTitleC (
      AjPGraph thys,
      const char* title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const char* title Input title.

void RETURN

Input

title:

(Input)

title.

Input & Output

thys:

(Modify)

Graph structure to store info in.

Returns

void:

No return value

Description

Set the graph Title.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetTitlePlus

Set an empty graph title from the description and extra text supplied by the caller.

Synopsis

Prototype

void ajGraphSetTitlePlus (
      AjPGraph thys,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const AjPStr title Input Title.

void RETURN

Input

title:

(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 and extra text supplied by the caller.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetSubTitle

Set the title for the Y axis.

Synopsis

Prototype

void ajGraphSetSubTitle (
      AjPGraph thys,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const AjPStr title Input Subtitle

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetSubTitleC

Set the graph subtitle.

Synopsis

Prototype

void ajGraphSetSubTitleC (
      AjPGraph thys,
      const char* title
);

Type Name Read/Write Description

AjPGraph thys Modify Graph structure to store info in.

const char* title Input subtitle.

void RETURN

Input

title:

(Input)

subtitle.

Input & Output

thys:

(Modify)

Graph structure to store info in.

Returns

void:

No return value

Description

Set the graph subtitle.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetYTitle

Set the title for the Y axis.

Synopsis

Prototype

void ajGraphPlpDataSetYTitle (
      AjPGraphPlpData graphdata,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph structure to store info in.

const AjPStr title Input title for the Y axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetYTitleC

Set the title for the Y axis.

Synopsis

Prototype

void ajGraphPlpDataSetYTitleC (
      AjPGraphPlpData graphdata,
      const char* title
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph structure to store info in.

const char* title Input title for the Y axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetXTitle

Set the title for the X axis.

Synopsis

Prototype

void ajGraphPlpDataSetXTitle (
      AjPGraphPlpData graphdata,
      const AjPStr title
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph structure to store info in.

const AjPStr title Input title for the X axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetXTitleC

Set the title for the X axis.

Synopsis

Prototype

void ajGraphPlpDataSetXTitleC (
      AjPGraphPlpData graphdata,
      const char* title
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph structure to store info in.

const char* title Input title for the X axis.

void RETURN

Input

title:

(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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxyDel

Destructor for a graph object

Synopsis

Prototype

void ajGraphxyDel (
      AjPGraph* pthis
);

Type Name Read/Write Description

AjPGraph* pthis Output Graph 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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataNew

Creates a new empty graph

Synopsis

Prototype

AjPGraphPlpData ajGraphPlpDataNew (
      void
);

Type Name Read/Write Description

AjPGraphPlpData RETURN New empty graph

Returns

AjPGraphPlpData:

New empty graph

Description

Creates a new empty graph

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataSetXY

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

Synopsis

Prototype

void ajGraphPlpDataSetXY (
      AjPGraphPlpData graphdata,
      const float* x,
      const float* y
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph object

const float* x Input X coordinates

const float* y Input Y coordinates

void RETURN

Input

x:	(Input)	X coordinates
y:	(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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataCalcXY

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 ajGraphPlpDataCalcXY (
      AjPGraphPlpData graphdata,
      ajint numofpoints,
      float start,
      float incr,
      const float* y
);

Type Name Read/Write Description

AjPGraphPlpData graphdata Modify Graph object

ajint numofpoints Input Number of points in array

float start Input Start position

float incr Input Increment

const float* y Input Y 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySetXRangeII

Sets the X axis range with integers

Synopsis

Prototype

void ajGraphxySetXRangeII (
      AjPGraph thys,
      ajint start,
      ajint end
);

Type Name Read/Write Description

AjPGraph thys Modify Graph

ajint start Input start position

ajint end Input end 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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxySetYRangeII

Sets the Y axis range with integers

Synopsis

Prototype

void ajGraphxySetYRangeII (
      AjPGraph thys,
      ajint start,
      ajint end
);

Type Name Read/Write Description

AjPGraph thys Modify Graph

ajint start Input start position

ajint end Input end 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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphPlpDataNewI

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

Synopsis

Prototype

AjPGraphPlpData ajGraphPlpDataNewI (
      ajint numofpoints
);

Type Name Read/Write Description

ajint numofpoints Input Number of points

AjPGraphPlpData RETURN Pointer to new graph structure.

Input

numofpoints:

(Input)

Number of points

Returns

AjPGraphPlpData:

Pointer to new graph structure.

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

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

ajint ajGraphDataAdd (
      AjPGraph thys,
      AjPGraphPlpData graphdata
);

Type Name Read/Write Description

AjPGraph thys Modify multiple graph structure.

AjPGraphPlpData graphdata Modify graph to be added.

ajint RETURN 1 if graph added successfully else 0;

Input & Output

thys:	(Modify)	multiple graph structure.
graphdata:	(Modify)	graph to be added.

Returns

ajint:

1 if graph added successfully else 0;

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.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

ajint ajGraphDataReplace (
      AjPGraph thys,
      AjPGraphPlpData graphdata
);

Type Name Read/Write Description

AjPGraph thys Modify multiple graph structure.

AjPGraphPlpData graphdata Modify graph to be added.

ajint RETURN 1 if graph added successfully else 0;

Input & Output

thys:	(Modify)	multiple graph structure.
graphdata:	(Modify)	graph to be added.

Returns

ajint:

1 if graph added successfully else 0;

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.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

ajint ajGraphDataReplaceI (
      AjPGraph thys,
      AjPGraphPlpData graphdata,
      ajint num
);

Type Name Read/Write Description

AjPGraph thys Modify multiple graph structure.

AjPGraphPlpData graphdata Modify graph to be added.

ajint num Input number within multiple graph.

ajint RETURN 1 if graph added successfully else 0;

Input

num:

(Input)

number within multiple graph.

Input & Output

thys:	(Modify)	multiple graph structure.
graphdata:	(Modify)	graph to be added.

Returns

ajint:

1 if graph added successfully else 0;

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphNew

Create a structure to hold a general graph.

Synopsis

Prototype

AjPGraph ajGraphNew (
      void
);

Type Name Read/Write Description

AjPGraph RETURN multiple graph structure.

Returns

AjPGraph:

multiple graph structure.

Description

Create a structure to hold a general graph.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphxyNewI

Create a structure to hold a number of graphs.

Synopsis

Prototype

AjPGraph ajGraphxyNewI (
      ajint numsets
);

Type Name Read/Write Description

ajint numsets Input maximum number of graphs that can stored.

AjPGraph RETURN multiple graph structure.

Input

numsets:

(Input)

maximum number of graphs that can stored.

Returns

AjPGraph:

multiple graph structure.

Description

Create a structure to hold a number of graphs.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 5.0.0

Function ajGraphSetMulti

Create a structure to hold a number of graphs.

Synopsis

Prototype

void ajGraphSetMulti (
      AjPGraph thys,
      ajint numsets
);

Type Name Read/Write Description

AjPGraph thys Output Graph structure to store info in.

ajint numsets Input maximum number of graphs that can stored.

void RETURN

Input

numsets:

(Input)

maximum number of graphs that can 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.

Usage

See source code

Example

In prepa

Type	Name	Read/Write	Description
PLFLT	xcentre	Input	x coor for centre.
PLFLT	ycentre	Input	y coor for centre.
float	radius	Input	radius of the circle.
void		RETURN

Type	Name	Read/Write	Description
ajint	colour	Input	colour to set drawing to.
ajint		RETURN	the previous colour.

Type	Name	Read/Write	Description
const AjPStr	codes	Input	Residue codes for each numbered position
ajint*		RETURN	Array of colours (see PLPLOT)

Type	Name	Read/Write	Description
float*	defheight	Modify	where to store the default char height
float*	currentheight	Modify	where to store the current char height
void		RETURN

Type	Name	Read/Write	Description
ajint	style	Input	line style to set drawing to.
ajint		RETURN	the previous line style.

Type	Name	Read/Write	Description
float	scale	Input	character scale.
float		RETURN	the previous character scale factor.

Type	Name	Read/Write	Description
float	size	Input	character size.
float		RETURN	the previous character size factor.

Type	Name	Read/Write	Description
PLFLT*	xx1	Modify	xx1 coord.
PLFLT*	yy1	Modify	yy1 coord.
PLFLT*	xx2	Modify	xx2 coord.
PLFLT*	yy2	Modify	yy2 coord.
ajint	numoflines	Input	The number of lines to be drawn.
void		RETURN

Type	Name	Read/Write	Description
CONST PLFLT*	xx1	Input	xx1 coord.
CONST PLFLT*	yy1	Input	yy1 coord.
ajint	numofdots	Input	The number of dots to be drawn.
void		RETURN

Type	Name	Read/Write	Description
ajint	numofpoints	Input	number of error bars to be drawn.
CONST PLFLT*	x	Input	x positions to draw at.
CONST PLFLT*	ymin	Input	y positions to start at.
CONST PLFLT*	ymax	Input	y positions to end at.
void		RETURN

Type	Name	Read/Write	Description
AjPGraphPlpData	graphdata	Modify	Graph structure to store info in.
ajint	type	Input	Set the line type.
void		RETURN

Type	Name	Read/Write	Description
AjPGraph*	pthis	Output	Graph structure to store info in.
void		RETURN

Type	Name	Read/Write	Description
ajint	numsets	Input	maximum number of graphs that can stored.
AjPGraph		RETURN	multiple graph structure.

ajgraph.c

Synopsis

Prototype

Input

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also