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
- (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.