new FilteredCacheItemResults(evaluation_result, title, url, desc)
Constructs a data structure of cache items associated with a rule category The cache items returned can be filtered by the tpe of evaluation result
Parameters:
Name | Type | Description |
---|---|---|
evaluation_result |
Object | Evaluation result object containing the evaluation results |
title |
String | Title for the group |
url |
String | URL to more information on the group |
desc |
String | Description of the group |
- Source:
- scripts/filtered_cache_item_results.js, line 7
Methods
-
<static> filterCacheItemsByNodeResultsFromList(cache_items, filter, start)
-
Returns a lists of cache item results by filtered node results based on the filter. Does not traverse the children of the cache items
Parameters:
Name Type Description cache_items
Array List of cache element items filter
Number Number representing the types of results to include in the array start
Number Start for the ordinal position - Source:
- scripts/filtered_cache_item_results.js, line 310
-
<static> filterCacheItemsByNodeResultsFromTree(cache_items, filter, as_list, start) → {Number}
-
Returns an nested lists of cache item results by node results based on the filter
Parameters:
Name Type Description cache_items
Array Array of cache element items filter
Number Number representing the types of results to include in the array as_list
Boolean Optional parameter to force result to be a list start
Number Start for the ordinal position - Source:
- scripts/filtered_cache_item_results.js, line 353
Returns:
Number of cache items that were not included due to filter settings- Type
- Number
-
<static> getCacheItemResults(element_type, filter)
-
Constructs a data structure of cache items associated with a rule category The cache items returned can be filtered by the tpe of evaluation result
Parameters:
Name Type Description element_type
Number Number representing the element types to be included filter
Number (optional) - Number representing the evaluation results filter (default all results) - Source:
- scripts/filtered_cache_item_results.js, line 207
-
<static> getDescription() → {String}
-
Returns the description of the group, can be empty
- Source:
- scripts/filtered_cache_item_results.js, line 110
Returns:
String describing the group of rules- Type
- String
-
<static> getResultSummary() → {ResultSummary}
-
Gets numerical summary information about the cache item results
- Source:
- scripts/filtered_cache_item_results.js, line 141
Returns:
Returns the ResultSummary object- Type
- ResultSummary
-
<static> getTitle() → {String}
-
Returns the title of the group
- Source:
- scripts/filtered_cache_item_results.js, line 80
Returns:
String representing the title of the group- Type
- String
-
<static> getURL() → {String}
-
Returns the url of the group, can be empty
- Source:
- scripts/filtered_cache_item_results.js, line 95
Returns:
String of the url to more information about a group- Type
- String
-
<static> hasElements() → {Boolean}
-
Tests if any of their are any elements of this type
- Source:
- scripts/filtered_cache_item_results.js, line 175
Returns:
True if the group contains at least one element, otherwise false- Type
- Boolean
-
<static> hasResults() → {Boolean}
-
Tests if any of the rules in this group applied to the content in the page
- Source:
- scripts/filtered_cache_item_results.js, line 159
Returns:
True if any of the rule have results, otherwise false- Type
- Boolean
-
<static> isTree() → {Boolean}
-
Tests if the cache items has a tree structure (otherwise simple list)
- Source:
- scripts/filtered_cache_item_results.js, line 125
Returns:
true if cache items are organized as a tree, otherwise false- Type
- Boolean
-
<static> toCSV(title) → {String}
-
Returns an CSV representation of the filtered cache item results
Parameters:
Name Type Description title
String Title of the report - Source:
- scripts/filtered_cache_item_results.js, line 551
Returns:
String representing the CSV for the report- Type
- String
-
<static> toHTML(title) → {String}
-
Returns an HTML representation of the filtered cache item results
Parameters:
Name Type Description title
String Title of the report - Source:
- scripts/filtered_cache_item_results.js, line 511
Returns:
String representing the HTML for the report- Type
- String
-
<static> toJSON(prefix) → {String}
-
Returns an JSON representation of the filtered cache item results
Parameters:
Name Type Description prefix
String A prefix string typically spaces - Source:
- scripts/filtered_cache_item_results.js, line 435
Returns:
JSON string representing the report data- Type
- String
-
<static> updateSummary(cache_item_result)
-
Updated summary result counts with cache item results
Parameters:
Name Type Description cache_item_result
Array Cache item result to add to summary information - Source:
- scripts/filtered_cache_item_results.js, line 191