Class History

constructor

• new History(
      label: string,
      state: string,
      annotatorName: string,
      timestamp: string,
  ): History

  Constructor for the History class.

  Parameters

  • label: string

    The label of the entity at this point in history.
  • state: string

    The state of the entity at this point in history.
  • annotatorName: string

    The name of the annotator who made this change.
  • timestamp: string

    The timestamp when this change was made.

  Returns History

  Description

  This constructor initializes the History with label, state, annotator name, and timestamp.

annotatorName

label

state

timestamp

toJSON

• toJSON(): REF_HistoryJSONFormat

  Converts the History instance to a JSON object.

  Returns REF_HistoryJSONFormat

  The JSON representation of the History.

  Description

  This method generates a JSON format for the history entry.

StaticformatDate

• formatDate(date: Date): string

  Formats the date to a string.

  Parameters

  • date: Date

    The date to format.

  Returns string

  The formatted date string.

  Description

  This method formats the date to a string in ISO format.

StaticfromJSON

• fromJSON(json: REF_HistoryJSONFormat): History

  Creates a History instance from a JSON object.

  Parameters

  • json: REF_HistoryJSONFormat

    The JSON object to convert.

  Returns History

  The History instance created from the JSON object.

  Description

  This method converts a JSON representation of a history entry back into a History instance.