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.
Comment: Updated for 9.3 release.

...

This feature allows you to display dynamic report values, such as the name of the report, its description, filters defined in a report, and more, on your charts by entering predefined keywords using Yellowfin's text widgets.

 


Predefined Text Widget Parameters

You can include the following parameters (in the exact format shown below) in your text widget. Yellowfin will replace them with their values when you preview your chart. 


Text Widget ParameterDescription
[reportname]Adding this will replace the name of your report in your chart. You can set the report name when you publish it.
[reportdescription]This will show your report's description. You can provide this description when you publish the report.

[tablevalue:column=<value>:row=<value>]

This parameter takes a column and row coordinate from a report table and displays its value in the text widget. 

For example, [tablevalue:column=1:row=1] will display whatever value is in the first column and row of a table.

Note:

  • If the target contains a drill link, the parameter will ignore it.
  • If the target contains special formatting, such as bold, typeface, and border, the parameter will ignore it and use the text widget formatting instead.
  • If the target column field format is set (eg, Sparkline Formatter, Image Link Formatter, Action Button etc.), the parameter will preserve that setting.
  • If the target table has hidden columns, these should be counted (eg, if column 1 has a hidden field before it, it is actually column 2).
  • If the target doesn't exist, the parameter will be replaced with an empty string.
[filter:<filter_order>]

This widget parameter returns the filter you have applied in your report. You can include any filter by entering its order number.

For example, [filter:2] displays the second filter. Note however, that if a specified filter yields no value, then (None) will be displayed by default.

[filter:<filter_order>:format=<value>]

This operator is used to display the filter value in its raw form or with the applied format.

Use the following keywords in place of <value>:

  • Raw: This displays the filter value in its raw form, even if a format has been applied to it. (Applied by default.) For example: [filter:1:format=raw]

  • Formatted: Use this keyword to display the filter value with its applied format. For example: [filter:1:format=formatted]

[filter:<filter_order>:empty=<text>]

You can also specify the exact text to display, if the selected filter brings up no value, by using the Empty operator. Simply enter the text that you want to show in case the filter returns empty.

E.g. [filter:1:empty=No result] - If the first filter is empty, then the text 'No result' will appear where this text widget filter parameter is placed.

Note: The following characters should not be included in the text: “:”, “[” or “]”.

[total:<column_number>]

Use this to display the total aggregation value set on a column field, where the column is specified with its order number in the report.

For example: [total:3] will show the total aggregated value of the third column.

This value will depend on the aggregation type set on the total of the column field in the report, if any has been defined; otherwise it will display the total Sum value for metric fields, or the total Count for dimension fields.
[total:<column_number>:<aggregation_type>]

This is similar to the above parameter, however it displays the total column value depending on the aggregation type that you specify in here. This will override the existing aggregation type defined in the report. Use the following keywords to specify the aggregation type (ensure the same format is used for these keywords, i.e. all capital letters):

SUM, AVG, MAX, MIN, COUNT, and COUNTDISTINCT.

For example, [total:2:AVG] will display the total average of the second column.

Note

Note: For dimension fields, only COUNT and COUNTDISTINCT can be applied.


[parameter:<parameter_order>:format=<value>]

Use this operator to display the value of  Yellowfin’s unique Parameter field, in its raw form or with the applied format. (You can learn more about the parameter field here.)

Use the following keywords in place of <value>:

  • Raw: This displays the parameter value in its raw form, even if a format has been applied to it. (Applied by default.)

  • Formatted: Use this keyword to display the parameter value with its applied format.

[parameter:<parameter_order>:empty=<text>]

By default, if the selected parameter brings up no value, then instead of nothing appearing on the chart, (None) will be displayed. However, with the Empty operator, you can select the exact text to display. Simply enter the text that you want to show in case the parameter has no value.

E.g. EMPTY=Details will appear.

Note: The following characters should not be included in the text: “:”, “[” or “]”.

...

  1. Create a report. (See our Report Creation section for more detail.)
  2. Note: In order to use the filter text widget parameter, make sure to include values in the Filters field when creating your report.



  3. Once you have created your charts (you would need at least two charts), proceed to the Design mode.
  4. Drag a text widget (from the left side menu) onto your canvas, while in the edit mode.



  5. Type in one of the text widget parameters.

    Note

    To view the values of some of the text widget parameters, e.g. [reportname] and [reportdescription], you will first need to publish the report and provide the details in the form. Then return to the design editing mode to use the parameters.


  6. Then click on the Preview button to preview the chart.



  7. You will be able to see the values of the text widget parameters you have included in the chart, as shown in the example below.




    Note

    If nothing gets displayed, ensure that the applied text widget parameter contains a value.

 

 

 

 

...