MATLAB Function Reference
  Go to function:
    Search    Help Desk 
line    Examples

Create Line object

Syntax

Description

line creates a Line object in the current Axes. You can specify the color, width, line style, and marker type, as well as other characteristics.

The line function has two forms:

line(X,Y) adds the Line defined in vectors X and Y to the current Axes. If X and Y are matrices of the same size, line draws one Line per column.

line(X,Y,Z) creates Lines in three-dimensional coordinates.

line(X,Y,Z,'PropertyName',PropertyValue,...) creates a Line using the values for the property name/property value pairs specified and default values for all other properties.

See the LineStyle and Marker properties for a list of supported values.

line('XData',x,'YData',y,'ZData',z,'PropertyName',PropertyValue,.. .) creates a Line in the current Axes using the property values defined as arguments. This is the low-level form of the line function, which does not accept matrix coordinate data as the other informal forms described above.

h = line(...) returns a column vector of handles corresponding to each Line object the function creates.

Remarks

In its informal form, the line function interprets the first three arguments (two for 2-D) as the X, Y, and Z coordinate data, allowing you to omit the property names. You must specify all other properties as name/value pairs. For example,

The low-level form of the line function can have arguments that are only property name/property value paris. For example,

Line properties control various aspects of the Line object and are described in the "Line Properties" section. You can also set and query property values after creating the Line using set and get.

You can specify properties as property name/property value pairs, structure arrays, and cell arrays (see the set and get reference pages for examples of how to specify these data types).

Unlike high-level functions such as plot, line does not respect the setting of the Figure and Axes NextPlot properties. It simply adds Line objects to the current Axes. However, Axes properties that are under automatic control such as the axis limits can change to accommodate the Line within the current Axes.

Examples

This example uses the line function to add a shadow to plotted data. First, plot some data and save the Line's handle:

Next, add a shadow by offsetting the x coordinates. Make the shadow Line light gray and wider than the default LineWidth:

Finally, pop the first Line to the front:

Input Argument Dimensions - Informal Form

This statement reuses the one column matrix specified for ZData to produce two lines, each having four points.

If all the data has the same number of columns and one row each, MATLAB transposes the matrices to produce data for plotting. For example,

is changed to:

This also applies to the case when just one or two matrices have one row. For example, the statement,

is equivalent to:

Object Hierarchy

Setting Default Properties

You can set default Line properties on the Axes, Figure, and Root levels:

Where PropertyName is the name of the Line property and PropertyValue is the value you are specifying. Use set and get to access Line properties.

The following table lists all Line properties and provides a brief description of each. The property name links take you to an expanded description of the properties.

Property Name
Property Description
Property Value
Data Defining the Object
XData
The x-coordinates defining the Line
Values: vector or matrix
Default: [0 1]
YData
The y-coordinates defining the Line
Values: vector or matrix
Default: [0 1]
ZData
The z-coordinates defining the Line
Values: vector or matrix
Default: [] empty matrix
Defining Line Styles and Markers
LineStyle
Select from five line styles.
Values: -, --, :, -., none
Default: -
LineWidth
The width of the Line in points
Values: scalar
Default: 0.5 points
Marker
Marker symbol to plot at data points
Values: see Marker property
Default: none
MarkerEdgeColor
Color of marker or the edge color for filled markers
Values: ColorSpec, none, auto
Default: auto
MarkerFaceColor
Fill color for markers that are closed shapes
Values: ColorSpec, none, auto
Default: none
MarkerSize
Size of marker in points
Values: size in points
Default: 6
Controlling the Appearance
Clipping
Clipping to Axes rectangle
Values: on, off
Default: on
EraseMode
Method of drawing and erasing the Line (useful for animation)
Values: normal, none, xor, background
Default: normal
SelectionHighlight
Highlight Line when selected (Selected property set to on)
Values: on, off
Default: on
Visible
Make the Line visible or invisible
Values: on, off
Default: on
Color
Color of the Line
ColorSpec
Data Defining the Object
XData
The x-coordinates defining the Line
Values: vector or matrix
Default: [0 1]
YData
The y-coordinates defining the Line
Values: vector or matrix
Default: [0 1]
ZData
The z-coordinates defining the Line
Values: vector or matrix
Default: [] empty matrix
Controlling Access to Objects
HandleVisibility
Determines if and when the the Line's handle is visible to other functions
Values: on, callback, off
Default: on
HitTest
Determines if the Line can become the current object (see the Figure CurrentObject property)
Values: on, off
Default: on
General Information About the Line
Children
Line objects have no children
Values: [] (empty matrix)
Parent
The parent of a Line object is always an Axes object
Value: Axes handle
Selected
Indicate whether the Line is in a "selected" state.
Values: on, off
Default: on
Tag
User-specified label
Value: any string
Default: '' (empty string)
Type
The type of graphics object (read only)
Value: the string 'line'
UserData
User-specified data
Values: any matrix
Default: [] (empty matrix)
Properties Related to Callback Routine Execution
BusyAction
Specify how to handle callback routine interruption
Values: cancel, queue Default: queue
ButtonDownFcn
Define a callback routine that executes when a mouse button is pressed on over the Line
Values: string
Default: '' (empty string)
CreateFcn
Define a callback routine that executes when an Line is created
Values: string
Default: '' (empty string)
DeleteFcn
Define a callback routine that executes when the Line is deleted (via close or delete)
Values: string
Default: '' (empty string)
Interruptible
Determine if callback routine can be interrupted
Values: on, off
Default: on (can be interrupted)
UIContextMenu
Associate a context menu with the Line
Values: handle of a Uicontrextmenu



[ Previous | Help Desk | Next ]