Plugin API » Hooks » hLabellingUserInterface

hLabellingUserInterface

This hook enables your plugin to add additional labelling UI to the object editor using a LabellingUserInterface object.

Labels are presented as checkboxes. For creating new objects, your plugin specifies whether they’re enabled by default, and on updates, and the Platform checks the boxes to maintain the existing labelling.

See also hLabelObject for applying labels without user intervention.

Arguments

Name	Type	Description
object	StoreObject	Object which is about to be edited
user	SecurityPrincipal	SecurityPrincipal representing the user who is editing the object
operation	String	What operation is being performed: ‘create’ or ‘update’

Response

Return information by changing these properties of the response object.

Name	Type	Description
ui	LabellingUserInterface	LabellingUserInterface object representing extra labelling UI

JavaScript template

P.hook('hLabellingUserInterface', function(response, object, user, operation) {
    // Respond to hook, for example
    // response.ui = ...
});