Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Interface IAnnotationProperties

A union of properties for annotation types that inherit the base IAnnotation type. Properties of the IAnnotation type are supported by all subtypes, as well as some extra ones for each subtype.

Properties list

arcRadius arrowSize baseLength displayText fillColor fillOpacity fontFamily fontSize height horizontalTextAlignment lineSize orientation outlineColor outlineOpacity outlineWidth rotation rubberstampPath textColor vertexPosition verticalTextAlignment width xpos ypos zOrder

Properties

arcRadius

Supported by

Declaration
arcRadius?: number;
Property Value
Type Description
number

arrowSize

Supported by

Declaration
arrowSize?: number;
Property Value
Type Description
number

baseLength

Supported by

Declaration
baseLength?: number;
Property Value
Type Description
number

displayText

Declaration
displayText?: string;
Property Value
Type Description
string

fillColor

Declaration
fillColor?: string;
Property Value
Type Description
string

fillOpacity

Declaration
fillOpacity?: number;
Property Value
Type Description
number

fontFamily

Declaration
fontFamily?: AnnotationTextFontFamily;
Property Value
Type Description
AnnotationTextFontFamily

fontSize

Declaration
fontSize?: number;
Property Value
Type Description
number

height

Declaration
height?: number;
Property Value
Type Description
number

horizontalTextAlignment

Declaration
horizontalTextAlignment?: AnnotationTextAlignment;
Property Value
Type Description
AnnotationTextAlignment

lineSize

Declaration
lineSize?: number;
Property Value
Type Description
number

orientation

Declaration
orientation?: AnnotationArrowOrientation;
Property Value
Type Description
AnnotationArrowOrientation

outlineColor

Declaration
outlineColor?: string;
Property Value
Type Description
string

outlineOpacity

Declaration
outlineOpacity?: number;
Property Value
Type Description
number

outlineWidth

Declaration
outlineWidth?: number;
Property Value
Type Description
number

rotation

Declaration
rotation?: number;
Property Value
Type Description
number

rubberstampPath

Supported by

Declaration
rubberstampPath?: string;
Property Value
Type Description
string

textColor

Declaration
textColor?: string;
Property Value
Type Description
string

vertexPosition

Declaration
vertexPosition?: number;
Property Value
Type Description
number

verticalTextAlignment

Declaration
verticalTextAlignment?: AnnotationTextAlignment;
Property Value
Type Description
AnnotationTextAlignment

width

Declaration
width?: number;
Property Value
Type Description
number

xpos

Declaration
xpos?: number;
Property Value
Type Description
number

ypos

Declaration
ypos?: number;
Property Value
Type Description
number

zOrder

Declaration
zOrder?: number;
Property Value
Type Description
number
Back to top Generated by DocFX