Page History
User input parameters are created within setupParameters(), by creating parameter objects and adding them to the advanced function through the addParameter() method.
...
| Parameter Method | Description |
|---|---|
| setUniqueKey | Unique text key for this parameter, used to access parameter data and control dependent display. |
| setDisplayName | Text name. |
| setDescription | Text description. |
| setDataType | Type of object this parameter will return. See Yellowfin Data the data type appendix. |
| setAcceptsFieldType | Limit the type of fields available to be selected in field selection (TYPE_FIELD DISPLAY_SELECT) parameters. See Yellowfin Data the data type appendix. |
| setDisplayType | Display type of the input parameter. See Yellowfin Display the display types appendix. |
| setDefaultValue | Sets the default value for this parameter. Must be of the type specified in setDataType. |
| addOption | add Add possible values to DISPLAY_SELECT, and DISPLAY_RADIO parameters. |
Example
The following code creates two parameters. Column is a field selection drop-down which allows you to select any Numeric field from the report. Operator is a drop-down menu with 4 values representing basic mathematical operations.
...