IPmiService

class wvc.IPmiService()

Index

Properties

• serviceName

Methods

• getPmiColor
• getPmiColorOverride
• isAutoFlipPmiEnabled
• resetConfiguration
• setAutoFlipPmiEnabled
• setPmiColor
• setPmiColorOverride

Properties

wvc.IPmiService.serviceName

inherited

serviceName: ServiceName

Methods

wvc.IPmiService.getPmiColor()

getPmiColor(): string

Returns: string

wvc.IPmiService.getPmiColorOverride()

getPmiColorOverride(): boolean

Returns: boolean

wvc.IPmiService.isAutoFlipPmiEnabled()

isAutoFlipPmiEnabled(): boolean

Reports whether automatic PMI flipping is enabled.

Returns: boolean

true when automatic PMI flipping is enabled.

wvc.IPmiService.resetConfiguration()

resetConfiguration(obj: object): Promise

Parameters

obj: object

Returns: Promise

wvc.IPmiService.setAutoFlipPmiEnabled()

setAutoFlipPmiEnabled(enabled: boolean): void

Enables or disables automatic PMI flipping.

Parameters

enabled: boolean

Whether automatic PMI flipping should be enabled.

Returns: void

void

Throws

Error when the viewer is not set.

wvc.IPmiService.setPmiColor()

setPmiColor(color: string): void

Parameters

color: string

Returns: void

wvc.IPmiService.setPmiColorOverride()

setPmiColorOverride(enableOverride: boolean, rootId: number): Promise

Parameters

enableOverride: boolean

rootId: number

Returns: Promise