Function | Package: cg | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version

## plot-value

Arguments: plot-widget value-type value-index &key object-index object-id

Returns an individual value that is in a `plot-widget`. This could be a value that was added by calling set-plot-value or a value that is returned by the widget's plot-value-returner function if it has one. The value will be `nil` if the plot does not define a value for the specified value-type, value-index, and object, and otherwise it will be a number.

plot-widget is the widget to be accessed.

value-type is the type of value to return. This argument may be one of the following keywords:

- `:x`: The X coordinate of the value-index'th point to plot for some object.
- `:y`: The Y coordinate of the value-index'th point to plot for some object.
- `:x-high`: an optional value that's normally greater than the X coordinate. Typically represents an error range.
- `:x-low`: an optional value that's normally less than the X coordinate.
- `:y-high`: an optional value that is normally greater than the Y coordinate.
- `:y-low`: an optional value that's normally less than the Y coordinate.
- `:icon-size`: an optional size for a built-in icon that is drawn at X,Y.

value-index is the zero-based index of the plot value to access.

The keyword arguments are:

- object-index is the zero-based index of the chart object to access, or `nil` to not specify an object index. The default is zero if neither this argument nor object-id is true. object-index takes precedence if both are true. The widget's chart-object-id-equality-test is used to find a matching object-index.
- object-id is the arbitrary ID of the chart object to access, as defined in the chart-objects property, or `nil` to not specify an ID.

See `plot-widget`.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.

|  | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version