Class Entity

constructor

• new Entity(
      start: number,
      end: number,
      history?: History[],
      labelClass?: undefined | Label,
      reviewed?: boolean,
      currentState?: string,
  ): Entity

  Constructor for the Entity class.

  Parameters

  • start: number

    The start index of the entity in the text.
  • end: number

    The end index of the entity in the text.
  • history: History[] = []

    An optional array of history entries for the entity.
  • labelClass: undefined | Label = undefined

    An optional label class for the entity.
  • reviewed: boolean = false

    Indicates if the entity has been reviewed.
  • OptionalcurrentState: string

    The current state of the entity.

  Returns Entity

  Description

  This constructor initializes the Entity with start and end indices, an optional history array, a label class, and a reviewed status.

currentState

end

history

labelClass

labelName

name

reviewed

start

latestEntry

• latestEntry(): null | History

  A method to get the latest history entry.

  Returns null | History

toJSON

• toJSON(newAnnotator: string): REF_EntityJSONFormat

  Converts the Entity instance to a JSON object.

  Parameters

  • newAnnotator: string

    The name of the annotator for the export.

  Returns REF_EntityJSONFormat

  The JSON representation of the Entity.

  Description

  This method generates a JSON format for the entity, including start, end, history, and label information.

StaticfromJSON

• fromJSON(json: REF_EntityJSONFormat): Entity

  Returns a new instance of Entity from a JSON object.

  Parameters

  • json: REF_EntityJSONFormat

    The JSON object to convert.

  Returns Entity

  The Entity instance created from the JSON object.

  Description

  This method converts a JSON representation of an entity back into an Entity instance.