TextFormatter – amCharts 4 Documentation

Type class

Handles formatting of pseudo-markdown in text.

@todo Encode < > in output
@todo Add more adapters

Sources

TextFormatter can be used (imported) via one of the following packages.

/**
 * --------------------------------------------------------
 * Import from: "core.ts"
 * Use like: am4core.TextFormatter
 * --------------------------------------------------------
 */
import * as am4core from "@amcharts/amcharts4/core";

/**
 * --------------------------------------------------------
 * Include via: <script src="core.js"></script>
 * Access items like: am4.TextFormatter
 * --------------------------------------------------------
 */

Inheritance

TextFormatter extends BaseObject.

TextFormatter is not extended by any other symbol.

Properties

adapter #	Type `Adapter` < `TextFormatter`, `ITextFormatterAdapters` > Default `new Adapter<TextFormatter, ITextFormatterAdapters>(this)` Adapter.
clonedFrom #	Type `$type.Optional` < `this` > Inherited from `BaseObject` Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.
config #	Type `object` Inherited from `BaseObject` Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc. Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.
id #	Type `$type.Optional` < `string` > Inherited from `BaseObject` Sets the user-defined id of the element.
uid #	Type `string` Inherited from `BaseObject` Returns object's internal unique ID.
There are 4 inherited items currently hidden from this list.

Methods

clone( cloneId?: `string` ) #	Returns `this` Inherited from `BaseObject` Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.
constructor() #	Returns `TextFormatter` Constructor
copyFrom( object: `this` ) #	Returns `void` Inherited from `BaseObject` Copies all properties and related data from different element.
dispose() #	Returns `void` Inherited from `BaseObject` Destroys this object and all related data.
format( text: `string`, output?: `string` ) #	Returns `string` Formats the text according to specifications passed in.
getCurrentThemes() #	Returns `ITheme[]` Inherited from `BaseObject` Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide.
isDisposed() #	Returns `boolean` Inherited from `BaseObject` Returns if this object has been already been disposed.
There are 5 inherited items currently hidden from this list.

clone(

cloneId?: string

)

Returns this

Inherited from BaseObject

Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.

constructor()

Returns TextFormatter

Constructor

copyFrom(

object: this

)

Returns void

Inherited from BaseObject

Copies all properties and related data from different element.

dispose()

Returns void

Inherited from BaseObject

Destroys this object and all related data.

format(

text: string,
output?: string

)

Returns string

Formats the text according to specifications passed in.

getCurrentThemes()

Returns ITheme[]

Inherited from BaseObject

Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide.

isDisposed()

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

There are 5 inherited items currently hidden from this list.

Events

TextFormatter does not have any events.

Adapters

#chunk	Param `string` Applied to each chunk of text when it is parsed and added to chunk list.

#chunk

Param string

Applied to each chunk of text when it is parsed and added to chunk list.