Title class resource descriptions

tiDeltaF

Sets the default offset for all of the titles. This value multiplied by the appropriate ti...FontHeightF resource value gives the amount, in NDC, that the titles will be offset. Positive values move the titles away from the viewport center. For example, a positive value would cause the Main title to move upwards when tiMainSide is set to NhlTOP.

Default: 1.5

tiUseMainAttributes

When this boolean resource is set to True, the Title object copies the value of Main title resources that set text attributes to the corresponding X-Axis and Y-Axis title resources. The resources copied include tiMainFont, tiMainFontHeightF, tiMainFontAspectF, tiMainConstantSpacingF, tiMainFontThicknessF, tiMainFuncCode, tiMainJust, and tiMainAngleF.

V4.0 Status Note 1

Default: False

tiMainOn

Setting this boolean resource to True causes the Main title to appear. Setting it False turns the Main title off. By default, tiMainOn will be set True if and only if you explicitly set tiMainString.

Default: <Dynamic>

tiMainString

Sets the string to use as the Main title. The string may contain Text Function Codes that allow you to control typographical attributes such as subscripting and superscripting, change fonts within a string, embed newlines, etc.

Default: "Main"

tiMainSide

This resource of type NhlPosition specifies the side of the viewport relative to which the justification point of the Main title is located. There are two choices:

NhlTOP

Locate the justification point of the Main title relative to the top edge of the viewport.

NhlBOTTOM

Locate the justification point of the Main title relative to the bottom edge of the viewport.

If you set tiMainPosition to NhlLEFT, NhlCENTER, or NhlRIGHT Title issues a warning message and reverts to the default value, NhlTOP.

Default: NhlTOP

tiMainPosition

This resource of type NhlPosition specifies the base horizontal location of the justification point of the Main title with respect to the viewport boundaries. There are three choices:

NhlLEFT

Locate the base position of the justification point of the Main title along the line of the left edge of the viewport.

NhlCENTER

Locate the base position of the justification point of the Main title along the line of the horizontal center of the viewport.

NhlRIGHT

Locate the base position of justification point of the Main title along the line of the left edge of the viewport.

From any of these base positions you can displace the Main title left or right by setting the resource tiMainOffsetXF. If you set tiMainPosition to NhlBOTTOM or NhlTOP Title issues a warning message and reverts to the default value, NhlCENTER.

Default: NhlCENTER

tiMainOffsetXF

Sets an offset in NDC coordinates by which the Main title will be displaced in a direction parallel to X-Axis from its base location. This value does not scale in response to changes to the viewport size.

Default: 0.0

tiMainOffsetYF

Sets an offset in NDC coordinates by which the Main title will be displaced in a direction parallel to the Y-Axis from its base location. This offset is applied over any offset due to tiDeltaF. It does not scale in response to change to the viewport size.

Default: 0.0

tiMainJust

This resource of type NhlJustification sets the Justification point of the Main title.

Default: NhlCENTERCENTER

tiMainFont

This resource of type NhlFont sets the font index for the Main title.

Default: 0

tiMainFontColor

Sets the font color index for the Main title.

Default: 1

tiMainFontHeightF

Sets the font height in NDC coordinates of the Main title. This value scales proportionally to changes in the width of the viewport.

This resource may be intercepted or disabled by:

• PlotManager

Default: 0.025

tiMainFontAspectF

This resource sets the aspect ratio, defined as the height divided by the width of a reference character box within which all characters of the font will fit. Its value determines the width of characters in the Main title relative to tiMainFontHeightF. If given the value 1.0, wide characters such as 'M' will be approximately square in shape. Values increasing from 1.0 result in thinner characters, while values decreasing from 1.0 result in wider characters.

Default: 1.3125

tiMainConstantSpacingF

If this resource has the value 0.0, the characters in the Main title will be proportionally spaced. If it has a value greater than 0.0, the distance from the beginning of one character to the beginning of the next character will be constant.The value of tiMainConstantSpacingF sets this constant distance as a multiple of the width of a reference character box within which all characters of the font will fit. If txConstantSpacingF has the value 1.0, the constant distance will cause there to be almost no space between two wide characters such as 'M' placed next to each other. As tiMainConstantSpacingF decreases from 1.0, characters will begin to overlap. As it increases from 1.0 characters become further separated from each other. Values less than 0.0 result in an error and are replaced with the default value.

Default: 0.0

tiMainFontThicknessF

Sets the thickness of the lines used to draw the characters of the Main title. The value acts as a multiplier of a (device-dependent) unit thickness. This resource is ignored when the txFont specifies a filled font (font indexes 21, 22, 25 - 30, and 33 - 37).

Default: 1.0

tiMainFuncCode

Specifies the character used to delimit Text Function Codes that may be embedded in the Main title.

Default: :

tiMainFontQuality

Sets the font quality for the Main title.

Default: NhlHIGH

tiMainAngleF

Angle of counter-clockwise rotation of the Main title.

Default: 0.00

tiMainDirection

This resource of type NhlTextDirection specifies the direction of the text used for the Main title. There are three choices of which two are actually the same:

NhlDOWN

Each character is placed below the previous character in the text string.

NhlUP

Each character is placed below the previous character in the text string.

NhlACROSS

Each character is placed to the right of the previous character in the text string.

These descriptions apply before any rotation due to tiMainAngleF is applied to the Main title.

Default: NhlACROSS

tiXAxisOn

Setting this boolean resource to True causes the X-Axis title to appear. Setting it False turns the X-Axis title off. By default, tiXAxisOn will be set True if and only if you explicit set tiXAxisString.

Default: <Dynamic>

tiXAxisString

Sets the string to use as the X-Axis title. The string may contain Text Function Codes that allow you to control typographical attributes such as subscripting and superscripting, change fonts within a string, embed newlines, etc.

Default: "XAxis"

tiXAxisSide

This resource of type NhlPosition specifies the side of the viewport relative to which the justification point of the X-Axis title is located. There are two choices:

NhlTOP

Locate the justification point of the X-Axis title relative to the top edge of the viewport.

NhlBOTTOM

Locate the justification point of the X-Axis title relative to the bottom edge of the viewport.

If you set tiXAxisPosition to NhlLEFT, NhlCENTER, or NhlRIGHT Title issues a warning message and reverts to the default value, NhlBOTTOM.

Default: NhlBOTTOM

tiXAxisPosition

This resource of type NhlPosition specifies the base horizontal location of the justification point of the X-Axis title with respect to the viewport boundaries. There are three choices:

NhlLEFT

Locate the base position of the justification point of the X-Axis title along the line of the left edge of the viewport.

NhlCENTER

Locate the base position of the justification point of the X-Axis title along the line of the horizontal center of the viewport.

NhlRIGHT

Locate the base position of the justification point of the X-Axis title along the line of the left edge of the viewport.

From any of these base positions you can displace the X-Axis title left or right by setting the resource tiXAxisOffsetXF. If you set tiXAxisPosition to NhlBOTTOM or NhlTOP Title issues a warning message and reverts to the default value, NhlCENTER.

Default: NhlCENTER

tiXAxisOffsetXF

Sets an offset in NDC coordinates by which the X-Axis title will be displaced in a direction parallel to X-Axis from its base location. This value does not scale in response to changes to the viewport size.

Default: 0.0

tiXAxisOffsetYF

Sets an offset in NDC coordinates by which the X-Axis title will be displaced in a direction parallel to the Y-Axis from its base location. This offset is applied over any offset due to tiDeltaF. It does not scale in response to change to the viewport size.

Default: 0.0

tiXAxisJust

This resource of type NhlJustification sets the Justification point of the X-Axis title.

Default: NhlCENTERCENTER

tiXAxisFont

This resource of type NhlFont sets the font index for the X-Axis title.

Default: 0

tiXAxisFontColor

Sets the font color for the X-Axis title.

Default: 1

tiXAxisFontHeightF

Sets the font height in NDC coordinates of the X-Axis title. This value scales proportionally to changes in the width of the viewport.

This resource may be intercepted or disabled by:

• PlotManager

Default: 0.025

tiXAxisFontAspectF

This resource sets the aspect ratio, defined as the height divided by the width of a reference character box within which all characters of the font will fit. Its value determines the width of characters in the X-Axis title relative to tiXAxisFontHeightF. If given the value 1.0, wide characters such as 'M' will be approximately square in shape. Values increasing from 1.0 result in thinner characters, while values decreasing from 1.0 result in wider characters.

Default: 1.3125

tiXAxisConstantSpacingF

If this resource has the value 0.0, the characters in the X-Axis title will be proportionally spaced. If it has a value greater than 0.0, the distance from the beginning of one character to the beginning of the next character will be constant.The value of tiXAxisConstantSpacingF sets this constant distance as a multiple of the width of a reference character box within which all characters of the font will fit. If txConstantSpacingF has the value 1.0, the constant distance will cause there to be almost no space between two wide characters such as 'M' placed next to each other. As tiXAxisConstantSpacingF decreases from 1.0, characters will begin to overlap. As it increases from 1.0 characters become further separated from each other. Values less than 0.0 result in an error and are replaced with the default value.

Default: 0.0

tiXAxisFontThicknessF

Sets the thickness of the lines used to draw the characters of the X-Axis title. The value acts as a multiplier of a (device-dependent) unit thickness. This resource is ignored when the txFont specifies a filled font (font indexes 21, 22, 25 - 30, and 33 - 37).

Default: 1.0

tiXAxisFuncCode

Specifies the character used to delimit Text Function Codes that may be embedded in the X-Axis title.

Default: :

tiXAxisFontQuality

Sets the font quality for the X-Axis title.

Default: NhlHIGH

tiXAxisAngleF

Sets the counter-clockwise rotation angle for the X-Axis title.

Default: 0.0

tiXAxisDirection

This resource of type NhlTextDirection specifies the direction of the text used for the X-Axis title. There are three choices of which two are actually the same:

NhlDOWN

Each character is placed below the previous character in the text string.

NhlUP

Each character is placed below the previous character in the text string.

NhlACROSS

Each character is placed to the right of the previous character in the text string.

These descriptions apply before any rotation due to tiXAxisAngleF is applied to the X-Axis title.

Default: NhlACROSS

tiYAxisOn

Setting this boolean resource to True causes the Y-Axis title to appear. Setting it False turns the Y-Axis title off. By default, tiYAxisOn will be set True if and only if you explicit set tiYAxisString.

Default: <Dynamic>

tiYAxisString

Sets the string to use as the Y-Axis title. The string may contain Text Function Codes that allow you to control typographical attributes such as subscripting and superscripting, change fonts within a string, embed newlines, etc.

Default: "YAxis"

tiYAxisSide

This resource of type NhlPosition specifies the side of the viewport relative to which the justification point of the Y-Axis title is located. There are two choices:

NhlLEFT

Locate the justification point of the Y-Axis title relative to the left edge of the viewport.

NhlRIGHT

Locate the justification point of the Y-Axis title relative to the right edge of the viewport.

If you set tiYAxisPosition to NhlBOTTOM, NhlCENTER, or NhlTOP Title issues a warning message and reverts to the default value, NhlLEFT.

Default: NhlLEFT

tiYAxisPosition

This resource of type NhlPosition specifies the base vertical location of the justification point of the Y-Axis title with respect to the viewport boundaries. There are three choices:

NhlBOTTOM

Locate the base position of the justification point of the Y-Axis title along the line of the bottom edge of the viewport.

NhlCENTER

Locate the base position of the justification point of the Y-Axis title along the line of the horizontal center of the viewport.

NhlTOP

Locate the base position of the justification point of the Y-Axis title along the line of the top edge of the viewport.

From any of these base positions you can displace the Y-Axis title up or down by setting the resource tiYAxisOffsetYF. If you set tiYAxisPosition to NhlRIGHT or NhlLEFT Title issues a warning message and reverts to the default value, NhlCENTER.

Default: NhlCENTER

tiYAxisOffsetYF

Sets an offset in NDC coordinates by which the Y-Axis title will be displaced in a direction parallel to Y-Axis from its base location. This value does not scale in response to changes to the viewport size.

Default: 0.0

tiYAxisOffsetXF

Sets an offset in NDC coordinates by which the Y-Axis title will be displaced in a direction parallel to the X-Axis from its base location. This offset is applied over any offset due to tiDeltaF. It does not scale in response to change to the viewport size.

Default: 0.0

tiYAxisJust

This resource of type NhlJustification sets the Justification point of the Y-Axis title.

Default: NhlCENTERCENTER

tiYAxisFont

This resource of type NhlFont sets the font index for the Y-Axis title.

Default: 0

tiYAxisFontColor

Sets the font color for the Y-Axis title.

Default: 1

tiYAxisFontHeightF

Sets the font height in NDC coordinates to use for the Y-Axis title. This values scales proportionally to changes in the height of the viewport.

This resource may be intercepted or disabled by:

• PlotManager

Default: 0.025

tiYAxisFontAspectF

This resource sets the aspect ratio, defined as the height divided by the width of a reference character box within which all characters of the font will fit. Its value determines the width of characters in the Y-Axis title relative to tiYAxisFontHeightF. If given the value 1.0, wide characters such as 'M' will be approximately square in shape. Values increasing from 1.0 result in thinner characters, while values decreasing from 1.0 result in wider characters.

Default: 1.3125

tiYAxisConstantSpacingF

If this resource has the value 0.0, the characters in the Y-Axis title will be proportionally spaced. If it has a value greater than 0.0, the distance from the beginning of one character to the beginning of the next character will be constant.The value of tiYAxisConstantSpacingF sets this constant distance as a multiple of the width of a reference character box within which all characters of the font will fit. If txConstantSpacingF has the value 1.0, the constant distance will cause there to be almost no space between two wide characters such as 'M' placed next to each other. As tiYAxisConstantSpacingF decreases from 1.0, characters will begin to overlap. As it increases from 1.0 characters become further separated from each other. Values less than 0.0 result in an error and are replaced with the default value.

Default: 0.0

tiYAxisFontThicknessF

Sets the thickness of the lines used to draw the characters of the Y-Axis title. The value acts as a multiplier of a (device-dependent) unit thickness. This resource is ignored when the txFont specifies a filled font (font indexes 21, 22, 25 - 30, and 33 - 37).

Default: 1.0

tiYAxisFuncCode

Specifies the character used to delimit Text Function Codes that may be embedded in the Y-Axis title.

Default: :

tiYAxisFontQuality

Sets the font quality for the Y-Axis title.

Default: NhlHIGH

tiYAxisAngleF

Sets the counter-clockwise rotation angle for the Y-Axis title.

Default: 90.0

tiYAxisDirection

This resource of type NhlTextDirection specifies the direction of the text used for the Y-Axis title. There are three choices of which two are actually the same:

NhlDOWN

Each character is placed below the previous character in the text string.

NhlUP

Each character is placed below the previous character in the text string.

NhlACROSS

Each character is placed to the right of the previous character in the text string.

These descriptions apply before any rotation due to tiYAxisAngleF is applied to the Y-Axis title.

Default: NhlACROSS

Reference Manual Control Panel

NG4 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?