config.global.hide_tags - Initialization - Author API

Author API Initialization

hide_tags

Specifies Tags that should be hidden from all Tag suggestion lists.

You would want to use this to hide specific Tags so they cannot be selected by authors, for example.

Tags will be hidden in the following situations:

  • Using "find by Tags" drop-down menu in the Item or Activity list views
  • Applying Tags to Items or Activities
  • Viewing the Tags attached to an Item or Activity
  • Browsing via browse controls in the Item list view

Examples

var initializationOptions = {
    "config": {
        "global": {
            "hide_tags": [
                { "type": "TYPE1" },
                { "type": "TYPE2" },
                // ...
            ]
        }
    }
};

Values

Attribute path config.global.hide_tags

Type array[TagSearchByTypeObject]

Each array entry should be in the form of a TagSearchByType object.

Caveats

You can only specify hide_tags or show_tags, but not both at the same time.

Related articles

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.