CLASS ndi.gui.docViewer
table2list
Superclasses
handle
Properties
| Property | Description |
|---|---|
| fullDocuments | |
| fullTable | |
| tempDocuments | |
| tempTable | |
| search | |
| table | |
| panel | |
| info | |
| docs | |
| fig |
Methods
| Method | Description |
|---|---|
| addDoc | Todo: needs documentation |
| addlistener | addlistener Add listener for event. |
| clearView | ndi.gui.docViewer/clearView is a function. |
| contentSearch | ndi.gui.docViewer/contentSearch is a function. |
| delete | DELETE Delete a handle object. |
| details | Display array details |
| docViewer | table2list |
| eq | == (EQ) Test handle equality. |
| filter | 1-D digital filter |
| filterHelper | ndi.gui.docViewer/filterHelper is a function. |
| findobj | FINDOBJ Find objects matching specified conditions. |
| findprop | findprop Find property of MATLAB handle object. |
| ge | >= (GE) Greater than or equal relation for handles. |
| graph | Graph with undirected edges |
| gt | > (GT) Greater than relation for handles. |
| isvalid | ISVALID Test handle validity. |
| le | <= (LE) Less than or equal relation for handles. |
| listener | listener Add listener for event without binding the listener to the source object. |
| lt | < (LT) Less than relation for handles. |
| ne | ~= (NE) Not equal relation for handles. |
| notify | NOTIFY Notify listeners of event. |
| restore | Todo: needs documentation; are we restoring the view or the underlying data? |
| searchFieldName | ndi.gui.docViewer/searchFieldName is a function. |
| searchID | ndi.gui.docViewer/searchID is a function. |
| subgraph | ndi.gui.docViewer/subgraph is a function. |
Methods help
addDoc - Todo: needs documentation
addlistener - addlistener Add listener for event.
el = addlistener(hSource, Eventname, callbackFcn) creates a listener
for the event named Eventname. The source of the event is the handle
object hSource. If hSource is an array of source handles, the listener
responds to the named event on any handle in the array. callbackFcn
is a function handle that is invoked when the event is triggered.
el = addlistener(hSource, PropName, Eventname, Callback) adds a
listener for a property event. Eventname must be one of
'PreGet', 'PostGet', 'PreSet', or 'PostSet'. Eventname can be
a string scalar or character vector. PropName must be a single
property name specified as string scalar or character vector, or a
collection of property names specified as a cell array of character
vectors or a string array, or as an array of one or more
matlab.metadata.Property objects. The properties must belong to the
class of hSource. If hSource is scalar, PropName can include dynamic
properties.
For all forms, addlistener returns an event.listener. To remove a
listener, delete the object returned by addlistener. For example,
delete(el) calls the handle class delete method to remove the listener
and delete it from the workspace.
addlistener binds the listener's lifecycle to the object that is the
source of the event. Unless you explicitly delete the listener, it is
destroyed only when the source object is destroyed. To control the
lifecycle of the listener independently from the event source object,
use listener or the event.listener constructor to create the listener.
See also listener, event.listener, ndi.gui.docviewer, matlab.metadata.Property, events
Help for ndi.gui.docViewer/addlistener is inherited from superclass handle
clearView - ndi.gui.docViewer/clearView is a function.
clearView(obj, ~, ~)
contentSearch - ndi.gui.docViewer/contentSearch is a function.
contentSearch(obj, fieldValue, data)
delete - DELETE Delete a handle object.
DELETE(H) deletes all handle objects in array H. After the delete
function call, H is an array of invalid objects.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/ISVALID, CLEAR
Help for ndi.gui.docViewer/delete is inherited from superclass handle
details - Display array details
This MATLAB function displays detailed information about the array, A.
Syntax
details(A)
Input Arguments
A - Input array
scalar or nonscalar array of any type
Examples
web /Applications/MATLAB_R2024b.app/help/matlab/ref/details.html#bt8wlxq-2
See also classdef, disp
Introduced in MATLAB in R2013b
Documentation for details
doc details
docViewer - table2list
Documentation for ndi.gui.docViewer/docViewer
doc ndi.gui.docViewer
eq - == (EQ) Test handle equality.
Handles are equal if they are handles for the same object.
H1 == H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise equality result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = EQ(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/GE, NDI.GUI.DOCVIEWER/GT, NDI.GUI.DOCVIEWER/LE, NDI.GUI.DOCVIEWER/LT, NDI.GUI.DOCVIEWER/NE
Help for ndi.gui.docViewer/eq is inherited from superclass handle
filter - 1-D digital filter
This MATLAB function filters the input data x using a rational transfer
function defined by the numerator and denominator coefficients b and a.
Syntax
y = filter(b,a,x)
y = filter(b,a,x,zi)
y = filter(b,a,x,zi,dim)
[y,zf] = filter(___)
Input Arguments
b - Numerator coefficients of rational transfer function
vector
a - Denominator coefficients of rational transfer function
vector
x - Input data
vector | matrix | multidimensional array
zi - Initial conditions for filter delays
[] (default) | vector | matrix | multidimensional array
dim - Dimension to operate along
positive integer scalar
Output Arguments
y - Filtered data
vector | matrix | multidimensional array
zf - Final conditions for filter delays
vector | matrix | multidimensional array
Examples
openExample('matlab/MovingAverageFilterOfVectorDataExample')
openExample('matlab/FilterMatrixRowsExample')
openExample('matlab/SpecifyInitialConditionsExample')
openExample('matlab/FilterDataInSectionsExample')
See also conv, filter2
Introduced in MATLAB before R2006a
Documentation for filter
doc filter
filterHelper - ndi.gui.docViewer/filterHelper is a function.
filterHelper(obj, search1, search2, searchStr)
findobj - FINDOBJ Find objects matching specified conditions.
The FINDOBJ method of the HANDLE class follows the same syntax as the
MATLAB FINDOBJ command, except that the first argument must be an array
of handles to objects.
HM = FINDOBJ(H, <conditions>) searches the handle object array H and
returns an array of handle objects matching the specified conditions.
Only the public members of the objects of H are considered when
evaluating the conditions.
See also FINDOBJ, NDI.GUI.DOCVIEWER
Help for ndi.gui.docViewer/findobj is inherited from superclass handle
findprop - findprop Find property of MATLAB handle object.
p = findprop(H,PropName) finds and returns the matlab.metadata.Property
object associated with property name PropName of scalar handle object H.
PropName can be a string scalar or character vector. It can be the
name of a property defined by the class of H or a dynamic property
added to scalar object H.
If no property named PropName exists for object H, an empty
matlab.metadata.Property array is returned.
See also ndi.gui.docviewer, ndi.gui.docviewer/findobj, dynamicprops, matlab.metadata.Property
Help for ndi.gui.docViewer/findprop is inherited from superclass handle
ge - >= (GE) Greater than or equal relation for handles.
H1 >= H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise >= result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = GE(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/EQ, NDI.GUI.DOCVIEWER/GT, NDI.GUI.DOCVIEWER/LE, NDI.GUI.DOCVIEWER/LT, NDI.GUI.DOCVIEWER/NE
Help for ndi.gui.docViewer/ge is inherited from superclass handle
graph - Graph with undirected edges
graph objects represent undirected graphs, which have direction-less
edges connecting the nodes.
Creation
Syntax
G = graph
G = graph(A)
G = graph(A,nodenames)
G = graph(A,NodeTable)
G = graph(A,___,type)
G = graph(A,___,'omitselfloops')
G = graph(s,t)
G = graph(s,t,weights)
G = graph(s,t,weights,nodenames)
G = graph(s,t,weights,NodeTable)
G = graph(s,t,weights,num)
G = graph(s,t,___,'omitselfloops')
G = graph(s,t,EdgeTable,___)
G = graph(EdgeTable)
G = graph(EdgeTable,NodeTable)
G = graph(EdgeTable,___,'omitselfloops')
Input Arguments
A - Adjacency matrix
matrix
nodenames - Node names
cell array of character vectors | string array
type - Type of adjacency matrix
'upper' | 'lower'
s,t - Node pairs (as separate arguments)
node indices | node names
weights - Edge weights
scalar | vector | matrix | multidimensional array | []
num - Number of graph nodes
positive scalar integer
EdgeTable - Table of edge information
table
NodeTable - Table of node information
table
Properties
Edges - Edges of graph
table
Nodes - Nodes of graph
table
Object Functions
layoutcoords - Graph node and edge layout coordinates
simplify - Reduce multigraph to simple graph
ismultigraph - Determine whether graph has multiple edges
edgecount - Number of edges between two nodes
isisomorphic - Determine whether two graphs are isomorphic
isomorphism - Compute isomorphism between two graphs
nearest - Nearest neighbors within radius
centrality - Measure node importance
minspantree - Minimum spanning tree of graph
maxflow - Maximum flow in graph
dfsearch - Depth-first graph search
bfsearch - Breadth-first graph search
bctree - Block-cut tree graph
biconncomp - Biconnected graph components
conncomp - Connected graph components
subgraph - Extract subgraph
reordernodes - Reorder graph nodes
shortestpathtree - Shortest path tree from node
shortestpath - Shortest path between two single nodes
distances - Shortest path distances of all node pairs
laplacian - Graph Laplacian matrix
incidence - Graph incidence matrix
adjacency - Graph adjacency matrix
rmedge - Remove edge from graph
addedge - Add new edge to graph
findedge - Locate edge in graph
numedges - Number of edges in graph
outedges - Outgoing edges from node
neighbors - Neighbors of graph node
degree - Degree of graph nodes
rmnode - Remove node from graph
addnode - Add new node to graph
findnode - Locate node in graph
numnodes - Number of nodes in graph
allcycles - Find all cycles in graph
allpaths - Find all paths between two graph nodes
cyclebasis - Fundamental cycle basis of graph
hascycles - Determine whether graph contains cycles
plot - Plot graph nodes and edges
Examples
openExample('matlab/CreateAndModifyGraphObjectExample')
openExample('matlab/AdjacencyMatrixGraphConstructionExample')
openExample('matlab/AdjacencyMatrixConstructionWithNodeNamesExample')
openExample('matlab/EdgeListGraphConstructionExample')
openExample('matlab/EdgeListGraphConstructionWithNodeNamesAndEdgeWeightsExample')
openExample('matlab/EdgeListConstructionWithExtraNodesExample')
openExample('matlab/AddNodesAndEdgesToEmptyGraphExample')
openExample('matlab/GraphConstructionWithTablesExample')
See also digraph, subgraph
Introduced in MATLAB in R2015b
Documentation for graph
doc graph
gt - > (GT) Greater than relation for handles.
H1 > H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise > result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = GT(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/EQ, NDI.GUI.DOCVIEWER/GE, NDI.GUI.DOCVIEWER/LE, NDI.GUI.DOCVIEWER/LT, NDI.GUI.DOCVIEWER/NE
Help for ndi.gui.docViewer/gt is inherited from superclass handle
isvalid - ISVALID Test handle validity.
TF = ISVALID(H) performs an element-wise check for validity on the
handle elements of H. The result is a logical array of the same
dimensions as H, where each element is the element-wise validity
result.
A handle is invalid if it has been deleted or if it is an element
of a handle array and has not yet been initialized.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/DELETE
Help for ndi.gui.docViewer/isvalid is inherited from superclass handle
le - <= (LE) Less than or equal relation for handles.
Handles are equal if they are handles for the same object. All
comparisons use a number associated with each handle object. Nothing
can be assumed about the result of a handle comparison except that the
repeated comparison of two handles in the same MATLAB session will
yield the same result. The order of handle values is purely arbitrary
and has no connection to the state of the handle objects being
compared.
H1 <= H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise >= result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = LE(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/EQ, NDI.GUI.DOCVIEWER/GE, NDI.GUI.DOCVIEWER/GT, NDI.GUI.DOCVIEWER/LT, NDI.GUI.DOCVIEWER/NE
Help for ndi.gui.docViewer/le is inherited from superclass handle
listener - listener Add listener for event without binding the listener to the source object.
el = listener(hSource, Eventname, callbackFcn) creates a listener
for the event named Eventname. The source of the event is the handle
object hSource. If hSource is an array of source handles, the listener
responds to the named event on any handle in the array. callbackFcn
is a function handle that is invoked when the event is triggered.
el = listener(hSource, PropName, Eventname, callback) adds a
listener for a property event. Eventname must be one of
'PreGet', 'PostGet', 'PreSet', or 'PostSet'. Eventname can be a
string sclar or character vector. PropName must be either a single
property name specified as a string scalar or character vector, or
a collection of property names specified as a cell array of character
vectors or a string array, or as an array of one ore more
matlab.metadata.Property objects. The properties must belong to the
class of hSource. If hSource is scalar, PropName can include dynamic
properties.
For all forms, listener returns an event.listener. To remove a
listener, delete the object returned by listener. For example,
delete(el) calls the handle class delete method to remove the listener
and delete it from the workspace. Calling delete(el) on the listener
object deletes the listener, which means the event no longer causes
the callback function to execute.
listener does not bind the listener's lifecycle to the object that is
the source of the event. Destroying the source object does not impact
the lifecycle of the listener object. A listener created with listener
must be destroyed independently of the source object. Calling
delete(el) explicitly destroys the listener. Redefining or clearing
the variable containing the listener can delete the listener if no
other references to it exist. To tie the lifecycle of the listener to
the lifecycle of the source object, use addlistener.
See also addlistener, event.listener, ndi.gui.docviewer, matlab.metadata.Property, events
Help for ndi.gui.docViewer/listener is inherited from superclass handle
lt - < (LT) Less than relation for handles.
H1 < H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise < result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = LT(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/EQ, NDI.GUI.DOCVIEWER/GE, NDI.GUI.DOCVIEWER/GT, NDI.GUI.DOCVIEWER/LE, NDI.GUI.DOCVIEWER/NE
Help for ndi.gui.docViewer/lt is inherited from superclass handle
ne - ~= (NE) Not equal relation for handles.
Handles are equal if they are handles for the same object and are
unequal otherwise.
H1 ~= H2 performs element-wise comparisons between handle arrays H1
and H2. H1 and H2 must be of the same dimensions unless one is a
scalar. The result is a logical array of the same dimensions, where
each element is an element-wise equality result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = NE(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/EQ, NDI.GUI.DOCVIEWER/GE, NDI.GUI.DOCVIEWER/GT, NDI.GUI.DOCVIEWER/LE, NDI.GUI.DOCVIEWER/LT
Help for ndi.gui.docViewer/ne is inherited from superclass handle
notify - NOTIFY Notify listeners of event.
NOTIFY(H, eventname) notifies listeners added to the event named
eventname for handle object array H that the event is taking place.
eventname can be a string scalar or character vector.
H is the array of handles to the event source objects, and 'eventname'
must be a character vector.
NOTIFY(H,eventname,ed) provides a way of encapsulating information
about an event which can then be accessed by each registered listener.
ed must belong to the EVENT.EVENTDATA class.
See also NDI.GUI.DOCVIEWER, NDI.GUI.DOCVIEWER/ADDLISTENER, NDI.GUI.DOCVIEWER/LISTENER, EVENT.EVENTDATA, EVENTS
Help for ndi.gui.docViewer/notify is inherited from superclass handle
restore - Todo: needs documentation; are we restoring the view or the underlying data?
searchFieldName - ndi.gui.docViewer/searchFieldName is a function.
searchFieldName(obj, ~, ~, fieldName)
searchID - ndi.gui.docViewer/searchID is a function.
searchID(obj, list_ID)
subgraph - ndi.gui.docViewer/subgraph is a function.
subgraph(obj, ~, ~, ind)