Type Alias: NotificationsAPI

type NotificationsAPI = object;

Properties

dismissAll()

dismissAll: () => void;

Dismisses all the notifications

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.dismissAll();
});

// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.dismissAll();
});

	const designer = GrapeCity.ActiveReports.Designer.apiOf('ar-web-designer');
	designer.notifications.dismissAll();

---

error()

error: (caption, errorText?) => void;

Sends an error notification

Parameters

caption

string

Error caption

errorText?

string

Optional error details

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.error("Application error");
});

// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.error("Application error");
});

	var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
      storeUnsavedReport: false
  }).then((api: DesignerAPI) => {
          api.notifications.error("Application error");
 });

---

info()

info: (caption, text?) => void;

Sends a general notification. Can be used to notify when any user-initiated action is complete

Parameters

caption

string

Notification caption

text?

string

Optional notification content

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.info('Notification');
});

// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.info('Notification');
});

var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
     storeUnsavedReport: false
 }).then((api: DesignerAPI) => {
     api.notifications.info('Notification');
		});

***

### send()

```ts
send: (level, caption, content?) => void;

Sends a notification of specified level, caption and content

Parameters

level

Notification level. Determines color and icons used for the notifications

"info" | "warning" | "error"

caption

string

Notification caption. Shown by default when notification pops up, then used as a title in Notification Details view

content?

string

Notification content. Only visible when Notification Details are open

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.send('info', 'My information');
});

// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.send('info', 'My information');
});

var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
     storeUnsavedReport: false
 }).then((api: DesignerAPI) => {
     api.notifications.send('info', 'My information');
});

---

warning()

warning: (caption, warningText?) => void;

Sends a warning notification

Parameters

caption

string

Warning caption

warningText?

string

Optional warning details

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.warning('Warning');
});

// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.warning('Warning');
});

	var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
      storeUnsavedReport: false
  }).then((api: DesignerAPI) => {
      api.notifications.warning('Warning');
 });