Function to plot, specified as a function handle, anonymous function, or a symbolic expression or function.

Plotting interval for x values, specified as a two-element vector of the form [xmin xmax].

Selection mode for XRange, specified as one of these values:

• 'auto' — Use the default value [-5 5]. If axes limits are specified, follow the specified limits instead.

• 'manual' — Use manually specified values. To specify the values, set the XRange property.

Number of evaluation points, specified as a number. The default is 23. Because Function Line uses adaptive evaluation, the actual number of evaluation points is greater.

Display asymptotes at poles, specified as 'on' (default) or 'off'. The asymptotes display as gray, dashed vertical lines. fplot displays asymptotes only with the fplot(f) syntax or variants, and not with the fplot(xt,yt) syntax.

Line style, specified as one of the line styles listed in this table.

Line width, specified as a positive value in points. If the line has markers, then the line width also affects the marker edges.

Example: 0.75

Line color, specified as an RGB triplet, a character vector of a color name, or 'none'. If you specify the Color as 'none', then the line is invisible.

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]. This table lists the long and short color name options and the equivalent RGB triplet values.

Example: 'blue'

Example: [0 0 1]

Marker symbol, specified as one of the markers listed in this table. By default, the line does not have markers. Specifying a marker symbol adds markers at selected points along the line.

Example: '+'

Example: 'diamond'

Marker size, specified as a positive value in points.

Example: 10

Marker outline color, specified as one of these values:

• 'auto' — Use the same color specified in the Color property.

• 'none' — Use no color, which makes unfilled markers invisible.

• RGB triplet or character vector of a color name — Use the specified color.

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]. This table lists the long and short color name options and the equivalent RGB triplet values.

Example: [0.5 0.5 0.5]

Example: 'blue'

Marker fill color, specified as one of these values:

• 'none' — Use no color, which makes the interior invisible.

• 'auto' — Use the same color specified in the MarkerEdgeColor property.

• RGB triplet or character vector of a color name — Use the specified color.

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]. This table lists the long and short color name options and the equivalent RGB triplet values.

Example: [0.3 0.2 0.1]

Example: 'green'

This property is read only.

x values, specified as a vector. XData, YData, and ZData have equal lengths.

This property is read only.

y values, specified as a vector. XData, YData, and ZData have equal lengths.

This property is read only.

z values, returned as a vector of zeros. XData, YData, and ZData have equal lengths.

State of visibility, specified as one of these values:

• 'on' — Display the function line.

• 'off' — Hide the function line without deleting it. You still can access the properties of an invisible function line object.

Clipping of the function line object to the axes limits, specified as one of these values:

• 'on' — Do not display parts of the function line object that are outside the axes limits.

• 'off' — Display the entire function line object, even if parts of it appear outside the axes limits. Parts of the function line object might appear outside the axes limits if you create a plot, set hold on, freeze the axis scaling, and then create the function line object so that it is larger than the original plot.

The Clipping property of the axes that contains the function line object must be set to 'on', otherwise this property has no effect. For more information about the clipping behavior, see the Clipping property of the axes.

This property is read only.

Type of graphics object, returned as 'functionline'. Use this property to find all objects of a given type within a plotting hierarchy, for example, searching for the type using findobj.

User-specified tag to associate with the function line, specified as a character vector. Tags provide a way to identify graphics objects. Use this property to find all objects with a specific tag within a plotting hierarchy, for example, searching for the tag using findobj.

Example: 'January Data'

Data to associate with the function line object, specified as any MATLAB data, for example, a scalar, vector, matrix, cell array, character array, table, or structure. MATLAB does not use this data.

To associate multiple sets of data or to attach a field name to the data, use the getappdata and setappdata functions.

Example: 1:100

Text for legend label, specified as a custom character vector. The default label is autogenerated from the Function property and the texlabel function. The legend does not appear until you call the legend function.

This property is read only.

Control for including or excluding the function line from a legend, returned as an Annotation object. Set the underlying IconDisplayStyle property to one of these values:

• 'on' — Include the function line in the legend (default).

• 'off' — Do not include the function line in the legend.

For example, exclude a stem chart from the legend.

p = plot(1:10,'DisplayName','Line Chart');
hold on
s = stem(1:10,'DisplayName','Stem Chart');
hold off
s.Annotation.LegendInformation.IconDisplayStyle = 'off';
legend('show')

Alternatively, you can control the items in a legend using the legend function. Specify the first input argument as a vector of the graphics objects to include.

p = plot(1:10,'DisplayName','Line Chart');
hold on
s = stem(1:10,'DisplayName','Stem Chart');
hold off
legend(p)

Parent of function line, specified as an axes, group, or transform object.

The function line has no children. You cannot set this property.

Visibility of function line object handle in the Children property of the parent, specified as one of these values:

• 'on' — The function line object handle is always visible.

• 'off' — The function line object handle is invisible at all times. This option is useful for preventing unintended changes to the UI by another function. Set the HandleVisibility to 'off' to temporarily hide the handle during the execution of that function.

• 'callback' — The function line object handle is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. This option blocks access to the function line at the command-line, but allows callback functions to access it.

If the function line object is not listed in the Children property of the parent, then functions that obtain object handles by searching the object hierarchy or querying handle properties cannot return it. This includes get, findobj, gca, gcf, gco, newplot, cla, clf, and close.

Hidden object handles are still valid. Set the root ShowHiddenHandles property to 'on' to list all object handles regardless of their HandleVisibility property setting.

Mouse-click callback, specified as one of these values:

• Function handle

• Cell array containing a function handle and additional arguments

• Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

Use this property to execute code when you click the function line. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

• The function line object — You can access properties of the function line object from within the callback function.

• Event data — This argument is empty for this property. Replace it with the tilde character (~) in the function definition to indicate that this argument is not used.

For more information on how to use function handles to define callback functions, see Callback Definition.

Note:   If the PickableParts property is set to 'none' or if the HitTest property is set to 'off', then this callback does not execute.

Example: @myCallback

Example: {@myCallback,arg3}

Context menu, specified as a uicontextmenu object. Use this property to display a context menu when you right-click the function line. Create the context menu using the uicontextmenu function.

Note:   If the PickableParts property is set to 'none' or if the HitTest property is set to 'off', then the context menu does not appear.

Selection state, specified as one of these values:

• 'on' — Selected. If you click the function line when in plot edit mode, then MATLAB sets its Selected property to 'on'. If the SelectionHighlight property also is set to 'on', then MATLAB displays selection handles around the function line.

• 'off' — Not selected.

Display of selection handles when selected, specified as one of these values:

• 'on' — Display selection handles when the Selected property is set to 'on'.

• 'off' — Never display selection handles, even when the Selected property is set to 'on'.

Ability to capture mouse clicks, specified as one of these values:

• 'visible' — Can capture mouse clicks when visible. The Visible property must be set to 'on' and you must click a part of the function line that has a defined color. You cannot click a part that has an associated color property set to 'none'. If the plot contains markers, then the entire marker is clickable if either the edge or the fill has a defined color. The HitTest property determines if the function line responds to the click or if an ancestor does.

• 'all' — Can capture mouse clicks regardless of visibility. The Visible property can be set to 'on' or 'off' and you can click a part of the function line that has no color. The HitTest property determines if the function line responds to the click or if an ancestor does.

• 'none' — Cannot capture mouse clicks. Clicking the function line passes the click through it to the object below it in the current view of the figure window. The HitTest property has no effect.

Response to captured mouse clicks, specified as one of these values:

• 'on' — Trigger the ButtonDownFcn callback of the function line. If you have defined the UIContextMenu property, then invoke the context menu.

• 'off' — Trigger the callbacks for the nearest ancestor of the function line that has a HitTest property set to 'on' and a PickableParts property value that enables the ancestor to capture mouse clicks.

Note:   The PickableParts property determines if the function line object can capture mouse clicks. If it cannot, then the HitTest property has no effect.

Callback interruption, specified as 'on' or 'off'. The Interruptible property determines if a running callback can be interrupted.

Note:   There are two callback states to consider: The running callback is the currently executing callback. The interrupting callback is a callback that tries to interrupt the running callback. Whenever MATLAB invokes a callback, that callback attempts to interrupt a running callback. The Interruptible property of the object owning the running callback determines if interruption is allowed. If interruption is not allowed, then the BusyAction property of the object owning the interrupting callback determines if it is discarded or put in the queue.

If the ButtonDownFcn callback of the function line is the running callback, then the Interruptible property determines if it another callback can interrupt it:

• 'on' — Interruptible. Interruption occurs at the next point where MATLAB processes the queue, such as when there is a drawnow, figure, getframe, waitfor, or pause command.

  • If the running callback contains one of these commands, then MATLAB stops the execution of the callback at this point and executes the interrupting callback. MATLAB resumes executing the running callback when the interrupting callback completes. For more information, see Interrupt Callback Execution.

  • If the running callback does not contain one of these commands, then MATLAB finishes executing the callback without interruption.

• 'off' — Not interruptible. MATLAB finishes executing the running callback without any interruptions.

Callback queuing specified as 'queue' or 'cancel'. The BusyAction property determines how MATLAB handles the execution of interrupting callbacks.

Note:   There are two callback states to consider: The running callback is the currently executing callback. The interrupting callback is a callback that tries to interrupt the running callback. Whenever MATLAB invokes a callback, that callback attempts to interrupt a running callback. The Interruptible property of the object owning the running callback determines if interruption is allowed. If interruption is not allowed, then the BusyAction property of the object owning the interrupting callback determines if it is discarded or put in the queue.

If the ButtonDownFcn callback of the function line tries to interrupt a running callback that cannot be interrupted, then the BusyAction property determines if it is discarded or put in the queue. Specify the BusyAction property as one of these values:

• 'queue' — Put the interrupting callback in a queue to be processed after the running callback finishes execution. This is the default behavior.

• 'cancel' — Discard the interrupting callback.

Creation callback, specified as one of these values:

• Function handle

• Cell array containing a function handle and additional arguments

• Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

Use this property to execute code when you create the function line. Setting the CreateFcn property on an existing function line has no effect. You must define a default value for this property, or define this property using a Name,Value pair during function line creation. MATLAB executes the callback after creating the function line and setting all of its properties.

If you specify this callback using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

• The function line object — You can access properties of the function line object from within the callback function. You also can access the function line object through the CallbackObject property of the root, which can be queried using the gcbo function.

• Event data — This argument is empty for this property. Replace it with the tilde character (~) in the function definition to indicate that this argument is not used.

For more information on how to use function handles to define callback functions, see Callback Definition.

Example: @myCallback

Example: {@myCallback,arg3}

Deletion callback, specified as one of these values:

• Function handle

• Cell array containing a function handle and additional arguments

• Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

Use this property to execute code when you delete the function line. MATLAB executes the callback before destroying the function line so that the callback can access its property values.

If you specify this callback using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

• The function line object — You can access properties of the function line object from within the callback function. You also can access the function line object through the CallbackObject property of the root, which can be queried using the gcbo function.

• Event data — This argument is empty for this property. Replace it with the tilde character (~) in the function definition to indicate that this argument is not used.

For more information on how to use function handles to define callback functions, see Callback Definition.

Example: @myCallback

Example: {@myCallback,arg3}

This property is read only.

Deletion status of function line, returned as 'off' or 'on'. MATLAB sets the BeingDeleted property to 'on' when the delete function of the function line begins execution (see the DeleteFcn property). The BeingDeleted property remains set to 'on' until the function line no longer exists.

Check the value of the BeingDeleted property to verify that the function line is not about to be deleted before querying or modifying it.