Bar Series Properties

Control bar series appearance and behavior

Bar series properties control the appearance and behavior of a bar series object. By changing property values, you can modify certain aspects of the bar series.

Starting in R2014b, you can use dot notation to refer to a particular object and property:

h = bar(1:10);
w = h.BarWidth;
h.BarWidth = 1;

If you are using an earlier release, use the get and set functions to query and set properties.

Bars

expand all

BarWidthRelative width of individual bars0.8 (default) | scalar in range [0,1]

Relative width of individual bars, specified as a scalar value in the range [0,1]. Use this property to control the separation of bars within a group. The default value is 0.8, which means that MATLAB® separates the bars slightly. If you set this property to 1, then adjacent bars touch.

Example: 0.5

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

EdgeColorBar outline color[0 0 0] (default) | 'flat' | 'none' | RGB triplet | color string

Bar outline color, specified as one of these values:

  • 'flat' — Colors based on axes colormap. To change the colormap, use the colormap function.

  • 'none' — No color, which makes the outlines invisible.

  • RGB triplet or color string — Specify a custom color. The default RGB triplet value of [0 0 0] corresponds to black.

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 RGB triplet values that have equivalent color strings.

Long NameShort NameRGB Triplet
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

Example: 'blue'

Example: [0 0 1]

FaceColorBar fill color'flat' (default) | 'none' | RGB triplet | color string

Bar fill color, specified as one of these values:

  • 'flat' — Colors based on the axes colormap.

  • 'none' — No color, which makes the fill invisible.

  • RGB triplet or color string — Specify a custom 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 RGB triplet values that have equivalent color strings.

Long NameShort NameRGB Triplet
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

LineStyleLine style'-' (default) | '--' | ':' | '-.' | 'none'

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

StringLine StyleResulting Line
'-'Solid line

'--'Dashed line

':'Dotted line

'-.'Dash-dotted line

'none'No lineNo line

LineWidthWidth of bar outlines0.5 (default) | positive value

Width of bar outlines, specified as a positive value in point units. One point equals 1/72 inch.

Example: 1.5

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Bar Graph Type

expand all

BarLayoutArrangement of bars'grouped' (default) | 'stacked'

Arrangement of bars, specified as one of these values:

  • 'grouped' — Group bars by rows in Y, where Y is the input argument to the bar or barh function that created the bar chart.

  • 'stacked' — Display one bar for each row in Y. The bar height is the sum of the elements in the row. Each bar is multicolored. Colors correspond to distinct elements and show the relative contribution each row element makes to the total sum.

HorizontalHorizontal bar chart'off' (default) | 'on'

Horizontal bar chart, specified as one of these values:

  • 'on' — Display bars horizontally. If you create a graph with barh, then the Horizontal property is set to 'on'.

  • 'off' — Display bars vertically. If you create the chart with bar, then the Horizontal property is set to 'off'.

Baseline

expand all

BaseLineBaselinebaseline object

This property is read only.

Baseline object. For a list of baseline properties, see Baseline Properties.

BaseValueBaseline location0 (default) | numeric scalar value

Baseline location, specified as a numeric scalar value.

ShowBaseLineBaseline visibility'on' (default) | 'off'

Baseline visibility, specified as one of these values:

  • 'on' — Show the baseline.

  • 'off' — Hide the baseline.

Data

expand all

XDataBar locationsvector of real values

Bar locations, specified as a vector. For vertical bar charts, the values in XData are the bar locations along the x-axis. For horizontal bar charts, the values are the bar locations along the y-axis. You cannot specify the same value twice.

The input argument X to the bar and barh functions determines the bar locations. If you do not specify X, then the indices of the values in YData determine the bar locations. XData and YData must have equal lengths.

Setting this property sets the associated mode property to manual.

Example: 1:10

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

YDataBar lengthsvector

Bar lengths, specified as a vector. The input argument Y to the bar and barh functions determines the bar lengths.

XData and YData must have equal lengths.

Example: 1:10

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

XDataSourceVariable linked to XData'' (default) | string containing MATLAB workspace variable name

Variable linked to XData, specified as a string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the XData.

By default, there is no linked variable so the value is an empty string, ''. If you link a variable, then MATLAB does not update the XData values immediately. To force an update of the data values, use the refreshdata function.

    Note:   If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values.

Example: 'x'

YDataSourceVariable linked to YData'' (default) | string containing MATLAB workspace variable name

Variable linked to YData, specified as a string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the YData.

By default, there is no linked variable so the value is an empty string, ''. If you link a variable, then MATLAB does not update the YData values immediately. To force an update of the data values, use the refreshdata function.

    Note:   If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values.

Example: 'y'

XDataModeSelection mode for XData'auto' (default) | 'manual'

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

  • 'auto' — Use the indices of the values in YData (or ZData for 3-D plots).

  • 'manual' — Use manually specified values. To specify the values, set the XData property or specify the input argument X to the plotting function.

Visibility

expand all

VisibleVisibility of bar series'on' (default) | 'off'

Visibility of bar series, specified as one of these values:

  • 'on' — Display the bar series.

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

ClippingClipping of bar series to axes limits'on' (default) | 'off'

Clipping of bar series to the axes limits, specified as one of these values:

  • 'on' — Do not display parts of the bar series that are outside the axes limits.

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

EraseMode(removed) Technique to draw and erase objects'normal' (default) | 'none' | 'xor' | 'background'

    Note:   EraseMode has been removed. You can delete code that accesses the EraseMode property with minimal impact. If you were using EraseMode to create line animations, use the animatedline function instead.

Technique to draw and erase objects, specified as one of these values:

  • 'normal' — Redraw the affected region of the display, performing the three-dimensional analysis necessary to correctly render all objects. This mode produces the most accurate picture, but is the slowest. The other modes are faster, but do not perform a complete redraw and, therefore, are less accurate.

  • 'none' — Do not erase the object when it is moved or destroyed. After you erase the object with EraseMode,'none', it is still visible on the screen. However, you cannot print the object because MATLAB does not store any information on its former location.

  • 'xor' — Draw and erase the object by performing an exclusive OR (XOR) with the color of the screen beneath it. This mode does not damage the color of the objects beneath it. However, the object color depends on the color of whatever is beneath it on the display.

  • 'background' — Erase the object by redrawing it in the axes background color, or the figure background color if the axes Color property is 'none'. This damages objects that are behind the erased object, but properly colors the erased object.

MATLAB always prints figures as if the EraseMode property of all objects is set to 'normal'. This means graphics objects created with EraseMode set to 'none', 'xor', or 'background' can look different on screen than on paper. On screen, MATLAB mathematically combines layers of colors and ignores three-dimensional sorting to obtain greater rendering speed. However, MATLAB does not apply these techniques to the printed output. Use the getframe command or other screen capture applications to create an image of a figure containing nonnormal mode objects.

Identifiers

expand all

TypeType of graphics object'bar' (default)

This property is read only.

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

TagTag to associate with bar series'' (default) | string

Tag to associate with the bar series, specified as a string. 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 Types: char

UserDataData to associate with bar series[] (default) | scalar, vector, or matrix | cell array | character array | table | structure

Data to associate with the bar series object, specified as 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

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | struct | table | cell

DisplayNameText used by legend'' (default) | string

Text used by the legend, specified as a string. The text appears next to an icon of the bar series.

  • If you specify text for the bar series object as an input argument to the legend function, then the legend uses the specified text and updates the DisplayName.

  • If you do not specify text for the bar series object as an input argument to the legend function, then the legend uses the text in the DisplayName property. If the DisplayName property does not contain any text, then the legend generates a string. The string has the form 'dataN', where N is the number assigned to the bar series object based on its location in the list of legend entries.

If you edit interactively the string in an existing legend, then MATLAB updates the DisplayName to the edited string.

Example: 'Text Description'

AnnotationLegend icon display styleAnnotation object

This property is read only.

Legend icon display style, returned as an Annotation object. Use this object to include or exclude the bar series from a legend.

  1. Query the Annotation property to get the Annotation object.

  2. Query the LegendInformation property of the Annotation object to get the LegendEntry object.

  3. Specify the IconDisplayStyle property of the LegendEntry object to one of these values:

    • 'on' — Include the bar series object in the legend as one entry (default).

    • 'off' — Do not include the bar series object in the legend.

    • 'children' — Include only children of the bar series object as separate entries in the legend.

If a legend already exists and you change the IconDisplayStyle setting, then you must call legend to update the display.

Parent/Child

expand all

ParentParent of bar seriesaxes object | group object | transform object

Parent of bar series, specified as an axes, group, or transform object.

ChildrenChildren of bar seriesempty GraphicsPlaceholder array

The bar series has no children. You cannot set this property.

HandleVisibilityVisibility of object handle'on' (default) | 'off' | 'callback'

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

  • 'on' — List the bar series object.

  • 'off' — Do not list the bar series object. Use this option to hide object handles when a callback invokes a function that could damage the GUI, such as evaluating a user-typed string.

  • 'callback' — List the bar series object in the Children property of the parent from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. Use this option to protect a GUI from command-line users, while allowing callbacks to have access to objects.

If the bar series 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.

Interactive Control

expand all

ButtonDownFcnMouse-click callback'' (default) | function handle | cell array | string

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

  • Function handle

  • Cell array containing a function handle and additional arguments

  • String 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 bar series. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

  • The bar series object — You can access properties of the bar series 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}

UIContextMenuContext menuuicontextmenu object

Context menu, specified as a uicontextmenu object. Use this property to display a context menu when you right-click the bar series. 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.

SelectedSelection state'off' (default) | 'on'

Selection state, specified as one of these values:

  • 'on' — Selected. If you click the bar series 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 bar series.

  • 'off' — Not selected.

SelectionHighlightDisplay of selection handles when selected'on' (default) | 'off'

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'.

Callback Execution Control

expand all

PickablePartsAbility to capture mouse clicks'visible' (default) | 'none'

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 bar series that has a defined color. You cannot click a part that has an associated color property set to 'none'. The HitTest property determines if the bar series responds to the click or if an ancestor does.

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

HitTestResponse to captured mouse clicks'on' (default) | 'off'

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

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

  • 'off' — Trigger the callbacks for the nearest ancestor of the bar series 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 bar series object can capture mouse clicks. If it cannot, then the HitTest property has no effect.

HitTestArea(removed) Extents of clickable area for bar series'off' (default) | 'on'

    Note:   HitTestArea has been removed. Use PickableParts instead.

Extents of clickable area for bar series, specified as one of these values:

  • 'off' — Click the bar series plot to select it. This is the default value.

  • 'on' — Click anywhere within the extent of the bar series plot to select it, that is, anywhere within the rectangle that encloses the bar series plot.

Example: 'off'

InterruptibleCallback interruption'on' (default) | 'off'

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 bar series 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.

BusyActionCallback queuing'queue' (default) | 'cancel'

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 bar series 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 and Deletion Control

expand all

CreateFcnCreation callback'' (default) | function handle | cell array | string

Creation callback, specified as one of these values:

  • Function handle

  • Cell array containing a function handle and additional arguments

  • String 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 bar series. Setting the CreateFcn property on an existing bar series has no effect. You must define a default value for this property, or define this property using a Name,Value pair during bar series creation. MATLAB executes the callback after creating the bar series 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 bar series object — You can access properties of the bar series object from within the callback function. You also can access the bar series 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}

DeleteFcnDeletion callback'' (default) | function handle | cell array | string

Deletion callback, specified as one of these values:

  • Function handle

  • Cell array containing a function handle and additional arguments

  • String 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 bar series. MATLAB executes the callback before destroying the bar series 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 bar series object — You can access properties of the bar series object from within the callback function. You also can access the bar series 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}

BeingDeletedDeletion status of bar series'off' (default) | 'on'

This property is read only.

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

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

Was this topic helpful?