Evaluation Library API: Information and Summary Objects
From MemberWiki
Accessibility Home | Downloads | Evaluation Library Objects and APIs | Rule Format | Issue Tracker
Evaluation Library API: Evaluation Objects | Result Objects | Information and Summary Objects
Contents |
Overview
The objects covered here are simple JavaScript objects that only provide properties (i.e., no constructors or methods). Conceptually, they fall into two groups:
1. Results-related objects
2. Evaluation-related objects
RuleResultsSummary object
RuleResultsSummary JSDoc documentation
An object that contains:
- Count information about the rule result values for a group of rules
RuleResultsSummary properties
| Property | Type | Description |
|---|---|---|
| violations | Number | Number of rule results with the result of violation |
| warnings | Number | Number of rule results with the result of warning |
| manual_checks | Number | Number of rule results with the result of manual check |
| passed | Number | Number of rule results with the result of passed |
| not_applicable | Number | Number of rule results with the result of not applicable |
| implementation_score | Number | Number of rule results with the result of passed:
|
| mplementation_value | Number | Number with a value between 0 and 100 that indicates the level of implementation of the rule:
|
ElementResultsSummary object
ElementResultsSummary JSDoc documentation
An object that contains:
- Count information about the element result values for a group of rules
ElementResultsSummary properties
| Property | Type | Description |
|---|---|---|
| violations | Number | Number of element results that are a violation |
| warnings | Number | Number of element results that are a warning |
| manual_checks | Number | Number of element results that require a manual check |
| passed | Number | Number of element results that passed |
| hidden | Number | Number of elements that a rule applied by the element was not evaluated because it was hidden |
ElementInfo object
ElementInfo JSDoc documentation
An object that contains:
- NLS localized name of an element property
- value of an element property
ElementInfo properties
| Property | Type | Description |
|---|---|---|
| name | String | Name of element attribute or property |
| value | String | Value of element attribute or property |
| description | String | Description of attribute or property |
RelatedElementInfo object
RelatedElementInfo JSDoc documentation
An object that contains:
- Element tag and/or attribute information use to identify the element
- Reference to the live DOM node in the web page
RelatedElementInfo properties
| Property | Type | Description |
|---|---|---|
| element_identifier | String | A string that identifies the element which can include a key attribute or key property like an ID attribute |
| dom_node | DOM Node | DOM node pointer of the element in the document object |
RulesetInfo object
RulesetInfo JSDoc documentation
An object that contains:
- Title of ruleset
- Author of the the ruleset
- Date the ruleset was last updated
- URL to more information about a ruleset
- Description of ruleset goals and requirements
RulesetInfo properties
| Property | Type | Description |
|---|---|---|
| title | String | The title of the ruleset |
| description | String | A description of the goals and requirements of the ruleset |
| abbrev | String | An abbreviation of the ruleset title |
| tooltip | String | A string that provides more information about the ruleset (typically longer than the title, but shorter than the description) |
| version | String | The version identifier of the ruleset |
| date | String | The date the ruleset was last updated |
| url | String | The URL to more information on the ruleset |
| author_name | String | The name of the person or group that created the ruleset |
| author_url | String | A URL to more information about the author |
| num_rules_required | Number | The number of required rules in the ruleset |
| num_rules_recommended | Number | The number of recommended rules in the ruleset |
| num_rules_total | Number | The total number of rules in the ruleset |
RuleCategoryInfo object
RuleCategoryInfo JSDoc documentation
An object that contains information about a particular Rule Category.
RuleCategoryInfo properties
| Property | Type | Description |
|---|---|---|
| title | String | The title of the rule category |
| description | String | A description of the goals and requirements of the rule category |
| url | String | The URL to more information on the rule category |
RuleGroupInfo object
RuleGroupInfo JSDoc documentation
An object that contains information about the group of rules associated with a Rule Category, a WCAG Guideline or a RuleGroupResult object in the context of a Ruleset.
RuleGroupInfo properties
| Property | Type | Description |
|---|---|---|
| title | String | A title identifying the rule group |
| description | String | An extended description of the rule group |
| url | String | The URL to more information on a group (e.g. W3C Specification) |
| num_rules_required | number | Number of required rules in the group |
| num_rules_recommended | number | Number of recommended rules in the group |
| num_rules_total | number | Total number of rules in the group |
InformationalLinkInfo object
InformationalLinkInfo JSDoc documentation
An object that contains properties from which an informational link can be constructed that references additional rule-related information.
InformationalLinkInfo properties
| Property | Type | Description |
|---|---|---|
| title | String | Title identifying the information related to the rule |
| url | String | The URL to the rule-related information |
| reference_type | Number | A number that represents the type of additional rule information being provided by the link:
|
GuidelineInfo object
GuidelineInfo JSDoc documentation
An object that contains information about a particular WCAG Guideline.
GuidelineInfo properties
| Property | Type | Description |
|---|---|---|
| id | String | id identifying a guideline (e.g. 1.1, 2.2..) |
| title | String | The title of the guideline |
| description | String | A description of the guideline |
| url | String | The URL to more information on the guideline |
SuccessCriterionInfo object
SuccessCriterionInfo JSDoc documentation
An object that contains:
- Success Criterion Level (e.g. A, AA or AAA)
- Title of WCAG 2.0 requirements
- Description of the requirement
- URL to more information about the requirement
SuccessCriterionInfo properties
| Property | Type | Description |
|---|---|---|
| id | String | id identifying a success criterion number (e.g. 1.1.1) |
| title | String | Title describing the success criterion (e.g. 1.1.1 Non-text Content Primary) |
| description | String | Longer description of the success criterion |
| level | Number | A constant defining the success criteria level:
|
| level_nls | String | A string defining the success criteria level:
|
| url_spec | String | URL to the WCAG 2.0 specification |
| url_how_to_meet | String | URL to the WCAG 2.0 techniques and failure conditions to meet or violate the requirements |
| url_understand | String | URL to more information on the requirements of the success criteria |
