Skip to main content

Help Guide Events

HelpGuideSectionOpened​

Description​

The HelpGuideSectionOpened event is triggered when a section of the help guide is opened by the user in the map application using the Maptaskr for Power Pages App. This event provides information about the opened section's name.

Usage​

To listen for the HelpGuideSectionOpened event, you can use the on method of the window['maptaskrPCF'] object. This allows you to register an event listener that executes a call-back function when the event is triggered.

Example​

window['maptaskrPCF'].on("HelpGuideSectionOpened", function(sectionName) { 
    
    console.log("sectionName: " + sectionName);

});

In the example above, we've registered an event listener for the HelpGuideSectionOpened event. When the event occurs, the provided call-back function is executed, logging the name of the opened help guide section to the console.

Parameters​

  • sectionName (string): The name of the opened help guide section.

Removing Event Listeners​

To remove the event listener for the HelpGuideSectionOpened event, you can use the off method of the window['maptaskrPCF'] object. This is useful when you no longer want to listen to this specific event.

Example​

window['maptaskrPCF'].off(" HelpGuideSectionOpened");

In the example above, the event listener for HelpGuideSectionOpened is removed, ensuring that the associated call-back function no longer executes when the event is triggered.