You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IframeApi Reference

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

Modules

Name Description
CustomersCanvas

To use the Customer's Canvas IFrame API, you should link the IframeApi.js script located in ~/Resources/SPEditor/Scripts/IFrame/. In addition, you need to specify a URL leading to Customer's Canvas instance - either by adding id="CcIframeApiScript" to the script tag or using the IframeApi.editorUrl property. Here is the simplest way to enable IFrame API on your page.

Type aliases

DeepPartial

DeepPartial: If < IsArrayType < T > , MapArrayType < T & List < __type > > , MapScalarOrObjectType < T > >

Makes all properties of T optional.