Frame / SView / Commands / AnnotationNumberCommand

Class: AnnotationNumberCommand

SView.Commands.AnnotationNumberCommand

Memberof

SView.Commands

Description

序号批注Command

Author

WZ

Date

2022-08-03

Version

1.0

Hierarchy

• AnnotationCommand

  ↳ AnnotationNumberCommand

Table of contents

Constructors

• constructor

Properties

• annotationType
• description
• executedHandleMode
• frame
• inputParas
• isCanAbort
• isDisplayView
• isEdit
• isInterruptible
• isParametersComplete
• isPreView
• isShowLoadingDialog
• maxValue
• name
• outputParas
• paraInit
• priority
• scene
• state
• type
• view
• ID
• fillColor
• firstPoint
• fontName
• fontSize
• frameColor
• isEnvelope
• isFixed
• isLeader
• modelID
• secondPoint
• text
• textColor

Methods

• apply
• cancel
• clear
• close
• doPreview
• execute
• existValidParameters
• getAnnotation
• getAnnotationType
• getConfigData
• getDescription
• getExecuteResult
• getExecutedHandleMode
• getInputParas
• getIsCanAbort
• getIsDisplayView
• getIsInterruptible
• getIsParametersComplete
• getIsPreView
• getIsShowLoadingDialog
• getName
• getOutputParas
• getPriority
• getScene
• getState
• getView
• interrupt
• isShowView
• onClearPreview
• onExecuted
• preview
• release
• resume
• setAnnotation
• setAnnotationType
• setExecuteResult
• setExecutedHandleMode
• setInputParas
• setIsCanAbort
• setIsDisplayView
• setIsInterruptible
• setIsParametersComplete
• setIsPreView
• setIsShowLoadingDialog
• setName
• setOutputParas
• setPriority
• setScene
• setState
• setView
• touchHandle
• undo

Constructors

constructor

• new AnnotationNumberCommand(name): AnnotationNumberCommand

Parameters

Name	Type	Description
name	string	命令名称

Returns

AnnotationNumberCommand

Description

创建前进播放命令对象

Overrides

AnnotationCommand.constructor

Properties

annotationType

• annotationType: AnnotationType = M3D.Shapes.AnnotationType.TEXT_ANNOTATION

Inherited from

AnnotationCommand.annotationType

---

description

• description: string

Inherited from

AnnotationCommand.description

---

executedHandleMode

• executedHandleMode: ExecutedHandleMode

Inherited from

AnnotationCommand.executedHandleMode

---

frame

• frame: FrameMain

Inherited from

AnnotationCommand.frame

---

inputParas

• inputParas: CommandParameters

Inherited from

AnnotationCommand.inputParas

---

isCanAbort

• isCanAbort: boolean

Inherited from

AnnotationCommand.isCanAbort

---

isDisplayView

• isDisplayView: boolean

Inherited from

AnnotationCommand.isDisplayView

---

isEdit

• isEdit: boolean

Inherited from

AnnotationCommand.isEdit

---

isInterruptible

• isInterruptible: boolean

Inherited from

AnnotationCommand.isInterruptible

---

isParametersComplete

• isParametersComplete: boolean

Inherited from

AnnotationCommand.isParametersComplete

---

isPreView

• isPreView: boolean

Inherited from

AnnotationCommand.isPreView

---

isShowLoadingDialog

• isShowLoadingDialog: boolean

Inherited from

AnnotationCommand.isShowLoadingDialog

---

maxValue

• maxValue: number = 99999

---

name

• name: string

Inherited from

AnnotationCommand.name

---

outputParas

• outputParas: CommandParameters

Inherited from

AnnotationCommand.outputParas

---

paraInit

• paraInit: boolean = false

Inherited from

AnnotationCommand.paraInit

---

priority

• priority: CommandPriority

Inherited from

AnnotationCommand.priority

---

scene

• scene: Scene

Inherited from

AnnotationCommand.scene

---

state

• state: CommandState

Inherited from

AnnotationCommand.state

---

type

• type: number

Inherited from

AnnotationCommand.type

---

view

• view: SCommandView

Inherited from

AnnotationCommand.view

---

ID

▪ Static Readonly ID: string = "ID"

Inherited from

AnnotationCommand.ID

---

fillColor

▪ Static Readonly fillColor: string = "FillColor"

Inherited from

AnnotationCommand.fillColor

---

firstPoint

▪ Static Readonly firstPoint: string = "FirstPoint"

Inherited from

AnnotationCommand.firstPoint

---

fontName

▪ Static Readonly fontName: string = "FontName"

Inherited from

AnnotationCommand.fontName

---

fontSize

▪ Static Readonly fontSize: string = "FontSize"

Inherited from

AnnotationCommand.fontSize

---

frameColor

▪ Static Readonly frameColor: string = "FrameColor"

Inherited from

AnnotationCommand.frameColor

---

isEnvelope

▪ Static Readonly isEnvelope: string = "IsShowOutFrame"

Inherited from

AnnotationCommand.isEnvelope

---

isFixed

▪ Static Readonly isFixed: string = "IsFixed"

Inherited from

AnnotationCommand.isFixed

---

isLeader

▪ Static Readonly isLeader: string = "IsShowLeader"

Inherited from

AnnotationCommand.isLeader

---

modelID

▪ Static Readonly modelID: string = "ModelID"

Inherited from

AnnotationCommand.modelID

---

secondPoint

▪ Static Readonly secondPoint: string = "SecondPoint"

Inherited from

AnnotationCommand.secondPoint

---

text

▪ Static Readonly text: string = "Text"

Inherited from

AnnotationCommand.text

---

textColor

▪ Static Readonly textColor: string = "TextColor"

Inherited from

AnnotationCommand.textColor

Methods

apply

▸ apply(): number

Returns

number

Description

应用

Inherited from

AnnotationCommand.apply

---

cancel

▸ cancel(): void

Returns

void

Description

取消

Memberof

SCommand

Inherited from

AnnotationCommand.cancel

---

clear

▸ clear(): number

Returns

number

Description

清空

Inherited from

AnnotationCommand.clear

---

close

▸ close(): void

Returns

void

Description

关闭

Inherited from

AnnotationCommand.close

---

doPreview

▸ doPreview(): number

Returns

number

Description

执行预览

Inherited from

AnnotationCommand.doPreview

---

execute

▸ execute(executeAll?): number

Parameters

Name	Type
executeAll?	boolean

Returns

number

Description

执行

Inherited from

AnnotationCommand.execute

---

existValidParameters

▸ existValidParameters(): boolean

Returns

boolean

Description

是否存在有效参数

Inherited from

AnnotationCommand.existValidParameters

---

getAnnotation

▸ getAnnotation(): Annotation

Returns

Annotation

Annotation对象

Description

新建或者编辑的批注对象

Inherited from

AnnotationCommand.getAnnotation

---

getAnnotationType

▸ getAnnotationType(): AnnotationType

Returns

AnnotationType

annotationType

Description

获取批注类型

Inherited from

AnnotationCommand.getAnnotationType

---

getConfigData

▸ getConfigData(): number

Returns

number

Description

获取配置中的命令信息

Inherited from

AnnotationCommand.getConfigData

---

getDescription

▸ getDescription(): string

Returns

string

参数描述

Description

获取描述

Inherited from

AnnotationCommand.getDescription

---

getExecuteResult

▸ getExecuteResult(): CommandExecuteResult

Returns

CommandExecuteResult

Description

获取执行结果

Inherited from

AnnotationCommand.getExecuteResult

---

getExecutedHandleMode

▸ getExecutedHandleMode(): ExecutedHandleMode

Returns

ExecutedHandleMode

Description

获取执行模式

Inherited from

AnnotationCommand.getExecutedHandleMode

---

getInputParas

▸ getInputParas(): CommandParameters

Returns

CommandParameters

参数对象

Description

获取命令参数

Overrides

AnnotationCommand.getInputParas

---

getIsCanAbort

▸ getIsCanAbort(): boolean

Returns

boolean

Description

是否可以中止

Inherited from

AnnotationCommand.getIsCanAbort

---

getIsDisplayView

▸ getIsDisplayView(): boolean

Returns

boolean

Description

是否显示View

Inherited from

AnnotationCommand.getIsDisplayView

---

getIsInterruptible

▸ getIsInterruptible(): boolean

Returns

boolean

Description

获取是否可被中断

Inherited from

AnnotationCommand.getIsInterruptible

---

getIsParametersComplete

▸ getIsParametersComplete(): boolean

Returns

boolean

Description

判断参数是否完全，仅判断参数是否有空缺,可重写方法，实现自己的判定规则

Inherited from

AnnotationCommand.getIsParametersComplete

---

getIsPreView

▸ getIsPreView(): boolean

Returns

boolean

Description

获取命令是否预显

Inherited from

AnnotationCommand.getIsPreView

---

getIsShowLoadingDialog

▸ getIsShowLoadingDialog(): boolean

Returns

boolean

Description

是否显示加载对话框

Inherited from

AnnotationCommand.getIsShowLoadingDialog

---

getName

▸ getName(): string

Returns

string

Description

获取命令名称

Inherited from

AnnotationCommand.getName

---

getOutputParas

▸ getOutputParas(): CommandParameters

Returns

CommandParameters

Description

获取输出参数

Inherited from

AnnotationCommand.getOutputParas

---

getPriority

▸ getPriority(): CommandPriority

Returns

CommandPriority

Description

获取命令优先级

Inherited from

AnnotationCommand.getPriority

---

getScene

▸ getScene(): Scene

Returns

Scene

Description

获取scene

Inherited from

AnnotationCommand.getScene

---

getState

▸ getState(): CommandState

Returns

CommandState

Description

获取命令状态

Inherited from

AnnotationCommand.getState

---

getView

▸ getView(): SCommandView

Returns

SCommandView

Description

获取view

Inherited from

AnnotationCommand.getView

---

interrupt

▸ interrupt(): CommandExecuteResult

Returns

CommandExecuteResult

Description

中断当前命令

Inherited from

AnnotationCommand.interrupt

---

isShowView

▸ isShowView(): boolean

Returns

boolean

Description

判断是否需要显示面板

Inherited from

AnnotationCommand.isShowView

---

onClearPreview

▸ onClearPreview(): void

Returns

void

Description

清空预览

Inherited from

AnnotationCommand.onClearPreview

---

onExecuted

▸ onExecuted(): number

Returns

number

执行结果

Description

业务逻辑执行完毕后

Inherited from

AnnotationCommand.onExecuted

---

preview

▸ preview(): number

Returns

number

Description

预览

Inherited from

AnnotationCommand.preview

---

release

▸ release(): boolean

Returns

boolean

Description

释放

Inherited from

AnnotationCommand.release

---

resume

▸ resume(): number

Returns

number

Description

恢复命名

Inherited from

AnnotationCommand.resume

---

setAnnotation

▸ setAnnotation(value): Failure | Success

Parameters

Name	Type	Description
value	Annotation	Annotation对象

Returns

Failure | Success

Description

设置批注对象

Inherited from

AnnotationCommand.setAnnotation

---

setAnnotationType

▸ setAnnotationType(value): void

Parameters

Name	Type	Description
value	AnnotationType	AnnotationType

Returns

void

Description

设置批注类型

Inherited from

AnnotationCommand.setAnnotationType

---

setExecuteResult

▸ setExecuteResult(result): boolean

Parameters

Name	Type	Description
result	CommandExecuteResult	命令执行结果

Returns

boolean

Description

设置命令执行结果

Inherited from

AnnotationCommand.setExecuteResult

---

setExecutedHandleMode

▸ setExecutedHandleMode(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置执行模式

Inherited from

AnnotationCommand.setExecutedHandleMode

---

setInputParas

▸ setInputParas(value): void

Parameters

Name	Type	Description
value	CommandParameters	参数对象

Returns

void

Description

设置参数

Overrides

AnnotationCommand.setInputParas

---

setIsCanAbort

▸ setIsCanAbort(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置是否可以中止

Inherited from

AnnotationCommand.setIsCanAbort

---

setIsDisplayView

▸ setIsDisplayView(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置是否显示View

Inherited from

AnnotationCommand.setIsDisplayView

---

setIsInterruptible

▸ setIsInterruptible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否可被中断

Inherited from

AnnotationCommand.setIsInterruptible

---

setIsParametersComplete

▸ setIsParametersComplete(value): void

Parameters

Name	Type
value	any

Returns

void

Description

参数是否完整

Inherited from

AnnotationCommand.setIsParametersComplete

---

setIsPreView

▸ setIsPreView(value): void

@description: 设置命令是否预显

Parameters

Name	Type	Description
value	boolean	：0不预显，1预显

Returns

void

Inherited from

AnnotationCommand.setIsPreView

---

setIsShowLoadingDialog

▸ setIsShowLoadingDialog(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置是否显示加载对话框

Inherited from

AnnotationCommand.setIsShowLoadingDialog

---

setName

▸ setName(value): void

Parameters

Name	Type
value	string

Returns

void

Description

设置命令名称

Inherited from

AnnotationCommand.setName

---

setOutputParas

▸ setOutputParas(value): void

Parameters

Name	Type
value	CommandParameters

Returns

void

Description

设置输出参数

Inherited from

AnnotationCommand.setOutputParas

---

setPriority

▸ setPriority(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置命令优先级

Inherited from

AnnotationCommand.setPriority

---

setScene

▸ setScene(value): void

Parameters

Name	Type
value	Scene

Returns

void

Description

设置scene

Inherited from

AnnotationCommand.setScene

---

setState

▸ setState(state): void

Parameters

Name	Type
state	CommandState

Returns

void

Description

设置命令状态

Inherited from

AnnotationCommand.setState

---

setView

▸ setView(value): void

Parameters

Name	Type
value	SCommandView

Returns

void

Description

设置view

Inherited from

AnnotationCommand.setView

---

touchHandle

▸ touchHandle(event): boolean

Parameters

Name	Type
event	MouseEventArgs | KeyEventArgs | TouchEventArgs

Returns

boolean

Description

处理触摸事件

Inherited from

AnnotationCommand.touchHandle

---

undo

▸ undo(): boolean

Returns

boolean

回退结果

Description

回退

Inherited from

AnnotationCommand.undo