Class PresentationSeriesGroup

PresentationSeriesGroup class to manage list of PresentationDataContext

Hierarchy

PresentationSeriesGroup

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PresentationSeriesGroup(): PresentationSeriesGroup

description

Constructs the PresentationSeriesGroup object;

Returns PresentationSeriesGroup

This is a synchronous method that returns the newly PresentationSeriesGroup

Properties

Private presentationSeriesList

presentationSeriesList: Array<PresentationDataContext> = []

Private totalPresentations

totalPresentations: number = 0

Methods

add

add(presentationDataContext: PresentationDataContext): void

description

Add PresentationDataContext in to the list if not already available

Parameters
- presentationDataContext: PresentationDataContext
  
  PresentationDataContext object to be added
Returns void

clear

clear(): void

description

Clear the presentation series list

Returns void

enablePresentationData

enablePresentationData(): void

description

Enable the first presentation

Returns void

get

get(sopInstanceUid: string, instanceNumber: number): PresentationDataContext

description

Get presentation datacontext for given sopInstanceUid and instanceNumber

Parameters
- sopInstanceUid: string
  
  Sop insatance uid
- instanceNumber: number
  
  instanceNumber
Returns PresentationDataContext

a PresentationDataContext

getActivePresentationData

getActivePresentationData(referencedSeriesInstanceUid: string): PresentationDataContext

description

Get list of presentation data matching the given referenced series instance uid and is enabled

Parameters
- referencedSeriesInstanceUid: string
  
  referenced series instance*
Returns PresentationDataContext

Returns list of PresentationDataContext on success case, empty list on failure case

getAll

getAll(): Array<PresentationDataContext>

description

Get all presentation series list

Returns Array<PresentationDataContext>

a Presentationserieslist

getByReferencedSeries

getByReferencedSeries(referencedSeriesInstanceUid: string): Array<PresentationDataContext>

description

Get list of presentation data matching the given referenced series instance uid

Parameters
- referencedSeriesInstanceUid: string
  
  referenced series instance*
Returns Array<PresentationDataContext>

Returns list of presentation data on success case, empty list on failure case

getPresentationInfo

getPresentationInfo(): IPresentationDataContext[]

description

Get presentation info

Returns IPresentationDataContext[]

a Presentation array

getPresentationListToSave

getPresentationListToSave(includeExistingAnnotation?: boolean): Array<PresentationDataContext>

description

Get presentation list that modified to save

Parameters
- Default value includeExistingAnnotation: boolean = false
  
  true to save existing annotation , false to not save
Returns Array<PresentationDataContext>

Returns list of PresentationDataContext on success case, empty list on failure case

getTotalPresentation

getTotalPresentation(): number

description

Get total presentation

Returns number

Returns Total number of Presentations

remove

remove(sopInstanceUid: string): void

Parameters
- sopInstanceUid: string
Returns void

removeList

removeList(sopInstanceUidList: Array<string>): void

Parameters
- sopInstanceUidList: Array<string>
Returns void

togglePresentationData

togglePresentationData(sopInstanceUid: string): void

Toggle the presentation data to given sopinstance uid

Parameters
- sopInstanceUid: string
Returns void