Main Content

plannerLineSpec.reversePath

Specifications for plotting reverse path

Since R2023b

collapse all in page

    Syntax

    spec = plannerLineSpec.reversePath
    spec = plannerLineSpec.reversePath(Name=Value)
    [spec,structData] = plannerLineSpec.reversePath(___)

    Description

    spec = plannerLineSpec.reversePath specifies default color, line, and marker properties for plotting the reverse path.

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

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

    Input Arguments

    collapse all

    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.reversePath(Color="Red")

    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.

    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.

    Line width, specified as a positive numeric scalar.

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

    MarkerDescriptionResulting Marker
    "o" Circle

    Sample of circle marker

    "+" Plus sign

    Sample of plus sign marker

    "*" Asterisk

    Sample of asterisk marker

    "." Point

    Sample of point marker

    "x" Cross

    Sample of cross marker

    "_" Horizontal line

    Sample of horizontal line marker

    "|" Vertical line

    Sample of vertical line marker

    "square" Square

    Sample of square marker

    "diamond" Diamond

    Sample of diamond marker

    "^" Upward-pointing triangle

    Sample of upward-pointing triangle marker

    "v" Downward-pointing triangle

    Sample of downward-pointing triangle marker

    ">" Right-pointing triangle

    Sample of right-pointing triangle marker

    "<" Left-pointing triangle

    Sample of left-pointing triangle marker

    "pentagram" Pentagram

    Sample of pentagram marker

    "hexagram" Hexagram

    Sample of hexagram marker

    "none" No markersNot applicable

    Marker size, specified as a positive numeric 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.

    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.

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

    Output Arguments

    collapse all

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

    Data Types: cell

    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

    See Also

    | | | | | | |