Note

Valid Parents: Domain

Valid Children: None

Description

The Note object allows you to create and position text strings on the graph. Note that notes are transformed together with the graph but all positioning is done in the 2D X­Y plane.

Note resource tabs

• Main
• Style
• Position

Note resources

• Main

  Text
  Font
  Height
  Color

• Style
  • Text Style
    Shadow
    Skewing
    Boldness
    Expansion
    Spacing
  • Box
    Enabled
    Fill Color
    Frame Color

• Position
  • Position
    Position
    Rotation
    Path
  • Justification
    Horizontal
    Vertical

Notes Resource Set

Boldness (XuNboldness)
The relative boldness of the text. The value must be in the range of 0. ­ 20. and expresses a percentage of the character height. Vector fonts are by default represented by one pixel wide vectors on the screen and by a boldness of 10% of the character height on hardcopy devices. With polygon fonts, the boldness factor affects the outline of the fonts. By default the outline has no width. The character has a width but the line outlining it has no width. By setting the boldness factor, the width of the line surrounding the character is increased.

• Type: float
• Default: 0
• Range: 0:20

Enabled (XuNbox)
The note text is contained within a box which can be outlined and filled in with a color. This resource must be turned on to see the effects of the box resources.

• Type: float
• Default: false
• Range: false,true

Fill Color (XuNboxFillColor)
The color that is used to fill the box.

• Type: float
• Default: 0
• Range:

Frame Color (XuNboxFrameColor)
A color for the frame around the note box.

• Type: float
• Default: 1
• Range:

Color (XuNcolor)
The color of the note.

• Type: float
• Default: 1
• Range:

Expansion (XuNexpansion)
The width of the character body. To produce wider­than­normal characters set the expansion to greater than 1. Narrower characters are achieved by setting expansion to less than 1.

• Type: float
• Default: 1
• Range: 0.2:2

Font (XuNfont)
The font that is used for the note. The default font is determined by the textoption font resource. Refer to the font table for the UNICLD fonts.

• Type: string
• Default: Unset
• Range: " simp" ,"carg" ,"cart" ,"cenb" ,"cobo" ,"comp" ,"coub" ,"couo" ,"cour" ,"cyri" ,"dupl" ,"futu" ,"gote" ,"gotg" ,"goti" ,"gree" ,"hebo" ,"helb" ,"helo" ,"helv" ,"ital" ,"matr" ,"psim" ,"scri" ,"simg" ,"sims" ,"smag" ,"smai" ,"smal" ,"swib" ,"swil" ,"swim" ,"tem", "tibi", "tibo", "tiit", "tiro", "trii", "trip", "utbi", "utob", "utoi", "utor", "vsim"

Height (XuNheight)
The height of the note text.

• Type: float
• Default: 3
• Range: 0:100

Horizontal (XuNhorizontalJustification)
Sets the horizontal insertion point of text within a bounding box. Possible options:

• Type: string
• Default: "center"
• Range: "center" ," left" ," right"

Path (XuNpath)
The text path is the direction of the path along which text characters are drawn. Possible options:

• Type: string
• Default: "right."
• Range: "right. 'left'" ," up. 'down'"

Position (XuNposition)
The insertion coordinates for the note. Notes can be up to 80 characters long.

• Type: float
• Default: (50
• Range: 50)

Rotation (XuNrotation)
The rotation angle of the text relative to the base line. The angle of rotation of is always measured counterclockwise.

• Type: float
• Default: 0
• Range: ­180:180

Shadow (XuNshadow)
Controls the visibility of a black text shadow offset down and to the right.

• Type: float
• Default: false
• Range: false,true

Skewing (XuNskewing)
The skewing angle of the text.The skew angle is measured counterclockwise from the character base line. The skew angle must be between 10 and 170 degrees. The default value is 90, i.e., no skewing.

• Type: float
• Default: 90
• Range: 10:170

Spacing (XuNspacingMode)
Controls the spacing between characters. Possible options:

• Type: string
• Default: "kerned"
• Range: "kerned" ," fixed" ," proportional"

Text (XuNtext)
The text string of the note.

• Type: string
• Default: Unset
• Range: N/A

Vertical (XuNverticalJustification)
The vertical insertion point of the text's bounding box. Possible options:

• Type: string
• Default: "fontBottom"
• Range: "fontBottom" ," fontBase" ,"fontHalf" ," fontCap" ," fontTop" ,"physicalBottom" ," physicalHalf" ,"physicalTop"

Inherited Resources

Controls Resource Set

Destroyable (XuNdestroyable)
This resource controls whether the object can be destroyed by a destroy or reset command. Values can be true (On) to set the object as destroyable, or false (Off) to set the object as permanent.

• Type: float
• Default: true
• Range: false,true

Immutable (XuNimmutable)
This resource controls whether the object can be modified. Values are true (On) for non­modifiable, or false (Off) for modifiable. Setting this resource to true (On) locks the currents settings for the object and disables any further changes to the object, including resetting this resource.

• Type: float
• Default: false
• Range: false,true

Object Name (XuNname)
The name of the object.

• Type: string
• Default:
• Range: N/A

Object Enabled (XuNobjectEnabled)
This resource enables or disables the legend. This resource can be set to either true (On) to enable the object or false (Off) to disabled it.

• Type: float
• Default: true
• Range: false,true

Include in Saved GSL (XuNsave)
This resource controls whether the object is included in saved GSL. Values are true (On) to include the object in saved GSL or false (Off) to omit the object.

• Type: float
• Default: true
• Range: false,true

User Data (XuNuserData)
A dataset name or pointer which the user can associate with the object. The dataset is for user use and will not be used by Gsharp.

• Type: string
• Default: Unset
• Range: N/A

Return to Graphic Objects.