Interface: IErrorDisplayOptions

Options used to display a full screen error on top of an HTMLElement

Properties

backgroundColor?

optionalbackgroundColor: string

Optional background color for full screen error. If not provided, defaults to #fff (white).

---

imageFileName?

optionalimageFileName: string

Name of file to display with error. Default is 'DocFailUpdated.png' if not provided.

---

linkInformation?

optionallinkInformation: IErrorLinkInformation

Optional configuration to display a link in error message.

---

parentElement?

optionalparentElement: HTMLElement

The HTML Element to display the error on top of. If parentElementId is also defined, this will be ignored. If neither parentElementId nor parentElement are defined, the default will be used.

---

parentElementId?

optionalparentElementId: string

The ID of the HTML Element to display the error on top of.

---

retryHandler()?

optionalretryHandler: () => any

Callback for retry button handling. If not set, retry button will not be displayed.

Returns

any