ConstantLine Properties
Constant line appearance and behavior
A constant line is a line that is graphed at a specified x-
or y-value in Cartesian axes. The xline and
yline functions create constant vertical and horizontal lines,
respectively. You can modify the appearance and behavior of the constant line by changing
ConstantLine property values.
xl = xline(4); xl.LineWidth = 2;
Location
Labels
Label — Line label
'' (default) | character vector | cell array of character vectors | string array | numeric array
Line label, specified as a character vector, cell array of character vectors, string array, or numeric array. To create a multiline label, use a string array or a cell array of character vectors.
Example: "cutoff frequency"
Example: ["One row of text","A second row of text"]
Example: {'One row of text','A second row of text'}
To include special characters, such as superscripts, subscripts, Greek letters, or
mathematical symbols, use TeX markup. For a list of supported markup, see the Interpreter property.
LabelHorizontalAlignment — Horizontal alignment of label
'right' (default) | 'left' | 'center'
Horizontal alignment of the label with respect to the line, specified as one of the options in the table.
| Option | Description | |
|---|---|---|
'right' | Right side of the line.
| |
'left' | Left side of the line.
| |
'center' | Center of the line. For vertical lines, the label segments the line.
| |
LabelVerticalAlignment — Vertical alignment of label
'top' (default) | 'middle' | 'bottom'
Vertical alignment of the label with respect to the line, specified as one of the options in the table.
| Option | Description | |
|---|---|---|
'top' | Top of the line.
| |
'middle' | Middle of the line. For horizontal lines, the label segments the line.
| |
'bottom' | Bottom of the line.
| |
LabelOrientation — Label orientation
'aligned' (default) | 'horizontal'
Label orientation, specified as 'aligned' or
'horizontal'. Examples are shown in the table.
| Orientation | Description | |
|---|---|---|
'aligned' | Label has the same orientation as the line.
| |
'horizontal' | Label is horizontal, regardless of the line orientation.
| |
Text interpreter, specified as one of these values:
'tex'— Interpret characters using a subset of TeX markup.'latex'— Interpret characters using LaTeX markup.'none'— Display literal characters.
TeX Markup
By default, MATLAB® supports a subset of TeX markup. Use TeX markup to add superscripts and subscripts, modify the font type and color, and include special characters in the text.
Modifiers remain in effect until the end of the text.
Superscripts and subscripts are an exception because they modify only the next character or the
characters within the curly braces. When you set the interpreter to 'tex',
the supported modifiers are as follows.
| Modifier | Description | Example |
|---|---|---|
^{ } | Superscript | 'text^{superscript}' |
_{ } | Subscript | 'text_{subscript}' |
\bf | Bold font | '\bf text' |
\it | Italic font | '\it text' |
\sl | Oblique font (usually the same as italic font) | '\sl text' |
\rm | Normal font | '\rm text' |
\fontname{ | Font name — Replace
| '\fontname{Courier} text' |
\fontsize{ | Font size —Replace
| '\fontsize{15} text' |
\color{ | Font color — Replace
red, green,
yellow, magenta,
blue, black,
white, gray,
darkGreen, orange, or
lightBlue. | '\color{magenta} text' |
\color[rgb]{specifier} | Custom font color — Replace
| '\color[rgb]{0,0.5,0.5} text' |
This table lists the supported special characters for the
'tex' interpreter.
| Character Sequence | Symbol | Character Sequence | Symbol | Character Sequence | Symbol |
|---|---|---|---|---|---|
| α |
| υ |
| ~ |
| ∠ |
| ϕ |
| ≤ |
|
|
| χ |
| ∞ |
| β |
| ψ |
| ♣ |
| γ |
| ω |
| ♦ |
| δ |
| Γ |
| ♥ |
| ϵ |
| Δ |
| ♠ |
| ζ |
| Θ |
| ↔ |
| η |
| Λ |
| ← |
| θ |
| Ξ |
| ⇐ |
| ϑ |
| Π |
| ↑ |
| ι |
| Σ |
| → |
| κ |
| ϒ |
| ⇒ |
| λ |
| Φ |
| ↓ |
| µ |
| Ψ |
| º |
| ν |
| Ω |
| ± |
| ξ |
| ∀ |
| ≥ |
| π |
| ∃ |
| ∝ |
| ρ |
| ∍ |
| ∂ |
| σ |
| ≅ |
| • |
| ς |
| ≈ |
| ÷ |
| τ |
| ℜ |
| ≠ |
| ≡ |
| ⊕ |
| ℵ |
| ℑ |
| ∪ |
| ℘ |
| ⊗ |
| ⊆ |
| ∅ |
| ∩ |
| ∈ |
| ⊇ |
| ⊃ |
| ⌈ |
| ⊂ |
| ∫ |
| · |
| ο |
| ⌋ |
| ¬ |
| ∇ |
| ⌊ |
| x |
| ... |
| ⊥ |
| √ |
| ´ |
| ∧ |
| ϖ |
| ∅ |
| ⌉ |
| 〉 |
| | |
| ∨ |
| 〈 |
| © |
LaTeX Markup
To use LaTeX markup, set the interpreter to 'latex'. For inline
mode, surround the markup with single dollar signs ($). For
display mode, surround the markup with double dollar signs
($$).
| LaTeX Mode | Example | Result |
|---|---|---|
| Inline |
'$\int_1^{20} x^2 dx$' |
|
| Display |
'$$\int_1^{20} x^2 dx$$' |
|
The displayed text uses the default LaTeX font style. The
FontName, FontWeight, and
FontAngle properties do not have an effect. To change the
font style, use LaTeX markup.
The maximum size of the text that you can use with the LaTeX interpreter is 1200 characters. For multiline text, this reduces by about 10 characters per line.
For examples that use TeX and LaTeX, see Greek Letters and Special Characters in Chart Text. For more information about the LaTeX system, see The LaTeX Project website at https://www.latex-project.org/.
LabelColor — Label color
RGB triplet | hexadecimal color code | 'r' | 'g' | 'b' | ...
Since R2024b
Label color, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name.
For a custom color, specify an RGB triplet or a hexadecimal color code.
An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range
[0,1], for example,[0.4 0.6 0.7].A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (
#) followed by three or six hexadecimal digits, which can range from0toF. The values are not case sensitive. Therefore, the color codes"#FF8800","#ff8800","#F80", and"#f80"are equivalent.
Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.
| Color Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
|---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" |
|
"green" | "g" | [0 1 0] | "#00FF00" |
|
"blue" | "b" | [0 0 1] | "#0000FF" |
|
"cyan"
| "c" | [0 1 1] | "#00FFFF" |
|
"magenta" | "m" | [1 0 1] | "#FF00FF" |
|
"yellow" | "y" | [1 1 0] | "#FFFF00" |
|
"black" | "k" | [0 0 0] | "#000000" |
|
"white" | "w" | [1 1 1] | "#FFFFFF" |
|
"none" | Not applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
| RGB Triplet | Hexadecimal Color Code | Appearance |
|---|---|---|
[0 0.4470 0.7410] | "#0072BD" |
|
[0.8500 0.3250 0.0980] | "#D95319" |
|
[0.9290 0.6940 0.1250] | "#EDB120" |
|
[0.4940 0.1840 0.5560] | "#7E2F8E" |
|
[0.4660 0.6740 0.1880] | "#77AC30" |
|
[0.3010 0.7450 0.9330] | "#4DBEEE" |
|
[0.6350 0.0780 0.1840] | "#A2142F" |
|
![Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue](colororder1.png){kind=small}
![Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange](colororder2.png){kind=small}
![Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow](colororder3.png){kind=small}
![Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple](colororder4.png){kind=small}
![Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green](colororder5.png){kind=small}
![Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue](colororder6.png){kind=small}
![Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red](colororder7.png){kind=small}
LabelColorMode — Control how LabelColor is set
"auto" (default) | "manual"
Since R2024b
Control how the LabelColor property is set, specified as one of
these values:
"auto"— MATLAB sets theLabelColorproperty to the same value as theColorproperty, so the line and the label have the same color."manual"— You set the value of theLabelColorproperty directly, and the color does not change.
If you change the value of the LabelColor property manually,
MATLAB changes the value of the LabelColorMode property to
"manual".
Color and Styling
Color — Line color
[0.15 0.15 0.15] (default) | RGB triplet | hexadecimal color code | 'r' | 'g' | 'b' | ...
Line color, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name.
For a custom color, specify an RGB triplet or a hexadecimal color code.
An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range
[0,1], for example,[0.4 0.6 0.7].A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (
#) followed by three or six hexadecimal digits, which can range from0toF. The values are not case sensitive. Therefore, the color codes"#FF8800","#ff8800","#F80", and"#f80"are equivalent.
Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.
| Color Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
|---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" |
|
"green" | "g" | [0 1 0] | "#00FF00" |
|
"blue" | "b" | [0 0 1] | "#0000FF" |
|
"cyan"
| "c" | [0 1 1] | "#00FFFF" |
|
"magenta" | "m" | [1 0 1] | "#FF00FF" |
|
"yellow" | "y" | [1 1 0] | "#FFFF00" |
|
"black" | "k" | [0 0 0] | "#000000" |
|
"white" | "w" | [1 1 1] | "#FFFFFF" |
|
"none" | Not applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
| RGB Triplet | Hexadecimal Color Code | Appearance |
|---|---|---|
[0 0.4470 0.7410] | "#0072BD" |
|
[0.8500 0.3250 0.0980] | "#D95319" |
|
[0.9290 0.6940 0.1250] | "#EDB120" |
|
[0.4940 0.1840 0.5560] | "#7E2F8E" |
|
[0.4660 0.6740 0.1880] | "#77AC30" |
|
[0.3010 0.7450 0.9330] | "#4DBEEE" |
|
[0.6350 0.0780 0.1840] | "#A2142F" |
|
Example: 'g'
Example: [0.6 0.2 0.5]
Example: '#D2F9A7'
Line style, specified as one of the options listed in this table.
| Line Style | Description | Resulting Line |
|---|---|---|
"-" | Solid line |
|
"--" | Dashed line |
|
":" | Dotted line |
|
"-." | Dash-dotted line |
|
"none" | No line | No line |
LineWidth — Line width
0.5 (default) | positive value
Line width, specified as a positive value in points.
Alpha — Line transparency
0.7 (default) | scalar in range [0,1]
Line transparency, specified as a scalar in the range [0,1]. A
value of 1 is opaque and 0 is completely
transparent. Values between 0 and 1 are
semitransparent.
SeriesIndex — Series index
"none" (default) | positive whole number
Series index, specified as a positive whole number or "none".
This property is useful for reassigning the colors and line styles of
ConstantLine objects so that they match other objects.
When the SeriesIndex property is a number, MATLAB uses the number to calculate indices for assigning colors and line styles
when you call the xline or yline functions.
The indices refer to the rows of the arrays stored in the
ColorOrder and LineStyleOrder properties of
the axes. Any objects in the axes that have the same SeriesIndex
number will have the same color (and line style, if applicable).
A SeriesIndex value of "none" corresponds to a
solid line with a neutral color that does not participate in the indexing scheme.
How Manually Setting Colors, Line Styles, or Markers Overrides SeriesIndex Behavior
To manually control the color and line style, set the Color
and LineStyle properties of the ConstantLine
object.
When you manually set these properties of an object, MATLAB disables automatic color and line style selection for that object and
allows your selection to persist, regardless of the value of the
SeriesIndex property. The ColorMode and
LineStyleMode properties indicate whether the colors and line
styles have been set manually (by you) or automatically. For each of these mode
properties, a value of "manual" indicates manual selection, and
"auto" indicates automatic selection.
To enable automatic selection again, set the ColorMode,
LineStyleMode, or both properties to "auto",
and set the SeriesIndex property to a positive whole
number.
In some cases, MATLAB sets the SeriesIndex property to
0, which also disables automatic color selection.
Font
Legend
Interactivity
Callbacks
Callback Execution Control
Parent/Child
Identifiers
Version History
Introduced in R2018b
You can also select a web site from the following list
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)