Документация Melonity

MenuOption ​

MenuOption Класс представляет экземпляр параметра menu и предоставляет API для его чтения, обновления и настройки.

Методы ​

GetOptionID()число ​

Получает идентификатор опции.

Вернулся:

  • число - Идентификатор запрошенной опции.

GetType()Enum.MenuOptionType ​

Получает тип.

Вернулся:

IsFolder()логическое значение ​

Проверяет, является ли это папкой.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

OnChange(func: MenuOptionChangeCallback<T>, initCall?: boolean)этот ​

Зарегистрируйте функцию, которая будет вызываться при изменении значения опции.

  • funcMenuOptionChangeCallback<T> - функция для вызова при изменении значения опции
  • initCallлогическое значение (необязательный) - если true, функция будет вызываться с текущим значением для инициализации, полезной, если регистрация вашей цепочки не заканчивается GetValue (по умолчанию — false)

IMPORTANT

полезно, если регистрация вашей цепочки не заканчивается на GetValue

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

GetValue()Т ​

Получает указанное значение переменной консоли.

Вернулся:

  • Т - Запрошенное значение.

SetValue(value: T)этот ​

Устанавливает указанное значение переменной консоли.

  • valueТ — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetSlotValueByIndex(index: number)логическое значение ​

Получает значение слота по индексу.

  • indexчисло - Индекс.

IMPORTANT

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetSlotValueByIndex(index: number, value: boolean)этот ​

Устанавливает значение слота по индексу.

  • indexчисло - Индекс.
  • valueлогическое значение — Значение, которое нужно установить или использовать.

IMPORTANT

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetSlotValueByKey(key: string)логическое значение ​

Получает значение слота по ключу.

  • keyнить - Ключ.

IMPORTANT

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetSlotValueByKey(key: string, value: boolean)этот ​

Устанавливает значение слота по ключу.

  • keyнить - Ключ.
  • valueлогическое значение — Значение, которое нужно установить или использовать.

IMPORTANT

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetBindedValue(){ value: T } ​

Возвращаемый объект со значением, которое будет обновляться при изменении значения параметра, поможет избежать явной регистрации OnChange.

Вернулся:

  • { value: T } - Запрошенное привязанное значение.

GetPrioritySelectValue()нить[] ​

Получает значение выбора приоритета.

Вернулся:

  • нить[] - Массив с совпадающими значениями.

SetTip(text: string, locale?: LocaleVariant)этот ​

Установите текст, который будет отображаться под опцией

  • textнить - текст для показа
  • localeLocaleVariant (необязательный) - текстовая локаль, по умолчанию «en»

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

SetTip2(text: string, locale?: LocaleVariant)этот ​

Установите текст, который будет отображаться, если вы наведете курсор на опцию

  • textнить - текст для показа
  • localeLocaleVariant (необязательный) - текстовая локаль, по умолчанию «en»

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

SetTip2Title(text: string, locale?: LocaleVariant)этот ​

Установите заголовок, который будет отображаться, если вы наведете курсор на опцию

  • textнить - текст для показа
  • localeLocaleVariant (необязательный) - текстовая локаль, по умолчанию «en»

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

SetTip2Image(imagePath: string)этот ​

Установите изображение, которое будет отображаться, если вы наведете курсор на опцию

  • imagePathнить - путь к изображению

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

SetColumn(value: number)этот ​

Устанавливает столбец.

  • valueчисло - 0 - слева, 1 - справа

IMPORTANT

Это не будет работать, если используется MergeWithNext.

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

GetColumn()число ​

Извлекает столбец.

Вернулся:

  • число - Запрошенный столбец.

SetMergeWithNext(value: boolean)этот ​

Устанавливает слияние со следующим.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

MergeWithNext()этот ​

Объединяет этот параметр со следующим в одной группе.

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

IsMergedWithNext()логическое значение ​

Проверяет, объединено ли оно со следующим.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetTipLocale(locale: LocaleVariant, text: string)этот ​

Устанавливает локаль подсказки.

  • localeLocaleVariant - Локаль для использования.
  • textнить - Текстовое значение.

IMPORTANT

сделайте то же самое, что и SetTip

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetComboBoxLocale(locale: LocaleVariant, values: string[])этот ​

Установить переведенные строковые значения для поля со списком

  • localeLocaleVariant - локаль значений
  • valuesнить[] - массив переведенных значений

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

SetNameLocale(locale: LocaleVariant, name: string)этот ​

Установить переведенное название опции

  • localeLocaleVariant - локаль имени
  • nameнить - переведенное имя

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

SetGeneral(value: boolean)этот ​

Установите этот параметр как общий для своей группы. Если этот параметр отключен, все остальные параметры в группе будут отключены.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

IMPORTANT

работает только с опциями переключения, эта опция должна быть первой в группе

Вернулся:

  • этот - этот экземпляр, позволяющий создавать цепочки методов

IsGeneral()логическое значение ​

Проверяет, является ли оно общим.

IMPORTANT

См. SetGeneral

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetGeneralForTab(value: boolean)этот ​

Устанавливает общие параметры для вкладки.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsGeneralForTab()логическое значение ​

Проверяет, является ли оно общим для вкладки.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetHidden(value: boolean)этот ​

Устанавливает скрытое.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsHidden()логическое значение ​

Проверяет, скрыто ли оно.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetSlotHiddenByIndex(slot: number, value: boolean)этот ​

Устанавливает слот, скрытый индексом.

  • slotчисло - Слот.
  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsSlotHiddenByIndex(slot: number)логическое значение ​

Проверяет, скрыт ли слот по индексу.

  • slotчисло - Слот.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetSlotHiddenByKey(key: string, value: boolean)этот ​

Устанавливает слот, скрытый ключом.

  • keyнить - Ключ.
  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsSlotHiddenByKey(key: string)логическое значение ​

Проверяет, скрыт ли слот ключом.

  • keyнить - Ключ.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

GetName()нить ​

Получает имя.

Вернулся:

  • нить - Запрошенное имя.

GetNameTranslated()нить ​

Получает переведенное имя.

Вернулся:

  • нить - Запрошенное имя переведено.

GetChilds()MenuOption<any>[] ​

Возвращает детей.

Вернулся:

  • MenuOption<any>[] - Массив с совпадающими значениями.

IsKeyDownOnce(checkInputCapture?: boolean)логическое значение ​

Проверяет, была ли указанная клавиша нажата один раз.

  • checkInputCaptureлогическое значение (необязательный) - Захват чека input.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

IsKeyDown(checkInputCapture?: boolean)логическое значение ​

Проверяет, удерживается ли в данный момент указанная клавиша.

  • checkInputCaptureлогическое значение (необязательный) - Захват чека input.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

GetKeyString()нить ​

Получает ключевую строку.

Вернулся:

  • нить - Запрошенная строка ключа.

SetImage(imagePath: string)этот ​

Устанавливает изображение.

  • imagePathнить - Путь изображения.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetDisabled(value: boolean)этот ​

Устанавливает отключенный.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsDisabled()логическое значение ​

Проверяет, отключена ли она.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetSlotDisabledByIndex(slot: number, value: boolean)этот ​

Устанавливает слот, отключенный по индексу.

  • slotчисло - Слот.
  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsSlotDisabledByIndex(slot: number)логическое значение ​

Проверяет, отключен ли слот по индексу.

  • slotчисло - Слот.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetSlotDisabledByKey(key: string, value: boolean)этот ​

Устанавливает слот, отключенный клавишей.

  • keyнить - Ключ.
  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsSlotDisabledByKey(key: string)логическое значение ​

Проверяет, заблокирован ли слот ключом.

  • keyнить - Ключ.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetNoTitle(value: boolean)этот ​

Устанавливает отсутствие заголовка.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

IsNoTitle()логическое значение ​

Проверяет, нет ли заголовка.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetToggleBlockTipsTranslated(locale: LocaleVariant, hints: string[])этот ​

Устанавливает перевод подсказок блока переключения.

  • localeLocaleVariant - Локаль для использования.
  • hintsнить[] - Подсказки.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetNotStrictAlign(value: boolean)этот ​

Устанавливает не строгое выравнивание.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetToggleBlockLocale(locale: LocaleVariant, values: string[])этот ​

Устанавливает локаль блока переключения.

  • localeLocaleVariant - Локаль для использования.
  • valuesнить[] - Значения, которые следует использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetFolderTitleTranslated(locale: LocaleVariant, title: string)этот ​

Устанавливает переведенное название папки.

  • localeLocaleVariant - Локаль для использования.
  • titleнить - Название.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetNotDrawLabelAndHint(value: boolean)этот ​

Устанавливает метку и подсказку о запрете рисования.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

NotDrawLabelAndHint()этот ​

Предоставляет доступ к возможности не рисовать метки и подсказки.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetNotDrawLabelAndHint()логическое значение ​

Получает метку и подсказку о том, что нельзя рисовать.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

SetTabModeForFolder(value: boolean)этот ​

Устанавливает режим вкладок для папки.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetTabModeForFolder()логическое значение ​

Получает режим вкладок для папки.

Вернулся:

  • логическое значение - Истина, если условие выполнено, и ложь в противном случае.

AddAliases(aliases: Array<string>)этот ​

Добавляет псевдонимы.

  • aliasesArray<string> - Псевдонимы.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SaveValue()этот ​

Обеспечивает доступ к сохранению стоимости.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

LoadValue(processCallbacks?: boolean)этот ​

Загружает значение.

  • processCallbacksлогическое значение (необязательный) - Процесс callbacks.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetConfigKey()нить ​

Получает ключ config.

Вернулся:

  • нить - Запрошенный ключ config.

GetGeneratedConfigKey()нить ​

Получает сгенерированный ключ config.

Вернулся:

  • нить - Запрошенный сгенерированный ключ config.

SetOverridenConfigKey(key: string)этот ​

Устанавливает переопределенный ключ config.

  • keyнить - Ключ.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetOrdering(value: number)этот ​

Устанавливает порядок.

  • valueчисло — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

GetOrdering()число ​

Получает заказ.

Вернулся:

  • число - Запрошенный заказ.

SetKeyDown(value: boolean)этот ​

Устанавливает ключ.

  • valueлогическое значение — Значение, которое нужно установить или использовать.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

SetWheelStopReason(stopReason: Enum.WheelStopReason, maxTimePressInS?: number)этот ​

Устанавливает причину остановки колеса.

  • stopReasonEnum.WheelStopReason - Причина остановки.
  • maxTimePressInSчисло (необязательный) - Максимальное время нажатия в сек.

Вернулся:

  • этот - Текущий экземпляр для цепочки.

RemoveOption()пустота ​

Удаляет опцию.