binscatter properties
binscatter graphics object properties.
📄Description

This page documents the visible properties returned by properties for a binscatter graphics object.

Property Action Type and supported values
Annotation updates the annotation metadata used by interactive tools and object inspection. Type: graphics annotation object or empty handle value. Supported values: an annotation object associated with the graphics item, or an empty graphics handle when no annotation is attached.
BeingDeleted Nelson computes this value; graphics operations update it. Type: text scalar or character row vector. Supported values: 'off', 'on'.
BusyAction controls whether an interrupting callback is queued or canceled. Type: text scalar or character row vector. Supported values: 'queue', 'cancel'.
ButtonDownFcn runs when the object receives a mouse-button event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
Children parenting operations update the vector. Type: graphics object handle vector. Supported values: empty vector or child handles.
ContextMenu attaches the menu used for context-click actions. Type: graphics object handle scalar. Supported values: [] or a uicontextmenu handle.
CreateFcn runs when the object is created. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
DataTipTemplate updates the content used for interactive data tips. Type: data tip template object or empty handle value. Supported values: a data tip template object owned by the graphics item, or an empty graphics handle when data tips are not configured.
DeleteFcn runs when the object is deleted. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
DisplayName updates the label used by legend entries and object identification. Type: text value. Supported values: character row vector or string scalar.
FaceAlpha updates rendered output on the next graphics refresh. Type: numeric scalar or numeric array. Supported values: values in [0,1]; data arrays must match the related rendered data.
HandleVisibility controls whether handle-search functions can find the object. Type: text scalar or character row vector. Supported values: 'on', 'off', 'callback'.
HitTest includes or excludes the object from mouse hit testing. Type: text scalar or character row vector. Supported values: 'on', 'off'.
Interruptible controls whether a running callback can be interrupted. Type: text scalar or character row vector. Supported values: 'on', 'off'.
NumBins updates the stored object state. Type: integer scalar or numeric vector. Supported values: finite integer value, finite numeric value, or vector required by the property.
NumBinsMode 'auto' lets Nelson recompute the paired property; 'manual' preserves the assigned value. Type: text scalar or character row vector. Supported values: 'auto', 'manual'.
Parent reparents the object and updates Children on the old and new parents. Type: graphics object handle scalar. Supported values: a valid parent handle for the object class.
PickableParts selects which visible or invisible parts can receive mouse hits. Type: text scalar or character row vector. Supported values: 'visible', 'all', 'none'.
Selected updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'on', 'off'.
SelectionHighlight updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'on', 'off'.
ShowEmptyBins updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
Tag updates the stored object state. Type: text scalar or character row vector. Supported values: empty text or an object identifier.
Type Nelson computes this value; graphics operations update it. Type: text scalar or character row vector. Supported values: read-only object type name, for example 'figure', 'axes', 'line', or 'scatter'.
UserData updates the stored object state. Type: Nelson array. Supported values: any Nelson value, including [], numeric arrays, text, cells, structures, or handles.
Values replaces data and recomputes automatic limits that depend on it. Type: numeric, logical, categorical, string, vector, matrix, or table-derived data. Supported values: [] or data with dimensions compatible with the rendered object.
Visible updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'on', 'off'.
XBinEdges recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: [] or a finite numeric vector, normally increasing.
XData replaces data and recomputes automatic limits that depend on it. Type: numeric, logical, categorical, string, vector, matrix, or table-derived data. Supported values: [] or data with dimensions compatible with the rendered object.
XLimits recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: two finite increasing values [min max].
XLimitsMode 'auto' lets Nelson recompute the paired property; 'manual' preserves the assigned value. Type: text scalar or character row vector. Supported values: 'auto', 'manual'.
YBinEdges recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: [] or a finite numeric vector, normally increasing.
YData replaces data and recomputes automatic limits that depend on it. Type: numeric, logical, categorical, string, vector, matrix, or table-derived data. Supported values: [] or data with dimensions compatible with the rendered object.
YLimits recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: two finite increasing values [min max].
YLimitsMode 'auto' lets Nelson recompute the paired property; 'manual' preserves the assigned value. Type: text scalar or character row vector. Supported values: 'auto', 'manual'.
💡Examples
Create the graphics object and list its properties.
f = figure('Visible', 'off');
ax = axes('Parent', f);
h = binscatter(ax, [1 1 2 3], [1 2 2 3]);
names = properties(h);
close(f)
🔗See Also
binscatterpropertiesgetset
🕔Version History
Version Description
-- Property page added.
Edit this page on GitHub