Class CommentPlugin<Schemes, K>

__scope

comments

name

Optionalparent

signal

addInline

• addInline(text, position, link?): InlineComment

• Adds an inline comment which is represented by a block with text at certain position, which is attached to the node. When user translates a node, the comment will be translated as well. When user drops a comment on a node, the comment will be linked to the node.

  Parameters

  • text: string

    Comment text
  • position: [number, number]

    Comment position
  • Optionallink: string

    Node ID the comment is linked with

  Returns InlineComment

  comment that was created

addPipe

• addPipe(middleware): void

• Parameters

  • middleware: Pipe<K | Produces | BaseArea<Schemes>>

  Returns void

clear

• clear(): void

• Removes all comments

  Returns void

delete

• delete(id): void

• Removes a comment

  Parameters

  • id: string

    Comment id

  Returns void

editComment

• editComment(id): Promise<void>

• Trigger edit form for a comment

  Parameters

  • id: string

    Comment id

  Returns Promise<void>

emit

• emit<C>(context): Promise<
      | undefined
      | Extract<{
          data: Comment;
          type: "commentcreated";
      }, C>
      | Extract<{
          data: Comment;
          type: "commentremoved";
      }, C>
      | Extract<{
          data: Comment;
          type: "editcomment";
      }, C>
      | Extract<{
          data: Comment;
          type: "commentselected";
      }, C>
      | Extract<{
          data: Comment;
          type: "commentunselected";
      }, C>
      | Extract<{
          data: {
              dx: number;
              dy: number;
              id: string;
              sources?: string[];
          };
          type: "commenttranslated";
      }, C>
      | Extract<{
          data: {
              id: string;
              link: string;
          };
          type: "commentlinktranslate";
      }, C>>

• Type Parameters

  • C extends Produces

  Parameters

  • context: C

  Returns Promise<
      | undefined
      | Extract<{
          data: Comment;
          type: "commentcreated";
      }, C>
      | Extract<{
          data: Comment;
          type: "commentremoved";
      }, C>
      | Extract<{
          data: Comment;
          type: "editcomment";
      }, C>
      | Extract<{
          data: Comment;
          type: "commentselected";
      }, C>
      | Extract<{
          data: Comment;
          type: "commentunselected";
      }, C>
      | Extract<{
          data: {
              dx: number;
              dy: number;
              id: string;
              sources?: string[];
          };
          type: "commenttranslated";
      }, C>
      | Extract<{
          data: {
              id: string;
              link: string;
          };
          type: "commentlinktranslate";
      }, C>>

hasParent

• hasParent(): boolean

• Returns boolean

parentScope

• parentScope<T, P>(): Scope<T, P>

• Type Parameters

  • T
  • P extends []

  Returns Scope<T, P>

• parentScope<T>(type): T

• Type Parameters

  • T

  Parameters

  • type: Type<T>

  Returns T

select

• select(id): void

• Selects a comment

  Parameters

  • id: string

    Comment id

  Returns void

translate

• translate(id, dx, dy): void

• Translates a comment

  Parameters

  • id: string

    Comment id
  • dx: number

    Delta x
  • dy: number

    Delta y

  Returns void

unselect

• unselect(id): void

• Unselects a comment

  Parameters

  • id: string

    Comment id

  Returns void

use

• use<S>(scope): {
      debug<T>(_f: ((p: {
          [K in string | number | symbol]: K | Produces | BaseArea<Schemes>
      }) => T)): void;
  }

• Type Parameters

  • S extends Scope<any, any[]>

  Parameters

  • scope: NestedScope<S, [Produces, K | BaseArea<Schemes>]>

  Returns {
      debug<T>(_f: ((p: {
          [K in string | number | symbol]: K | Produces | BaseArea<Schemes>
      }) => T)): void;
  }

  • debug:function

    • debug<T>(_f): void

    • Type Parameters

      • T extends [] | [KeepIfNonAssignable<unknown, K | Produces | BaseArea<Schemes>>]

      Parameters

      • _f: ((p: {
            [K in string | number | symbol]: K | Produces | BaseArea<Schemes>
        }) => T)
        • • (p): T

          • Parameters

            • p: {
                  [K in string | number | symbol]: K | Produces | BaseArea<Schemes>
              }

            Returns T

      Returns void