Interface ISearchContextHit

Represents a context hit for a search result.

interface ISearchContextHit {
    annotationId?: number;
    context?: string;
    edocHitCount?: number;
    fieldHitCount?: number;
    fieldName?: string;
    highlight1Length?: number;
    highlight1Offset?: number;
    highlight2Length?: number;
    highlight2Offset?: number;
    hitNumber?: number;
    hitType?: HitType;
    hitWidth?: number;
    isAnnotationHit?: boolean;
    pageNumber?: number;
    pageOffset?: number;
}

Implemented by

Properties

annotationId? context? edocHitCount? fieldHitCount? fieldName? highlight1Length? highlight1Offset? highlight2Length? highlight2Offset? hitNumber? hitType? hitWidth? isAnnotationHit? pageNumber? pageOffset?

Properties

OptionalannotationId

annotationId?: number

The ID of the annotation that the context hit is in.

Optionalcontext

context?: string

The line of context for the search hit.

OptionaledocHitCount

edocHitCount?: number

The number of hits in the electronic document.

OptionalfieldHitCount

fieldHitCount?: number

The number of hits in the template.

OptionalfieldName

fieldName?: string

The name of a template field containing the hit.

Optionalhighlight1Length

highlight1Length?: number

The length of the first highlight in characters.

Optionalhighlight1Offset

highlight1Offset?: number

The character offset from the beginning of the context line of the start of the first highlight.

Optionalhighlight2Length

highlight2Length?: number

The length of the second highlight in characters.

Optionalhighlight2Offset

highlight2Offset?: number

The character offset from the beginning of the context line of the start of the second highlight.

OptionalhitNumber

hitNumber?: number

The hit number.

OptionalhitType

hitType?: HitType

The type of context hit this instance represents.

OptionalhitWidth

hitWidth?: number

The number of words in the context hit.

OptionalisAnnotationHit

isAnnotationHit?: boolean

A boolean indicating if this context hit occurs on an annotation.

OptionalpageNumber

pageNumber?: number

The page number in the document of the search hit's context.

OptionalpageOffset

pageOffset?: number

The offset from the beginning of the page of the starting character of the search hit's context line.

Settings

Member Visibility

On This Page

Properties