Package org.cytoscape.view.model

Interface CyNetworkViewFactoryConfig

public interface CyNetworkViewFactoryConfig

Used to configure the behavior of CyNetworkView objects created using the CyNetworkViewFactoryFactory service.

Since:

3.8

Module: viewmodel-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>viewmodel-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Method Summary

Modifier and Type	Method	Description
void	addNonClearableVisualProperty(VisualProperty<?> vp)	Add a VisualProperty that will not have its value cleared when View.clearVisualProperties() is called.
<T,V extends T> void	addTrackedVisualProperty(Object key, VisualProperty<? extends T> vp, Predicate<V> valueTester)	Turns on tracking of the given VisualProperty such that nodes/edge that have the VisualProperty set to a value that satisfies the given Predicate are returned by the CyNetworkViewSnapshot.getTrackedNodes(Object) or CyNetworkViewSnapshot.getTrackedEdges(Object) method .
default <T,V extends T> void	addTrackedVisualProperty(Object key, VisualProperty<? extends T> vp, V value)	Turns on tracking of the given VisualProperty such that nodes/edge that have the VisualProperty set to a value that is equal to the given value are returned by the CyNetworkViewSnapshot.getTrackedNodes(Object) or CyNetworkViewSnapshot.getTrackedEdges(Object) method .

Method Detail

addTrackedVisualProperty

<T,V extends T> void addTrackedVisualProperty(Object key,
                                                    VisualProperty<? extends T> vp,
                                                    Predicate<V> valueTester)

Turns on tracking of the given VisualProperty such that nodes/edge that have the VisualProperty set to a value that satisfies the given Predicate are returned by the CyNetworkViewSnapshot.getTrackedNodes(Object) or CyNetworkViewSnapshot.getTrackedEdges(Object) method .

Type Parameters:

T - Data type of the visual property. This can be subclasses of type T.

V - Value of the visual property. This can be subclasses of T.

Parameters:

key - Key object used to retrieve tracked nodes/edges from CyNetworkViewSnapshot.getTrackedNodes(Object) or CyNetworkViewSnapshot.getTrackedEdges(Object)

vp - The VisualProperty to track.

valueTester - Predicate nodes/edges that satisfy this predicate are tracked

addTrackedVisualProperty

default <T,V extends T> void addTrackedVisualProperty(Object key,
                                                            VisualProperty<? extends T> vp,
                                                            V value)

Turns on tracking of the given VisualProperty such that nodes/edge that have the VisualProperty set to a value that is equal to the given value are returned by the CyNetworkViewSnapshot.getTrackedNodes(Object) or CyNetworkViewSnapshot.getTrackedEdges(Object) method .

Type Parameters:

T - Data type of the visual property. This can be subclasses of type T.

V - Value of the visual property. This can be subclasses of T.

Parameters:

key - Key object used to retrieve tracked nodes/edges from CyNetworkViewSnapshot.getTrackedNodes(Object) or CyNetworkViewSnapshot.getTrackedEdges(Object)

vp - The VisualProperty to track.

value - Visual property values that are equal to this value are tracked.

addNonClearableVisualProperty

void addNonClearableVisualProperty(VisualProperty<?> vp)

Add a VisualProperty that will not have its value cleared when View.clearVisualProperties() is called. This is typically used with node coordinates (ie X and Y position) so that the network layout isn't lost when VisualProperties are cleared.