Package org.cytoscape.view.presentation.property.values

Interface MappableVisualPropertyValue

All Superinterfaces:

VisualPropertyValue

public interface MappableVisualPropertyValue
extends VisualPropertyValue

This is a special VisualPropertyValue that allows a VisualProperty value to be specified as depending on one or more CyColumns. That way, if the columns or column values change, Cytoscape can also update the Views that have the corresponding visual property values.

Module: presentation-api

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

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

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary

Modifier and Type	Method	Description
Set<CyColumnIdentifier>	getMappedColumns()
void	update()	Cytoscape will call this method every time the columns corresponding to the CyColumnIdentifiers returned by getMappedColumns() change.

Methods inherited from interface org.cytoscape.view.presentation.property.values.VisualPropertyValue

getDisplayName, getSerializableString

Method Detail

getMappedColumns

Set<CyColumnIdentifier> getMappedColumns()

Returns:

A set of CyColumnIdentifier objects that contain the information about all the CyColumns this visual property value depends on.

update

void update()

Cytoscape will call this method every time the columns corresponding to the CyColumnIdentifiers returned by getMappedColumns() change.