API / SView / BaseParameters

Class: BaseParameters

SView.BaseParameters

Brief

配置信息类

Memberof

SView

Author

WZ

Date

2022-3-23

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• Parameters

  ↳ BaseParameters

Table of contents

Constructors

• constructor

Properties

• UseBackImage
• annotationCharacter
• annotationDepartment
• annotationFrontShow
• annotationUser
• backgrounImage
• bottomColor
• changeViewTime
• hotSpotImageSize
• hotspotPath
• hotspotSelectedPath
• imageMeasureSize
• isMergeModels
• isNoteFixSize
• isShowAniTrochoid
• measureBoardColor
• measureBoardWidth
• measurePointSize
• measureResultRadius
• screenDPI
• sequenceAnnotationMaxValue
• textNoteStyle
• thicknessDirectionType
• topColor

Methods

• add
• fromJson
• getBoolParameter
• getColorParameter
• getMapParameter
• getNumberParameter
• getParameter
• getParameters
• getParentParameters
• getStringParameter
• getVector2Parameter
• remove
• setBackgroudBottomColor
• setBackgroudColor
• setBackgroudImg
• setBackgroudTopColor
• setBoolParameter
• setColorParameter
• setCookieParameter
• setDefault
• setMapParameter
• setNumberParameter
• setParameter
• setParameterByCookie
• setParentParameters
• setStringParameter
• setVector2Parameter
• toJson
• getInstance

Constructors

constructor

• new BaseParameters(): BaseParameters

构造函数

Returns

BaseParameters

Inherited from

M3D.Config.Parameters.constructor

Properties

UseBackImage

• UseBackImage: boolean

---

annotationCharacter

• annotationCharacter: string

Inherited from

M3D.Config.Parameters.annotationCharacter

---

annotationDepartment

• annotationDepartment: string

Inherited from

M3D.Config.Parameters.annotationDepartment

---

annotationFrontShow

• annotationFrontShow: boolean

Inherited from

M3D.Config.Parameters.annotationFrontShow

---

annotationUser

• annotationUser: string

Inherited from

M3D.Config.Parameters.annotationUser

---

backgrounImage

• backgrounImage: ImageBitmap

---

bottomColor

• bottomColor: Color

---

changeViewTime

• changeViewTime: number

Inherited from

M3D.Config.Parameters.changeViewTime

---

hotSpotImageSize

• hotSpotImageSize: number

Inherited from

M3D.Config.Parameters.hotSpotImageSize

---

hotspotPath

• hotspotPath: string

Inherited from

M3D.Config.Parameters.hotspotPath

---

hotspotSelectedPath

• hotspotSelectedPath: string

Inherited from

M3D.Config.Parameters.hotspotSelectedPath

---

imageMeasureSize

• imageMeasureSize: number

Inherited from

M3D.Config.Parameters.imageMeasureSize

---

isMergeModels

• isMergeModels: boolean

Inherited from

M3D.Config.Parameters.isMergeModels

---

isNoteFixSize

• isNoteFixSize: boolean

Inherited from

M3D.Config.Parameters.isNoteFixSize

---

isShowAniTrochoid

• isShowAniTrochoid: boolean

Inherited from

M3D.Config.Parameters.isShowAniTrochoid

---

measureBoardColor

• measureBoardColor: Color

Inherited from

M3D.Config.Parameters.measureBoardColor

---

measureBoardWidth

• measureBoardWidth: number

Inherited from

M3D.Config.Parameters.measureBoardWidth

---

measurePointSize

• measurePointSize: number

Inherited from

M3D.Config.Parameters.measurePointSize

---

measureResultRadius

• measureResultRadius: number

Inherited from

M3D.Config.Parameters.measureResultRadius

---

screenDPI

• screenDPI: any

Inherited from

M3D.Config.Parameters.screenDPI

---

sequenceAnnotationMaxValue

• sequenceAnnotationMaxValue: number

Inherited from

M3D.Config.Parameters.sequenceAnnotationMaxValue

---

textNoteStyle

• textNoteStyle: number

Inherited from

M3D.Config.Parameters.textNoteStyle

---

thicknessDirectionType

• thicknessDirectionType: number

Inherited from

M3D.Config.Parameters.thicknessDirectionType

---

topColor

• topColor: Color

Methods

add

▸ add(para): void

添加所属子配置项

Parameters

Name	Type
para	SParameters

Returns

void

Inherited from

M3D.Config.Parameters.add

---

fromJson

▸ fromJson(value): void

Parameters

Name	Type
value	string

Returns

void

Description

根据json字符串设置配置信息

Inherited from

M3D.Config.Parameters.fromJson

---

getBoolParameter

▸ getBoolParameter(key): boolean

Parameters

Name	Type	Description
key	string	key关键词

Returns

boolean

Description

获取boolean类型参数

Inherited from

M3D.Config.Parameters.getBoolParameter

---

getColorParameter

▸ getColorParameter(key): Color

Parameters

Name	Type	Description
key	string	key关键词

Returns

Color

Description

获取Color类型参数

Inherited from

M3D.Config.Parameters.getColorParameter

---

getMapParameter

▸ getMapParameter(key): Map<any, any>

Parameters

Name	Type	Description
key	string	key关键词

Returns

Map<any, any>

Description

获取map类型参数

Inherited from

M3D.Config.Parameters.getMapParameter

---

getNumberParameter

▸ getNumberParameter(key): number

Parameters

Name	Type	Description
key	string	key关键词

Returns

number

Description

获取number类型参数

Inherited from

M3D.Config.Parameters.getNumberParameter

---

getParameter

▸ getParameter(key): any

Parameters

Name	Type	Description
key	string	key关键词

Returns

any

Description

获取string类型参数

Inherited from

M3D.Config.Parameters.getParameter

---

getParameters

▸ getParameters(para): SParameters

获取指定的 Parameters对象

Parameters

Name	Type
para	SParameters

Returns

SParameters

Inherited from

M3D.Config.Parameters.getParameters

---

getParentParameters

▸ getParentParameters(): SParameters

Returns

SParameters

Inherited from

M3D.Config.Parameters.getParentParameters

---

getStringParameter

▸ getStringParameter(key): string

Parameters

Name	Type	Description
key	string	key关键词

Returns

string

Description

获取string类型参数

Inherited from

M3D.Config.Parameters.getStringParameter

---

getVector2Parameter

▸ getVector2Parameter(key): Vector2

Parameters

Name	Type	Description
key	string	key关键词

Returns

Vector2

Description

获取Vector2类型参数

Inherited from

M3D.Config.Parameters.getVector2Parameter

---

remove

▸ remove(para): boolean

移除配置类，一般用不到该方法

Parameters

Name	Type
para	SParameters

Returns

boolean

Inherited from

M3D.Config.Parameters.remove

---

setBackgroudBottomColor

▸ setBackgroudBottomColor(bottomColor): void

Parameters

Name	Type
bottomColor	Color

Returns

void

Description

设置背景底部颜色

---

setBackgroudColor

▸ setBackgroudColor(topColor, bottomColor): void

Parameters

Name	Type	Description
topColor	Color	顶部颜色
bottomColor	Color	底部颜色

Returns

void

Description

设置背景颜色

---

setBackgroudImg

▸ setBackgroudImg(img): void

Parameters

Name	Type	Description
img	ImageBitmap	图片

Returns

void

Description

设置背景图片

---

setBackgroudTopColor

▸ setBackgroudTopColor(topColor): void

Parameters

Name	Type	Description
topColor	Color	顶部颜色

Returns

void

Description

设置背景顶部颜色

---

setBoolParameter

▸ setBoolParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	boolean	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置boolean类型参数

Inherited from

M3D.Config.Parameters.setBoolParameter

---

setColorParameter

▸ setColorParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	string | Color	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置Color类型参数

Inherited from

M3D.Config.Parameters.setColorParameter

---

setCookieParameter

▸ setCookieParameter(key, value, all?): boolean

将配置项存到cookie中

Parameters

Name	Type
key	string
value	any
all?	boolean

Returns

boolean

Inherited from

M3D.Config.Parameters.setCookieParameter

---

setDefault

▸ setDefault(): void

设置默认值

Returns

void

Inherited from

M3D.Config.Parameters.setDefault

---

setMapParameter

▸ setMapParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	Map<any, any>	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置map类型参数

Inherited from

M3D.Config.Parameters.setMapParameter

---

setNumberParameter

▸ setNumberParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	number	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置number类型参数

Inherited from

M3D.Config.Parameters.setNumberParameter

---

setParameter

▸ setParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	any	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置配置项

Inherited from

M3D.Config.Parameters.setParameter

---

setParameterByCookie

▸ setParameterByCookie(key, defaultValue): void

从cookie中取值

Parameters

Name	Type
key	string
defaultValue	any

Returns

void

Inherited from

M3D.Config.Parameters.setParameterByCookie

---

setParentParameters

▸ setParentParameters(parentPara): void

Parameters

Name	Type
parentPara	SParameters

Returns

void

Inherited from

M3D.Config.Parameters.setParentParameters

---

setStringParameter

▸ setStringParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	string	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置string类型参数

Inherited from

M3D.Config.Parameters.setStringParameter

---

setVector2Parameter

▸ setVector2Parameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	string | Vector2	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置Vector2类型参数

Inherited from

M3D.Config.Parameters.setVector2Parameter

---

toJson

▸ toJson(): string

Returns

string

Description

将配置信息输出成json字符串

Inherited from

M3D.Config.Parameters.toJson

---

getInstance

▸ getInstance(): Parameters

Returns

Parameters

Description

获得配置项（如果存在则返回现有配置项，如果没有则创建一个新的）

Inherited from

M3D.Config.Parameters.getInstance