Enabling Custom Load Mask

To enable a load mask to indicate the progress of any activity in your application, use the CTCUSTOMLOADMASKMANAGER.showCustomLoadMask

The developer can configure the values for the following API parameters as objects:

  • templateUrl - This is a mandatory parameter. The value for this parameter should be either the path of the template (CTTPL) file or name of the CTTPL file if it is placed within the templates folder as instructed in the Prerequisite.
  • dataConfig - This is a mandatory parameter. The following attributes should be configured for this parameter:
    • title - Indicates the title of the load mask. The maximum character limit for this parameter is 30. The characters exceeding this limit will not be displayed and only an eclipse (...) will be rendered.
    • loaderMessage - Indicates the message that is to be rendered within the load mask. The maximum character limit for this parameter is 40. The characters exceeding this limit will not be displayed and only an eclipse (...) will be rendered.
    • width - Indicates the width of the load mask on the screen. The value for this parameter can either be provided as pixels or % of the screen size.
    • height - Indicates the height of the load mask on the screen. The value for this parameter can either be provided as pixels or % of the screen size.

If no values are provided for the templateUrl and dataConfig parameters, then the default load mask will be rendered.

Example:

var loadMaskConfig = 
{

	'templateUrl' : "square_rotate_Loader.cttpl",

	'dataConfig' : 
					{
						title : 'Canvas',
						loaderMessage : 'Preparing Your Workspace',
						width : '100%',
						height : '100%'
					}

}
CTCUSTOMLOADMASKMANAGER.showCustomLoadMask(loadMaskConfig)


 Load Mask - Desktop


 Load Mask - Mobile