AxiomaPlugin - Модуль ГИС «Аксиома»¶

class axipy.AxiomaPlugin¶

Базовые классы: axipy.interface.AxiomaInterface

Модуль для ГИС Аксиома.

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

Примечание

Не переопределяйте конструктор. Переопределяйте метод load().

См.также

Подробнее в главе Модули (Плагины).

Methods:

`active_tool_panel`()	Возвращает экземпляр панели активного инструмента.
`create_action`(title, on_click[, icon, …])	Создает кнопку с действием.
`create_separator`()	Создает разделитель.
`create_tool`(title, on_click[, icon, …])	Создает кнопку с инструментом.
`get_position`(tab, group)	Возвращает положение в меню.
`load`()	Загружает модуль.
`local_file`(*paths)	Возвращает путь к файлу/папке относительно модуля.
`tr`(text)	Ищет перевод строки.
`unload`()	Выгружает модуль.
`user_plugin_data_dir`([file_name])	Возвращает каталог, в котором находится изменяемые данные модуля.
`user_plugin_dir`([file_name])	Возвращает каталог данного модуля.
`window`()	Возвращает главное окно ГИС Аксиома.

Attributes:

`catalog`	Хранилище объектов данных.
`io`	Класс открытия/создания объектов данных.
`language`	Значение языка, с которым запущено приложение.
`menubar`	Объект с функциями меню главного окна ГИС Аксиома.
`notifications`	Отправление уведомлений в виде всплывающего окна.
`settings`	Настройки модуля.

active_tool_panel()¶

Возвращает экземпляр панели активного инструмента.

Тип результата: ActiveToolPanel
Результат: Менеджер для управления панелью активного инструмента.

property catalog¶

Хранилище объектов данных.

Тип результата: DataManager

create_action(title, on_click, icon='', enable_on=None, tooltip=None, doc_file=None)¶

Создает кнопку с действием.

Параметры

title (str) – Текст.
on_click (Callable[[], Any]) – Действие на нажатие.
icon (Union[str, QIcon]) – Иконка. Может быть путем к файлу или адресом ресурса.
enable_on (Union[str, DefaultKeys, None]) – Идентификатор наблюдателя для определения доступности кнопки.
tooltip (Optional[str]) – Строка с дополнительной короткой информацией по данному действию.
doc_file (Optional[str]) – Относительная ссылка на файл документации. Расположение рассматривается по отношению к каталогу documentation.

Тип результата

ActionButton

Результат

Кнопка с действием.

См.также

axipy.da.StateManager.

Примечание

То же, что и axipy.menubar.ActionButton, но дополнительно делает идентификатор кнопки уникальным для данного модуля.

create_separator()¶

Создает разделитель.

Тип результата: Separator

create_tool(title, on_click, icon='', enable_on=None, tooltip=None, doc_file=None)¶

Создает кнопку с инструментом.

Параметры

title (str) – Текст.
on_click (Callable[[], MapTool]) – Класс инструмента.
icon (Union[str, QIcon]) – Иконка. Может быть путем к файлу или адресом ресурса.
enable_on (Union[str, DefaultKeys, None]) – Идентификатор наблюдателя для определения доступности кнопки.
tooltip (Optional[str]) – Строка с дополнительной короткой информацией по данному действию.
doc_file (Optional[str]) – Относительная ссылка на файл документации. Расположение рассматривается по отношению к каталогу documentation.

Тип результата

ToolButton

Результат

Кнопка с инструментом.

См.также

class:axipy.da.StateManager.

Примечание

То же, что и axipy.menubar.ToolButton, но дополнительно делает идентификатор кнопки уникальным для данного модуля.

get_position(tab, group)¶

Возвращает положение в меню. Может заранее не существовать.

Параметры

tab (str) – Название вкладки.
group (str) – Название группы.

Тип результата

Position

Результат

Положение для кнопки.

Примечание

Дублирует axipy.menubar.Position.

property io¶

Класс открытия/создания объектов данных.

Тип результата: ProviderManager

property language¶

Значение языка, с которым запущено приложение.

Тип результата: str

load()¶

Загружает модуль.

Переопределяйте этот метод для задания логики модуля.

local_file(*paths)¶

Возвращает путь к файлу/папке относительно модуля.

Параметры: *path – Составные относительного пути.
Тип результата: str
Результат: Абсолютный путь.

Пример:

plugin_path = iface.local_file()
icon_path = iface.local_file('images', '32px', 'logo.png')

property menubar¶: Объект с функциями меню главного окна ГИС Аксиома.

См.также

axipy.menubar

property notifications¶

Отправление уведомлений в виде всплывающего окна.

Type: Notifications

property settings¶

Настройки модуля.

Позволяет сохранять и загружать параметры.

См.также

Подробнее в документации на класс PySide2.QtCore.QSettings.

Тип результата: QSettings

tr(text)¶

Ищет перевод строки.

Производит поиск строки в загруженных файлах перевода.

Параметры: text (str) – Строка для перевода.
Тип результата: str
Результат: Перевод стоки, если строка найдена. Иначе - сама переданная строка.

Пример:

button_name = iface.tr('My button')

unload()¶

Выгружает модуль.

Переопределяйте этот метод для очистки ресурсов.

user_plugin_data_dir(file_name='')¶

Возвращает каталог, в котором находится изменяемые данные модуля. Расположение определяется в подкаталоге installed_plugins_data, расположенном на один уровень вверх по отношению к каталогу самого модуля plugin_dir().

Параметры: file_name (str) – Если параметр указан, возвращается полный путь файла в данном каталоге.
Тип результата: str

user_plugin_dir(file_name='')¶

Возвращает каталог данного модуля.

Параметры: file_name (str) – Если параметр указан, возвращается полный путь файла в каталоге модуля.
Тип результата: str

window()¶

Возвращает главное окно ГИС Аксиома.

Тип результата: QMainWindow