Class TextBitByBit

Travailler avec du texte : découper, assembler, chercher, rogner, compléter, changer la casse, expressions régulières et formatage avec des emplacements réservés. vectorChar et vectorText transforment le texte en chemins de lignes dessinés avec une police à traits simple, pour que des mots puissent devenir de la géométrie. Les positions dans le texte comptent à partir de 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
Transmet un texte sans changement, pour qu'une valeur puisse recevoir un nom et être réutilisée.

Exemple : 'Hello World' -> 'Hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le même texte
- Defined in bitbybit-docs.d.ts:56548

query

includes

includes(inputs: TextSearchDto): boolean
Indique si un texte contient un texte cherché.

Exemple : 'hello world' contient 'world' -> true
Parameters
- inputs: TextSearchDto
  Le texte et ce qu'il faut chercher
Returns boolean
Vrai quand le texte cherché s'y trouve
Example
```
const has = bitbybit.text.includes({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56647

startsWith

startsWith(inputs: TextSearchDto): boolean
Indique si un texte commence par un texte cherché.

Exemple : 'hello world' commence par 'hello' -> true
Parameters
- inputs: TextSearchDto
  Le texte et ce qu'il faut chercher à son début
Returns boolean
Vrai quand le texte commence par cela
Example
```
const starts = bitbybit.text.startsWith({ text: "hello world", search: "hello" });
```
- Defined in bitbybit-docs.d.ts:56662

endsWith

endsWith(inputs: TextSearchDto): boolean
Indique si un texte finit par un texte cherché.

Exemple : 'hello world' finit par 'world' -> true
Parameters
- inputs: TextSearchDto
  Le texte et ce qu'il faut chercher à sa fin
Returns boolean
Vrai quand le texte se termine par cela
Example
```
const ends = bitbybit.text.endsWith({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56677

indexOf

indexOf(inputs: TextSearchDto): number
Trouve où un texte cherché apparaît pour la première fois, en comptant les caractères à partir de 0, ou -1 quand il n'apparaît pas.

Exemple : 'hello world' en cherchant 'world' -> 6
Parameters
- inputs: TextSearchDto
  Le texte et ce qu'il faut chercher
Returns number
La position de la première occurrence, ou -1
Example
```
const at = bitbybit.text.indexOf({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56693

lastIndexOf

lastIndexOf(inputs: TextSearchDto): number
Trouve où un texte cherché apparaît pour la dernière fois, en comptant les caractères à partir de 0, ou -1 quand il n'apparaît pas.

Exemple : 'hello world hello' en cherchant 'hello' -> 12
Parameters
- inputs: TextSearchDto
  Le texte et ce qu'il faut chercher
Returns number
La position de la dernière occurrence, ou -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
Lit le caractère à une position, en comptant à partir de 0.

Exemple : 'hello' à 1 -> 'e'
Parameters
- inputs: TextIndexDto
  Le texte et la position
Returns string
Le caractère, ou un texte vide quand la position est en dehors du texte
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
Compte les caractères d'un texte.

Exemple : 'hello' -> 5
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns number
Le nombre de caractères
- Defined in bitbybit-docs.d.ts:56902

isEmpty

isEmpty(inputs: Bit.Inputs.Text.TextDto): boolean
Indique si un texte est vide ou ne contient que des espaces.

Exemple : ' ' -> true, 'a' -> false
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns boolean
Vrai quand il n'y a que des espaces
- Defined in bitbybit-docs.d.ts:56913

regex

regexTest

regexTest(inputs: TextRegexDto): boolean
Indique si une expression régulière correspond quelque part dans un texte.

Exemple : 'hello123' contre '[0-9]+' -> true
Parameters
- inputs: TextRegexDto
  Le texte, le motif et les drapeaux
Returns boolean
Vrai quand le motif correspond
Example
```
const hasDigits = bitbybit.text.regexTest({ text: "hello123", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:56943

regexMatch

regexMatch(inputs: TextRegexDto): string[]
Trouve les parties d'un texte auxquelles une expression régulière correspond.

Avec le drapeau g, chaque correspondance est listée ; sans lui, seulement la première correspondance et ses groupes de capture. Aucune correspondance donne null. Exemple : 'hello123world456' contre '[0-9]+' avec 'g' -> ['123', '456']
Parameters
- inputs: TextRegexDto
  Le texte, le motif et les drapeaux
Returns string[]
Les correspondances, ou null quand il n'y en a pas
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
Remplace ce à quoi une expression régulière correspond par un autre texte.

Avec le drapeau g, chaque correspondance est remplacée ; sans lui, seulement la première. Exemple : 'hello123world456' contre '[0-9]+' avec 'g', remplacé par 'X' -> 'helloXworldX'
Parameters
- inputs: TextRegexReplaceDto
  Le texte, le motif, les drapeaux et le remplacement
Returns string
Le texte avec les remplacements effectués
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
Trouve où une expression régulière correspond pour la première fois, en comptant les caractères à partir de 0, ou -1 quand elle ne correspond pas.

Exemple : 'hello123' contre '[0-9]+' -> 5
Parameters
- inputs: TextRegexDto
  Le texte, le motif et les drapeaux
Returns number
La position de la première correspondance, ou -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[]
Découpe un texte en morceaux partout où une expression régulière correspond ; les correspondances elles-mêmes sont supprimées.

Exemple : 'a1b2c3' découpé par '[0-9]+' -> ['a', 'b', 'c', '']
Parameters
- inputs: TextRegexDto
  Le texte, le motif et les drapeaux
Returns string[]
Les morceaux, dans l'ordre
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[]
Découpe un texte en morceaux partout où un séparateur apparaît ; le séparateur lui-même est supprimé.

Exemple : 'apple,banana,cherry' découpé par ',' -> ['apple', 'banana', 'cherry']
Parameters
- inputs: TextSplitDto
  Le texte et le séparateur
Returns string[]
Les morceaux, dans l'ordre
Example
```
const parts = bitbybit.text.split({ text: "apple,banana,cherry", separator: "," });
```
- Defined in bitbybit-docs.d.ts:56563

replaceAll

replaceAll(inputs: TextReplaceDto): string
Remplace chaque occurrence d'un texte cherché par un autre texte.

Exemple : 'hello hello' en remplaçant 'hello' par 'hi' -> 'hi hi'
Parameters
- inputs: TextReplaceDto
  Le texte, ce qu'il faut chercher et ce qu'il faut mettre à la place
Returns string
Le texte avec les remplacements effectués
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
Joint une liste de textes en un seul, avec un séparateur entre les voisins.

Exemple : ['apple', 'banana', 'cherry'] joints par ', ' -> 'apple, banana, cherry'
Parameters
- inputs: TextJoinDto
  Les textes et le séparateur
Returns string
Le texte assemblé
Example
```
const line = bitbybit.text.join({ list: ["apple", "banana"], separator: ", " });
```
- Defined in bitbybit-docs.d.ts:56593

toString

toString<T>(inputs: ToStringDto<T>): string
Transforme n'importe quelle valeur en texte, tel que JavaScript l'affiche.

Exemple : 42 -> '42', [1, 2] -> '1,2'
Type Parameters
- T
Parameters
- inputs: ToStringDto<T>
  La valeur
Returns string
La valeur sous forme de texte
- Defined in bitbybit-docs.d.ts:56604

toStringEach

toStringEach<T>(inputs: ToStringEachDto<T>): string[]
Transforme chaque élément d'une liste en texte, tel que JavaScript l'affiche.

Exemple : [1, 2.5, true] -> ['1', '2.5', 'true']
Type Parameters
- T
Parameters
- inputs: ToStringEachDto<T>
  La liste des valeurs
Returns string[]
Un texte par élément, dans l'ordre
- Defined in bitbybit-docs.d.ts:56615

format

format(inputs: TextFormatDto): string
Remplit les espaces réservés numérotés d'un texte avec des valeurs : {0} prend la première valeur, {1} la seconde, et ainsi de suite.

Un espace réservé sans valeur est laissé tel quel. Exemple : 'Point: ({0}, {1})' avec [10, 5] -> 'Point: (10, 5)'
Parameters
- inputs: TextFormatDto
  Le texte avec des emplacements réservés et les valeurs à y insérer
Returns string
Le texte complété
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
Prend les caractères d'une position de début jusqu'à une position de fin, non comprise.

Un début plus grand que la fin échange les deux, et les positions négatives comptent comme 0. Exemple : 'hello world' de 0 à 5 -> 'hello'
Parameters
- inputs: TextSubstringDto
  Le texte et les positions de début et de fin
Returns string
Les caractères de cette plage
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
Prend les caractères d'une position de début jusqu'à une position de fin, non comprise.

Contrairement à substring, une position négative compte depuis la fin du texte. Exemple : 'hello world' de 0 à 5 -> 'hello' ; depuis -5 -> 'world'
Parameters
- inputs: TextSubstringDto
  Le texte et les positions de début et de fin
Returns string
Les caractères de cette plage
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
Retire les espaces, tabulations et sauts de ligne aux deux extrémités d'un texte.

Exemple : ' hello ' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte sans espaces aux extrémités
- Defined in bitbybit-docs.d.ts:56767

trimStart

trimStart(inputs: Bit.Inputs.Text.TextDto): string
Retire les espaces, tabulations et sauts de ligne au début d'un texte.

Exemple : ' hello ' -> 'hello '
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte sans espaces au début
- Defined in bitbybit-docs.d.ts:56778

trimEnd

trimEnd(inputs: Bit.Inputs.Text.TextDto): string
Retire les espaces, tabulations et sauts de ligne à la fin d'un texte.

Exemple : ' hello ' -> ' hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte sans espaces à la fin
- Defined in bitbybit-docs.d.ts:56789

padStart

padStart(inputs: TextPadDto): string
Ajoute un texte de remplissage devant jusqu'à ce que le texte atteigne une longueur ; un texte déjà aussi long est laissé tel quel.

Exemple : 'x' à la longueur 3 avec 'a' -> 'aax'
Parameters
- inputs: TextPadDto
  Le texte, la longueur à atteindre et le caractère de remplissage
Returns string
Le texte complété
Example
```
const padded = bitbybit.text.padStart({ text: "7", length: 3, padString: "0" });
```
- Defined in bitbybit-docs.d.ts:56805

padEnd

padEnd(inputs: TextPadDto): string
Ajoute un texte de remplissage derrière jusqu'à ce que le texte atteigne une longueur ; un texte déjà aussi long est laissé tel quel.

Exemple : 'x' à la longueur 3 avec 'a' -> 'xaa'
Parameters
- inputs: TextPadDto
  Le texte, la longueur à atteindre et le caractère de remplissage
Returns string
Le texte complété
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
Transforme chaque lettre en majuscule.

Exemple : 'hello' -> 'HELLO'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte en majuscules
- Defined in bitbybit-docs.d.ts:56832

toLowerCase

toLowerCase(inputs: Bit.Inputs.Text.TextDto): string
Transforme chaque lettre en minuscule.

Exemple : 'HELLO' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte en minuscules
- Defined in bitbybit-docs.d.ts:56843

toUpperCaseFirst

toUpperCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Transforme le premier caractère en majuscule et laisse le reste tel quel.

Exemple : 'hello world' -> 'Hello world'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte avec son premier caractère en majuscule
- Defined in bitbybit-docs.d.ts:56854

toLowerCaseFirst

toLowerCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Transforme le premier caractère en minuscule et laisse le reste tel quel.

Exemple : 'Hello World' -> 'hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte avec son premier caractère en minuscule
- Defined in bitbybit-docs.d.ts:56865

repeat

repeat(inputs: TextRepeatDto): string
Répète un texte un certain nombre de fois, bout à bout.

Exemple : 'ha' trois fois -> 'hahaha'
Parameters
- inputs: TextRepeatDto
  Le texte et le nombre de fois où le répéter
Returns string
Le texte répété
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
Inverse l'ordre des caractères.

Exemple : 'hello' -> 'olleh'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  Le texte
Returns string
Le texte inversé
- Defined in bitbybit-docs.d.ts:56891

concat

concat(inputs: TextConcatDto): string
Joint plusieurs textes en un seul sans rien entre eux.

Exemple : ['hello', ' ', 'world'] -> 'hello world'
Parameters
- inputs: TextConcatDto
  Les textes à assembler
Returns string
Le texte assemblé
Example
```
const sentence = bitbybit.text.concat({ texts: ["hello", " ", "world"] });
```
- Defined in bitbybit-docs.d.ts:56928

vector

vectorChar

vectorChar(inputs: VectorCharDto): VectorCharData
Dessine un caractère sous forme de chemins de lignes avec une police de traits simple.

Les chemins sont posés à plat sur le plan XZ, mis à l'échelle pour que le caractère mesure height de haut, et sont renvoyés avec la largeur et la hauteur du caractère. Un caractère inconnu est dessiné comme un point d'interrogation. Exemple : 'A' à la hauteur 10 -> les traits d'un A, de 10 unités de haut
Parameters
- inputs: VectorCharDto
  Le caractère, sa hauteur et ses décalages
Returns VectorCharData
La largeur, la hauteur et les chemins de traits du caractère sous forme de listes de points
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[]
Dessine un texte, avec ses sauts de ligne, sous forme de chemins de lignes avec une police de traits simple.

Chaque ligne revient sous forme de ses caractères avec leurs chemins, disposés à plat sur le plan XZ avec la hauteur, l'espacement et l'alignement donnés ; centerOnOrigin place le milieu du bloc à l'origine. Exemple : 'Hello' à la hauteur 10 -> cinq caractères avec leurs traits
Parameters
- inputs: VectorTextDto
  Le texte et la façon de le disposer
Returns VectorTextData[]
Une entrée par ligne, chacune avec ses caractères et leurs chemins de traits
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