datatip properties

Description

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

parent:

See polyline_properties help page.

children:

See polyline_properties help page.

visible:

See polyline_properties help page.

data:

See polyline_properties help page.

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

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

display_components:

This field controls which components are displayed. Its default value is "xy"for 2D views and "xyz" for 3D views. Possible values for this field are any combination of "x", "y" and "z". Some examples for this field are "zy", "xzy", "xz", "y" and so on. PS: The components are drawn in the same order they are found in the string.

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.

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

display_function:

See polyline_properties help page.

detached_position:

This field sets the position to draw the datatip text box. When its value is [] the datatip text box is drawn attached to its anchor point in the polyline, if its value is a 3-components vector [x y z], the text box is drawn in the given position.

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 — description of the Polyline entity properties
• figure_properties — description of the graphics figure entity properties
• graphics_entities — description of the graphics entities data structures

History