datatip properties description of the Datatip entity properties

## Description

The Datatip entity is a leaf of the graphics entities hierarchy. This entity defines the parameters for datatips.

parent:

  handle of the curve the datatip is plugged on.

children:

  unused.

visible:

  "on": the datatip is displayable according to the `parent.datatip_display_mode` setting.

  "off": the datatip display is canceled anyway.

data:

  Cartesian coordinates of the datatip's anchor on its curve, in data scales. For curves in special not-cartesian grids (after polarplot(), sgrid(), etc), `.data` contains the raw equivalent cartesian coordinates.

text:

  Matrix of texts to be displayed (as a matrix) in the datatip label. Leading and trailing spaces are all trimmed. In each cell, the text is centered.

interp_mode:

  This field sets the interpolation mode for tip location. Its value should be `"on"` (interpolation is made between mesh points) or `"off"` (the tips can only be located at the mesh points).

box_mode:

  This field contains the default `box_mode` property value for the datatip. Its value should be `"on"` (box drawn) or `"off"` (no box drawn).

label_mode:

  This field contains the default `label_mode` property value for the datatip. Its value should be `"on"` (label written) or `"off"` (no label written).

display_components:

  This field controls which components are displayed. Its default value is `"xy"`for 2D views and `"xyz"` for 3D views. Possible values are any combination of `"x"`, `"y"` and `"z"`, like `"zy"`, `"xzy"`, `"xz"`, `"y"`, etc.

  The components are drawn in the order they are found in the string.

display_function:

  See `polyline_properties` help page.

orientation:

  This field sets the position on the text box with respect to polyline point. The possible values are 0 (upper left), 1 (upper right), 2 (lower left), 3 (lower right), 4 (left), 5 (right), 6 (upper) or 7 (lower).

auto_orientation:

  This field contains the default `auto_orientation` property value for the datatip. Its value should be `"on"` (automatic orientation) or `"off"` (no automatic orientation). In the `"off"` case, See `orientation` property.

detached_position:

  This field sets the position `[x y z]` of the bottom left corner of the datatip text box, even when the link to the polyline starts from another corner. When its value is `[]`, the datatip text box is drawn attached to its anchor point in the polyline.

  In detached mode, it is not possible to force the starting point of the link on the box frame. It is autoset.

font_foreground:

  This field contains the default `font_foreground` property Its value should be a color index (relative to the current colormap).

foreground:

  This field contains the default `foreground` property used to draw the box. Its value should be a color index (relative to the current colormap).

background:

  See `polyline_properties` help page.

line_style:

  This field contains the `line_style` used in the line linking the datatip anchor point to its text box when `detached_position` is set.

  See `polyline_properties` help page.

mark_mode:

  See `polyline_properties` help page.

mark_style:

  See `polyline_properties` help page.

mark_size_unit:

  See `polyline_properties` help page.

mark_size:

  See `polyline_properties` help page.

mark_foreground:

  See `polyline_properties` help page.

mark_background:

  See `polyline_properties` help page.

user_data:

  See `polyline_properties` help page.

tag:

  This fields contains a string generally used to identify the control. See `figure_properties` help page.

## See also

- polyline_properties
- figure_properties
- graphics_entities

## History

5.5.2

New "orientation" values available: "left", "right", "upper", "lower".

6.0.0

- `.z_component` is removed.
- New `.display_components` and `.detached_position` properties.