GlobalDesignerAPI

Type Alias: GlobalDesignerAPI

type GlobalDesignerAPI = object;

Type of GrapeCity.ActiveReports.Designer object exported by web-designer.js module.

Properties

addLanguage()

addLanguage: (lng, resources) => void;

Adds language resources for all instances of WebDesigner

Example: GrapeCity.ActiveReports.Designer.addLanguage('en', [ { "ns": "app", "lng": "en", "resources": { "textAppTitleCompact": "", } }, ]); **

Parameters

lng

string

resources

ResourceBundle[]

Returns

void

apiOf()

apiOf: (instanceId) => DesignerAPI | undefined;

Returns DesignerAPI of previously created instance of WebDesigner

Example: const designer = GrapeCity.ActiveReports.Designer.apiOf('ar-web-designer'); **

Parameters

instanceId

string

Returns

DesignerAPI | undefined

create()

create: (selector, settings) => Promise<DesignerAPI>;

Renders Web Designer to

element with given selector using the specified DesignerSettings object.

Example:

GrapeCity.ActiveReports.Designer.create('#designer-id', designerSettings);

Parameters

selector

string

Designer container selector

settings

DesignerSettings

DesignerSettings object

Returns

Promise<DesignerAPI>

DesignerAPI of this instance

destroy()

destroy: (selector, instanceId) => void;

Destroys Designer Application

Example:

// with instanceId
GrapeCity.ActiveReports.Designer.create('#container-1', { ...settings, instanceId: 'instance-1' });
GrapeCity.ActiveReports.Designer.destroy('#container-1', 'instance-1');

// without instanceId
GrapeCity.ActiveReports.Designer.create('#container-2', settings);
GrapeCity.ActiveReports.Designer.destroy('#container-2');

Parameters

selector

string

Designer container selector

instanceId

string

Optional parameter. Use only if Designer was created using DesignerSettings.instanceId.

Returns

void