Interface CyNetworkView

    • Method Detail

      • getNodeView

        View<CyNode> getNodeView​(CyNode node)
        Returns a View for a specified Node.
        Parameters:
        node - Node object
        Returns:
        View for the given node object.
      • getNodeViews

        Collection<View<CyNode>> getNodeViews()
        Returns a list of Views for all CyNodes in the network.
        Returns:
        Collection of all node views in this network.
      • getNodeViewsIterable

        default Iterable<View<CyNode>> getNodeViewsIterable()
        Returns an Iterable for all node views in the network. This operation may have better performance than getNodeViews() but that is not guaranteed.
      • getEdgeView

        View<CyEdge> getEdgeView​(CyEdge edge)
        Returns a View for a specified Edge.
        Parameters:
        edge - the edge to return the view for.
        Returns:
        View model for the edge data.
      • getEdgeViews

        Collection<View<CyEdge>> getEdgeViews()
        Returns a list of Views for all CyEdges in the network.
        Returns:
        All edge views in this network.
      • getEdgeViewsIterable

        default Iterable<View<CyEdge>> getEdgeViewsIterable()
        Returns an Iterable for all edge views in the network. This operation may have better performance than getEdgeViews() but that is not guaranteed.
      • getAllViews

        Collection<View<? extends CyIdentifiable>> getAllViews()
        Returns a list of all View including those for Nodes, Edges, and Network.
        Returns:
        All view objects in this network including network view itself.
      • fitContent

        void fitContent()
        Utility method to fit content to the presentation container (usually a Swing Window). This fires event to the presentation layer for updating presentation.
      • fitSelected

        void fitSelected()
        Utility method to fit selected graph objects to the presentation container. This fires event to the presentation layer for updating presentation.
      • updateView

        void updateView()
        Cascading event for the presentation layer for updating presentation.
      • getRendererId

        String getRendererId()
        Returns the ID of the renderer that must be used to render this view.
        See Also:
        NetworkViewRenderer.getId(), org.cytoscape.application.CyApplicationManager#getNetworkViewRenderer(rendererId)
      • setViewDefault

        <T,​V extends T> void setViewDefault​(VisualProperty<? extends T> vp,
                                                  V defaultValue)
        Sets the default value to be used for the specified visual property.
        Type Parameters:
        T - The type of the visual property value.
        V - The default value for the visual property, which must extend T.
        Parameters:
        vp - The visual property whose default value we're specifying.
        defaultValue - The default value to be used for this visual property for this view.
      • supportsSnapshots

        default boolean supportsSnapshots()
        Returns true if this network view supports creating snapshots, the createSnapshot() method will not throw an exception.
        Since:
        3.8
      • createSnapshot

        default CyNetworkViewSnapshot createSnapshot()
        Returns an immutable snapshot of this network view (optional operation).
        Throws:
        UnsupportedOperationException - if creating a snapshot is not supported by this network view
        Since:
        3.8
      • isDirty

        default boolean isDirty​(boolean clear)
        If this network view supports creating snapshots using the createSnapshot() method, then this method will return true if the state of the network has changed since last clearing the dirty flag. If this network view does not support creating snapshots then this method will always return false.
        Parameters:
        clear - If true then the dirty flag will be set to false.
        Since:
        3.8
      • addNetworkViewListener

        default void addNetworkViewListener​(CyNetworkViewListener listener)
        Adds a CyNetworkViewListener (optional operation).
        Throws:
        UnsupportedOperationException - if this method is not supported by this network view
        Since:
        3.8