slrealtime.instrument.LineStyle

Create real-time instrument LineStyle object

Since R2022b

Description

An slrealtime.instrument.LineStyle object defines line style properties for a connectLine function.

Creation

lineStyle_object = slrealtime.instrument.LineStyle() creates an empty instrument LineStyle object for setting line style properties.

Example: Configure Line Style Properties for connectLine

Properties

Color — Line color

[-1 -1 -1](auto select) (default) | 'red' | 'r' | 'green' | 'g' | 'blue' | 'b' | 'cyan' | 'c' | 'magenta' | 'm' | 'yellow' | 'y' | 'black' | 'k' | 'white' | 'w'

Select the line color.

Example: myLineStyle.Color = 'black';

Marker — Marker character

'none' (default) | +' | 'o' | '*' | '.' | 'x' | 'square' | 'diamond' | 'v' | '^' | '>' | '<' | 'pentagram' | 'hexagram'

Select the marker character in the line.

Example: myLineStyle.Marker = '*';

MarkerSize — Marker character size

6 (default) | positive scalar value

Select the marker character size in the line.

Example: myLineStyle.MarkerSize = 4;

Style — Line style character

'-' (default) | '--' | ':' | '-.'

Select the line style character.

Example: myLineStyle.Style = '--';

Width — Line width

0.5 (default) | positive scalar value

Select the line width.

Example: myLineStyle.Width = 1;

Label — Line label

character vector

Select a line label.

Example: myLineStyle.Label = 'My Line';

Examples

Configure Line Style Properties for connectLine

• You can configure style properties in a LineStyle object and apply the style in the connectLine function.

  tg = slrealtime;
  removeAllInstruments(tg);
  % next assumes that real-time application has been built
  mldatxfile = 'slrt_ex_pendulum_100Hz.mldatx';
  hInst  = slrealtime.Instrument(mldatxfile);
  myLineStyle = slrealtime.instrument.LineStyle();
  myLineStyle.Marker = '*';
  myLineStyle.MarkerSize = 4;
  myLineStyle.Color = 'black';
  myLineStyle.Label = 'Cart Position';
  hAxis = uiaxes ();
  legend(hAxis);
  connectLine(hInst,hAxis,'cartposition', ...
      'LineStyle', myLineStyle);
  addInstrument(tg,hInst);
  load(tg,mldatxfile);
  start(tg);
  pause(10);
  stop(tg);

Version History

Introduced in R2022b

R2024a: Set Label Property for LineStyle object

Information is available for the slrealtime.instrument.LineStyle function Label property.