Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


UserInputParameters API

Yellowfin uses a common ancestor API for providing basic configuration UI and persistence to plugins plug-ins in a generic way. This API is called UserInputParameters (UIP) and is the base class for most Yellowfin Pluginsplug-ins, except for some specific exceptions such as Data Transformations, which require more sophisticated UI and persistence.

...

Note

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:

 

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

 

 For more details, refer to the appendix for this API.

 

 

 

Section
Column
width75

 

Column

Next topic: Parameter class