1PLSLABELFUNC(3plplot)             PLplot API             PLSLABELFUNC(3plplot)
2
3
4

NAME

6       plslabelfunc  -  Assign  a  function  to use for generating custom axis
7       labels
8

SYNOPSIS

10       plslabelfunc(label_func, label_data)
11

DESCRIPTION

13       This function allows a user to provide their own  function  to  provide
14       axis  label  text.   The user function is given the numeric value for a
15       point on an axis and returns a string label  to  correspond  with  that
16       value.   Custom axis labels can be enabled by passing appropriate argu‐
17       ments to plenv(3plplot), plbox(3plplot),  plbox3(3plplot)  and  similar
18       functions.
19
20       This function is used in example 19.
21

ARGUMENTS

23       label_func (void (*) (PLINT, PLFLT, char *, PLINT, void *), input)
24              This  is  the  custom  label function.  In order to reset to the
25              default labeling, set this to NULL. The labeling function param‐
26              eters  are, in order: .TP axis This indicates which axis a label
27              is being requested for. The value  will  be  one  of  PL_X_AXIS,
28              PL_Y_AXIS or PL_Z_AXIS.
29
30       value  This is the value along the axis which is being labeled.
31
32       label_text
33              The string representation of the label value.
34
35       length The maximum length in characters allowed for label_text.
36
37
38       label_data (void *, input)
39              This  parameter may be used to pass data to the label_func func‐
40              tion.
41
42

AUTHORS

44       Geoffrey Furnish and Maurice LeBrun wrote and  maintain  PLplot.   This
45       man  page  was  automatically  generated from the DocBook source of the
46       PLplot  documentation,  maintained  by  Alan  W.   Irwin   and   Rafael
47       Laboissiere.
48

SEE ALSO

50       PLplot documentation at http://plplot.sourceforge.net/resources.
51
52
53
54                                  July, 2010             PLSLABELFUNC(3plplot)