API галереи iload
Галерея обладает собсвенным программным интерфейсом который поможет вам расширить её функции и ещё точнее настроить галерею для своих нужд. Функции галереи помогут вам создать на своих сайтах различные всплывающие окна, уведомления. Вы легко сможете написать свой плагин к примеру для открытия фреймов в окне галереи или сделать такое меню управления изображениями что можно будет легко переключаться с одного на другое изображение в сете. Ниже подробно рассмотрены все доступные функции и переменные. они позволят управлять настройками галереи, изменять различные её участки без перезагрузки текущей страницы.
| Объект | Тип | Описание |
| L.animating | boolean | Принимает положительное значение пока галерея анимируется каким либо образом. Например меняет размер, центрируется, открывается или закрывается |
| L.opened | boolean | Принимает положительное значение если галерея в данный момент открыта или начала процесс открытия |
| L.bigPanelOpened | boolean | Принимает положительное значение если в данный момент открыта большая панель |
| L.ready | boolean | Принимает положительное значение после того как галерея развернет свой код на странице и инициализирует нужные для работы события. |
| L.size | string | Параметр, отвечающий за размер открываемой фотографии. Может иметь три значения: "default" - размер изображения устанавливается в зависимости от настройки галереи, "computed" - изображение подстроится под размер экрана независимо от других настроек, и "original" - изображение откроется в оригинальном размере независимо от других настроек |
| L.data | array | Содержит массив данных текущего сета. Каждый элемент массива - строка с адресом, названием и описание изображения, разделенная знаком-разделителем, указанным в настройках |
| L.setName | string | Содержит название текущего сета |
| L.imageName | string | Содержит название текущего изображения |
| L.imageDesc | string | Содержит описание текущего изображения |
| L.cursorPosition | number | Пересчитывается в реальном времени и отражает положение мыши в данный момент:0 - над левой частью изображения при условии что возможен переход на предыдущую фотографию, 1 - над правой частью изображения при условии что возможен переход на следующую фотографию, 2 - вне изображения или над неактивной частью изображения. Благодаря этой технологии, изображение не перекрывается другими элементами и всегда доступно для взаимодействия с контекстным меню |
| L.num | number | Содержит номер текущего изображения в сете начиная с единицы или 0, если ни одно изображение не было открыто с момента загрузки страницы или пересоздания кода галереи. В противном случае хранит номер последнего открытого изображения. |
| L.slideshow | boolean | Если переменная положительна, то после открытия любой фотографии запустится таймер переключения на следующее фото. Технически - ключевой элемент слайдшоу. |
| L.imagePrev | object | Ссылается на элемент предыдущего изображения если таковое присутствует |
| L.imageNext | object | Ссылается на элемент следующего изображения если таковое присутствует |
| L.imageThis | object | Ссылается на элемент текущего изображения |
| L.total | number | Содержит количество фотографий в сете начиная с единицы |
| L | string | В качестве строки функция L возвращает стандартный закрытый код |
Далее перечисляются функции галереи, которые доступны пользователю. В квадратных скобках указаны необязательные аргументы. Аргумент callback принимает функцию, которая будет выполнена по завершении основной функции.
| Функция | Описание |
| L.animate(object, {param:value[,param:value]}, time[,callback]) | Функция анимирования элементов галереи. Первый аргумент принимает ссылку на анимируемый элемент. Второй аргумент представляет собой объект, содержащий ключи и значения анимируемых параметров. Третий аргуент - время анимации в миллисекундах. Допустимые параметры: marginTop, marginLeft, width, height, top, left, right, bottom, opacity. При попытке повторно анимировать анимируемый в данный момент параметр одного и того же элемента, новая анимация сначала завершит старую. |
| L.cInfo(1/2/3/4) | Функция вернет данные о клиентском окне в зависимости от переданного параметра. Доступна исключительно потому, что используется в css expression для IE6 |
| L.current() | Перезагрузит текущую фотографию. Обратите внимание что даже после закрытия галереи текущая фотография, как и все её данные, запоминается. |
| L.next() | Откроет следующую фотографию в сете |
| L.previous() | Откроет предыдущую фотографию в сете |
| L.first() | Откроет первую фотографию в сете |
| L.last() | откроет последнюю фотографию в сете |
| L.play() | Запускает слайдшоу |
| L.stop() | Останавливает слайдшоу и перезагружает текущую фотографию чтобы обновит кнопки на панелях |
| L.computed() | Откроет текущую фотографию, подогнав её под размеры экрана |
| L.original() | Откроет текущую фотографию в натуральный размер |
| L.openPanel([param]) | Откроет большую панель. Если параметр положителен, так же покажет кнопку размерных режимов |
| L.closePanel([callback][,param]) | Закроет большую панель если настройка L.hidePanelWhenScale или если второй аргумент положителен |
| L.openSize([callback]) | Открывает кнопку размерных режимов на большой панели |
| L.closeSize([callback]) | Скрывает кнопку размерных режимов на большой панели |
| L.show([callback]) | Плавно показывает затенение, затем вьюпорт, после чего выполняет callback если он передан |
| L.hide([callback]) | Последовательно скрывает все элементы галереи, прерывает анимацию в любой стадии, останавливает слайдшоу |
| L.create() | Создает код галереи на странице, назначает необходимые события |
| L.destroy() | Полностью удаляет код галереи со страницы (кроме ссылки на скрипт), снимает назначенные события |
| L.recreate() | Сначала выполняет предыдущую функцию а затем вновь создает код галереи с учетом всех новых настроек. Используйте эту функцию при изменении фоновых цветов элементов, css стилей и так далее |
| L.showLoader([callback]) | Отобразит индикатор загрузки |
| L.hideLoader([callback]) | Скроет индикатор загрузки |
| L.showContent([callback]) | Отобразит контент. Скрытие контента происходит благодаря тому что над ним создается прозрачный блок, залитый цветом фона, и затем изменяет свою прозрачность. Сам контент прозрачность не меняет, что позволяет сохранить качество рендеринга и избежать многих багов анимации прозрачности. |
| L.hideContent([callback]) | Скроет контент. Окно вьюпорта при этом никуда не исчезнет |
| L.center([callback]) | Центровка окна вьюпорта на странице |
| L.scale(width,height[,callback]) | Скроет контент и изменит размеры вьюпорта до установленных значений. Если текущие и новые значения совпадают, время будет сведено к нулю. Обратите внимание что оба параметра обязательны и задают ширину и высоту вьюпорта относительно его внешних граней а не контента |
| L.hideLeftArrow([callback]) | Скроет левую стрелку |
| L.showLeftArrow([callback]) | Откроет левую стрелку |
| L.hideRightArrow([callback]) | Скроет правую стрелку |
| L.showRightArrow([callback]) | Откроет правую стрелку |
| L.event.add("onerror"/ "onchange"/ "onshow"/ "onhide"/ "onscale"/ "onload",holder) | В галерее предусмотрена событийная модель для более удобного взаимодействия с процессом отображения изображений. Эта функция служит для того чтобы прикрепить нужный обработчик на одно из шести предусмотренных событий. |
| L.event.remove("onerror"/ "onchange"/ "onshow"/ "onhide"/ "onscale"/ "onload",holder) | Удалит событие указанного типа |
| L(["url[|name][|description]"[, "url[|name][|description]"]][, setName][, num]) | Основная функция управления. Первый аргумент (массив) обязателен и представляет собой коллекцию строк, в каждой из которых содержится адрес картинки, её название через разделитель (опционально), её описание через разделитель (опционально). Проще говоря, эти строки - копия тега title для реальных изображений, открываемых галереей. Второй аргумент функции - название сета галереи. Он опционален и может быть либо пустой строкой либо булевным отрицанием. Третий и последний аргумент - номер открываемого изображения в сете начиная с единицы. Аргумент так же опционален и по умолчанию будет равен единице. Таким образом данная функция может дублировать все навигационные функции, перечисленные выше. Фактически все навигационные функции являются упрощенными сокращениями вызова данной функции с правильно подставленными аргументами. Пример: L.current() выполнит то же самое что и L(L.data,L.setName,L.num) и так далее. Как видите, эта функция очень удобна и позволяет открывать почти неограниченные сеты изображений одним кликом |
