new HeadingElement(dom_element)
Creates a heading element object used to hold information about a h1 - h6 heading elements
Parameters:
Name | Type | Description |
---|---|---|
dom_element |
DOMelement | The dom element object representing the heading element |
- Source:
- scripts/cache_headings_landmarks.js, line 1066
Properties:
Name | Type | Description |
---|---|---|
dom_element |
DOMElement | Reference to the dom element representing the optgroup element |
cache_id |
String | String that uniquely identifies the cache element object in the cache |
document_order |
Number | Ordinal position of the heading element in the document in relationship to other heading elements |
parent_landmark |
Object | Cache item object that is the parent landmark element (note: can be null) |
level |
Number | Level of the heading |
name |
String | Calculated accessible name of the heading |
name_length |
Number | Length of accessible name |
name_for_comparison |
String | Accessible name for comparison (i.e. lowercase, trimmed and space normalized) |
name_from_text_nodes |
String | Accessible name content from text nodes |
name_from_image_alt |
String | Accessible name content from alt content of images |
image_count |
Number | Number of images that are descendents of the link |
text_only_from_image |
Boolean | true if accessble name is onky from an image, otherwise false |
Methods
-
<static> getAttributes(unsorted) → {Array}
-
Returns an array of attributes for the element, sorted in alphabetical order
Parameters:
Name Type Description unsorted
Boolean If defined and true the results will NOT be sorted alphabetically - Source:
- scripts/cache_headings_landmarks.js, line 1174
Returns:
Returns a array of attribute display object- Type
- Array
-
<static> getCacheProperties(unsorted) → {Array}
-
Returns an array of cache properties sorted by property name
Parameters:
Name Type Description unsorted
Boolean If defined and true the results will NOT be sorted alphabetically - Source:
- scripts/cache_headings_landmarks.js, line 1198
Returns:
Returns a array of cache property display object- Type
- Array
-
<static> getCachePropertyValue(property) → {String|Number}
-
Returns the value of a property
Parameters:
Name Type Description property
String The property to retreive the value - Source:
- scripts/cache_headings_landmarks.js, line 1229
Returns:
Returns the value of the property- Type
- String | Number
-
<static> getEvents() → {Array}
-
Returns an array of events for the element, sorted in alphabetical order
- Source:
- scripts/cache_headings_landmarks.js, line 1253
Returns:
Returns a array of event item display objects- Type
- Array
-
<static> getNodeResults() → {Array}
-
Returns an array of node results in severity order
- Source:
- scripts/cache_headings_landmarks.js, line 1144
Returns:
Returns a array of node results- Type
- Array
-
<static> getStyle() → {Array}
-
Returns an array of style items
- Source:
- scripts/cache_headings_landmarks.js, line 1158
Returns:
Returns a array of style display objects- Type
- Array
-
<static> toString() → {String}
-
Returns a text string representation of the heading (h1-h6) element
- Source:
- scripts/cache_headings_landmarks.js, line 1271
Returns:
Returns string represention the heading element object- Type
- String