Extension

This document describes the properties of the JSON API object. You also can access the document in JSON Schema format: json-extension.schema.json

An extension that can be put into the ImageJ plugin folder

id: string

Unique ID of this extension. Should have format . :

version: string

Version of this extension

metadata: See metadata

General metadata about the extension

algorithms: object[]

List of added algorithms

Example

{
  "id" : "org.hkijena.jipipe:example-list-tiff",
  "version" : "1.0.0",
  "metadata" : {
    "name" : "Example extension",
    "description" : "An example extension",
    "authors" : "Ruman Gerst",
    "website" : "",
    "license" : "BSD-2",
    "citation" : ""
  },
  "algorithms" : [ {
    "id" : "folder-list-tif",
    "metadata" : {
      "name" : "List TIFF files",
      "description" : "Lists all TIFF files in a folder",
      "authors" : "Ruman Gerst",
      "website" : "",
      "license" : "BSD-2",
      "citation" : ""
    },
    "category" : "Converter",
    "graph" : {
      "nodes" : {
        "default-preprocessing-filter-files" : {
          "jipipe:slot-configuration" : {
            "Files" : {
              "slot-data-type" : "file",
              "slot-type" : "Input",
              "inherited-slot" : null,
              "name" : "Files",
              "custom-name" : null,
              "inheritance-conversions" : { }
            },
            "Filtered files" : {
              "slot-data-type" : "file",
              "slot-type" : "Output",
              "inherited-slot" : null,
              "name" : "Filtered files",
              "custom-name" : null,
              "inheritance-conversions" : { }
            }
          },
          "jipipe:algorithm-ui-location" : {
            "{Vertical}" : {
              "x" : 25,
              "y" : 250
            }
          },
          "jipipe:algorithm-type" : "file-filter",
          "jipipe:algorithm-compartment" : "DEFAULT",
          "name" : "Filter *.tif",
          "description" : null,
          "filters" : [ {
            "mode" : "Glob",
            "filterString" : "*.tif"
          } ],
          "jipipe:trait-generation" : {
            "modification" : {
              "per-slot" : { },
              "global" : { }
            },
            "transfer" : {
              "transfers" : [ ],
              "transfer-all-to-all" : true
            }
          },
          "jipipe:dynamic-parameters" : { }
        },
        "default-preprocessing-list-files" : {
          "jipipe:slot-configuration" : {
            "Folders" : {
              "slot-data-type" : "folder",
              "slot-type" : "Input",
              "inherited-slot" : null,
              "name" : "Folders",
              "custom-name" : null,
              "inheritance-conversions" : { }
            },
            "Files" : {
              "slot-data-type" : "file",
              "slot-type" : "Output",
              "inherited-slot" : null,
              "name" : "Files",
              "custom-name" : null,
              "inheritance-conversions" : { }
            }
          },
          "jipipe:algorithm-ui-location" : {
            "{Vertical}" : {
              "x" : 25,
              "y" : 50
            }
          },
          "jipipe:algorithm-type" : "folder-list-files",
          "jipipe:algorithm-compartment" : "DEFAULT",
          "name" : "List files",
          "description" : null,
          "jipipe:trait-generation" : {
            "modification" : {
              "per-slot" : { },
              "global" : { }
            },
            "transfer" : {
              "transfers" : [ ],
              "transfer-all-to-all" : true
            }
          },
          "jipipe:dynamic-parameters" : { }
        }
      },
      "edges" : [ {
        "source-algorithm" : "default-preprocessing-list-files",
        "target-algorithm" : "default-preprocessing-filter-files",
        "source-slot" : "Files",
        "target-slot" : "Files"
      } ]
    },
    "menu-path" : "",
    "jipipe:project-type" : "graph-wrapper-algorithm",
    "preferred-traits" : [ ],
    "unwanted-traits" : [ ],
    "added-traits" : [ ],
    "removed-traits" : [ ]
  } ],
  "dependencies" : [ {
    "metadata" : {
      "name" : "Filesystem types and algorithms",
      "description" : "Data types and algorithms for interacting with files and folders",
      "authors" : "Zoltán Cseresnyés, Ruman Gerst",
      "website" : "https://jipipe.org/",
      "license" : "BSD-2",
      "citation" : ""
    },
    "id" : "org.hkijena.jipipe:filesystem",
    "version" : "1.0.0"
  } ],
  "jipipe:project-type" : "json-extension"
}