Skip to content
amCharts 4

TextFormatter

Type class

Handles formatting of pseudo-markdown in text.

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";

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.

4 inherited items
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 objectInherited 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 stringInherited from BaseObject

Returns object's internal unique ID.

Methods

constructor()

Returns TextFormatter

Constructor

format(text: string,
output?: string)

Returns string

Formats the text according to specifications passed in.

5 inherited items
clone(cloneId?: string)

Returns thisInherited 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.

copyFrom(object: this)

Returns voidInherited from BaseObject

Copies all properties and related data from different element.

dispose()

Returns voidInherited from BaseObject

Destroys this object and all related data.

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 booleanInherited from BaseObject

Returns if this object has been already been disposed.

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.