Skip to content

IConfig

Type interface

Editor configuration.

Sources

IConfig is an interface: it describes a shape of data and is not imported on its own.

Properties

allowDefaultTemplates

Type boolean

If set to true bundled Editor templates will be displayed.

Otherwise, only template supplied through the launcher are available.

chartConfig

Type object

Object-style (JSON) chart configuration for editing.

Leave unset when creating a new chart or set to an existing configuration for editing.

You can also pass the configuration via the argument to the EditorLauncher.launch() method.

editorLicense

Type string

Editor license key

enabledModules

Type ModuleType[]

Enabled Editor modules.

List editor modules that should be accessible to the user.

Supported values 'home' | 'design' | 'data' | 'code'

engineConfig

Type IEngineConfig

Configuration for amCharts 4 engine (am4core).

You can set amCharts themes and license numbers via this property.

language

Type ITranslationPack

Translation prompts.

presetData

Type IPresetData

Data to use in place of template data when creating a new chart.

Set this to your dataset when you want users to create charts based on your existing data.

templates

Type ITemplateGroup[]

Available chart templates.

If set these templates will be presented to the user on the Home screen of the Editor.

Set allowDefaultTemplates to true to display built-in (bundled) templates instead.