Property name | Supported Template | Description |
---|
Name | Canvas & layouts | Allows you to edit the default report name. Tip: This name will appear in Code Mode in the canvas, making it easy to code this widget. |
Report type | Canvas & layouts | Allows you to change the report’s content type. Example, if your report has multiple charts, you can choose which one to display on the dashboard. Similarly, a live report can be changed to a saved snapshot or bookmark. |
Refresh | Canvas & layouts | Enable this toggle to allow your report to be refreshed periodically once the dashboard is published. |
Refresh time | Canvas & layouts | If opting to refresh reports, define frequency of time (in seconds) that the report should be refreshed. |
Link interactions | Canvas & layouts | This button allows you to enable and link interactions to your report, such as drilling, or brushing. To do this, your report must be set up beforehand to allow for these interactions. For example, to perform drilling, the report must have data hierarchy that takes it from one level to another level. |
Interactions |
---|
Allow interactions | Canvas & layouts | Enable this toggle to allow interactions to be performed on the chart. This toggle allows you to display additional toggles, so you can choose the exact interaction functionality to be enabled on a chart. |
Brushing | Canvas & layouts | Allows users to perform brushing on a chart if enabled. The chart must have brushing capabilities set up prior. |
Drill down | Canvas & layouts | Allows users to perform drill down on a chart if enabled. The chart must have drill down capabilities set up prior. |
Drill path | Canvas & layouts | Allows users to use the drill path on a report if enabled. |
Size & location |
---|
X | Canvas | Specify the x coordinates of the top left corner of the report, in order to position it exactly on your dashboard canvas. |
Y | Canvas | Specify the y coordinates of the top left corner of the report, in order to position it exactly on your dashboard canvas. |
Width | Canvas | Specify the width of the currently selected report, in pixels, in order to resize it exactly. |
Height | Canvas & layouts | Specify the height of the currently selected report, in pixels, in order to resize it exactly. |
Corners | Canvas | This option allows you to define the roundness of your report border corners. Tip: For maximum circular edges, enter half the value of the widget height. For example, if the height is 400 pixels, then set the edge value to 200 pixels. Moreover, any value greater than 200 for the edge, will not have any further effect in this example. |
Aspect ratio | Canvas | Enable this toggle to maintain the aspect ratio. This means when increasing or decreasing the report’s size, it maintains its shape (i.e. the relationship between its width and height). If this is disabled, the report can be stretched out of shape either vertically or horizontally. |
Lock widget | Canvas | Enable this toggle to lock the report in its location. This stops you from moving or resizing it. This holds true even when selecting multiple widgets on the canvas. Note that the report widget can still be customized. |
Background formatting |
---|
Background color | Canvas | Allows you to specify a background color for the report. |
Opacity | Canvas | Allows you to specify the transparency of the report’s background color. |
Customise padding | Canvas | This option allows you to define a custom padding or buffer around the report, in pixels, when enabled. This includes padding for each side to the report. If disabled, you can still define an overall padding size. |
Padding top | Canvas | When custom padding is enabled, this allows you to define padding to be added to the top of the report. |
Padding bottom | Canvas | When custom padding is enabled, this allows you to define padding to be added to the bottom of the report. |
Padding right | Canvas | When custom padding is enabled, this allows you to define padding to be added to the right of the report. |
Padding left | Canvas | When custom padding is enabled, this allows you to define padding to be added to the left of the report. |
Padding | Canvas | This allows you to define an overall padding size for the report. This size, defined in pixels will be constant for each report side. To add different sized padding on any of the sides, enable the Customise Padding option. |
Border width | Canvas | This allows you to specify the thickness of the report border. Note: to make the border visible, you must define values for all three border properties. |
Border style | Canvas | This allows you to select a style for the report border. Options include: dashed, solid, dotted, groove, and more. |
Border color | Canvas | This allows you to specify the color of the report border. |
Horizontal shadow | Canvas | This option allows you to drop a horizontal shadow on the report, by defining its size in pixels. |
Vertical shadow | Canvas | This option allows you to drop a vertical shadow on the report, by defining its size in pixels. |
Shadow blur | Canvas | This option allows you to define the sharpness of the report shadow. The smaller the value, the sharper and more defined the shadow will be. For a blurry or softer shadow, provide a bigger value. |
Shadow color | Canvas | This option allows you to set a color for the report shadow. |
Actions |
---|
Click Event |
| Select an event that will trigger when the selected report is clicked. Event options include:
- None: Use this if you do not wish the widget to trigger an event.
- Next sub tab: Navigates the user to the next tab within the same dashboard.
- Previous sub tab: Navigates the user to the previous tab within the same dashboard.
- Reset filters: Allows users to clear filter selections, or in case default values are set, then reset filters to their default values.
- Reset dashboard: Refreshes the dashboard by clearing any user interactivity performed on it, as well as removing all applied filters.
- Go to report: Navigates users to a specified report. This report can be specified by providing its report UUID.
- Go to sub tab: Navigates to any sub tab in the same dashboard, where the sub tab is specified by its order number. For example to jump to the forth sub tab, enter 4 in the sub tab # field. Note that the sub tab order starts from number 1.
- Go to URL: Navigates to an external link or page using the specified URL. You can also choose to open the new link in a new tab or window or in the current window. (See the below URL and Target settings for more information.)
|
Report ID |
| If navigating to a report using the ‘Go to report’ click event, provide the UUID of the report. |
Sub Tab # |
| If navigating to a sub tab using the ‘Go to sub tab’ click event, enter the order number of the sub tab. |
URL |
| If navigating to an external page using the ‘Go to URL’ click event, provide the full URL of the page. |
Target |
| If navigating to an external page using the ‘Go to URL’ click event, specify the page target. Options include: - New Tab/Window: Opens the URL page in a new tab or window, depending on your browser’s settings. Note: The default for most browsers is a window, however users can use computer shorts (Ctrl in Windows, and Cmd in Mac) to open in a new tab instead.
- Current Window: Open the page in the current window.
- Parent Frame: If Yellowfin is embedded as an iFrame, the new page will open (that is, its contents will appear) in the parent frame. Note that the parent frame is the one within which the Yellowfin frame is embedded.
- Current Frame: If Yellowfin is embedded as an iFrame, the contents of the URL page will open in the current frame. Note that the current frame is the one which embeds Yellowfin.
|