insights.clear
- 30 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
insights.clear
- Updated on 30 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
Removes insights and plots from the hosting product's insights panel. If a category is specified, only items within that category are removed.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| [category] | Text | No | Category of insights to remove |
| [insights] | Boolean | No | Whether or not to clear insights |
| [plots] | Boolean | No | Whether or not to clear plots |
Returns
No return value.
Examples
// remove all insights in all categories
ai.insights.clear();
// remove all message insights in the "Tests" category only
ai.insights.clear("Tests", true, false);
// remove all plot insights in the "Tests" category only
ai.insights.clear("Tests", false, true);
Remarks
Use this function when you want to remove several or all items from the hosting product's insights panel.