Class Elements

Index

Properties

invisibleElementsEnabled searchContextMode

Methods

findBySystemName findByTag findByTagName findByTagNames findByTags getContextElement getFirstById getFirstByIdOrNull getFirstBySystemName getFirstBySystemNameOrNull getFirstByTag getFirstByTagName getFirstByTagNameOrNull getFirstByTagNames getFirstByTagOrNull getFirstByTags setContextElement

Properties

`Static`invisibleElementsEnabled

invisibleElementsEnabled: boolean

Sets whether searching of invisible elements are enabled.

`Static`searchContextMode

searchContextMode: SearchContextMode

Sets the context in which elements are searched. Default is GLOBAL

Methods

`Static`findBySystemName

findBySystemName(systemName: string): DocumentElement[]
Finds elements with specified systemName.
Parameters
- systemName: string
  System name of element.
Returns DocumentElement[]
Elements with matching system name.
- Defined in project.d.ts:61

`Static`findByTag

findByTag(tag: Tag): DocumentElement[]
Finds all elements in the container that have specified tag.
Parameters
- tag: Tag
  Searched tag.
Returns DocumentElement[]
Array of elements.
- Defined in project.d.ts:33

`Static`findByTagName

findByTagName(tagName: string): DocumentElement[]
Finds all elements in the container that have tag with specified name.
Parameters
- tagName: string
  Name of the tag.
Returns DocumentElement[]
Array of elements.
- Defined in project.d.ts:47

`Static`findByTagNames

findByTagNames(tagNames: string[]): DocumentElement[]
Finds all elements in the container that have all tags with specified names.
Parameters
- tagNames: string[]
  Names of the tags.
Returns DocumentElement[]
Array of elements.
- Defined in project.d.ts:54

`Static`findByTags

findByTags(tags: Tag[]): DocumentElement[]
Finds all elements in the container that have all specified tags.
Parameters
- tags: Tag[]
  Searched tags.
Returns DocumentElement[]
Array of elements.
- Defined in project.d.ts:40

`Static`getContextElement

getContextElement(): DocumentElementContainer
Returns specified context element used for reducing the scope of area where elements are searched.

Returns DocumentElementContainer
Element used as a context for reducing search scope, or null if not set.
- Defined in project.d.ts:20

`Static`getFirstById

getFirstById(id: string): DocumentElement
Finds first element in the container that have specified id. Error is thrown if no element is found.
Parameters
- id: string
  element id
Returns DocumentElement
Element with matching tag.
- Defined in project.d.ts:85

`Static`getFirstByIdOrNull

getFirstByIdOrNull(id: string): DocumentElement
Finds first element in the container that have specified id. Null is returned if no element is found.
Parameters
- id: string
  element id
Returns DocumentElement
Element with matching tag.
- Defined in project.d.ts:93

`Static`getFirstBySystemName

getFirstBySystemName(systemName: string): DocumentElement
Finds first element with specified systemName. Error is thrown if no element is found. Error is thrown if no element is found.
Parameters
- systemName: string
  System name of element.
Returns DocumentElement
Element with matching system name.
- Defined in project.d.ts:133

`Static`getFirstBySystemNameOrNull

getFirstBySystemNameOrNull(systemName: string): DocumentElement
Finds first element with specified systemName. Error is thrown if no element is found. Error is thrown if no element is found.
Parameters
- systemName: string
  System name of element.
Returns DocumentElement
Element with matching system name.
- Defined in project.d.ts:141

`Static`getFirstByTag

getFirstByTag(tag: Tag): DocumentElement
Finds first element in the container that have specified tag. Error is thrown if no element is found.
Parameters
- tag: Tag
  Searched tag.
Returns DocumentElement
Element with matching tag.
- Defined in project.d.ts:69

`Static`getFirstByTagName

getFirstByTagName(tagName: string): DocumentElement
Finds first element in the container that have tag with specified name. Error is thrown if no element is found.
Parameters
- tagName: string
  Name of the tag.
Returns DocumentElement
Element with matching tag name.
- Defined in project.d.ts:109

`Static`getFirstByTagNameOrNull

getFirstByTagNameOrNull(tagName: string): DocumentElement
Finds first element in the container that have tag with specified name. Null is returned if no element is found.
Parameters
- tagName: string
  Name of the tag.
Returns DocumentElement
Element with matching tag name.
- Defined in project.d.ts:117

`Static`getFirstByTagNames

getFirstByTagNames(tagNames: string[]): DocumentElement
Finds first element in the container that have all tags with specified names. Error is thrown if no element is found.
Parameters
- tagNames: string[]
  Names of the tags.
Returns DocumentElement
Element with matching system name.
- Defined in project.d.ts:125

`Static`getFirstByTagOrNull

getFirstByTagOrNull(tag: Tag): DocumentElement
Finds first element in the container that have specified tag. Null is returned if no element is found.
Parameters
- tag: Tag
  Searched tag.
Returns DocumentElement
Element with matching tag.
- Defined in project.d.ts:77

`Static`getFirstByTags

getFirstByTags(tags: Tag[]): DocumentElement
Finds first element in the container that have all specified tags. Error is thrown if no element is found.
Parameters
- tags: Tag[]
  Searched tags.
Returns DocumentElement
Element with matching tags.
- Defined in project.d.ts:101

`Static`setContextElement

setContextElement(contextElement?: DocumentElementContainer): void
Sets context element used for reducing the scope of area where elements are searched.
Parameters
- OptionalcontextElement: DocumentElementContainer
  Element used as a context for reducing search scope.
Returns void
- Defined in project.d.ts:26