Widgets & Datasets

A Dataset is a logical grouping of data (typically the results of a query).

A Widget is a visualization on a dataset. One or more widgets can point to the same dataset.

A dataset and widget is automatically created by Knowi for a query.

Creation

Widgets and Datasets can be created in the following ways:

  1. Results of queries against your datasources, from the UI or via the Agent.
  2. Using our Push Data API.

To create a widget from an existing dataset, go to the widget listing menu or the Add Widget to Dashboard menu to create and point to an existing dataset.

Add Widget

Widgets can also be cloned from other widgets with its own filters and data manipulation.

Query, Dataset and Widget Mapping

To see a visual mapping of how widgets are related to datasets and their associated queries, click on Data Config on the widget settings.

You can preview visualizations, edit the query directly from the diagram as well as zoom into any derived datasets.

Data Management

The diagrams are also accessible the query listing page.

Widget Settings

Widget settings can be accessed from the options menu of a widget in a dashboard.

Add Widget

Field Comments
Widget Name Unique Name of the widget
Type Type of Widget, from various chart types, to grid, etc.
Category Optional, to easily categorize widgets into groups. Category lists are displayed as a dropdown on the widget list
Description Adds a popover description icon on the widget when present
Plot Data/Y-Axis Y-Axis fields, when applicable (Chart types only). Leave empty for multiple series
Series Categories/By Legend Grouping for multiple series for chart types, where applicable. Categories show up as separate legend items for each item.
X-Axis X-Axis field name (for chart types)
X-Axis Ordering Specify ordering for X-Axis values
X-Axis Type Enables Date/Time
Display Theme For chart types, there are two theme options available: Light/Dark
Data Feed Live option enables live autoupdated charts. Specify number of seconds to the update the chart
Max Records Maximum number of records to profile for this dataset
Footnote Adds an optional footnote to the bottom of the widget (always visible)

Chart Settings

Chart settings are only available for the widgets with an XY axis.

Add Widget

Field Comments
Plot Data/Y-Axis Numeric Y-axis field to use. Leave it empty if for multiple Y-axis fields.
Grouping/Legend Legend/series field if a column contains the fields.
X-Axis X-axis field if applicable.
X-Axis Ordering Optional X-axis data ordering if applicable.
X-Axis Type Set to date/time for a time series chart.
Legend Ordering Legend ordering method, if applicable.
Y-Axis Max Optional max Y-axis value. Use it in conjunction with the tick interval to set the Y-axis labels.
Y-Axis Tick Interval Optional Y-axis tick interval to set the Y-axis labels.
Target Line Optional value for the target line only applies to the primary Y-axis. It is available for the following widgets: Column, Stacked Column, Bar, Area, Stacked Area, Line, Spline, and Scatter. The bar chart would have a vertical target line. All other charts specified should have a horizontal target line.
Stacking - Second X-Axis Group Displays a seconds stacking group on the X-axis based on the string field selected.
Secondary Y-Axis Optional secondary Y-axis on the right-hand side of the chart.
Secondary Chart Type Chart type for the secondary chart.
Secondary Chart Send to Back If checked, adjusts(z-index) to send the secondary chart behind the first.
Synchronize Y-Axis If checked, synchronizes the Y-axis primary and secondary to the same value.

Display & Formatting

Add Widget

Field Comments
Title Font Color Set the title font color of the widget
Title Font Size Set the title font color of the widget. The default title font size is 14px.
Font size Set the font size of the widget data. The default widget data font size is 10pt.
Font color Set the font color of the widget data. The default widget data color is black.
Color of odd rows Set the background color of all the odd-numbered rows. The default color of odd rows is white.
Color of even rows Set the background color of all the even-numbered rows. The default color of odd rows is white.
Color of Header rows Set the background color of header rows. The default color of header rows is dark blue.
Header font color Set the font color of the data in the header row. The default header font color is black.
Header Height Set the height of the header.
Minimum Column Width Apply a minimum grid width to enable horizontal scroll instead of fitting the grid into the viewport in case of a large number of columns.
Grid line thickness Set the grid line thickness value.
Cells Padding Set the padding of cell content.
Row height Set the height of each row in the grid.
Format Set the formatting for one or more fields while providing all the fields in the drop-down list.
Hide Column This hides the chosen column from the grid.
Reset Column Width Reset each column width to default.


Data Settings

Add Widget

Field Comments
Aggregation Apply aggregation for the group on the selected field. It can perform aggregation functions like Min, Max, Total, Avg, Count, and Weighted Avg.
Aggregation on top If checked, show the results of the selected aggregation function on top of the widget.
Column Ordering Sort the values of the selected column into a descending or ascending order.
Grouping Make the different groups according to the values of the selected column. For example, put the rows with a similar value of column cells into the same group. You can also hide the grouping column and collapse the grid to show only the grouping column.
Scroll Limit Set the scroll paging limit. The default value is 1000 records.
Internal Sparkline Charts Allow you to create charts within cells to see trends but the data must be in array form.

Widget Menu

The options below can be toggled ON/OFF for an individual widget. They are ON by default.

Add Widget

Option Description
Show Title Toggle widget title display ON/OFF
Analyze Toggle Analyze (self-service analytics) icon display ON/OFF
Alerts Toggle Alert icon display ON/OFF
Filters Toggle Filters icon display ON/OFF
Drilldowns Toggle Drilldowns option in More Settings ON/OFF
Query Toggle Query Edit option in More Settings ON/OFF
Data Diagram Toggle Data Diagram option in More Settings ON/OFF
Refresh Toggle Refresh widget option in More Settings ON/OFF
Remove from Dashboard Toggle Remove from Dashboard option in More Settings ON/OFF

More options

Option Description
Change Dataset Change to a different dataset for producing widget data
On Click Event Handler Define custom javascript behavior when a point is clicked

Types

We support over 20 types of visualizations to choose from. See Visualization Options for more details.

Filters

  • Basic filtering can be used to set filtering on the data.
  • Cloud9QL can be used to further manipulate the data in advanced ways. See Cloud9QL documentation for more details.

Knowi widget filters have the same functionality as their dashboard counterparts with the added benefit of also being able to incorporate Knowi's highly flexible cloud9QL function to further manipulate the data contained in a particular widget.

Refer to the following for more details: Dashboard Filters Cloud9QL

Cloud9QL Widget Filtering

Ad hoc Analysis

Data associated to a widget can be analyzed using a drag & drop interface. See Ad Hoc Analysis section for more details.

Drilldowns

Drilldowns enable powerful point and click drilldowns from one widget into another widget. Data from the parent widget can be used as keys into the drilldown widget to filter the data specifically for the point selected.

Filter

Cloning

Cloning copies an existing widget with out without original data. Typically used in the following cases:

  • To create a new widget with the same settings as the existing data, but pointing to a new dataset.
  • To create a separate view of the same data.
  • To create a separate view of the different data by changing the dataset.

    Filter

Filters and Cloud9QL can be applied to the new widget to further manipulate the cloned widget.

Sharing

Share - Internal Users and Groups

A Widget can be shared with multiple internal users and groups within your organization. From the widget settings menu, 'Share' icon, check users and/or groups to share the Widget to.

User Groups can set in the Team settings in the User Settings menu.

You can also set one of following to user or group to define access:

  • View Only: The user will only be able to view and interact with the widget and will not be able to save, modify widget or widget settings.
  • Edit: Ability to edit the widget.
  • Admin: Ability to edit widget, plus being able to set Global filters and change widget level Cloud9QL.

Share - Public

A Widget can be shared in isolation (not as part of a dashboard) by selecting the 'Share' icon. This will generate a public URL for a widget.

Note: This makes the widget publicly accessible, without requiring a login. Do not use this option for sensitive data.

The widget shared in isolation will have no dashboard filters applied, so please always check how widget looks via url before sharing widget link to someone.

In addition, the embed code can also be used to embed the widget into your own portal/HTML pages.

To turn off a unique public URL, click on 'Disable Share URL'.

To add filter parameters to the share URL, pass in contentFilters parameter to the URL, where the value is in encoded JSON form.

Example: URL Parameter example: contentFilters=[{"fieldName":"opened","values":[1000],"operator":">"}]

Full URL, with the parameter and encoded JSON:
https://www.knowi.com/w/3cKltxiizxNFgxjRvanZwY2WZoiikPo5ip3EqS13cii1KdQie?contentFilters=%5B%7B%22fieldName%22%3A%22opened%22%2C%22values%22%3A%5B1000%5D%2C%22operator%22%3A%22%3E%22%7D%5D

Sharing Widget Analytics

In additional to sharing widget, it is possible to share widget with analytics mode expanded. Use same widget sharing URL by appending ?analytics=true.

See Self Service Analytics for more info.

Embedding

We provide a number of options for embedding, depending on the level of access required. See embed docs

Data Management

Data Management allows the user to configure additional settings for a given dataset. It can be accessed via the query listing screen by clicking the Data Management icon to the right of each query, or via a widget by navigating to More Settings > Data Diagram then selecting the edit icon of the dataset (blue box).

Data Types

Allows you to view/edit the data type of existing fields in the dataset.

NLP

NLP Indexer

Defaults to ON. Turning it off will exclude the dataset from Search-based Analytics/NLP queries. Note that it may take a few minutes for the change to take effect.

Synonyms

Synonyms are useful for adding context awareness to your Search-based Analytics/NLP queries. For example, if you have a field in your dataset named customer, you can add a synonym "tag" to this field such as "shopper", "buyer", "clent", etc. So, when you type in a question like "total sent by client", it will recognize the term "client" as equivalent to the field "customer". Multiple synonyms can be added for each field.

Indexes

Allows you to specify one or more index fields for commonly used filter attributes. Useful for larger datasets to help speed up results. For example, if the field date is a commonly used filter, setting this as an index will help speed up results when you filter by date.

Data

Displays the raw dataset in tabular format. Date/Time of the last data upload/update for this dataset is listed at the bottom left of the dataset. Click on the Export button to export data in CSV form.

Dynamic Widget Names

Widgets can be dynamically named, based on parameters passed into the dashboard, or via data elements within the widget.

To dynamically pass in widget name via a runtime parameters, use the $c9$ syntax and pass the token in via contentFilters in the UI/embed mode, or using the filters. Example: _A widget for $c9orgname$. In this case, the $c9orgname$ token is dynamically populated. See Content Filters for more info.

To dynamically populate widget names driven by a field within the data, use the {{fieldname:n}} syntax where fieldname is the field to use and n is the row position of that field. Example A widget for {{orgId:1}}. In this case, the first item in the orgId field in the dataset is used to dynamically display the widget name.