stickynote.add - Events - Annotations API

Annotations API Events

stickynote:add

Triggered when a sticky note is created. Returns the payloadData object for the sticky note, containing the variables listed.

Examples

annotationsApp.on('stickynote:add', function (payloadData) {
    console.log('Added a Sticky Note with an ID of ' + payloadData.id);
});

Callback arguments

  • collectionId string

    A group of sticky notes is known as a collection. The collection id string will be populated from the name of the Item in context. Empty by default.

  • content string

    The text shown inside the sticky note. Empty by default.

  • expanded boolean

    The window state of the sticky note. True = expanded. False = collapsed.

  • height number

    The vertical size of the sticky note window, in pixels.

  • id string

    The unique id of the sticky note that was created.

  • visible boolean

    The visibility state of the sticky note. True = visible. False = invisible.

  • width number

    The horizontal size of the sticky note window, in pixels.

  • x string

    The horizontal position of the top left corner of the sticky note window, in percentage or pixels.

  • y string

    The vertical position of the top left corner of the sticky note window, in percentage or pixels.

Versioning

Version added: v2018.2.LTS

Related articles

Was this article helpful?

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