serviceInputDefinition - cytoscape/cytoscape-web GitHub Wiki

Defines the input of the service-based app. This attribute describes how to assemble the data attribute in the request body to send to the service-based app. It should have this JSON structure:

{
  "type": string,
  "scope": string,
  "inputColumns": object,
  "inputNetwork": object
}

type

Denoting the source of the data. Valid values are:

• none: The Service-App does not want any data.
• node: The Service-App wants the node table as input data.
• edge: The service-App wants the edge table as input data.
• network: The service-based app wants the entire network (current network) as input data.

scope

Provides a way to filter the data sent to the service-based app. This only applies to the current network:

• dynamic (default): If there are selected elements, use selected elements. Otherwise, use all elements.
• selected: Only send the selected elements to the service. If there is no selection, the menu item for this app will be grayed out.
• all: Always send all elements to the service.

inputColumns

Defines how node/edge columns should be sent to service.

NOTE: Should only be set if type is node or edge

inputNetwork

Defines how network should be sent to service.

NOTE: Should only be set if type is network