Title (ti) Resources

tiDeltaF

Sets the default offset for all of the titles. The absolute value of this resource multiplied by the appropriate ti...FontHeightF resource value gives the amount, in NDC, that the titles will be offset perpendicularly from the viewport boundary in the direction opposite the viewport center. After the effect of this offset is calculated, if any part of a title is left overlapping the viewport, it is adjusted farther outward such that no overlap remains. If tiMainOffsetYF, tiXAxisOffsetYF, or tiYAxisOffsetXF are non-zero, they specify an additional offset applied unconditionally from the adjusted position in the same or the opposite direction.

Default: 1.5

tiMainAngleF

Angle of counterclockwise rotation of the Main title.

Default: 0.00

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 tiMainConstantSpacingF has the value 1.0, the constant distance will cause there to be almost no space between two wide characters (such as 'M' or 'W') 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

tiMainDirection

This resource of type NhlTTextDirection specifies the direction of the text used for the Main title. There are two choices:

Down

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

Across

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: Across

tiMainFont

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

Default: 0

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'or 'W') 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

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

tiMainFontQuality

Sets the font quality for the Main title.

Default: High

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 tiMainFont specifies a filled font (font indexes 21-22, 25-26, 29-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.

Note: the default function code was a colon (:) in NCL Versions 6.0.0 and earlier.

Default: ~

tiMainJust

This resource of type NhlTJustification sets the justification point of the main title.

The first part of the string should be set to the desired vertical justifcation ("top", "center", "bottom"), and the second part to the desired horizontal justification ("left", "center", "right").

Default: CenterCenter

tiMainOffsetXF

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

Default: 0.0

tiMainOffsetYF

Sets a positive or negative 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 after any offset due to tiDeltaF and the adjustment performed to prevent the Main title from intruding into the viewport (or into the X-Axis title). Therefore, this resource allows you to displace the title any distance away from the viewport or into its interior. The positive direction coincides with that of the NDC Y Axis. Its value does not scale in response to changes in the viewport size.

Default: 0.0

tiMainOn

Setting this boolean resource 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>

tiMainPosition

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

Left

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

Center

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

Right

Locate the base position of justification point of the Main title along the line of the right 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 Bottom or Top Title issues a warning message and reverts to the default value, Center.

Default: Center

tiMainSide

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

Top

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

Bottom

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

If you set tiMainPosition to Left, Center, or Right Title issues a warning message and reverts to its default value.

Default: Top

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"

tiUseMainAttributes

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

Default: False

tiXAxisAngleF

Sets the counterclockwise rotation angle for the X-Axis title.

Default: 0.0

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 tiXAxisConstantSpacingF has the value 1.0, the constant distance will cause there to be almost no space between two wide characters (such as 'M' or 'W') 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

tiXAxisDirection

This resource of type NhlTTextDirection specifies the direction of the text used for the X-Axis title. There are two choices:

Down

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

Across

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: Across

tiXAxisFont

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

Default: 0

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' or 'W') 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

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

tiXAxisFontQuality

Sets the font quality for the X-Axis title.

Default: High

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 tiXAxisFont specifies a filled font (font indexes 21-22, 25-26, 29-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.

Note: the default function code was a colon (:) in NCL Versions 6.0.0 and earlier.

Default: ~

tiXAxisJust

This resource of type NhlTJustification sets the justification point of the X-Axis title.

The first part of the string should be set to the desired vertical justifcation ("top", "center", "bottom"), and the second part to the desired horizontal justification ("left", "center", "right").

Default: CenterCenter

tiXAxisOffsetXF

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

Default: 0.0

tiXAxisOffsetYF

Sets a positive or negative 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 after any offset due to tiDeltaF and the adjustment performed to prevent the X-Axis title from intruding into the viewport. Therefore, this resource allows you to displace the title any distance away from the viewport or into its interior. The positive direction coincides with that of the NDC Y Axis. Its value does not scale in response to changes in the viewport size.

Default: 0.0

tiXAxisOn

Setting this boolean resource 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 explicitly set tiXAxisString.

Default: <dynamic>

tiXAxisPosition

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

Left

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

Center

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

Right

Locate the base position of the justification point of the X-Axis title along the line of the right 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 Bottom or Top, Title issues a warning message and reverts to the default value, Center.

Default: Center

tiXAxisSide

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

Top

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

Bottom

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

If you set tiXAxisPosition to Left, Center, or Right Title issues a warning message and reverts to the default value, Bottom.

Default: Bottom

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"

tiYAxisAngleF

Sets the counterclockwise rotation angle for the Y-Axis title.

Default: 90.0

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 tiYAxisConstantSpacingF has the value 1.0, the constant distance will cause there to be almost no space between two wide characters (such as 'M' or 'W') 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

tiYAxisDirection

This resource of type NhlTTextDirection specifies the direction of the text used for the Y-Axis title. There are two choices:

Down

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

Across

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: Across

tiYAxisFont

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

Default: 0

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' or 'W') 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

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

tiYAxisFontQuality

Sets the font quality for the Y-Axis title.

Default: High

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 tiYAxisFont specifies a filled font (font indexes 21-22, 25-26, 29-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.

Note: the default function code was a colon (:) in NCL Versions 6.0.0 and earlier.

Default: ~

tiYAxisJust

This resource of type NhlTJustification sets the justification point of the Y-Axis title.

The first part of the string should be set to the desired vertical justifcation ("top", "center", "bottom"), and the second part to the desired horizontal justification ("left", "center", "right").

Default: CenterCenter

tiYAxisOffsetXF

Sets a positive or negative 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 after any offset due to tiDeltaF and the adjustment performed to prevent the Y-Axis title from intruding into the viewport. Therefore, this resource allows you to displace the title any distance away from the viewport or into its interior. The positive direction coincides with that of the NDC X Axis. Its value does not scale in response to changes in the viewport size.

Default: 0.0

tiYAxisOffsetYF

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

Default: 0.0

tiYAxisOn

Setting this boolean resource 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 explicitly set tiYAxisString.

Default: <dynamic>

tiYAxisPosition

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

Bottom

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

Center

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

Top

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 Right or Left Title issues a warning message and reverts to the default value, Center.

Default: Center

tiYAxisSide

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

Left

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

Right

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

If you set tiYAxisPosition to Bottom, Center, or Top Title issues a warning message and reverts to the default value, Left.

Default: Left

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"