Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIMouseEvent

Класс представляет собой событие, которое происходит в результате взаимодействия пользователя с мышью. Наиболее частые из таких событий: click, dblclick.

Объект класса передается в обработчик события первым аргументом. Например:

 export function setClickListener(elem: IElement) {
     elem.on('click', (event: UIMouseEvent, form: IMyForm, elem: IElement, item: IElement) => {
         console.log(`Клик ${event.targetElement.name}`);
     });
 }

Hierarchy

Accessors

Methods

Accessors

altKey

  • get altKey(): boolean

  • Это свойство указывает была ли нажата клавиша Alt при возникновении события.

    Returns boolean

button

  • get button(): number

  • Это свойство предоставляет информацию только о том, какая кнопка или несколько кнопок были нажаты или отпущены для инициации события.

    Возвращаемые значения:

    • 0: Нажата основная кнопка. Левая кнопка мыши или переназначенная пользователем другая кнопка
    • 1: Нажата вспомогательная кнопка. Колёсико или средняя кнопка мыши, если она есть
    • 2: Нажата вторичная кнопка. Правая кнопка мыши
    • 3: Нажата четвёртая кнопка мыши. Обычно кнопка браузера Назад
    • 4: Нажата пятая кнопка мыши. Обычно кнопка браузера Вперёд

    Returns number

buttons

  • get buttons(): number

  • Это свойство показывает, какие клавиши мыши (или другого устройства ввода) были нажаты при срабатывании события. Если нажаты несколько кнопок одновременно, значения суммируются, создавая новое значение. Например, если нажата вторая кнопка (2 или 000010 в двоичном коде) вместе со средней (4 или 000100 в двоичном коде), значение будет равно 6 (2 + 4) или 000110 в двоичном коде.

    Возвращаемые значения:

    • 0: Нажата основная кнопка. Левая кнопка мыши или переназначенная пользователем другая кнопка
    • 1: Нажата вспомогательная кнопка. Колёсико или средняя кнопка мыши, если она есть
    • 2: Нажата вторичная кнопка. Правая кнопка мыши
    • 8: Нажата четвёртая кнопка мыши. Обычно кнопка браузера Назад
    • 16: Нажата пятая кнопка мыши. Обычно кнопка браузера Вперёд

    Returns number

ctrlKey

  • get ctrlKey(): boolean

  • Это свойство указывает была ли нажата клавиша Ctrl при возникновении события.

    Returns boolean

currentTargetElement

  • Текущий элемент, который обрабатывает клик в процессе погружения или всплытия

    Returns IElement<IElementEvents>

defaultPrevented

  • get defaultPrevented(): boolean

  • Возвращает логическое значение, указывающее, отменил ли вызов UIMouseEvent.preventDefault() действия элемента по умолчанию.

    Returns boolean

metaKey

  • get metaKey(): boolean

  • Это свойство указывает была ли нажата клавиша Meta при возникновении события.

    Returns boolean

onServer

  • get onServer(): boolean

  • Возвращает true, если выполняется на сервере (при Server Side Rendering) и false если выполняется на клиенте.

    Returns boolean

propagation

  • get propagation(): boolean

  • Возвращает логическое значение, указывающее, отменил ли вызов UIEvent.stop() распространение события. Отмена распространения propagation == false.

    Returns boolean

serverSideRendering

  • get serverSideRendering(): boolean

  • Возвращает true, если использовался Server Side Rendering иначе false.

    Returns boolean

shiftKey

  • get shiftKey(): boolean

  • Это свойство указывает была ли нажата клавиша Shift при возникновении события.

    Returns boolean

stopped

  • get stopped(): boolean

  • Возвращает логическое значение, указывающее, отменил ли вызов UIEvent.stop() распространение события.

    Returns boolean

target

  • get target(): HTMLElement

  • Ссылка на HTMLElement, на котором было совершено событие.

    Returns HTMLElement

targetElement

  • Элемент IElement, на котором произошло событие

    Returns IElement<IElementEvents>

Methods

preventDefault

  • preventDefault(): void

  • Отменяет действие по умолчанию элемента управления на форме. Например, выделение строки в списке. Событие продолжает распространяться как обычно, если только один из его прослушивателей событий не вызовет stopPropagation().

    Returns void

stop

  • stop(): void

  • Предотвращает дальнейшее распространение текущего события.

    Returns void

stopPropagation

  • stopPropagation(): void

  • Предотвращает дальнейшее распространение текущего события на этапах погружения и всплытия. Однако это не предотвращает возникновение любого поведения по умолчанию; например, строки списка продолжат выделяться. Если вы хотите остановить такое поведение, см. preventDefault() метод. Это также не предотвращает распространение на другие обработчики событий текущего элемента.

    Returns void

Generated using TypeDoc