VintaSoft Twain .NET SDK 15.0: Документация для Веб разработчика
Vintasoft.Shared Namespace / WebImageJS type / renderTileWithNeighbours Property
Синтаксис Exceptions Совместимость с браузерами Смотрите также
В этом разделе
    renderTileWithNeighbours Метод
    В этом разделе
    Отправляет асинхронный запрос на рендеринг "основного" фрагмента изображения и всех соседних фрагментов изображения вокруг основного фрагмента изображения.
    Синтаксис
    var instance = new Vintasoft.Shared.WebImageJS(imageSource, pageIndex);
    
    var value; // Type: object
    
    // Parameters
    var tileRenderingSettings; // Type: object
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.renderTileWithNeighbours(tileRenderingSettings, successFunc, errorFunc);
    
    
    function renderTileWithNeighbours(
    tileRenderingSettings
    Настройки для рендеринга фрагмента изображения.
    Объект со следующими свойствами:
    • x (число): координата X фрагмента на исходном изображении (координата X без масштаба) ). Обязательный параметр.
    • y (число): координата Y фрагмента на исходном изображении (координата Y без масштаба). Обязательный параметр.
    • width (число): ширина масштабированной плитки в пикселях. Обязательный параметр.
    • height (число): высота масштабированной плитки в пикселях. Обязательный параметр.
    • scale (object): масштаб (горизонтальный и вертикальный) фрагмента изображения. Поддерживаемые значения: 0,1–10 %, 1–100 % и т. д. Необязательный параметр, значение по умолчанию: {x:1,y:1}.
    • useCache (логическое значение): значение, указывающее, должен ли отображаться фрагмент изображения. сохраняться на сервере. Важно! текущий метод всегда устанавливает для этого параметра значение true.
    • format (object): экземпляр класса WebImageTypeEnumJS, который определяет формат, в котором отображается фрагмент изображения. должен быть возвращен. Необязательный параметр, значение по умолчанию - WebImageTypeEnumJS.Url
    • renderingSettings (object): объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - WebImageJS.get_RenderingSettings объекта image.
    • decodingSettings (object): WebDecodingSettingsJS. Необязательный параметр, значение по умолчанию - WebImageJS.get_DecodingSettings изображения.
    : object,
    successFunc
    Функция, которая будет выполнена, если запрос будет выполнен успешно.
    Вот прототип функции "function __success(data)".
    Параметр data имеет следующие свойства:
    • fileId (string): идентификатор файла изображения.
    • pos (object) : положение плитки в исходном изображении.
    • size (object): размер плитки.
    • useCache (логическое значение): указывает, что обработанная плитка изображения сохраняется на сервере.
    • scale (object): масштаб (горизонтальный и вертикальный) фрагмента изображения.
    • image (object): экземпляр класса WebImageJS, который представляет исходное изображение.
    : Function,
    errorFunc
    Функция, которая будет выполнена в случае сбоя запроса.
    Вот прототип функции "function __error(data)".
    Параметр данных может быть:
    1. Объект со следующими свойствами:
      • errorMessage (string): сообщение об ошибке.
      • blocked (логическое значение): указывает, что запрошенное действие заблокировано другим. запрос.
      , если исключение перехватывается внутри веб-службы.
    2. Иначе объект jqXHR.
    : Function
    ) : object;

    Parameters

    tileRenderingSettings
    Настройки для рендеринга фрагмента изображения.
    Объект со следующими свойствами:
    • x (число): координата X фрагмента на исходном изображении (координата X без масштаба) ). Обязательный параметр.
    • y (число): координата Y фрагмента на исходном изображении (координата Y без масштаба). Обязательный параметр.
    • width (число): ширина масштабированной плитки в пикселях. Обязательный параметр.
    • height (число): высота масштабированной плитки в пикселях. Обязательный параметр.
    • scale (object): масштаб (горизонтальный и вертикальный) фрагмента изображения. Поддерживаемые значения: 0,1–10 %, 1–100 % и т. д. Необязательный параметр, значение по умолчанию: {x:1,y:1}.
    • useCache (логическое значение): значение, указывающее, должен ли отображаться фрагмент изображения. сохраняться на сервере. Важно! текущий метод всегда устанавливает для этого параметра значение true.
    • format (object): экземпляр класса WebImageTypeEnumJS, который определяет формат, в котором отображается фрагмент изображения. должен быть возвращен. Необязательный параметр, значение по умолчанию - WebImageTypeEnumJS.Url
    • renderingSettings (object): объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - WebImageJS.get_RenderingSettings объекта image.
    • decodingSettings (object): WebDecodingSettingsJS. Необязательный параметр, значение по умолчанию - WebImageJS.get_DecodingSettings изображения.
    successFunc
    Функция, которая будет выполнена, если запрос будет выполнен успешно.
    Вот прототип функции "function __success(data)".
    Параметр data имеет следующие свойства:
    • fileId (string): идентификатор файла изображения.
    • pos (object) : положение плитки в исходном изображении.
    • size (object): размер плитки.
    • useCache (логическое значение): указывает, что обработанная плитка изображения сохраняется на сервере.
    • scale (object): масштаб (горизонтальный и вертикальный) фрагмента изображения.
    • image (object): экземпляр класса WebImageJS, который представляет исходное изображение.
    errorFunc
    Функция, которая будет выполнена в случае сбоя запроса.
    Вот прототип функции "function __error(data)".
    Параметр данных может быть:
    1. Объект со следующими свойствами:
      • errorMessage (string): сообщение об ошибке.
      • blocked (логическое значение): указывает, что запрошенное действие заблокировано другим. запрос.
      , если исключение перехватывается внутри веб-службы.
    2. Иначе объект jqXHR.

    Return Value

    Объект запроса.
    Исключения
    ИсключениеОписание
    Выдается, если аргументы имеют неверные типы.
    Вызывается, если координаты плитки находятся за пределами изображения.
    Смотрите также