Class TextBitByBit

Trabalhar com texto: dividir, juntar, pesquisar, aparar, preencher, mudar a capitalização, expressões regulares e formatação com marcadores de posição. vectorChar e vectorText transformam texto em caminhos de linhas desenhados com uma fonte de traços simples, para que as palavras possam tornar-se geometria. As posições no texto contam a 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
Passa um texto adiante sem alteração, para que um valor possa receber um nome e ser reutilizado.

Exemplo: 'Hello World' -> 'Hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O mesmo texto
- Defined in bitbybit-docs.d.ts:56548

query

includes

includes(inputs: TextSearchDto): boolean
Indica se um texto contém um texto de pesquisa.

Exemplo: 'hello world' inclui 'world' -> true
Parameters
- inputs: TextSearchDto
  O texto e o que procurar
Returns boolean
True quando o texto procurado ocorre nele
Example
```
const has = bitbybit.text.includes({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56647

startsWith

startsWith(inputs: TextSearchDto): boolean
Indica se um texto começa com um texto de pesquisa.

Exemplo: 'hello world' começa com 'hello' -> true
Parameters
- inputs: TextSearchDto
  O texto e o que procurar no seu início
Returns boolean
True quando o texto começa por ele
Example
```
const starts = bitbybit.text.startsWith({ text: "hello world", search: "hello" });
```
- Defined in bitbybit-docs.d.ts:56662

endsWith

endsWith(inputs: TextSearchDto): boolean
Indica se um texto termina com um texto de pesquisa.

Exemplo: 'hello world' termina com 'world' -> true
Parameters
- inputs: TextSearchDto
  O texto e o que procurar no seu fim
Returns boolean
True quando o texto termina com ele
Example
```
const ends = bitbybit.text.endsWith({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56677

indexOf

indexOf(inputs: TextSearchDto): number
Encontra onde um texto de pesquisa ocorre pela primeira vez, contando caracteres a partir de 0, ou -1 quando não ocorre.

Exemplo: 'hello world' a procurar 'world' -> 6
Parameters
- inputs: TextSearchDto
  O texto e o que procurar
Returns number
A posição da primeira ocorrência, 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
Encontra onde um texto de pesquisa ocorre pela última vez, contando caracteres a partir de 0, ou -1 quando não ocorre.

Exemplo: 'hello world hello' a procurar 'hello' -> 12
Parameters
- inputs: TextSearchDto
  O texto e o que procurar
Returns number
A posição da última ocorrência, 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
Lê o carácter numa posição, a contar de 0.

Exemplo: 'hello' em 1 -> 'e'
Parameters
- inputs: TextIndexDto
  O texto e a posição
Returns string
O caráter, ou um texto vazio quando a posição está fora do texto
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
Conta os caracteres de um texto.

Exemplo: 'hello' -> 5
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns number
O número de carateres
- Defined in bitbybit-docs.d.ts:56902

isEmpty

isEmpty(inputs: Bit.Inputs.Text.TextDto): boolean
Indica se um texto está vazio ou contém apenas espaços em branco.

Exemplo: ' ' -> true, 'a' -> false
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns boolean
True quando não há nada além de espaços em branco
- Defined in bitbybit-docs.d.ts:56913

regex

regexTest

regexTest(inputs: TextRegexDto): boolean
Indica se uma expressão regular corresponde em algum sítio de um texto.

Exemplo: 'hello123' contra '[0-9]+' -> true
Parameters
- inputs: TextRegexDto
  O texto, o padrão e as flags
Returns boolean
True quando o padrão corresponde
Example
```
const hasDigits = bitbybit.text.regexTest({ text: "hello123", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:56943

regexMatch

regexMatch(inputs: TextRegexDto): string[]
Encontra as partes de um texto a que uma expressão regular corresponde.

Com o indicador g todas as correspondências são listadas; sem ele só a primeira correspondência e os seus grupos de captura. Nenhuma correspondência dá null. Exemplo: 'hello123world456' contra '[0-9]+' com 'g' -> ['123', '456']
Parameters
- inputs: TextRegexDto
  O texto, o padrão e as flags
Returns string[]
As correspondências, ou null quando não há nenhuma
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
Substitui aquilo a que uma expressão regular corresponde por outro texto.

Com o indicador g todas as correspondências são substituídas; sem ele só a primeira. Exemplo: 'hello123world456' contra '[0-9]+' com 'g', substituído por 'X' -> 'helloXworldX'
Parameters
- inputs: TextRegexReplaceDto
  O texto, o padrão, as flags e a substituição
Returns string
O texto com as substituições feitas
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
Encontra onde uma expressão regular corresponde pela primeira vez, contando caracteres a partir de 0, ou -1 quando não corresponde.

Exemplo: 'hello123' contra '[0-9]+' -> 5
Parameters
- inputs: TextRegexDto
  O texto, o padrão e as flags
Returns number
A posição da primeira correspondência, 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[]
Corta um texto em pedaços onde quer que uma expressão regular corresponda; as próprias correspondências são descartadas.

Exemplo: 'a1b2c3' dividido por '[0-9]+' -> ['a', 'b', 'c', '']
Parameters
- inputs: TextRegexDto
  O texto, o padrão e as flags
Returns string[]
As partes, por ordem
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[]
Corta um texto em pedaços onde quer que ocorra um separador; o próprio separador é descartado.

Exemplo: 'apple,banana,cherry' dividido por ',' -> ['apple', 'banana', 'cherry']
Parameters
- inputs: TextSplitDto
  O texto e o separador
Returns string[]
As partes, por ordem
Example
```
const parts = bitbybit.text.split({ text: "apple,banana,cherry", separator: "," });
```
- Defined in bitbybit-docs.d.ts:56563

replaceAll

replaceAll(inputs: TextReplaceDto): string
Substitui todas as ocorrências de um texto de pesquisa por outro texto.

Exemplo: 'hello hello' a substituir 'hello' por 'hi' -> 'hi hi'
Parameters
- inputs: TextReplaceDto
  O texto, o que procurar e o que colocar no seu lugar
Returns string
O texto com as substituições feitas
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
Une uma lista de textos num só, com um separador entre vizinhos.

Exemplo: ['apple', 'banana', 'cherry'] unidos por ', ' -> 'apple, banana, cherry'
Parameters
- inputs: TextJoinDto
  Os textos e o separador
Returns string
O texto junto
Example
```
const line = bitbybit.text.join({ list: ["apple", "banana"], separator: ", " });
```
- Defined in bitbybit-docs.d.ts:56593

toString

toString<T>(inputs: ToStringDto<T>): string
Transforma qualquer valor em texto, tal como o JavaScript o imprime.

Exemplo: 42 -> '42', [1, 2] -> '1,2'
Type Parameters
- T
Parameters
- inputs: ToStringDto<T>
  O valor
Returns string
O valor como texto
- Defined in bitbybit-docs.d.ts:56604

toStringEach

toStringEach<T>(inputs: ToStringEachDto<T>): string[]
Transforma cada item de uma lista em texto, tal como o JavaScript o imprime.

Exemplo: [1, 2.5, true] -> ['1', '2.5', 'true']
Type Parameters
- T
Parameters
- inputs: ToStringEachDto<T>
  A lista de valores
Returns string[]
Um texto por item, por ordem
- Defined in bitbybit-docs.d.ts:56615

format

format(inputs: TextFormatDto): string
Preenche marcadores numerados num texto com valores: {0} recebe o primeiro valor, {1} o segundo, e assim por diante.

Um marcador sem valor é deixado tal como está. Exemplo: 'Point: ({0}, {1})' com [10, 5] -> 'Point: (10, 5)'
Parameters
- inputs: TextFormatDto
  O texto com marcadores de posição e os valores a preencher
Returns string
O texto preenchido
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
Toma os caracteres de uma posição inicial até, mas não incluindo, uma posição final.

Um início maior do que o fim troca os dois, e posições negativas contam como 0. Exemplo: 'hello world' de 0 a 5 -> 'hello'
Parameters
- inputs: TextSubstringDto
  O texto e as posições de início e fim
Returns string
Os carateres nesse intervalo
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
Toma os caracteres de uma posição inicial até, mas não incluindo, uma posição final.

Ao contrário de substring, uma posição negativa conta a partir do fim do texto. Exemplo: 'hello world' de 0 a 5 -> 'hello'; de -5 -> 'world'
Parameters
- inputs: TextSubstringDto
  O texto e as posições de início e fim
Returns string
Os carateres nesse intervalo
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
Remove espaços, tabulações e quebras de linha de ambas as extremidades de um texto.

Exemplo: ' hello ' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto aparado
- Defined in bitbybit-docs.d.ts:56767

trimStart

trimStart(inputs: Bit.Inputs.Text.TextDto): string
Remove espaços, tabulações e quebras de linha do início de um texto.

Exemplo: ' hello ' -> 'hello '
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto sem espaços iniciais
- Defined in bitbybit-docs.d.ts:56778

trimEnd

trimEnd(inputs: Bit.Inputs.Text.TextDto): string
Remove espaços, tabulações e quebras de linha do fim de um texto.

Exemplo: ' hello ' -> ' hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto sem espaços finais
- Defined in bitbybit-docs.d.ts:56789

padStart

padStart(inputs: TextPadDto): string
Acrescenta um texto de preenchimento à frente até o texto atingir um comprimento; um texto que já tenha esse comprimento é deixado em paz.

Exemplo: 'x' até ao comprimento 3 com 'a' -> 'aax'
Parameters
- inputs: TextPadDto
  O texto, o comprimento a atingir e o preenchimento
Returns string
O texto preenchido
Example
```
const padded = bitbybit.text.padStart({ text: "7", length: 3, padString: "0" });
```
- Defined in bitbybit-docs.d.ts:56805

padEnd

padEnd(inputs: TextPadDto): string
Acrescenta um texto de preenchimento atrás até o texto atingir um comprimento; um texto que já tenha esse comprimento é deixado em paz.

Exemplo: 'x' até ao comprimento 3 com 'a' -> 'xaa'
Parameters
- inputs: TextPadDto
  O texto, o comprimento a atingir e o preenchimento
Returns string
O texto preenchido
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
Transforma todas as letras em maiúsculas.

Exemplo: 'hello' -> 'HELLO'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto em maiúsculas
- Defined in bitbybit-docs.d.ts:56832

toLowerCase

toLowerCase(inputs: Bit.Inputs.Text.TextDto): string
Transforma todas as letras em minúsculas.

Exemplo: 'HELLO' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto em minúsculas
- Defined in bitbybit-docs.d.ts:56843

toUpperCaseFirst

toUpperCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Transforma o primeiro carácter em maiúscula e deixa o resto tal como está.

Exemplo: 'hello world' -> 'Hello world'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto com o seu primeiro caráter em maiúscula
- Defined in bitbybit-docs.d.ts:56854

toLowerCaseFirst

toLowerCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Transforma o primeiro carácter em minúscula e deixa o resto tal como está.

Exemplo: 'Hello World' -> 'hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto com o seu primeiro caráter em minúscula
- Defined in bitbybit-docs.d.ts:56865

repeat

repeat(inputs: TextRepeatDto): string
Repete um texto um número de vezes, de ponta a ponta.

Exemplo: 'ha' três vezes -> 'hahaha'
Parameters
- inputs: TextRepeatDto
  O texto e quantas vezes repeti-lo
Returns string
O texto repetido
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
Inverte a ordem dos caracteres.

Exemplo: 'hello' -> 'olleh'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  O texto
Returns string
O texto invertido
- Defined in bitbybit-docs.d.ts:56891

concat

concat(inputs: TextConcatDto): string
Une vários textos num só sem nada entre eles.

Exemplo: ['hello', ' ', 'world'] -> 'hello world'
Parameters
- inputs: TextConcatDto
  Os textos a juntar
Returns string
O texto junto
Example
```
const sentence = bitbybit.text.concat({ texts: ["hello", " ", "world"] });
```
- Defined in bitbybit-docs.d.ts:56928

vector

vectorChar

vectorChar(inputs: VectorCharDto): VectorCharData
Desenha um carácter como caminhos de linha com um tipo de letra de traço simples.

Os caminhos assentam planos no plano XZ, escalados para que o carácter tenha height de altura, e são devolvidos com a largura e a altura do carácter. Um carácter desconhecido é desenhado como um ponto de interrogação. Exemplo: 'A' com altura 10 -> os traços de um A, com 10 unidades de altura
Parameters
- inputs: VectorCharDto
  O caráter, a sua altura e os seus deslocamentos
Returns VectorCharData
A largura, a altura e os caminhos dos traços do caráter como listas de pontos
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[]
Desenha um texto, com quebras de linha, como caminhos de linha com um tipo de letra de traço simples.

Cada linha volta como os seus caracteres com os seus caminhos, dispostos planos no plano XZ com a altura, o espaçamento e o alinhamento dados; centerOnOrigin põe o meio do bloco na origem. Exemplo: 'Hello' com altura 10 -> cinco caracteres com os seus traços
Parameters
- inputs: VectorTextDto
  O texto e como o dispor
Returns VectorTextData[]
Uma entrada por linha, cada uma com os seus carateres e os caminhos dos seus traços
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