umbot - v2.1.3
    Preparing search index...

    Class Image

    Image Класс для обработки и отображения изображений в различных платформах.

    Основные возможности:

    • Управление изображениями и их метаданными
    • Поддержка различных источников изображений (URL, файлы, токены)
    • Настройка отображения текста (заголовок и описание)
    • Добавление кнопок и действий
    • Гибкая настройка параметров отображения
    // Создание изображения из URL
    const image = new Image();
    image.init(
        'https://example.com/image.jpg',
        'Заголовок изображения',
        'Описание изображения',
        { title: 'Нажми меня', url: 'https://example.com' }
    );

    // Создание изображения из файла
    const localImage = new Image();
    localImage.init(
        '/path/to/image.jpg',
        'Локальное изображение',
        'Описание локального изображения'
    );

    // Создание изображения с токеном
    const tokenImage = new Image();
    tokenImage.isToken = true;
    tokenImage.init(
        'image_token_123',
        'Изображение по токену',
        'Описание изображения по токену'
    );
    Index

    Constructors

    constructor

    Properties

    button desc imageDir imageToken isToken params title

    Methods

    init

    Constructors

    • Конструктор класса Image. Инициализирует все свойства значениями по умолчанию.

      Parameters

      • appContext: AppContext

        Контекст приложения

      • image: string | null = null

        Путь к изображению или токен

      • title: string = ''

        Заголовок изображения

      • Optionaldesc: string = ' '

        Описание изображения

      • Optionalbutton: TButton | null = null

        Кнопки для изображения

      Returns Image

      const image = new Image();
      // image.button = new Buttons()
      // image.title = ''
      // image.desc = ''
      // image.imageToken = null
      // image.imageDir = null
      // image.isToken = false
      // image.params = {}

    Properties

    button: Buttons

    Кнопки для обработки действий с изображением. Зависит от типа приложения и платформы.

    Buttons

    const image = new Image();
    image.button.addBtn('Нажми меня', 'https://example.com');
    image.button.addBtn('Другая кнопка', null, { action: 'custom' });
    desc: string

    Описание изображения. Отображается под изображением.

    const image = new Image();
    image.desc = 'Подробное описание товара';
    imageDir: string | null

    Путь к изображению. Может быть URL или путь к файлу.

    const image = new Image();
    image.imageDir = 'https://example.com/image.jpg';
    // или
    image.imageDir = '/path/to/image.jpg';
    imageToken: string | null

    Идентификатор изображения. Используется для платформ, поддерживающих токены.

    const image = new Image();
    image.imageToken = 'image_token_123';
    isToken: boolean

    Флаг использования токена. Если true, то imageToken используется как идентификатор.

    false

    const image = new Image();
    image.isToken = true;
    image.init('image_token_123', 'Заголовок', 'Описание');
    params: IImageParams

    Дополнительные параметры изображения. Настройки отображения для разных платформ.

    const image = new Image();
    image.params = {
        titleTypeface: 'headline2',
        titleText_color: 'default',
        descTypeface: 'body3',
        descText_color: 'secondary'
    };
    title: string

    Заголовок изображения. Отображается над изображением.

    const image = new Image();
    image.title = 'Название товара';

    Methods

    • Инициализация изображения. Устанавливает основные параметры изображения и проверяет их корректность.

      Процесс работы:

      1. Проверяет тип изображения (токен или путь):
        • Если isToken=true, использует image как токен
        • Иначе проверяет валидность URL или файла
      2. Устанавливает заголовок и описание:
        • Если заголовок пустой, возвращает false
        • Если описание пустое, устанавливает пробел
      3. Добавляет кнопки, если они есть:
        • Поддерживает строковые кнопки
        • Поддерживает объекты кнопок

      Parameters

      • image: string | null

        Путь к изображению или токен

      • title: string

        Заголовок изображения

      • Optionaldesc: string = ' '

        Описание изображения

      • Optionalbutton: TButton | null = null

        Кнопки для изображения

      Returns boolean

      true если инициализация успешна, false в противном случае

      const image = new Image();

      // Инициализация с URL
      image.init(
          'https://example.com/image.jpg',
          'Заголовок',
          'Описание',
          { title: 'Кнопка', url: 'https://example.com' }
      );

      // Инициализация с токеном
      image.isToken = true;
      image.init(
          'image_token_123',
          'Заголовок',
          'Описание'
      );

      // Инициализация с простой кнопкой
      image.init(
          'https://example.com/image.jpg',
          'Заголовок',
          'Описание',
          'Текст кнопки'
      );

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods