PmiService

class wvc.PmiService()

Constructors

wvc.PmiService.constructor()
PmiService(): PmiService

Returns: PmiService

Properties

wvc.PmiService.DefaultConfig

static readonly

DefaultConfig: { autoFlipPmiEnabled: boolean, color: string, isColorOverride: boolean }
wvc.PmiService.serviceName

readonly

serviceName: “PmiService”

Accessors

wvc.PmiService.viewer()
get viewer(): (undefined | IWebViewer)

Returns: (undefined | IWebViewer)

set viewer(viewer: (undefined | IWebViewer)): void

Parameters

viewer: (undefined | IWebViewer)

Returns: void

Methods

wvc.PmiService.getPmiColor()
getPmiColor(): string

Returns: string

wvc.PmiService.getPmiColorOverride()
getPmiColorOverride(): boolean

Returns: boolean

wvc.PmiService.isAutoFlipPmiEnabled()
isAutoFlipPmiEnabled(): boolean

Reports whether automatic PMI flipping is enabled.

Returns: boolean

true when automatic PMI flipping is enabled.
wvc.PmiService.resetConfiguration()
resetConfiguration(obj: object): Promise

Parameters

obj: object

Returns: Promise

wvc.PmiService.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.PmiService.setPmiColor()
setPmiColor(color: string): void

Parameters

color: string

Returns: void

wvc.PmiService.setPmiColorOverride()
setPmiColorOverride(enableOverride: boolean, rootId: number): Promise

Parameters

enableOverride: boolean

rootId: number

Returns: Promise