UserInputParameters API

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.

 

 

Guide Contents

This guide is broken into the following sections:

 

See also, the UserInputParameter appendix.

 

 

 

 

 

 

Next topic: Parameter class

 

 

  • No labels