Skip to main content
Version: v1

LogViewer Interface

Creates RevisionViews for the revisions in an EditLog

Signature

export interface LogViewer

Methods

Method Return Type Description
getRevisionView(revision) Promise<RevisionView>

Returns the TreeView output associated with the largest revision in editLog less than (but not equal to) the supplied revision.

For example: - revision 0 returns the initialRevision. - revision 1 returns the output of editLog[0] (or initialRevision if there is no edit 0). - revision Number.POSITIVE_INFINITY returns the newest revision.

getRevisionViewInSession(revision) RevisionView

Returns the TreeView output associated with the largest revision in editLog less than (but not equal to) the supplied revision. Can only be used to retrieve revisions added during the current sessions.

For example: - revision 0 returns the initialRevision. - revision 1 returns the output of editLog[0] (or initialRevision if there is no edit 0). - revision Number.POSITIVE_INFINITY returns the newest revision.

Method Details

getRevisionView

Returns the TreeView output associated with the largest revision in editLog less than (but not equal to) the supplied revision.

For example: - revision 0 returns the initialRevision. - revision 1 returns the output of editLog[0] (or initialRevision if there is no edit 0). - revision Number.POSITIVE_INFINITY returns the newest revision.

Signature

getRevisionView(revision: Revision): Promise<RevisionView>;

Parameters

Parameter Type Description
revision Revision

Returns

Return type: Promise<RevisionView>

getRevisionViewInSession

Returns the TreeView output associated with the largest revision in editLog less than (but not equal to) the supplied revision. Can only be used to retrieve revisions added during the current sessions.

For example: - revision 0 returns the initialRevision. - revision 1 returns the output of editLog[0] (or initialRevision if there is no edit 0). - revision Number.POSITIVE_INFINITY returns the newest revision.

Signature

getRevisionViewInSession(revision: Revision): RevisionView;

Parameters

Parameter Type Description
revision Revision

Returns

Return type: RevisionView