Class TextBitByBit

Работа с текстом: разделение, соединение, поиск, обрезка, дополнение, изменение регистра, регулярные выражения и форматирование с подстановочными местами. vectorChar и vectorText превращают текст в линейные пути, рисуемые простым штриховым шрифтом, так что слова могут стать геометрией. Позиции в тексте считаются с 0.

Index

Constructors

constructor

create

Constructors

constructor

new TextBitByBit(point: Bit.Point): TextBitByBit
Parameters
- point: Bit.Point
Returns TextBitByBit
- Defined in bitbybit-docs.d.ts:56537

create

create(inputs: Bit.Inputs.Text.TextDto): string
Передает текст без изменений, так что значению можно дать имя и использовать повторно.

Пример: 'Hello World' -> 'Hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Тот же текст
- Defined in bitbybit-docs.d.ts:56548

query

includes

includes(inputs: TextSearchDto): boolean
Сообщает, содержит ли текст искомый текст.

Пример: 'hello world' содержит 'world' -> true
Parameters
- inputs: TextSearchDto
  Текст и что искать
Returns boolean
true, если искомый текст в нем встречается
Example
```
const has = bitbybit.text.includes({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56647

startsWith

startsWith(inputs: TextSearchDto): boolean
Сообщает, начинается ли текст с искомого текста.

Пример: 'hello world' начинается с 'hello' -> true
Parameters
- inputs: TextSearchDto
  Текст и что искать в его начале
Returns boolean
true, если текст с этого начинается
Example
```
const starts = bitbybit.text.startsWith({ text: "hello world", search: "hello" });
```
- Defined in bitbybit-docs.d.ts:56662

endsWith

endsWith(inputs: TextSearchDto): boolean
Сообщает, заканчивается ли текст искомым текстом.

Пример: 'hello world' заканчивается на 'world' -> true
Parameters
- inputs: TextSearchDto
  Текст и что искать в его конце
Returns boolean
true, если текст этим заканчивается
Example
```
const ends = bitbybit.text.endsWith({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56677

indexOf

indexOf(inputs: TextSearchDto): number
Находит, где искомый текст встречается впервые, считая символы с 0, или -1, когда он не встречается.

Пример: 'hello world' ищем 'world' -> 6
Parameters
- inputs: TextSearchDto
  Текст и что искать
Returns number
Позиция первого вхождения или -1
Example
```
const at = bitbybit.text.indexOf({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56693

lastIndexOf

lastIndexOf(inputs: TextSearchDto): number
Находит, где искомый текст встречается в последний раз, считая символы с 0, или -1, когда он не встречается.

Пример: 'hello world hello' ищем 'hello' -> 12
Parameters
- inputs: TextSearchDto
  Текст и что искать
Returns number
Позиция последнего вхождения или -1
Example
```
const at = bitbybit.text.lastIndexOf({ text: "hello world hello", search: "hello" });
```
- Defined in bitbybit-docs.d.ts:56709

charAt

charAt(inputs: TextIndexDto): string
Читает символ на позиции, считая с 0.

Пример: 'hello' на 1 -> 'e'
Parameters
- inputs: TextIndexDto
  Текст и позиция
Returns string
Символ или пустой текст, если позиция вне текста
Example
```
const second = bitbybit.text.charAt({ text: "hello", index: 1 });
```
- Defined in bitbybit-docs.d.ts:56756

length

length(inputs: Bit.Inputs.Text.TextDto): number
Считает символы в тексте.

Пример: 'hello' -> 5
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns number
Число символов
- Defined in bitbybit-docs.d.ts:56902

isEmpty

isEmpty(inputs: Bit.Inputs.Text.TextDto): boolean
Сообщает, пуст ли текст или содержит только пробельные символы.

Пример: ' ' -> true, 'a' -> false
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns boolean
true, если в нем нет ничего, кроме пробелов
- Defined in bitbybit-docs.d.ts:56913

regex

regexTest

regexTest(inputs: TextRegexDto): boolean
Сообщает, совпадает ли регулярное выражение где-нибудь в тексте.

Пример: 'hello123' по '[0-9]+' -> true
Parameters
- inputs: TextRegexDto
  Текст, шаблон и флаги
Returns boolean
true, если шаблон совпадает
Example
```
const hasDigits = bitbybit.text.regexTest({ text: "hello123", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:56943

regexMatch

regexMatch(inputs: TextRegexDto): string[]
Находит части текста, с которыми совпадает регулярное выражение.

С флагом g перечисляется каждое совпадение; без него только первое совпадение и его группы захвата. Отсутствие совпадения дает null. Пример: 'hello123world456' по '[0-9]+' с 'g' -> ['123', '456']
Parameters
- inputs: TextRegexDto
  Текст, шаблон и флаги
Returns string[]
Совпадения или null, если их нет
Example
```
const numbers = bitbybit.text.regexMatch({ text: "hello123world456", pattern: "[0-9]+", flags: "g" });
```
- Defined in bitbybit-docs.d.ts:56960

regexReplace

regexReplace(inputs: TextRegexReplaceDto): string
Заменяет то, с чем совпадает регулярное выражение, другим текстом.

С флагом g заменяется каждое совпадение; без него только первое. Пример: 'hello123world456' по '[0-9]+' с 'g', замененное на 'X' -> 'helloXworldX'
Parameters
- inputs: TextRegexReplaceDto
  Текст, шаблон, флаги и замена
Returns string
Текст с выполненными заменами
Example
```
const clean = bitbybit.text.regexReplace({ text: "hello123world456", pattern: "[0-9]+", flags: "g", replaceWith: "X" });
```
- Defined in bitbybit-docs.d.ts:56976

regexSearch

regexSearch(inputs: TextRegexDto): number
Находит, где регулярное выражение совпадает впервые, считая символы с 0, или -1, когда оно не совпадает.

Пример: 'hello123' по '[0-9]+' -> 5
Parameters
- inputs: TextRegexDto
  Текст, шаблон и флаги
Returns number
Позиция первого совпадения или -1
Example
```
const at = bitbybit.text.regexSearch({ text: "hello123", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:56992

regexSplit

regexSplit(inputs: TextRegexDto): string[]
Разрезает текст на части везде, где совпадает регулярное выражение; сами совпадения отбрасываются.

Пример: 'a1b2c3', разделенный по '[0-9]+' -> ['a', 'b', 'c', '']
Parameters
- inputs: TextRegexDto
  Текст, шаблон и флаги
Returns string[]
Части, по порядку
Example
```
const letters = bitbybit.text.regexSplit({ text: "a1b2c3", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:57008

transform

split

split(inputs: TextSplitDto): string[]
Разрезает текст на части везде, где встречается разделитель; сам разделитель отбрасывается.

Пример: 'apple,banana,cherry', разделенный по ',' -> ['apple', 'banana', 'cherry']
Parameters
- inputs: TextSplitDto
  Текст и разделитель
Returns string[]
Части, по порядку
Example
```
const parts = bitbybit.text.split({ text: "apple,banana,cherry", separator: "," });
```
- Defined in bitbybit-docs.d.ts:56563

replaceAll

replaceAll(inputs: TextReplaceDto): string
Заменяет каждое вхождение искомого текста другим текстом.

Пример: 'hello hello' с заменой 'hello' на 'hi' -> 'hi hi'
Parameters
- inputs: TextReplaceDto
  Текст, что искать и что поставить на его место
Returns string
Текст с выполненными заменами
Example
```
const greeting = bitbybit.text.replaceAll({ text: "hello hello", search: "hello", replaceWith: "hi" });
```
- Defined in bitbybit-docs.d.ts:56578

join

join(inputs: TextJoinDto): string
Соединяет список текстов в один, с разделителем между соседями.

Пример: ['apple', 'banana', 'cherry'], соединенные через ', ' -> 'apple, banana, cherry'
Parameters
- inputs: TextJoinDto
  Тексты и разделитель
Returns string
Соединенный текст
Example
```
const line = bitbybit.text.join({ list: ["apple", "banana"], separator: ", " });
```
- Defined in bitbybit-docs.d.ts:56593

toString

toString<T>(inputs: ToStringDto<T>): string
Превращает любое значение в текст так, как его печатает JavaScript.

Пример: 42 -> '42', [1, 2] -> '1,2'
Type Parameters
- T
Parameters
- inputs: ToStringDto<T>
  Значение
Returns string
Значение как текст
- Defined in bitbybit-docs.d.ts:56604

toStringEach

toStringEach<T>(inputs: ToStringEachDto<T>): string[]
Превращает каждый элемент списка в текст так, как его печатает JavaScript.

Пример: [1, 2.5, true] -> ['1', '2.5', 'true']
Type Parameters
- T
Parameters
- inputs: ToStringEachDto<T>
  Список значений
Returns string[]
По одному тексту на элемент, по порядку
- Defined in bitbybit-docs.d.ts:56615

format

format(inputs: TextFormatDto): string
Заполняет нумерованные заполнители в тексте значениями: {0} берет первое значение, {1} второе и так далее.

Заполнитель без значения остается как есть. Пример: 'Point: ({0}, {1})' с [10, 5] -> 'Point: (10, 5)'
Parameters
- inputs: TextFormatDto
  Текст с подстановочными местами и значения для заполнения
Returns string
Заполненный текст
Example
```
const label = bitbybit.text.format({ text: "Point: ({0}, {1})", values: ["10", "5"] });
```
- Defined in bitbybit-docs.d.ts:56632

substring

substring(inputs: TextSubstringDto): string
Берет символы от начальной позиции до конечной, не включая ее.

Начало больше конца меняет их местами, а отрицательные позиции считаются как 0. Пример: 'hello world' от 0 до 5 -> 'hello'
Parameters
- inputs: TextSubstringDto
  Текст и начальная и конечная позиции
Returns string
Символы в этом диапазоне
Example
```
const word = bitbybit.text.substring({ text: "hello world", start: 0, end: 5 });
```
- Defined in bitbybit-docs.d.ts:56725

slice

slice(inputs: TextSubstringDto): string
Берет символы от начальной позиции до конечной, не включая ее.

В отличие от substring, отрицательная позиция считается от конца текста. Пример: 'hello world' от 0 до 5 -> 'hello'; от -5 -> 'world'
Parameters
- inputs: TextSubstringDto
  Текст и начальная и конечная позиции
Returns string
Символы в этом диапазоне
Example
```
const tail = bitbybit.text.slice({ text: "hello world", start: 6, end: 11 });
```
- Defined in bitbybit-docs.d.ts:56741

trim

trim(inputs: Bit.Inputs.Text.TextDto): string
Удаляет пробелы, табуляции и переносы строк с обоих концов текста.

Пример: ' hello ' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Обрезанный текст
- Defined in bitbybit-docs.d.ts:56767

trimStart

trimStart(inputs: Bit.Inputs.Text.TextDto): string
Удаляет пробелы, табуляции и переносы строк с начала текста.

Пример: ' hello ' -> 'hello '
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Текст без начальных пробелов
- Defined in bitbybit-docs.d.ts:56778

trimEnd

trimEnd(inputs: Bit.Inputs.Text.TextDto): string
Удаляет пробелы, табуляции и переносы строк с конца текста.

Пример: ' hello ' -> ' hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Текст без конечных пробелов
- Defined in bitbybit-docs.d.ts:56789

padStart

padStart(inputs: TextPadDto): string
Добавляет текст-заполнитель спереди, пока текст не достигнет длины; текст, уже такой длины, остается без изменений.

Пример: 'x' до длины 3 с 'a' -> 'aax'
Parameters
- inputs: TextPadDto
  Текст, длина, которую нужно достичь, и заполнитель
Returns string
Дополненный текст
Example
```
const padded = bitbybit.text.padStart({ text: "7", length: 3, padString: "0" });
```
- Defined in bitbybit-docs.d.ts:56805

padEnd

padEnd(inputs: TextPadDto): string
Добавляет текст-заполнитель сзади, пока текст не достигнет длины; текст, уже такой длины, остается без изменений.

Пример: 'x' до длины 3 с 'a' -> 'xaa'
Parameters
- inputs: TextPadDto
  Текст, длина, которую нужно достичь, и заполнитель
Returns string
Дополненный текст
Example
```
const padded = bitbybit.text.padEnd({ text: "x", length: 3, padString: "a" });
```
- Defined in bitbybit-docs.d.ts:56821

toUpperCase

toUpperCase(inputs: Bit.Inputs.Text.TextDto): string
Превращает каждую букву в заглавную.

Пример: 'hello' -> 'HELLO'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Текст в верхнем регистре
- Defined in bitbybit-docs.d.ts:56832

toLowerCase

toLowerCase(inputs: Bit.Inputs.Text.TextDto): string
Превращает каждую букву в строчную.

Пример: 'HELLO' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Текст в нижнем регистре
- Defined in bitbybit-docs.d.ts:56843

toUpperCaseFirst

toUpperCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Превращает первый символ в заглавный и оставляет остальное как есть.

Пример: 'hello world' -> 'Hello world'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Текст с первым символом в верхнем регистре
- Defined in bitbybit-docs.d.ts:56854

toLowerCaseFirst

toLowerCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Превращает первый символ в строчный и оставляет остальное как есть.

Пример: 'Hello World' -> 'hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Текст с первым символом в нижнем регистре
- Defined in bitbybit-docs.d.ts:56865

repeat

repeat(inputs: TextRepeatDto): string
Повторяет текст несколько раз, один за другим.

Пример: 'ha' три раза -> 'hahaha'
Parameters
- inputs: TextRepeatDto
  Текст и сколько раз его повторить
Returns string
Повторенный текст
Example
```
const laugh = bitbybit.text.repeat({ text: "ha", count: 3 });
```
- Defined in bitbybit-docs.d.ts:56880

reverse

reverse(inputs: Bit.Inputs.Text.TextDto): string
Обращает порядок символов.

Пример: 'hello' -> 'olleh'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Текст
Returns string
Перевернутый текст
- Defined in bitbybit-docs.d.ts:56891

concat

concat(inputs: TextConcatDto): string
Соединяет несколько текстов в один без ничего между ними.

Пример: ['hello', ' ', 'world'] -> 'hello world'
Parameters
- inputs: TextConcatDto
  Соединяемые тексты
Returns string
Соединенный текст
Example
```
const sentence = bitbybit.text.concat({ texts: ["hello", " ", "world"] });
```
- Defined in bitbybit-docs.d.ts:56928

vector

vectorChar

vectorChar(inputs: VectorCharDto): VectorCharData
Рисует один символ линейными путями простым штриховым шрифтом.

Пути лежат плоско на плоскости XZ, масштабированные так, чтобы символ был высотой height, и возвращаются с шириной и высотой символа. Неизвестный символ рисуется как вопросительный знак. Пример: 'A' высотой 10 -> штрихи буквы A, высотой 10 единиц
Parameters
- inputs: VectorCharDto
  Символ, его высота и его смещения
Returns VectorCharData
Ширина, высота и пути штрихов символа как списки точек
Example
```
const letter = bitbybit.text.vectorChar({ char: "A", height: 10, xOffset: 0, yOffset: 0, extrudeOffset: 0 });
```
- Defined in bitbybit-docs.d.ts:57026

vectorText

vectorText(inputs: VectorTextDto): VectorTextData[]
Рисует текст, с переносами строк, линейными путями простым штриховым шрифтом.

Каждая строка возвращается как ее символы с их путями, размещенные плоско на плоскости XZ с заданными высотой, интервалами и выравниванием; centerOnOrigin помещает середину блока в начало координат. Пример: 'Hello' высотой 10 -> пять символов с их штрихами
Parameters
- inputs: VectorTextDto
  Текст и как его расположить
Returns VectorTextData[]
По одной записи на строку, каждая со своими символами и путями их штрихов
Example
```
const lines = bitbybit.text.vectorText({
    text: "Hello\nWorld",
    height: 10,
    align: Bit.Inputs.Base.horizontalAlignEnum.center,
    centerOnOrigin: true,
});
```
- Defined in bitbybit-docs.d.ts:57049

Class TextBitByBit

Index

Constructors

create

query

regex

transform

vector

Constructors

constructor

Parameters

Returns TextBitByBit

create

create

Parameters

Returns string

query

includes

Parameters

Returns boolean

Example

startsWith

Parameters

Returns boolean

Example

endsWith

Parameters

Returns boolean

Example

indexOf

Parameters

Returns number

Example

lastIndexOf

Parameters

Returns number

Example

charAt

Parameters

Returns string

Example

length

Parameters

Returns number

isEmpty

Parameters

Returns boolean

regex

regexTest

Parameters

Returns boolean

Example

regexMatch

Parameters

Returns string[]

Example

regexReplace

Parameters

Returns string

Example

regexSearch

Parameters

Returns number

Example

regexSplit

Parameters

Returns string[]

Example

transform

split

Parameters

Returns string[]

Example

replaceAll

Parameters

Returns string

Example

join

Parameters

Returns string