Class Paragraph

constructor

• new Paragraph(
      paragraphText: string,
      paragraphEntities?: REF_EntityJSONFormat[],
  ): Paragraph

  Constructor for the Paragraph class.

  Parameters

  • paragraphText: string

    The text of the paragraph.
  • OptionalparagraphEntities: REF_EntityJSONFormat[]

    An optional array of entities in the paragraph.

  Returns Paragraph

  Description

  This constructor initializes the Paragraph with text and an optional array of entities.

entities

id

text

toJSON

• toJSON(newAnnotator: string): REF_ParagraphJSONFormat

  Converts the Paragraph instance to a JSON object.

  Parameters

  • newAnnotator: string

    The name of the annotator for the export.

  Returns REF_ParagraphJSONFormat

  The JSON representation of the Paragraph.

toRDF

• toRDF(
      paragraphNumber: number,
      documentId: string,
      paragraphIds: string[],
      labelManager: LabelManager,
  ): string

  Generates the RDF representation of the paragraph.

  Parameters

  • paragraphNumber: number

    position of the paragraph in the document
  • documentId: string

    unique identifier for the document
  • paragraphIds: string[]

    array of paragraph IDs
  • labelManager: LabelManager

    instance of LabelManager to include labels in the RDF export

  Returns string

  RDF representation of the paragraph

StaticfromJSON

• fromJSON(json: REF_ParagraphJSONFormat): Paragraph

  Creates a Paragraph instance from a JSON object.

  Parameters

  • json: REF_ParagraphJSONFormat

    The JSON object to convert.

  Returns Paragraph

  The Paragraph instance created from the JSON object.

  Description

  This method converts a JSON representation of a paragraph back into a Paragraph instance.