This documents provides Gephi APIs documentation and gives details about
current status of each API. Each API is categorized by it's stability:
stable, under development, deprecated or
friend.
API Changes
- (April 30 2010) Change FilterController.filter() to FilterController.filterVisible() and FilterController.select()
to FilterController.selectVisible(). The controller is managing this process in a separate thread, with progress,
and takes care of properties change. A more simple direct way to filter is required for headless access.
The FilterController.filter() has been created and return the GraphView builded by the filter process.
- (April 24 2010) Expose basic visualization features in a newly created Visualization API. No proper visualization
API exists but its creation is necessary to avoid implementation module dependencies.
- (April 17 2010) In PreviewAPI, the background color has been put in the PreviewModel. The PreviewController has
been updated as well.
- (March 28 2010) Add a
doImport() method in ImportController that accepts
InputStream. In ImportAPI also, add getWeight() in EdgeDraft to let importers
increment weight. New AttributeUtils methods. Progress in GraphAPI and ImportAPI documentation.
- (Feb 17 2010) Change in ImportAPI to support bounded time intervals. Add methods
that manage
TimeIntervalMin and TimeIntervalMax. Changes in
GraphAPI about elements counting. Henceforth only enabled elements are counted, in node
and edge counting, but also in degree methods. This counting is more logical, as it match
with the number of elements returned by getNodes() and getEdges().
- (Feb 7 2010) Initial import, for 0.7alpha milestone. Half of
APIs are fully documented and the rest needs to be soon. Expose
only Core APIs, that plugins could need by now. Friend
packages exists, in particular between Plugin and PluginUI
modules but they are not shown here. Netbeans APIs documentation
dependencies are missing, thus see
Netbeans API Index.
Due to early development status, most of APIs are still marked as
under development. Moreover APIs marked as stable are also suspected to
change, but with much less impact than ones marked as under development.
API List
- Attributes API - Provides access to attributes values through an efficient column/row system.
- Clustering API - API/SPI for clustering algorithms (experimental).
- Export API - Export API/SPI provides the infrastructure for exporting data to any support and define new exporters.
- Filters API - API/SPI for filters, define and control current filtering.
- Generator API - Generator API/SPI provides the way to create and execute graph generators.
- Graph API - API for accessing the graph.
- Import API - Import API/SPI provides the import workflow to import data form any support.
- Layout API - Layout API/SPI provides real-time layout algorithms execution.
- LongTask API - LongTask API provides utility features for long and asynchronous task execution.
- Partition API - API for manipulating partition within data.
- Preview API - API for building the graph preview structure.
- Project API - Project API/SPI for project and worskpaces manipulation.
- Ranking API - API/SPI for ranking data values and create transformers.
- Statistics API - Statistics and Metrics API/SPI provides asynchronous algorithms execution and UI infrastructure.
- Timeline API - Timeline API provides access to the timeline component.
- Tools API - Tool API/SPI defines interactive actions users can make with the visualization.