Bitbybit Docs
    Preparing search index...

    Class Color

    Цвета в двух формах, которые использует библиотека: текст hex, такой как #ff5733, и объект { r, g, b } или { r, g, b, a }, каналы которого идут либо от 0 до 255, либо от 0 до 1. Методы здесь строят цвета в каждой форме, конвертируют между ними с явным диапазоном каналов, читают отдельные каналы и инвертируют цвет.

    Index

    Constructors

    convert

    • Читает цвет в формате hex в объект { r, g, b } с каналами от 0 до 255.

      Текст может начинаться с # или без; все, кроме шести шестнадцатеричных цифр, выбрасывает ошибку. Пример: '#FF5733' -> { r: 255, g: 87, b: 51 }

      Parameters

      • inputs: HexDto

        Цвет в формате hex

      Returns ColorRGB

      Объект цвета с каналами от 0 до 255

      const rgb = bitbybit.color.hexToRgb({ color: "#ff5733" });
      
    • Записывает три значения каналов как цвет в формате hex.

      min и max говорят, какой диапазон используют значения; диапазон, отличный от 0 до 255, сначала переотображается, так что каналы от 0 до 1 тоже работают. Пример: r 255, g 87, b 51 в [0,255] -> '#ff5733'; r 1, g 0.5, b 0.2 в [0,1] -> '#ff8033'

      Parameters

      • inputs: RGBMinMaxDto

        Значения красного, зеленого и синего и их диапазон

      Returns string

      Цвет в формате hex

      const hex = bitbybit.color.rgbToHex({ r: 1, g: 0.5, b: 0.2, min: 0, max: 1 });
      
    • Записывает цвет { r, g, b } как цвет в формате hex.

      min и max говорят, какой диапазон используют каналы; диапазон, отличный от 0 до 255, сначала переотображается. Пример: { r: 1, g: 0.5, b: 0.2 } в [0,1] -> '#ff8033'

      Parameters

      • inputs: RGBObjectMaxDto

        Объект цвета и диапазон, который используют его каналы

      Returns string

      Цвет в формате hex

      const hex = bitbybit.color.rgbObjToHex({ rgb: { r: 1, g: 0.5, b: 0.2 }, min: 0, max: 1 });
      
    • Читает цвет в формате hex в объект { r, g, b } с каналами, переотображенными в диапазон по вашему выбору.

      Пример: '#FF5733', отображенный в [0,1] -> { r: 1, g: 0.341, b: 0.2 }

      Parameters

      • inputs: HexDtoMapped

        Цвет в формате hex и диапазон, в который отобразить каналы

      Returns ColorRGB

      Объект цвета с каналами в этом диапазоне

      const rgb = bitbybit.color.hexToRgbMapped({ color: "#ff5733", from: 0, to: 1 });
      

    create

    • Передает цвет в формате hex без изменений, так что цвету можно дать имя и использовать повторно.

      Пример: '#FF5733' -> '#FF5733'

      Parameters

      • inputs: HexDto

        Цвет в формате hex

      Returns string

      Тот же цвет в формате hex

    • Передает цвет { r, g, b } с каналами от 0 до 255 без изменений, так что ему можно дать имя и использовать повторно.

      Пример: { r: 255, g: 87, b: 51 } -> тот же объект

      Parameters

      Returns ColorRGB

      Тот же объект цвета

    • Передает цвет { r, g, b } с каналами от 0 до 1 без изменений, так что ему можно дать имя и использовать повторно.

      Пример: { r: 1, g: 0.34, b: 0.2 } -> тот же объект

      Parameters

      • inputs: Rgb1Dto

        Объект цвета

      Returns ColorRGB

      Тот же объект цвета

    • Передает цвет { r, g, b, a } с цветовыми каналами от 0 до 255 и непрозрачностью от 0 до 1 без изменений, так что ему можно дать имя и использовать повторно.

      Пример: { r: 255, g: 87, b: 51, a: 1 } -> тот же объект

      Parameters

      Returns ColorRGBA

      Тот же объект цвета

    • Передает цвет { r, g, b, a } с каждым каналом от 0 до 1 без изменений, так что ему можно дать имя и использовать повторно.

      Пример: { r: 1, g: 0.34, b: 0.2, a: 1 } -> тот же объект

      Parameters

      • inputs: Rgba1Dto

        Объект цвета

      Returns ColorRGBA

      Тот же объект цвета

    • Строит цвет { r, g, b } из трех отдельных значений каналов от 0 до 255.

      Пример: r 255, g 87, b 51 -> { r: 255, g: 87, b: 51 }

      Parameters

      • inputs: RgbAttomic255Dto

        Значения красного, зеленого и синего

      Returns ColorRGB

      Объект цвета

      const orange = bitbybit.color.rgbAtomic255Color({ r: 255, g: 87, b: 51 });
      
    • Строит цвет { r, g, b } из трех отдельных значений каналов от 0 до 1.

      Пример: r 1, g 0.34, b 0.2 -> { r: 1, g: 0.34, b: 0.2 }

      Parameters

      • inputs: RgbAttomic1Dto

        Значения красного, зеленого и синего

      Returns ColorRGB

      Объект цвета

      const orange = bitbybit.color.rgbAtomic1Color({ r: 1, g: 0.34, b: 0.2 });
      

    hex to

    • Читает красный канал цвета в формате hex, переотображенный в диапазон по вашему выбору.

      Пример: '#FF5733' в [0,1] -> 1

      Parameters

      • inputs: HexDtoMapped

        Цвет в формате hex и диапазон, в который отобразить канал

      Returns number

      Красный канал в этом диапазоне

      const red = bitbybit.color.getRedParam({ color: "#ff5733", from: 0, to: 1 });
      
    • Читает зеленый канал цвета в формате hex, переотображенный в диапазон по вашему выбору.

      Пример: '#FF5733' в [0,1] -> 0.341

      Parameters

      • inputs: HexDtoMapped

        Цвет в формате hex и диапазон, в который отобразить канал

      Returns number

      Зеленый канал в этом диапазоне

      const green = bitbybit.color.getGreenParam({ color: "#ff5733", from: 0, to: 1 });
      
    • Читает синий канал цвета в формате hex, переотображенный в диапазон по вашему выбору.

      Пример: '#FF5733' в [0,1] -> 0.2

      Parameters

      • inputs: HexDtoMapped

        Цвет в формате hex и диапазон, в который отобразить канал

      Returns number

      Синий канал в этом диапазоне

      const blue = bitbybit.color.getBlueParam({ color: "#ff5733", from: 0, to: 1 });
      
    • Инвертирует цвет в формате hex, превращая каждый канал в его противоположность: 255 минус значение.

      При включенном blackAndWhite результат - просто черный для светлого цвета или белый для темного, что подходит для текста на цветном фоне. Пример: '#FF5733' -> '#00a8cc'; с blackAndWhite -> '#ffffff'

      Parameters

      • inputs: InvertHexDto

        Цвет в формате hex и сводить ли результат к черному или белому

      Returns string

      Инвертированный цвет в формате hex

      const textColor = bitbybit.color.invert({ color: "#ff5733", blackAndWhite: true });
      

    rgb to

    • Читает красный канал цвета { r, g, b }.

      Пример: { r: 255, g: 87, b: 51 } -> 255

      Parameters

      Returns number

      Красный канал в том диапазоне, который использует объект

    • Читает зеленый канал цвета { r, g, b }.

      Пример: { r: 255, g: 87, b: 51 } -> 87

      Parameters

      Returns number

      Зеленый канал в том диапазоне, который использует объект

    • Читает синий канал цвета { r, g, b }.

      Пример: { r: 255, g: 87, b: 51 } -> 51

      Parameters

      Returns number

      Синий канал в том диапазоне, который использует объект