Skip to main content

getHelpTopic

Retrieves help topic data that is set using the helpTopics property of the builder. This mechanism is used to set the URLs of help topics used in the builder.

tip

See the helpTopics property documentation for a list of topics used by the builder.

Signature

getHelpTopic(topic: string): string | undefined

Parameters

NameTypeOptionalDescription
topicstringNoSpecifies the topic identifier.

Return value

Returns the help topic data string or undefined when no data was found for the supplied topic.