Yellowfin uses a common ancestor API for providing basic configuration UI and persistence to plug-ins in a generic way. This API is called UserInputParameters (UIP) and is the base class for most Yellowfin plug-ins, except for some specific exceptions such as Data Transformations, which require more sophisticated UI and persistence.
Some plug-in APIs which descend from UIP redefine how developers should interact with UIP, so check the documentation for those APIs to see if anything is redefined.
Some parts of UIP are used by the Yellowfin backend to facilitate the use and persistence of plug-in data. These parts of the API are not documented here, and developers are not expected to know about their implementation.
This guide is broken into the following sections:
- Parameter class: An inner class of UIP to display and persist data.
- Basic UI set up: Methods used for setting up a basic UI.
- Dynamic UI set up: Methods used for more complex UI interactions, such as button callbacks, optional parameters, etc.
See also, the UserInputParameter appendix.