plannerLineSpec.reverseTree

Specifications for plotting reverse search tree

Since R2023b

Syntax

spec = plannerLineSpec.reverseTree

spec = plannerLineSpec.reverseTree(Name=Value)

[spec,structData] = plannerLineSpec.reverseTree(___)

Description

spec = plannerLineSpec.reverseTree specifies default color, line, and marker properties for plotting the reverse search tree.

spec = plannerLineSpec.reverseTree(Name=Value) specifies new values for the color, line, and marker properties by using one or more name-value arguments.

[spec,structData] = plannerLineSpec.reverseTree(___) returns the properties and their values as a structure using any combination of inputs from the previous syntaxes.

Input Arguments

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: plannerLineSpec.reverseTree(Color="Red")

Color — Line color

"#5E2296" (default) | RGB triplet | character vector | string scalar

Line color, specified as one of these values:

• RGB triplet — Specify the intensities of the red, green, and blue components of the color as a three-element vector in the order [R G B]. Each intensity must be in the range [0, 1]. For example, you can specify a shade of pink as [1 0.5 0.8].

• Character vector or string scalar — Specify the hexadecimal color code, color name, or short name of the color.

For more information on the types of color values and how to specify them, see Specify Plot Colors.

LineStyle — Line style

"-" (default) | "--" | ":" | "-." | "none"

Line style, specified as one of these values:

• "-" — For a solid line. This is the default.

• "--" — For a dashed line.

• ":" — For a dotted line.

• "-." — For a dash-dotted line.

• "none" — For no line.

LineWidth — Line width

1 (default) | positive numeric scalar

Line width, specified as a positive numeric scalar.

Marker — Marker symbol

"." (default) | "o" | "+" | "*" | "x" | ...

Marker symbol, specified as one of the values listed in this table.

Marker	Description	Resulting Marker
"o"	Circle
"+"	Plus sign
"*"	Asterisk
"."	Point
"x"	Cross
"_"	Horizontal line
"|"	Vertical line
"square"	Square
"diamond"	Diamond
"^"	Upward-pointing triangle
"v"	Downward-pointing triangle
">"	Right-pointing triangle
"<"	Left-pointing triangle
"pentagram"	Pentagram
"hexagram"	Hexagram
"none"	No markers	Not applicable

MarkerSize — Marker size

2 (default) | positive numeric scalar

Marker size, specified as a positive numeric scalar.

MarkerEdgeColor — Marker outline color

"#5E2296" (default) | RGB triplet | character vector | string scalar

Marker outline color, specified as one of these values:

• RGB triplet — Specify the intensities of the red, green, and blue components of the color as a three-element vector in the order [R G B]. Each intensity must be in the range [0, 1]. For example, you can specify a shade of pink as [1 0.5 0.8].

• Character vector or string scalar — Specify the hexadecimal color code, color name, or short name of the color.

For more information on the types of color values and how to specify them, see Specify Plot Colors.

MarkerFaceColor — Marker fill color

"#5E2296" (default) | RGB triplet | character vector | string scalar

Marker fill color, specified as one of these values:

• RGB triplet — Specify the intensities of the red, green, and blue components of the color as a three-element vector in the order [R G B]. Each intensity must be in the range [0, 1]. For example, you can specify a shade of pink as [1 0.5 0.8].

• Character vector or string scalar — Specify the hexadecimal color code, color name, or short name of the color.

For more information on the types of color values and how to specify them, see Specify Plot Colors.

DisplayName — Label to include in legend

"Reverse Tree" (default) | character vector | string scalar

Label to include in the legend, specified as a character vector or string scalar.

Output Arguments

spec — Color, line, and marker specifications

cell array

Color, line, and marker specifications for plotting the reverse search tree, returned as a cell array of size 1-by-16.

Data Types: cell

structData — Specifications for the plot

structure

Specifications for the plot, returned as a structure with fields Color, LineStyle, LineWidth, Marker, MarkerSize, MarkerEdgecolor, MarkerFaceColor, and DisplayName. Each field contains the value specified to the corresponding name-value argument.

Data Types: struct

Version History

Introduced in R2023b