IConfig

[ Interface ]

export interface IConfig {
    basePath: string;
    scaleMode: ScaleModeString;
    startupView: string;
    loginPage?: string;
    dependencyFiles?: (StylesheetFileDescription | JavaScriptFileDescription)[];
    activeTheme: string;
    themes: Dictionary<ProjectThemeDescription>;
    tcHmiServer: {
        websocketIntervalTime: number;
        websocketTimeout: number;
        websocketSystemTimeout: number;
        websocketSubscriptionMode?: 'Change' | 'Poll';
    };
    symbols: ISymbolConfig;
    trigger: Trigger[];
    packages: IPackageInfo[];
    views: IView[];
    userFunctions: IUserFunction[];
    userControls: IUserControl[];
    content: IContent[];
    actionTemplates: ActionTemplate[];
    languages: ILanguageFileMap;
    keyboardLayouts: IProjectKeyboardLayout[];
    disableLoadingOptimization?: boolean;
    creatorSettings: {
        viewport: {
            defaultWidth: number;
            defaultHeight: number;
        };
    };
}

Represents the contents of the file: tcmiconfig.json.

Properties

Name	Type	Description
basePath	string	The path to the framework directory.
scaleMode	ScaleModeString	Global scaling mode
startupView	string	Path to the View file to be loaded by default.
loginPage	string	Path to an HTML file that should be used as an alternative login page.
dependencyFiles	(StylesheetFileDescription \| JavaScriptFileDescription)[]	Project dependencies
activeTheme	string	The currently used theme.
themes	Dictionary<ProjectThemeDescription>	List of all available themes.
tcHmiServer	{ websocketIntervalTime: number; websocketTimeout: number; websocketSystemTimeout: number; websocketSubscriptionMode?: 'Change' \| 'Poll'; };	Global settings for the connections with the TwinCAT HMI server.
symbols	ISymbolConfig	Configuration of internal symbols.
trigger	Trigger[]	Global triggers
packages	IPackageInfo[]	TwinCAT HMI NuGet packages that are to be loaded.
views	IView[]	List of Views available in the project.
userFunctions	IUserFunction[]	List of functions available in the project.
userControls	IUserControl[]	List of user controls available in the project.
content	IContent[]	List of contents available in the project.
actionTemplates	ActionTemplate[]	List of ActionTemplates available in the project.
languages	ILanguageFileMap	List of localization files available in the project.
keyboardLayouts	IProjectKeyboardLayout[]	List of keyboard layouts available in the project.
disableLoadingOptimization [ optional ]	boolean	Contains persistent designer settings.
creatorSettings	{ viewport: { defaultWidth: number; defaultHeight: number; } }	Contains persistent designer settings.

	Available from version 1.12