PopulateString – amCharts 5 Documentation

Type module

Sources

Items from PopulateString can be imported/included and used via following ways.

/**
 * --------------------------------------------------------
 * Import via: PopulateString.ts
 * Access items like: $populatestring.myVariable
 *                    $populatestring.myFunction()
 * --------------------------------------------------------
 */
import * as $populatestring from "@amcharts/amcharts5/PopulateString";

Variables

PopulateString does not have any variables.

Functions

getCustomDataValue( target: `Sprite`, prop: `string` ) #	Returns `any` Returns a value from target `Sprite`'s `customData`.
getTagValue( target: `Sprite`, tagName: `string`, format?: `undefined` \| `string` ) #	Returns `string` Returns an abstract value from the target `Sprite`'s data item, settings, properties or parents.
populateString( target: `Sprite`, string: `string` ) #	Returns `string` Populates the curly-bracket placeholders with actual values from a `Sprite`.

getCustomDataValue(

target: Sprite,
prop: string

)

Returns any

Returns a value from target Sprite's customData.

getTagValue(

target: Sprite,
tagName: string,
format?: undefined | string

)

Returns string

Returns an abstract value from the target Sprite's data item, settings, properties or parents.

populateString(

target: Sprite,
string: string

)

Returns string

Populates the curly-bracket placeholders with actual values from a Sprite.