RedlineService

class wvc.RedlineService()

Index

Constructors

• constructor

Properties

• serviceName

Accessors

• markupManager

Methods

• getActiveView
• getActiveViewKey
• getRedlineView
• getRedlineViewKeys
• getRedlineViews
• removeRedlineItem
• removeRedlineView
• reset
• setActiveView

Constructors

wvc.RedlineService.constructor()

RedlineService(markupManager: MarkupManager): RedlineService

Parameters

markupManager: MarkupManager

Returns: RedlineService

Properties

wvc.RedlineService.serviceName

readonly

serviceName: “RedlineService”

Accessors

wvc.RedlineService.markupManager()

get markupManager(): (undefined | MarkupManager)

Returns: (undefined | MarkupManager)

set markupManager(value: (undefined | MarkupManager)): void

Parameters

value: (undefined | MarkupManager)

Returns: void

Methods

wvc.RedlineService.getActiveView()

getActiveView(): (undefined | RedlineViewData)

Returns: (undefined | RedlineViewData)

wvc.RedlineService.getActiveViewKey()

getActiveViewKey(): (undefined | string)

Returns: (undefined | string)

wvc.RedlineService.getRedlineView()

getRedlineView(uniqueId: string): (undefined | RedlineViewData)

Parameters

uniqueId: string

Returns: (undefined | RedlineViewData)

wvc.RedlineService.getRedlineViewKeys()

getRedlineViewKeys(): string[]

Returns: string[]

wvc.RedlineService.getRedlineViews()

getRedlineViews(): RedlineViewData[]

Returns: RedlineViewData[]

wvc.RedlineService.removeRedlineItem()

removeRedlineItem(viewId: string, item: RedlineItemData): Promise

Parameters

viewId: string

item: RedlineItemData

Returns: Promise

wvc.RedlineService.removeRedlineView()

removeRedlineView(uniqueId: string): void

Parameters

uniqueId: string

Returns: void

wvc.RedlineService.reset()

reset(): void

Returns: void

wvc.RedlineService.setActiveView()

setActiveView(uniqueId: string): Promise

Parameters

uniqueId: string

Returns: Promise