Constructor: EvaluationResult

OpenAjax.a11y.EvaluationResult

new EvaluationResult(ruleset, title, url, dom, dom_cache)

Parameters:
Name Type Description
ruleset Object Ruleset object used to generate
title String Title of the web page being evaluated
url String URL of the web page being evaluated
dom Object DOM of the web page being evaluated
dom_cache Object DOMCache object used for evaluation
Source:
  • scripts/evaluation_result.js, line 8

Methods

<static> getCacheItemsByElementType(element_type, filter) → {FilteredCacheItemResults}

Returns an object containing a set of cache items based on the element type and evaluation results

Parameters:
Name Type Description
element_type Number Number representing the element type
filter Number Number representing the evaluation results filter
Source:
  • scripts/evaluation_result.js, line 359
Returns:
The object containing the set of cache items
Type
FilteredCacheItemResults

<static> getCacheItemsByRuleCategory(rule_category, filter) → {FilteredCacheItemResults}

Returns an object containing a set of cache items based on their evaluation results and rule category

Parameters:
Name Type Description
rule_category Number Number representing the rule category
filter Number Number representing the evaluation results filter
Source:
  • scripts/evaluation_result.js, line 383
Returns:
The object containing the set of cache items
Type
FilteredCacheItemResults

<static> getDate() → {String}

Get the date the document

Source:
  • scripts/evaluation_result.js, line 176
Returns:
String representing the title
Type
String

<static> getDocumentObject() → {Object}

Get the document object evaluated

Source:
  • scripts/evaluation_result.js, line 104
Returns:
Document object
Type
Object

<static> getFilteredRuleResultsByGuideline(guideline_id, filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules associated with a WCAG 2.0 Guideline

Parameters:
Name Type Description
guideline_id Number Number representing the guideline id
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 987
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByGuidelines(filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules organized in a tree structure by WCAG 2.0 Guidelines

Parameters:
Name Type Description
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1023
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByPrinciple(principle_id, filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules associated with a WCAG 2.0 Principle

Parameters:
Name Type Description
principle_id Number Number representing the principle id
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 898
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByPrinciples(filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules organized in a tree structure by WCAG 2.0 Principles

Parameters:
Name Type Description
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 933
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByRuleCategories(filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules organized in a tree structure by rule category

Parameters:
Name Type Description
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1599
Returns:
The object containing the filtered rule results organized by rule categories
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByRuleCategory(category, filter) → {FilteredRuleResultsGroup}

Returns an object containing a set of all rule results for a set of rule categories

Parameters:
Name Type Description
category Number Number of bit mask for which rule groups to include in the group
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1668
Returns:
The object containing the filtered rule results
Type
FilteredRuleResultsGroup

<static> getFilteredRuleResultsByRuleSummary(option, filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of all rule results for a set of rule categories

Parameters:
Name Type Description
option Number Number representing the type of summary
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1696
Returns:
The object containing the filtered rule results
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByRuleType(filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules organized in a tree structure by rule type, defined in a ruleset

Parameters:
Name Type Description
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1563
Returns:
The object containing the filtered rule results that include tirage rules
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsBySuccessCriteria(filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules organized in a tree structure by WCAG 2.0 Success Criteria

Parameters:
Name Type Description
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1149
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsBySuccessCriterion(success_criterion_id, filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules associated with a WCAG 2.0 Success Criterion

Parameters:
Name Type Description
success_criterion_id Number Number representing the success criterion id
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 1111
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getFilteredRuleResultsByWCAG20(filter) → {FilteredRuleResultsGroups}

Returns an object containing a set of rules organized in a tree structure by WCAG 2.0 Principles, Guidelines and Success Criteria

Parameters:
Name Type Description
filter Number Filter for node results (bit mapped mask)
Source:
  • scripts/evaluation_result.js, line 408
Returns:
The object containing the filtered rule results organized by wcag 2.0 requirements
Type
FilteredRuleResultsGroups

<static> getNumberOfRecommendedRules() → {Number}

Return number of recommended rules

Source:
  • scripts/evaluation_result.js, line 292
Returns:
Number of recommended rules in the ruleset
Type
Number

<static> getNumberOfRequiredRules() → {Number}

Return number of required rules

Source:
  • scripts/evaluation_result.js, line 278
Returns:
Number of required rules in the ruleset
Type
Number

<static> getNumberOfRules() → {Number}

Return total number of rules

Source:
  • scripts/evaluation_result.js, line 306
Returns:
Total number of rules in the ruleset
Type
Number

<static> getPageInfo() → {PageInfo}

Return information on the web page evaluated

Source:
  • scripts/evaluation_result.js, line 133
Returns:
PageInfo object
Type
PageInfo

<static> getResultSummary() → {ResultSummary}

Gets numerical summary information about the rule results

Source:
  • scripts/evaluation_result.js, line 321
Returns:
Returns the ResultSummary object
Type
ResultSummary

<static> getRuleResultById() → {RuleResult}

Gets rule result object with the associated id

Source:
  • scripts/evaluation_result.js, line 336
Returns:
Returns the ResultResult object
Type
RuleResult

<static> getRulesetAuthor() → {String}

Return the author of the ruleset

Source:
  • scripts/evaluation_result.js, line 249
Returns:
String representing the author
Type
String

<static> getRulesetAuthorURL() → {String}

Return the author url of the ruleset

Source:
  • scripts/evaluation_result.js, line 263
Returns:
String representing the author url
Type
String

<static> getRulesetDescription() → {String}

Return the description of the ruleset

Source:
  • scripts/evaluation_result.js, line 235
Returns:
String representing the version
Type
String

<static> getRulesetId() → {String}

Return id of the ruleset

Source:
  • scripts/evaluation_result.js, line 193
Returns:
String representing the ruleset ID
Type
String

<static> getRulesetInfo() → {RulesetInfo}

Return ruleset of information

Source:
  • scripts/evaluation_result.js, line 119
Returns:
RulesetInfo object
Type
RulesetInfo

<static> getRulesetTitle() → {String}

Return title of the ruleset

Source:
  • scripts/evaluation_result.js, line 207
Returns:
String representing the NLS title
Type
String

<static> getRulesetVersion() → {String}

Return version of the ruleset

Source:
  • scripts/evaluation_result.js, line 221
Returns:
String representing the version
Type
String

<static> getTitle() → {String}

Get the title of the evaluated document

Source:
  • scripts/evaluation_result.js, line 148
Returns:
String representing the title
Type
String

<static> getURL() → {String}

Get the url of the evaluated document

Source:
  • scripts/evaluation_result.js, line 162
Returns:
String representing the title
Type
String

<static> isSameDocument(document, True)

Determines if a window document property is the one for this evaluation

Parameters:
Name Type Description
document Object Document Object Model (DOM) to be analyzed
True Boolean if the same document, false if not
Source:
  • scripts/evaluation_result.js, line 1751

<static> toJSON(node_results_option) → {String}

Creates a string representing the evaluation results in a JSON format

Parameters:
Name Type Description
node_results_option Boolean Optional param, if false then node results are not included in the JSON file
Source:
  • scripts/evaluation_result.js, line 1770
Returns:
Returns a string in JSON format
Type
String