Type Alias: DesignerApiAppSettings

type DesignerApiAppSettings = object;

Properties

about

about: AppAboutSettings;

Contains documentation links and application info

editor

editor: AppEditorSettings;

Information about the availability of common actions with the report and selected items

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
const designer = arWebDesigner.apiOf('ar-web-designer');
if (designer.app.editor.canUndo) designer.app.editor.undo();

// UMD usage
const designer = GrapeCity.ActiveReports.Designer.apiOf('ar-web-designer');
if (designer.app.editor.canUndo) designer.app.editor.undo();

	const designer = GrapeCity.ActiveReports.Designer.apiOf('ar-web-designer');
	if (designer.app.editor.canUndo) designer.app.editor.undo();

focus()

focus: () => void;

Returns focus to Designer. Focus may be lost when plug-in components are opened/closed.
Returning focus is essential to continue using Designer hotkeys like Ctrl+Z (undo), Ctrl+Y (redo), etc.

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		rpx: { enabled: true },
		appBar: { openButton: { visible: true } }
	}).then((designer) => {
			designer.app.focus();
		 });

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		rpx: { enabled: true },
		appBar: { openButton: { visible: true } }
	}).then((designer) => {
			designer.app.focus();
		 });

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		rpx: { enabled: true },
		appBar: { openButton: { visible: true } }
	}).then((designer: DesignerAPI) => {
			designer.app.focus();
		 });

panels

panels: AppPanelsSettings;

Contains access to the menu and sidebar panels

themes

themes: ThemesAPI;