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 (PLLABEL_FUNC_callback(3plplot), input)
24              This  is  the  custom  label function.  In order to reset to the
25              default labelling, set this  to  NULL.  The  labelling  function
26              parameters  are,  in order: .TP axis This indicates which axis a
27              label  is  being  requested  for.  The  value  will  be  one  of
28              PL_X_AXIS, PL_Y_AXIS or PL_Z_AXIS.
29
30       value  This is the value along the axis which is being labelled.
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 (PLPointer(3plplot), input)
39              This  parameter may be used to pass data to the label_func func‐
40              tion.
41
42

AUTHORS

44       Many developers (who  are  credited  at  http://plplot.org/credits.php)
45       have contributed to PLplot over its long history.
46

SEE ALSO

48       PLplot documentation at http://plplot.org/documentation.php.
49
50
51
52                                September, 2020          PLSLABELFUNC(3plplot)