1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/Tencent-vConsole

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
public_properties_methods.md 8.9 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 10.03.2025 04:58 3421616

Открытые свойства и методы

Некоторые полезные свойства и методы vConsole доступны для разработки плагинов.


Статические свойства


VConsole.instance

Получает текущий экземпляр vConsole, который является единственным экземпляром. Возвращает undefined, если он ещё не был создан.


VConsole.VConsolePlugin

Прототип пользовательского плагина. Подробнее см. Плагины: Начало работы.


Экземплярные свойства


vConsole.version

Текущая версия vConsole.

  • Только для чтения
  • Тип: строка

Пример:

vConsole.version // => "3.11.0"

vConsole.option

Конфигурационный объект.

  • Изменяемый
  • Тип: объектКлюч | Тип | Необязательный | Значение по умолчанию | Описание ----------------------- | --------- | -------------- | ---------------------------------------------------- | ----------------- defaultPlugins | Массив(строка) | true | ['system', 'network', 'element', 'storage'] | Указанные встроенные плагины будут инициализированы и загружены в vConsole. pluginOrder | Массив(строка) | true | [] | Панели плагинов будут отсортированы согласно этому списку. Плагины, не указанные в списке, будут расположены последними. onReady | Функция | true | | Вызывается после того, как vConsole будет инициализирован и загружен список по умолчанию. disableLogScrolling | Логический | true | | Если false, панель не будет прокручиваться до нижней части при выводе новых логов. тема | Строка | true | 'light' | Тема оформления, 'light' | 'dark'. целевой_элемент | Строка, HTMLElement | true | document.documentElement | Элемент HTMLElement или строковый селектор CSS для рендера. log.maxLogNumber | Число | true | 1000 | При достижении этого значения старые логи будут удалены из панели логов. log.showTimestamps | Логический | true | false | Отображение меток времени для логов. network.maxNetworkNumber | Число | true | 1000 | При достижении этого значения старые запросы будут удаляться из панели сети. network.ignoreUrlRegExp | Объект регулярного выражения | true | | Пропускаются запросы, чьи URL совпадают с этим регулярным выражением. storage.defaultStorages | Массив | true | ['cookies', 'localStorage', 'sessionStorage'] | Указанные хранилища будут доступны в панели хранения. Пример:```javascript // получить vConsole.option // => {...} // установить ключ только vConsole.setOption('log.maxLogNumber', 5000); // перезаписать объект 'log' vConsole.setOption({ log: { maxLogNumber: 5000 } });

---

## Методы

---

### vConsole.setOption(keyOrObj[, value])

Обновляет `vConsole.option`.

##### Параметры:
- (обязательный) keyOrObj: Ключ опции или объект с ключами и значениями.
- (необязательный) value: Значение опции.

##### Возвращаемое значение:
- Ничего

##### Пример:

```javascript
vConsole.setOption('maxLogNumber', 5000);
// или:
vConsole.setOption({ maxLogNumber: 5000 });

vConsole.setSwitchPosition(x, y)

Обновляет позицию кнопки переключения.

Параметры:
  • (обязательный) x: Координата X, начало координат находится в правом нижнем углу экрана.
  • (обязательный) y: Координата Y, начало координат находится в правом нижнем углу экрана.
Возвращаемое значение:
  • Ничего
Пример:
vConsole.setSwitchPosition(20, 20);

vConsole.destroy()

Уничтожает экземпляр объекта vConsole и удаляет панель vConsole из документа.

Параметры:
  • Ничего
Возвращаемое значение:
  • Ничего
Пример:
var vConsole = new VConsole();
// ... выполните какие-либо действия
vConsole.destroy();

vConsole.addPlugin(plugin)

Добавляет новый плагин к vConsole. Дублирование плагина будет игнорировано.

Параметры:
  • (обязательный) plugin: Объект VConsolePlugin.
Возвращаемое значение:
  • Логическое значение: true, если успешно, false, если неудачно.
Пример:```javascript

var myPlugin = new VConsolePlugin('my_plugin', 'Мой плагин'); vConsole.addPlugin(myPlugin);


---

### vConsole.removePlugin(pluginID)

Удаляет существующий плагин.

##### Параметры:
- (обязательный) pluginID: Строка, идентификатор плагина.

##### Возвращаемое значение:
- Логическое значение: `true`, если успешно, `false`, если неудачно.

##### Пример:

```javascript
vConsole.removePlugin('my_plugin');

vConsole.showPlugin(pluginID)

Активирует панель согласно её идентификатору плагина.

Событие плагина hide будет вызвано для предыдущей активной панели, а событие show — для текущей активной панели.

Параметры:
  • (обязательный) pluginID: Строка, идентификатор плагина панели.
Возвращаемое значение:
  • Ничего
Пример:
vConsole.showPlugin("system"); // показать панель системы

vConsole.show()

Отображает панель vConsole. Этот метод вызывает событие плагина showConsole.

Параметры:
  • Нет
Возвращаемое значение:
  • Нет
Пример:
vConsole.show();

vConsole.hide()

Скрывает панель vConsole. Этот метод вызывает событие плагина hideConsole.

Параметры:
  • Нет
Возвращаемое значение:
  • Нет
Пример:
vConsole.hide();

vConsole.showSwitch()

Отображает кнопку переключения vConsole.

Параметры:
  • Нет
Возвращаемое значение:
  • Нет
Пример:
vConsole.showSwitch();

vConsole.hideSwitch()

Скрывает кнопку переключения vConsole.

После того как кнопка скрыта, пользователь не сможет вызывать vConsole вручную. Кнопку или панель можно отобразить программно с помощью vConsole.showSwitch() или vConsole.show().##### Параметры:

  • Нет
Возвращаемое значение:
  • Нет
Пример:
vConsole.hideSwitch();

Назад к содержанию

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/Tencent-vConsole.git
git@api.gitlife.ru:oschina-mirror/Tencent-vConsole.git
oschina-mirror
Tencent-vConsole
Tencent-vConsole
dev