Функции для работы с DOM.
Требует загрузки модуля Dom.
$
y5.Dom.$(id) -> Element — элемент DOM
Сокращение для document.getElementById.
Имя аргумента | Тип | Описание |
---|---|---|
id | String |
XPathSupport
y5.Dom.XPathSupport -> Boolean
Браузер поддерживает запросы с помощью XPath.
cutNode
y5.Dom.cutNode(node)
Удаляет узел из документа и добавляет всех его потомков к его родителю.
Имя аргумента | Тип | Описание |
---|---|---|
node | Node | узел |
em2px
y5.Dom.em2px(em, element) -> Number — результат в px
Преобразовывает значение свойства элемента из em в px.
Имя аргумента | Тип | Описание |
---|---|---|
em | Number | значение в em |
element | Element | элемент (НЕ 'display: none'). |
filterElements
y5.Dom.filterElements(elements, tagName, className, limit) -> Array of Elements — результат фильтрации
Фильтрует список элементов по имени тега и класса.
Имя аргумента | Тип | Описание |
---|---|---|
elements | Array of Elements | список элементов |
tagName | Array, String | имя/имена элемента для проверки ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
limit | Number | лимит количества найденных элементов |
getAncestor
y5.Dom.getAncestor(context, tagName, className) -> Element, null — результат поиска
Возвращает первый элемент-родитель по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getAncestorOrSelf
y5.Dom.getAncestorOrSelf(context, tagName, className) -> Element, null — результат поиска
Возвращает первый элемент-родитель узла и/или самого узла по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getAncestors
y5.Dom.getAncestors(context, tagName, className) -> Array — результат поиска
Возвращает элементы-предки по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getAncestorsOrSelf
y5.Dom.getAncestorsOrSelf(context, tagName, className) -> Array — результат поиска
Возвращает элементы-предки узла и/или самого узла по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getBody
y5.Dom.getBody() -> HTMLElement — элемент body
Возвращает элемент body документа.
getChild
y5.Dom.getChild(context, tagName, className) -> Element, null — результат поиска
Возвращает первый дочерний элемент по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getChildren
y5.Dom.getChildren(context, tagName, className) -> Array — результат поиска
Возвращает дочерние элементы по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getDescendant
y5.Dom.getDescendant(context, tagName, className) -> Element, null — результат поиска
Возвращает первого потомка по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getDescendantOrSelf
y5.Dom.getDescendantOrSelf(context, tagName, className) -> Element, null — результат поиска
Возвращает первого потомка по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getDescendants
y5.Dom.getDescendants(context, tagName, className, limit) -> Array — результат поиска
Возвращает список потомков по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
limit | Number | лимит количества найденных элементов |
getDescendantsOrSelf
y5.Dom.getDescendantsOrSelf(context, tagName, className, limit) -> Array — результат поиска
Возвращает список потомков узла и/или самого узла по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
limit | Number | лимит количества найденных элементов |
getElementByClass
y5.Dom.getElementByClass(className, context) -> Element — узел документа
Возвращает первого потомка с заданным классом.
Эквивалентно вызову getElementsByClass с параметром limit == 1.
Имя аргумента | Тип | Описание |
---|---|---|
className | String | имя класса |
context | Element | контекст поиска (если не указан, то используется document) |
getFollowing
y5.Dom.getFollowing(context, tagName, className) -> Element, null — результат поиска
Возвращает следующие элементы по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getHtml
y5.Dom.getHtml() -> HTMLElement — элемент html
Возвращает элемент html документа.
getNext
y5.Dom.getNext(context, tagName, className) -> Element, null — результат поиска
Возвращает первый следующий элемент по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getOffset
y5.Dom.getOffset(targetElement, relativeElement) -> Array — [левое смещение, верхнее смещение]
Возвращает левое и верхнее смещение одного элемента относительно другого.
Если второй аргумент не указан, то смещение считается от document.
Имя аргумента | Тип | Описание |
---|---|---|
targetElement | Element | Элемент, для которого считается смещение |
relativeElement | Element | Элемент, относительно которого считается смещение |
getPageScrollX
y5.Dom.getPageScrollX() -> Number — позиция прокрутки
Возвращает позицию горизонтальной прокрутки страницы.
getPageScrollY
y5.Dom.getPageScrollY() -> Number — позиция прокрутки
Возвращает позицию вертикальной прокрутки страницы.
getPreceding
y5.Dom.getPreceding(context, tagName, className) -> Element, null — результат поиска
Возвращает предыдущие элементы по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
getPrev
y5.Dom.getPrev(context, tagName, className) -> Element, null — результат поиска
Возвращает первый предыдущий элемент по имени и классу.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
insertAfter
y5.Dom.insertAfter(newElem, refElem) -> Node — вставленный элемент
Вставляет новый элемент после указанного.
Имя аргумента | Тип | Описание |
---|---|---|
newElem | Element | элемент для вставки |
refElem | Element | элемент после которого будет вставлен новый элемент |
Пример:
// - parent // - refElem y5.Dom.insertAfter(newElem, refElem); // - parent // - refElem // - newElem*
insertBefore
y5.Dom.insertBefore(newElem, refElem) -> Node — вставленный элемент
Вставляет новый элемент перед указанным.
Обертка для DOM-функции insertBefore.
Имя аргумента | Тип | Описание |
---|---|---|
newElem | Element | элемент для вставки |
refElem | Element | элемент перед которым будет вставлен новый элемент |
Пример:
// - parent // - refElem y5.Dom.insertBefore(newElem, refElem); // - parent // - newElem* // - refElem
isChild
y5.Dom.isChild(childNode, parentNode) -> Boolean — результат проверки
Проверяет, что элемент является дочерним.
Имя аргумента | Тип | Описание |
---|---|---|
childNode | Element | проверяемый элемент |
parentNode | Element | предполагаемый родитель (если не указан, то используется document) |
offsetLeft
y5.Dom.offsetLeft(targetElement, relativeElement) -> Number — левое смещение
Возвращает левое смещение одного элемента относительно другого.
Если второй аргумент не указан, то смещение считается от document.
Имя аргумента | Тип | Описание |
---|---|---|
targetElement | Element | Элемент, для которого считается смещение |
relativeElement | Element | Элемент, относительно которого считается смещение |
offsetTop
y5.Dom.offsetTop(targetElement, relativeElement) -> Number — верхнее смещение
Возвращает верхнее смещение одного элемента относительно другого.
Если второй аргумент не указан, то смещение считается от document.
Имя аргумента | Тип | Описание |
---|---|---|
targetElement | Element | Элемент, для которого считается смещение |
relativeElement | Element | Элемент, относительно которого считается смещение |
px2em
y5.Dom.px2em(px, element) -> Number — результат в em
Преобразовывает значение свойства элемента из px в em.
Имя аргумента | Тип | Описание |
---|---|---|
px | Number | значение в px |
element | Element | элемент (НЕ 'display: none'). |
px2unit
y5.Dom.px2unit(px, element) -> Number — результат в unit
Преобразовывает значение свойства элемента из px в unit (em, %, in,...).
Имя аргумента | Тип | Описание |
---|---|---|
px | Number | значение в px |
element | Element | элемент (НЕ 'display: none'). |
replaceNode
y5.Dom.replaceNode(element, newElement)
Заменяет один элемент на другой.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | заменяемый |
newElement | Element, String | новый элемент или строка HTML |
testClassName
y5.Dom.testClassName(element, className) -> Boolean — результат проверки
Проверяет имя класса элемента.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | элемент для проверки |
className | String, RegExp | имя класса ('*' - любое имя) |
Пример:
// <div class="foo"/> y5.Dom.testClassName(div, 'foo'); // -> true y5.Dom.testClassName(div, 'bar'); // -> false y5.Dom.testClassName(div, '*'); // -> true
testElement
y5.Dom.testElement(element, tagName, className) -> Boolean — результат проверки
Проверяет элемент на имя и класс.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | проверяемый элемент |
tagName | Array, String | имя/имена элемента для проверки ('*' - любое имя) |
className | String, RegExp | имя класса ('*' - любое имя) |
testTagName
y5.Dom.testTagName(element, tagName) -> Boolean — результат проверки
Проверяет имя элемента.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | элемент для проверки |
tagName | Array, String | имя/имена элемента для проверки ('*' - любое имя) |
Пример:
// <div /> y5.Dom.testTagName(div, 'div'); // -> true y5.Dom.testTagName(div, 'span'); // -> false y5.Dom.testTagName(div, ['div', 'span']); // -> true
textContent
y5.Dom.textContent(element) -> String — текст
Возвращает текстовое содержимое элемента.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | элемент |
unit2px
y5.Dom.unit2px(length, element) -> Number — результат в px
Преобразовывает значение свойства элемента из unit (em, %, in,...) в px.
Имя аргумента | Тип | Описание |
---|---|---|
length | Number | значение в unit |
element | Element | элемент (НЕ 'display: none'). |
viewPort
y5.Dom.viewPort() -> Array — [ширина, высота]
Возвращает размеры видимой области документа.
getParentByClass
Устарело, используйте y5.Dom.getAncestorOrSelf.
y5.Dom.getParentByClass(className, context) -> Element — узел документа
Возвращает первого предка с заданным именем класса.
Имя аргумента | Тип | Описание |
---|---|---|
className | String | имя класса |
context | Element | контекст поиска |
getParentByTagName
Устарело, используйте y5.Dom.getAncestorOrSelf.
y5.Dom.getParentByTagName(context, tagName) -> Element — узел документа
Возвращает первого предка с заданным именем.
Имя аргумента | Тип | Описание |
---|---|---|
context | Element | контекст поиска |
tagName | Array, String | имя элемента ('*' - любое имя) |
getElementByTagName
Устарело, используйте y5.Dom.getDescendant.
y5.Dom.getElementByTagName(tagName, context) -> Element — элемент
Возвращает первого потомка с заданным именем.
Имя аргумента | Тип | Описание |
---|---|---|
tagName | Array, String | имя элемента ('*' - любое имя) |
context | Element | контекст поиска (если не указан, то используется document) |
getElementByTagNameAndClass
Устарело, используйте y5.Dom.getDescendant.
y5.Dom.getElementByTagNameAndClass(tagName, className, context) -> Element — узел документа
Возвращает первого потомка с заданным именем и классом.
Эквивалентно вызову getElementsByTagNameAndClass с параметром limit == 1.
Имя аргумента | Тип | Описание |
---|---|---|
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String | имя класса |
context | Element | контекст поиска (если не указан, то используется document) |
getElementsByClass
Устарело, используйте y5.Dom.getDescendants.
y5.Dom.getElementsByClass(className, context, limit) -> Array of Elements — набор узлов документа
Возвращает потомков с заданным классом.
Имя аргумента | Тип | Описание |
---|---|---|
className | String | имя класса |
context | Element | контекст поиска (если не указан, то используется document) |
limit | Number | ограничить количество элементов |
getElementsByTagName
Устарело, используйте y5.Dom.getDescendants.
y5.Dom.getElementsByTagName(tagName, context) -> Element — элемент
Возвращает первого потомка с заданным именем.
Имя аргумента | Тип | Описание |
---|---|---|
tagName | Array, String | имя элемента ('*' - любое имя) |
context | Element | контекст поиска (если не указан, то используется document) |
getElementsByTagNameAndClass
Устарело, используйте y5.Dom.getDescendants.
y5.Dom.getElementsByTagNameAndClass(tagName, className, context, limit) -> Array of Elements — набор узлов документа
Возвращает потомков с заданным именем и классом.
Имя аргумента | Тип | Описание |
---|---|---|
tagName | Array, String | имя элемента ('*' - любое имя) |
className | String | имя класса |
context | Element | контекст поиска (если не указан, то используется document) |
limit | Number | ограничить количество элементов |
getPropertyValue
Устарело, используйте y5.Elements.getPropertyValue.
y5.Dom.getPropertyValue(element, propname) -> String — значение свойства, например '5px'
Возвращает вычисленное значение CSS-свойства элемента.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | элемент |
propname | String | свойство, например 'margin-left' |
getPropertyValuePx
Устарело, используйте y5.Elements.getPropertyValuePx.
y5.Dom.getPropertyValuePx(element, propname) -> String — значение свойства, например 5
Возвращает вычисленное числовое значение CSS-свойства элемента.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | элемент |
propname | String | свойство, например 'margin-left' |
getStyle
Устарело, используйте y5.Elements.getStyle.
y5.Dom.getStyle(element) -> Object — стили
Возвращает вычисленные стили элемента.
Имя аргумента | Тип | Описание |
---|---|---|
element | Element | элемент |