Next: , Previous: Line Properties, Up: Graphics Object Properties


15.3.3.5 Text Properties

The text properties are:

__modified__: "off" | {"on"}


backgroundcolor: colorspec, def. "none"
Background area is not yet implemented for text objects. backgroundcolor is unused.


beingdeleted: {"off"} | "on"


busyaction: "cancel" | {"queue"}


buttondownfcn: string | function handle, def. [](0x0)


children (read-only): vector of graphics handles, def. [](0x1)
children is unused.


clipping: "off" | {"on"}
If clipping is "on", the text is clipped in its parent axes limits.


color: colorspec, def. [0 0 0]
Color of the text. See colorspec.


createfcn: string | function handle, def. [](0x0)
Callback function executed immediately after text has been created. Function is set by using default property on root object, e.g., set (0, "defaulttextcreatefcn", 'disp ("text created!")').


deletefcn: string | function handle, def. [](0x0)
Callback function executed immediately before text is deleted.


displayname: def. ""


edgecolor: colorspec, def. "none"
Background area is not yet implemented for text objects. edgecolor is unused.


editing: {"off"} | "on"


erasemode: "background" | "none" | {"normal"} | "xor"
erasemode is unused.


extent (read-only): def. [0.000000 -0.005843 0.000000 0.032136]


fontangle: "italic" | {"normal"} | "oblique"
Flag whether the font is italic or normal. fontangle is currently unused.


fontname: string, def. "*"
The font used for the text.


fontsize: scalar, def. 10
The font size of the text as measured in fontunits.


fontunits: "centimeters" | "inches" | "normalized" | "pixels" | {"points"}
The units used to interpret fontsize property.


fontweight: "bold" | "demi" | "light" | {"normal"}
Control variant of base font used: bold, light, normal, etc.


handlevisibility: "callback" | "off" | {"on"}
If handlevisibility is "off", the text's handle is not visible in its parent's "children" property.


hittest: "off" | {"on"}


horizontalalignment: "center" | {"left"} | "right"


interpreter: "latex" | "none" | {"tex"}


interruptible: "off" | {"on"}


linestyle: {"-"} | "--" | "-." | ":" | "none"
Background area is not yet implemented for text objects. linestyle is unused.


linewidth: scalar, def. 0.50000
Background area is not yet implemented for text objects. linewidth is unused.


margin: scalar, def. 2
Background area is not yet implemented for text objects. margin is unused.


parent: graphics handle
Handle of the parent graphics object.


position: four-element vector, def. [0 0 0]
Vector [X0 Y0 Z0] where X0, Y0 and Z0 indicate the position of the text anchor as defined by verticalalignment and horizontalalignment.


rotation: scalar, def. 0
The angle of rotation for the displayed text, measured in degrees.


selected: {"off"} | "on"


selectionhighlight: "off" | {"on"}


string: string, def. ""
The text object string content.


tag: string, def. ""
A user-defined string to label the graphics object.


type (read-only): string
Class name of the graphics object. type is always "text"


uicontextmenu: graphics handle, def. [](0x0)
Graphics handle of the uicontextmenu object that is currently associated to this text object.


units: "centimeters" | {"data"} | "inches" | "normalized" | "pixels" | "points"


userdata: Any Octave data, def. [](0x0)
User-defined data to associate with the graphics object.


verticalalignment: "baseline" | "bottom" | "cap" | {"middle"} | "top"


visible: "off" | {"on"}
If visible is "off", the text is not rendered on screen.