Line Properties
Line
properties control the appearance and behavior of a
Line
object. By changing property values, you can modify certain aspects of
the line. Use dot notation to query and set properties.
shape = geolineshape(1:10,1:10); p = geoplot(shape); c = p.Color; p.Color = "r";
Line
Color
— Line color
[0 0 0]
(default) | 'flat'
| RGB triplet | hexadecimal color code | 'r'
| 'g'
| 'b'
| ...
Line color, specified as 'flat'
, an RGB triplet, a hexadecimal
color code, a color name, or a short name. The 'flat'
option uses
colors from the ColorData
property. When the
geoplot
function sets the ColorData
property, MATLAB® updates this property to 'flat'
.
For a custom color, specify an RGB triplet or a hexadecimal color code.
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]
.A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (
#
) followed by three or six hexadecimal digits, which can range from0
toF
. The values are not case sensitive. Therefore, the color codes"#FF8800"
,"#ff8800"
,"#F80"
, and"#f80"
are equivalent.
Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.
Color Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" | |
"green" | "g" | [0 1 0] | "#00FF00" | |
"blue" | "b" | [0 0 1] | "#0000FF" | |
"cyan"
| "c" | [0 1 1] | "#00FFFF" | |
"magenta" | "m" | [1 0 1] | "#FF00FF" | |
"yellow" | "y" | [1 1 0] | "#FFFF00" | |
"black" | "k" | [0 0 0] | "#000000" | |
"white" | "w" | [1 1 1] | "#FFFFFF" | |
"none" | Not applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[0 0.4470 0.7410] | "#0072BD" | |
[0.8500 0.3250 0.0980] | "#D95319" | |
[0.9290 0.6940 0.1250] | "#EDB120" | |
[0.4940 0.1840 0.5560] | "#7E2F8E" | |
[0.4660 0.6740 0.1880] | "#77AC30" | |
[0.3010 0.7450 0.9330] | "#4DBEEE" | |
[0.6350 0.0780 0.1840] | "#A2142F" |
Example: [0.5 0.5 0.5]
Example: 'blue'
Example: '#D2F9A7'
LineStyle
— Line style
"-"
(default) | "--"
| ":"
| "-."
| "none"
Line style, specified as one of the options listed in this table.
Line Style | Description | Resulting Line |
---|---|---|
"-" | Solid line |
|
"--" | Dashed line |
|
":" | Dotted line |
|
"-." | Dash-dotted line |
|
"none" | No line | No line |
LineWidth
— Line width
0.5
(default) | positive value
Line width, specified as a positive value in points, where 1 point = 1/72 of an inch.
The line width cannot be thinner than the width of a pixel. If you set the line width to a value that is less than the width of a pixel on your system, the line displays as one pixel wide.
Color Data
ColorData
— Line colors
[]
(default) | numeric vector
Line colors, specified as a numeric vector that linearly maps to the colors in the
current colormap. The plot uses a different color for each element of
ShapeData
. Specify ColorData
as a vector the
same length as ShapeData
.
The ColorData
property controls the colors of the lines when
the Color
property has a value of 'flat'
.
ColorDataMode
— Control how ColorData
is set
'auto'
(default) | 'manual'
Control how the ColorData
property is set, specified as one of these values:
'auto'
— MATLAB controls the value of theColorData
property.'manual'
— You manually control the value of theColorData
property. When you set theColorData
property, MATLAB sets this property to'manual'
.
To specify colors using the ColorVariable
property, this
property must have a value of 'auto'
.
SeriesIndex
— Series index
positive whole number | "none"
Series index, specified as a positive whole number or "none"
.
This property is useful for reassigning the colors of several
Line
objects so that they match each other. By default, the
SeriesIndex
property of a Line
object is
a number that corresponds to the order of creation of the object, starting at
1
.
MATLAB uses the number to calculate indices for assigning colors when you call
plotting functions. The indices refer to the rows of the array stored in the
ColorOrder
property of the axes. Any objects in the axes that
have the same SeriesIndex
number have the same color.
A SeriesIndex
value of
"none"
corresponds to a neutral color that does not participate
in the indexing scheme. (since R2023b)
The following conditions must be true for a change to have an effect:
The
ColorDataMode
property on theLine
object is has a value of'auto'
.The
Color
property on theLine
object has a value of'flat'
.The
SeriesIndex
property on theLine
object is greater than0
.The
NextSeriesIndex
property on the axes object is greater than0
.
Shape Data
ShapeData
— Line shapes
empty geolineshape
object (default) |
geolineshape
or maplineshape
object | vector of geolineshape
or maplineshape
objects
Line shapes, specified as a geolineshape
or
maplineshape
object or as a vector of geolineshape
or maplineshape
objects. For maplineshape
objects, the
value of the ProjectedCRS
property must not be empty.
When you pass shape objects or a geospatial table to the
geoplot
function, the geoplot
function sets
the value of ShapeData
.
ShapeDataMode
— Control how ShapeData
is set
'auto'
(default) | 'manual'
Control how the ShapeData
property is set, specified as one of these values:
'auto'
— MATLAB automatically updates theShapeData
property based on theSourceTable
andShapeVariable
properties. When you pass a geospatial table to thegeoplot
function, MATLAB sets this property to'auto'
.'manual'
— You manually control the value of theShapeData
property. When you set theShapeData
property or pass shape objects to thegeoplot
function, MATLAB sets this property to'manual'
.
Table Data
SourceTable
— Source table
geospatial table
Source table containing the data to plot, specified as a geospatial table. A geospatial table
is a table
or timetable
object that contains a
Shape
variable and attribute variables. For more information
about geospatial tables, see Create Geospatial Tables.
ShapeVariable
— Table variable containing shape objects
table variable index
Table variable containing the shape objects, specified as a table variable index.
The table variable must contain geolineshape
or
maplineshape
objects. For maplineshape
objects, the
value of the ProjectedCRS
property must not be empty.
When you pass a geospatial table to the geoplot
function, the
value of this property is 'Shape'
. When you set this property,
MATLAB updates the ShapeData
property.
This table lists the different indexing schemes you can use to specify the table variable.
Indexing Scheme | Examples |
---|---|
Variable name:
|
|
Variable index:
|
|
Variable type: A |
|
ColorVariable
— Table variable containing color data
table variable index
Table variable containing the color data, specified as a variable index into the source table.
Specifying the Table Index
Use any of these indexing schemes to specify the desired variable.
Indexing Scheme | Examples |
---|---|
Variable name:
|
|
Variable index:
|
|
Variable type: A |
|
Specifying Color Data
The ColorVariable
property controls the colors of the lines
when the Color
property has a value of
'flat'
.
Specify the color data values as a numeric vector that linearly maps to the colors
in the current colormap. The plot uses a different color for each element of
ShapeData
.
When you set the ColorVariable
property, MATLAB updates the ColorData
property.
Legend
DisplayName
— Legend label
''
(default) | character vector | string scalar
Legend label, specified as a character vector or string scalar. The legend does not
display until you call the legend
command. If you do not specify
the text, then legend
sets the label using the form
'dataN'
.
Annotation
— Control for including or excluding object from legend
Annotation
object
This property is read-only.
Control for including or excluding the object from a legend, returned as an
Annotation
object. Set the underlying
IconDisplayStyle
property to one of these values:
'on'
— Include the object in the legend (default).'off'
— Do not include the object in the legend.
For example, to exclude a graphics object, go
, from the legend set
the IconDisplayStyle
property to
'off'
.
go.Annotation.LegendInformation.IconDisplayStyle = 'off';
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. If you do not specify an existing graphics object in the
first input argument, then it does not appear in the legend. However, graphics objects
added to the axes after the legend is created do appear in the legend. Consider creating
the legend after creating all the plots to avoid extra items.
Interactivity
Visible
— State of visibility
'on'
(default) | on/off logical value
State of visibility, specified as 'on'
or 'off'
,
or as numeric or logical 1
(true
) or
0
(false
). A value of 'on'
is equivalent to true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a logical
value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Display the object.'off'
— Hide the object without deleting it. You still can access the properties of an invisible object.
ContextMenu
— Context menu
empty GraphicsPlaceholder
array (default) | ContextMenu
object
Context menu, specified as a ContextMenu
object. Use this property
to display a context menu when you right-click the object. 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.
Selected
— Selection state
'off'
(default) | on/off logical value
Selection state, specified as 'on'
or 'off'
, or
as numeric or logical 1
(true
) or
0
(false
). A value of 'on'
is equivalent to true, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a logical
value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Selected. If you click the object when in plot edit mode, then MATLAB sets itsSelected
property to'on'
. If theSelectionHighlight
property also is set to'on'
, then MATLAB displays selection handles around the object.'off'
— Not selected.
SelectionHighlight
— Display of selection handles
'on'
(default) | on/off logical value
Display of selection handles when selected, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true, and 'off'
is
equivalent to false
. Thus, you can use the value of this property as
a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Display selection handles when theSelected
property is set to'on'
.'off'
— Never display selection handles, even when theSelected
property is set to'on'
.
Callbacks
ButtonDownFcn
— Mouse-click callback
''
(default) | function handle | cell array | character vector
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 object. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:
Clicked object — Access properties of the clicked object from within the callback function.
Event data — Empty argument. 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 Create Callbacks for Graphics Objects.
Note
If the PickableParts
property is set to
'none'
or if the HitTest
property is set
to 'off'
, then this callback does not execute.
CreateFcn
— Creation function
''
(default) | function handle | cell array | character vector
Object creation function, specified as one of these values:
Function handle.
Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.
For more information about specifying a callback as a function handle, cell array, or character vector, see Create Callbacks for Graphics Objects.
This property specifies a callback function to execute when MATLAB creates the object. MATLAB initializes all property values before executing the CreateFcn
callback. If you do not specify the CreateFcn
property, then MATLAB executes a default creation function.
Setting the CreateFcn
property on an existing component has no effect.
If you specify this property as a function handle or cell array, you can access the object that is being created using the first argument of the callback function. Otherwise, use the gcbo
function to access the object.
DeleteFcn
— Deletion function
''
(default) | function handle | cell array | character vector
Object deletion function, specified as one of these values:
Function handle.
Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.
For more information about specifying a callback as a function handle, cell array, or character vector, see Create Callbacks for Graphics Objects.
This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes the DeleteFcn
callback before destroying the
properties of the object. If you do not specify the DeleteFcn
property, then MATLAB executes a default deletion function.
If you specify this property as a function handle or cell array, you can access the object that is being deleted using the first argument of the callback function. Otherwise, use the gcbo
function to access the object.
Callback Execution Control
Interruptible
— Callback interruption
'on'
(default) | on/off logical value
Callback interruption, specified as 'on'
or 'off'
, or as
numeric or logical 1
(true
) or
0
(false
). A value of 'on'
is equivalent to true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a logical
value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
This property determines if a running callback can be interrupted. 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.
MATLAB determines callback interruption behavior whenever it executes a command that
processes the callback queue. These commands include drawnow
, figure
, uifigure
, getframe
, waitfor
, and pause
.
If the running callback does not contain one of these commands, then no interruption occurs. MATLAB first finishes executing the running callback, and later executes the interrupting callback.
If the running callback does contain one of these commands, then the
Interruptible
property of the object that owns the running
callback determines if the interruption occurs:
If the value of
Interruptible
is'off'
, then no interruption occurs. Instead, theBusyAction
property of the object that owns the interrupting callback determines if the interrupting callback is discarded or added to the callback queue.If the value of
Interruptible
is'on'
, then the interruption occurs. The next time MATLAB processes the callback queue, it stops the execution of the running callback and executes the interrupting callback. After the interrupting callback completes, MATLAB then resumes executing the running callback.
Note
Callback interruption and execution behave differently in these situations:
If the interrupting callback is a
DeleteFcn
,CloseRequestFcn
, orSizeChangedFcn
callback, then the interruption occurs regardless of theInterruptible
property value.If the running callback is currently executing the
waitfor
function, then the interruption occurs regardless of theInterruptible
property value.If the interrupting callback is owned by a
Timer
object, then the callback executes according to schedule regardless of theInterruptible
property value.
BusyAction
— Callback queuing
'queue'
(default) | 'cancel'
Callback queuing, specified as 'queue'
or 'cancel'
. The BusyAction
property determines how MATLAB handles the execution of interrupting callbacks. 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.
The BusyAction
property determines callback queuing behavior only
when both of these conditions are met:
Under these conditions, the BusyAction
property of the
object that owns the interrupting callback determines how MATLAB handles the interrupting callback. These are possible values of the
BusyAction
property:
'queue'
— Puts the interrupting callback in a queue to be processed after the running callback finishes execution.'cancel'
— Does not execute the interrupting callback.
PickableParts
— Ability to capture mouse clicks
'visible'
(default) | 'none'
Ability to capture mouse clicks, specified as one of these values:
'visible'
— Capture mouse clicks only when visible. TheVisible
property must be set to'on'
. TheHitTest
property determines if theLine
object responds to the click or if an ancestor does.'none'
— Cannot capture mouse clicks. Clicking theLine
object passes the click to the object behind it in the current view of the figure window. TheHitTest
property of theLine
object has no effect.
HitTest
— Response to captured mouse clicks
'on'
(default) | on/off logical value
Response to captured mouse clicks, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true, and 'off'
is
equivalent to false
. Thus, you can use the value of this property as
a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Trigger theButtonDownFcn
callback of theLine
object. If you have defined theContextMenu
property, then invoke the context menu.'off'
— Trigger the callbacks for the nearest ancestor of theLine
object that has one of these:HitTest
property set to'on'
PickableParts
property set to a value that enables the ancestor to capture mouse clicks
Note
The PickableParts
property determines if the Line
object can capture mouse
clicks. If it cannot, then the HitTest
property has no
effect.
BeingDeleted
— Deletion status
on/off logical value
This property is read-only.
Deletion status, returned as an on/off logical value of type matlab.lang.OnOffSwitchState
.
MATLAB sets the BeingDeleted
property to
'on'
when the DeleteFcn
callback begins
execution. The BeingDeleted
property remains set to
'on'
until the component object no longer exists.
Check the value of the BeingDeleted
property to verify that the object is not about to be deleted before querying or modifying it.
Parent/Child
Parent
— Parent
GeographicAxes
object | MapAxes
object
Parent, specified as a GeographicAxes
object or MapAxes
object.
Children
— Children
empty GraphicsPlaceholder
array
The object has no children. You cannot set this property.
HandleVisibility
— Visibility of object handle
'on'
(default) | 'off'
| 'callback'
Visibility of the object handle in the Children
property of the
parent, specified as one of these values:
'on'
— Object handle is always visible.'off'
— Object handle is invisible at all times. This option is useful for preventing unintended changes by another function. Set theHandleVisibility
to'off'
to temporarily hide the handle during the execution of that function.'callback'
— 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 object at the command line, but permits callback functions to access it.
If the 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. Examples of such
functions include the get
, findobj
, gca
, gcf
, gco
, newplot
, cla
, clf
, and close
functions.
Hidden object handles are still valid. Set the root
ShowHiddenHandles
property to 'on'
to list all object handles regardless of their
HandleVisibility
property setting.
Identifiers
Type
— Type of graphics object
'line'
This property is read-only.
Type of graphics object, returned as 'line'
. Use this property to
find all objects of a given type within a plotting hierarchy, for example, searching for
the type using findobj
.
Tag
— Object identifier
''
(default) | character vector | string scalar
Object identifier, specified as a character vector or string scalar. You can specify a unique Tag
value to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use the findobj
function to search for the object based on the Tag
value.
UserData
— User data
[]
(default) | array
User data, specified as any MATLAB array. For example, you can specify a scalar, vector, matrix, cell array, character array, table, or structure. Use this property to store arbitrary data on an object.
If you are working in App Designer, create public or private properties in the app to share data instead of using the UserData
property. For more information, see Share Data Within App Designer Apps.
Version History
Introduced in R2022a
See Also
Functions
Objects
Properties
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)