Plugin API » Interfaces » LabellingUserInterface

LabellingUserInterface interface

Represents the addition of labelling UI to the object editor.

Construction

Created by the Platform and passed to the hLabellingUserInterface hook.

Interface

function label(label, offerAsDefault)

Offer a label to the user in the object editor for optionally labelling an object, at the user’s choice.

label is the Ref of any store object.

offerAsDefault is only applicable for create operation, and if true, the checkbox will be checked by default.