mlreportgen.chart.Border Class

Namespace: mlreportgen.chart

Border of a chart shape

Since R2026b

expand all in page

Description

Use an object of the mlreportgen.chart.Border class to define a border for a shape.

The mlreportgen.chart.Border class is a handle class.

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

For information on class attributes, see Class Attributes.

Creation

Description

borderObj = mlreportgen.chart.Border creates a Border object that is black.

borderObj = mlreportgen.chart.Border(color) creates a Border object of the color specified by the color argument.

Input Arguments

expand all

Color of the border, specified as a character vector or string scalar that contains a CSS color name, hexadecimal RGB value, or decimal RGB value.

FormatValue
CSS color nameSpecify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB valueUse the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color valueUse the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

This argument sets the Color property.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

Properties

expand all

Fill applied to the chart element object, specified as an object of these fill classes:

  • mlreportgen.chart.SolidFill

  • mlreportgen.chart.GradientFill

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Width of the chart element object, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. Valid abbreviations are:

  • "px" — Pixels

  • "cm" — Centimeters

  • "in" — Inches

  • "mm" — Millimeters

  • "pc" — Picas

  • "pt" — Points

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Example: "5in" specifies five inches

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Line dash type, specified as an mlreportgen.chart.LineDashType object of one of these enumerations:

Line DashDescription
mlreportgen.chart.LineDashType.SolidSolid line
mlreportgen.chart.LineDashType.RoundDotDotted line with round dots
mlreportgen.chart.LineDashType.SquareDotDotted line with square dots
mlreportgen.chart.LineDashType.DashDotLine with alternating dots and dashes
mlreportgen.chart.LineDashType.LongDashDashed line
mlreportgen.chart.LineDashType.LongDashDotLine with alternating dots and dashes
mlreportgen.chart.LineDashType.LongDashDotDotLine with alternating double dots and a dash

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Line cap type, specified as an mlreportgen.chart.LineCapType object of one of these enumerations:

Line CapDescription
mlreportgen.chart.LineCapType.FlatLine ends exactly at the endpoint with a flat edge
mlreportgen.chart.LineCapType.RoundLine midpoint ends exactly at the endpoint with a half round end that extends past the endpoint
mlreportgen.chart.LineCapType.SquareLine midpoint ends exactly at the endpoint with a square end that extends past the endpoint

Three thick black lines with white dashed mid-lines. The first line has flat ends and has the label "Flat". The second line has rounded ends that extend past the line endpoints and has the label "Round". The third line has square ends that extend past the line endpoints and has the label "Square".

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Line join type, specified as an mlreportgen.chart.LineJoinType object of one of these enumerations:

Line CapDescription
mlreportgen.chart.LineJoinType.BevelCuts off the corner of the line join with a straight line to form a flat edge
mlreportgen.chart.LineJoinType.RoundedAdds a circular arc between the lines to form a rounded corner
mlreportgen.chart.LineJoinType.MiterExtends the outer edge of the lines to connect at a single point to form a sharp corner

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Line compound type, specified as an mlreportgen.chart.LineCompoundType object of one of these enumerations:

Line CompoundDescription
mlreportgen.chart.LineCompoundType.SimpleSingle line
mlreportgen.chart.LineCompoundType.DoubleDouble line
mlreportgen.chart.LineCompoundType.ThinThickThin line, then thick line
mlreportgen.chart.LineCompoundType.ThickThinThick line, then thin line
mlreportgen.chart.LineCompoundType.TripleTriple line

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Version History

Introduced in R2026b