ArcObjects Library Reference  (Schematic)    

INgDiagram Interface

Provides access to members that control the graphic diagram.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.

Description

A diagram is a structure that is an implementation of a diagram type. A network, made up of nodes and links, is displayed in a diagram. One or more diagrams of a diagram type can exist in a project. Various schematic layout algorithms can represent the same network. Each schematic representation of a network is displayed in its own diagram. For instance, a network displayed as both an orthogonal schematic and a hierarchical schematic will be displayed in two different diagrams. A diagram cannot exist without a view, and it can create many views. All views of a diagram will display the same network in the same geographic or schematic position, with each view differing only in its zoom level or symbol size. An element selected in one view will be selected in all open views created from the same diagram.

Members

Description
Method CanRedoLastUndo Indicates if the last operation that impacted the diagram can be redone.
Method CanUndoLastOperation Indicates if the last operation that impacted the diagram can be undone.
Method Close Closes the diagram and all its views.
Method CreateDrawing Creates the drawing implemented by the 'eltType' type and named 'eltName' at the ('x','y') location in the diagram.
Method CreateLink Creates the link implemented by the 'eltType' element type and named 'eltName' between the 'fromNode' and 'toNode' nodes in the diagram.
Method CreateNode Creates the node implemented by the 'eltType' element type and named 'eltName' at the ('x','y') location in the diagram.
Method CreateNodeOnLink Creates the node-on-link implemented by the 'eltType' type and named 'eltName' at the 'Position' location on the 'refLink' link in the diagram.
Method CreateSubLink Creates the sub-link implemented by the 'eltType' element type and named 'eltName' on the 'refLink' link between the 'fromNode' and 'toNode' nodes in the diagram.
Method DeleteSavedLayout Removes the backup version of the diagram.
Read-only property DiagramType Diagram type that implements the diagram.
Read-only property Elements List of the elements contained in the diagram.
Method GetAttributeValue Returns the value of the attribute named 'attributeName' defined for the diagram.
Method GetDrawing Returns the drawing named 'drawingName' contained in the diagram.
Method GetElementsByElementType Returns the list of all elements implemented by the the 'eltType' element type that are contained in the diagram.
Method GetElementsByType Returns a list of all the elements belonging to the 'Type' type that are contained in the diagram.
Method GetElementsByUserData Returns all the elements contained in the diagram that are implemented by the 'eltType' element type and which each associated user-data in the 'userDatas' list verifies the 'values' list corresponding values.
Method GetLink Returns the link named 'linkName' contained in the diagram.
Method GetLinksBetweenNodes Returns a list of all the links that connect the two nodes 'n1' and 'n2' in the diagram.
Method GetNextRedoLabel Returns the label of the next operation in the redo stack.
Method GetNextUndoLabel Returns the label of the next operation in the undo stack.
Method GetNode Returns the node named 'nodeName' contained in the diagram.
Method IsLayoutSaved Indicates if there is a backup version for the diagram.
Method IsModified Indicates if the diagram has been modified regarding to its saving version.
Method MoveElements Moves the 'Elements' set of elements contained in the diagram to the (X,Y) relative position.
Read-only property Name Name of the diagram.
Method NewView Creates a new view associated with the active view comprising all the elements contained in the latter.
Method Open Opens the diagram.
Method OpenFromStream Loads the diagram from the specified stream.
Method RedoLastUndo Redoes the last undone operation in the diagram.
Method Redraw Redraws the elements contained in the diagram's view(s) according to the 'mode' redrawing option.
Method Refresh Updates all the views associated with the diagram, reflecting the modifications that may have occurred in the database.
Method RefreshLegend Updates the legend content for all the views associated with the diagram so it reflects the modifications that may have occurred in the database.
Method RestoreInitialPosition Restores the elements contained in the diagram to their initially defined positions.
Method Save Saves the diagram and records positions for all the elements contained in the different views of the diagram.
Read/write property SaveMode Saving option for the diagram.
Method SaveToStream Saves the diagram to the specified stream.
Method SetModified Forces the value returned by the 'IsModified' function.
Method StartOperation Starts a new operation that will impact the diagram.
Method StopOperation Stop the current started operation that impacted the diagram.
Method UndoLastOperation Undoes the last operation that impacted the diagram.
Read-only property Views List of the views associated with the diagram.

CoClasses that implement INgDiagram

CoClasses and Classes Description
NgDiagram Graphic diagram object.

See Also

INgDiagramType Interface | ISchematicDiagram Interface

 


Feedback Send feedback on this page