`str`

Text.

#Functions

#`str.contains`function

true when str occurs in source.

str.contains(source: string, str: string): bool

Parameter	Type	Description
`source`	`string`	The series to read.
`str`	`string`	The text to look for.

Returns bool.

Example

ChartScriptFragmentOpen in editor

const b = str.contains(market.id, "BTC")

Since ChartScript 1

#`str.endswith`function

true when source ends with str.

str.endswith(source: string, str: string): bool

Parameter	Type	Description
`source`	`string`	The series to read.
`str`	`string`	The text to look for.

Returns bool.

Example

ChartScriptFragmentOpen in editor

const b = str.endswith(market.symbol, "USDT")

Since ChartScript 1

#`str.format`function

Fills {0}, {1} ... with the arguments.

str.format(formatString: string): string

str.format(formatString: string, arg: T, …): string

Parameter	Type	Description
`formatString`	`string`	The pattern: {0}, {1}, ... with optional ,number,#.## formats.
`arg`	`T`	A value.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.format("{0} at {1,number,#.##}", market.symbol, close)

Since ChartScript 1

#`str.format_time`function

A time as text.

str.format_time(time: int, { format?: string = "yyyy-MM-dd'T'HH:mm:ssZ", timezone?: string = "UTC" }): string

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`format`	`string`default `"yyyy-MM-dd'T'HH:mm:ssZ"`	The number format (format.*).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.format_time(time, "yyyy-MM-dd HH:mm")

Since ChartScript 1

#`str.length`function

The number of characters.

str.length(string: string): int

Parameter	Type	Description
`string`	`string`	The text.

Returns int.

Example

ChartScriptFragmentOpen in editor

const n = str.length(market.symbol)

Since ChartScript 1

#`str.lower`function

Lower case.

str.lower(source: string): string

Parameter	Type	Description
`source`	`string`	The series to read.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.lower(market.base)

Since ChartScript 1

#`str.match`function

The first match of a pattern, or "".

str.match(source: string, regex: string): string

Parameter	Type	Description
`source`	`string`	The series to read.
`regex`	`string`	A pattern (a safe, length-capped subset).

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.match(market.symbol, "USD.?")

Since ChartScript 1

#`str.pos`function

The position of str in source, or na.

str.pos(source: string, str: string): int

Parameter	Type	Description
`source`	`string`	The series to read.
`str`	`string`	The text to look for.

Returns int.

Example

ChartScriptFragmentOpen in editor

const p = str.pos(market.id, ":")

Since ChartScript 1

#`str.repeat`function

The text repeated.

str.repeat(source: string, repeat: int, { separator?: string = "" }): string

Parameter	Type	Description
`source`	`string`	The series to read.
`repeat`	`int`	How many times.
`separator`	`string`default `""`	The text placed between the parts.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.repeat("*", 3)

Since ChartScript 1

#`str.replace`function

Replaces one occurrence (0 = the first).

str.replace(source: string, target: string, replacement: string, { occurrence?: int = 0 }): string

Parameter	Type	Description
`source`	`string`	The series to read.
`target`	`string`	The text to replace.
`replacement`	`string`	The replacement.
`occurrence`	`int`default `0`	Which occurrence: 0 = the latest.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.replace(market.id, ":", "/")

Since ChartScript 1

#`str.replace_all`function

Replaces every occurrence.

str.replace_all(source: string, target: string, replacement: string): string

Parameter	Type	Description
`source`	`string`	The series to read.
`target`	`string`	The text to replace.
`replacement`	`string`	The replacement.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.replace_all(market.id, ":", " ")

Since ChartScript 1

#`str.split`function

Splits the text into an array.

str.split(string: string, separator: string): array<string>

Parameter	Type	Description
`string`	`string`	The text.
`separator`	`string`	The text placed between the parts.

Returns array<string>.

Example

ChartScriptFragmentOpen in editor

const parts = str.split(market.id, ":")

Since ChartScript 1

#`str.startswith`function

true when source starts with str.

str.startswith(source: string, str: string): bool

Parameter	Type	Description
`source`	`string`	The series to read.
`str`	`string`	The text to look for.

Returns bool.

Example

ChartScriptFragmentOpen in editor

const b = str.startswith(market.symbol, "BTC")

Since ChartScript 1

#`str.substring`function

Part of the text.

str.substring(source: string, begin_pos: int): string

str.substring(source: string, begin_pos: int, end_pos: int): string

Parameter	Type	Description
`source`	`string`	The series to read.
`begin_pos`	`int`	The first character (0-based).
`end_pos`	`int`	One past the last character.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.substring(market.symbol, 0, 3)

Since ChartScript 1

#`str.tonumber`function

The number in the text, or na.

str.tonumber(string: string): float

Parameter	Type	Description
`string`	`string`	The text.

Returns float.

Example

ChartScriptFragmentOpen in editor

const n = str.tonumber("42.5")

Since ChartScript 1

#`str.tostring`function

The value as text; format "#.##", "0.00", format.mintick, format.percent or format.volume.

str.tostring(value: T, { format?: string = "" }): string

Parameter	Type	Description
`value`	`T`	The value.
`format`	`string`default `""`	The number format (format.*).

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.tostring(close, "#.##")

Since ChartScript 1

#`str.tpl`function

A text from a template with {0}, {1} ... (numbers as str.tostring writes them).

str.tpl(template: string, values: T, …): string

Parameter	Type	Description
`template`	`string`	The text with {0}, {1} ... places.
`values`	`T`	The values.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.tpl("{0}  {1}", "POC", close)

Since ChartScript 1

#`str.trim`function

Removes spaces at both ends.

str.trim(source: string): string

Parameter	Type	Description
`source`	`string`	The series to read.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.trim("  a  ")

Since ChartScript 1

#`str.upper`function

Upper case.

str.upper(source: string): string

Parameter	Type	Description
`source`	`string`	The series to read.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = str.upper(market.base)

Since ChartScript 1

str

#Functions

#str.containsfunction

#str.endswithfunction

#str.formatfunction

#str.format_timefunction

#str.lengthfunction

#str.lowerfunction

#str.matchfunction

#str.posfunction

#str.repeatfunction

#str.replacefunction

#str.replace_allfunction

#str.splitfunction

#str.startswithfunction

#str.substringfunction

#str.tonumberfunction

#str.tostringfunction

#str.tplfunction

#str.trimfunction

#str.upperfunction

`str`

#`str.contains`function

#`str.endswith`function

#`str.format`function

#`str.format_time`function

#`str.length`function

#`str.lower`function

#`str.match`function

#`str.pos`function

#`str.repeat`function

#`str.replace`function

#`str.replace_all`function

#`str.split`function

#`str.startswith`function

#`str.substring`function

#`str.tonumber`function

#`str.tostring`function

#`str.tpl`function

#`str.trim`function

#`str.upper`function