Annotation layers More...

Inherits Control.

Public Member Functions
void	AddNewLayer (LayerObject layer)
	Adds a new layer More...

LayerObject	AddNewLayer ()
	Adds a new layer More...

LayerObject	AddNewLayer (CoordinateControlStyle coordinateControlStyle)
	Adds a new layer More...

SegmentObject	AddNewOrUpdateSegment (string value)
	Adds a new or update segment More...

SegmentObject	AddNewOrUpdateSegment (string value, CoordinateControlStyle style)
	Adds a new or update segment More...

SegmentObject	AddNewSegment ()
	Adds new segment More...

SegmentObject	AddNewSegment (CoordinateControlStyle style)
	Adds new segment More...

void	AutoAlign ()
	Automaticaly align segments on selected layers More...

void	AutoResizeSegment (SegmentObject segment)
	Automatic resize segment More...

void	AutoResizeSegments ()
	Automatic resize segments More...

void	ConsolidateSegments ()
	Consolidate segments More...

bool	ConsolidateSegments (SegmentObject leftSegment, SegmentObject rightSegment, LayerObject layer)
	Consolidate segments More...

void	Crop (float start, float end)
	Crops annotation to start and end position More...

void	Delete ()
	Deletes all selected segments or layers More...

LayerObject	DuplicateLayer ()
	Duplicates layer and returns new created More...

LayerObject	DuplicateLayer (LayerObject layer)
	Duplicates layer using given layer More...

void	FillGaps (string gapLabel, bool onlySelectedSegments)
	Fills gaps in annotation More...

double	GetSegmentRateGross ()
	Calculates gross segment rate for selected Layer If any segments are selected rate will be calculated for them If no segments are selected rate will be calculated for all More...

double	GetSegmentRateGross (LayerObject layer)
	Calculates gross segment rate for layer given in parameter If any segments are selected rate will be calculated for them If no segments are selected rate will be calculated for all More...

double	GetSegmentRateGross (SegmentCollection segments, bool onlySelected)
	Calculates gross rate for segment collection More...

double	GetSegmentRateNetto ()
	Calculates netto segment rate for selected layer More...

double	GetSegmentRateNetto (LayerObject layer)
	Calculates netto segment rate for layer given in parameter If any segments are selected rate will be calculated for them If no segments are selected rate will be calculated for all More...

double	GetSegmentRateNetto (SegmentCollection segments, bool onlySelected)
	Calculates netto rate for segment collection More...

string	GetSegmentsStatus ()
	Gets total segments count and selected count as string More...

void	Segmentate (SegmentationModuleObject segmentationModule, bool onlySelectedSegments, SegmentationMode segmentationMode, ProgressBar progressBar, CancellationToken token)
	Segmentates annotation with given module and setup More...

bool	SegmentateSegment (SegmentationModuleObject segmentationModule, SegmentObject segment, LayerObject destinationLayer, SegmentationMode segmentationMode)
	Segmentates segment with segmentation module More...

void	SelectAllSegmentsOnLayer ()
	Selects all segments on layer More...

void	SelectNearestVisibleSegment (float position, LayerObject layer)
	Select nearest visible segment on given layer in position. More...

void	ShowSelectedSegments ()
	Shows the selected segments More...

void	ShowSelectedSegments (bool onWaveform, bool zoom, bool showAllSegments)
	Shows the selected segments More...

void	SpaceSegmentsEqually ()
	Space all or selected segment equally on selected layer More...

void	SplitSegment ()
	Splits a segment More...

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used. More...

Properties
Color	BackgroundColor `[get, set]`
	Gets or sets the color of the background More...

float	CursorPosition = Color.DarkGray `[get, set]`
	Gets or sets the cursor position. More...

float	EndViewPosition `[get]`
	Gets the end view position More...

bool	HighQuality `[get, set]`
	Gets or set if high quality drawing mode is enabled More...

int	LayersHeight `[get]`
	Gets the height of the layers More...

List< string >	RateExceptionList `[get, set]`
	Gets or sets a list of rate exceptions More...

Color	RullerBackColor `[get, set]`
	Gets or sets the color of the ruller back More...

Color	RullerBackColorInactive = Color.DarkGray `[get, set]`
	Gets or sets the ruller back color inactive More...

Color	RullerForeColor `[get, set]`
	Gets or sets the color of the ruller foreground More...

LayerObject	SelectedLayer `[get]`
	Gets the selected layer More...

LayerCollection	SelectedLayers `[get]`
	Gets the selected layers More...

SegmentObject	SelectedSegment = new List<string>() `[get]`
	Gets the selected segment More...

SegmentCollection	SelectedSegments `[get]`
	Gets the selected segments More...

int	SnapBorderDistance = 10 `[get, set]`
	Gets or sets the snap border distance More...

int	SnapDistance `[get, set]`
	Gets or sets the snap distance More...

float	StartViewPosition `[get, set]`
	Gets or sets the start view position More...

Synchronizer	Synchronizer `[get, set]`
	Gets or sets the synchronizer More...

int	VerticalOffset `[get, set]`
	Gets or sets the vertical offset More...

LayerCollection	VisibleLayers `[get]`
	Gets the visible layers More...

float	ZoomFactorX `[get, set]`
	Gets or sets the zoom factor x coordinate More...

Events
ChangedHandler	LayersHeightChanged
	Event queue for all listeners interested in LayersHeightChanged events More...

SegmentModifiedHandler	SegmentModified
	Event fired after segment modified More...

Detailed Description

Annotation layers

Member Function Documentation

◆ AddNewLayer() [1/3]

void AddNewLayer ( LayerObject layer )

inline

Adds a new layer

Parameters

layer The layer.

◆ AddNewLayer() [2/3]

LayerObject AddNewLayer ( )

inline

Adds a new layer

Returns: A LayerObject.

◆ AddNewLayer() [3/3]

LayerObject AddNewLayer ( CoordinateControlStyle coordinateControlStyle )

inline

Adds a new layer

Parameters

coordinateControlStyle The coordinate control style.

Returns: A LayerObject.

◆ AddNewOrUpdateSegment() [1/2]

SegmentObject AddNewOrUpdateSegment ( string value )

inline

Adds a new or update segment

Parameters

value The value.

Returns: A SegmentObject.

◆ AddNewOrUpdateSegment() [2/2]

SegmentObject AddNewOrUpdateSegment	(	string	value,
		CoordinateControlStyle	style
	)

inline

Adds a new or update segment

Parameters

value	The value.
style	The style.

Returns: A SegmentObject.

◆ AddNewSegment() [1/2]

SegmentObject AddNewSegment ( )

inline

Adds new segment

Returns: A SegmentObject.

◆ AddNewSegment() [2/2]

SegmentObject AddNewSegment ( CoordinateControlStyle style )

inline

Adds new segment

Parameters

style The style.

Returns: A SegmentObject.

◆ AutoAlign()

void AutoAlign ( )

inline

Automaticaly align segments on selected layers

◆ AutoResizeSegment()

void AutoResizeSegment ( SegmentObject segment )

inline

Automatic resize segment

Parameters

segment The segment.

◆ AutoResizeSegments()

void AutoResizeSegments ( )

inline

Automatic resize segments

◆ ConsolidateSegments() [1/2]

void ConsolidateSegments ( )

inline

Consolidate segments

◆ ConsolidateSegments() [2/2]

bool ConsolidateSegments	(	SegmentObject	leftSegment,
		SegmentObject	rightSegment,
		LayerObject	layer
	)

inline

Consolidate segments

Parameters

leftSegment	The left segment.
rightSegment	The right segment.
layer	The layer.

Returns: true if it succeeds, false if it fails.

◆ Crop()

void Crop	(	float	start,
		float	end
	)

inline

Crops annotation to start and end position

Parameters

start	cropping start position
end	cropping end position

◆ Delete()

void Delete ( )

inline

Deletes all selected segments or layers

◆ Dispose()

override void Dispose ( bool disposing )

inlineprotected

Clean up any resources being used.

Parameters

disposing true if managed resources should be disposed; otherwise, false.

◆ DuplicateLayer() [1/2]

LayerObject DuplicateLayer ( )

inline

Duplicates layer and returns new created

Returns: New duplicated layer

◆ DuplicateLayer() [2/2]

LayerObject DuplicateLayer ( LayerObject layer )

inline

Duplicates layer using given layer

Parameters

layer The layer.

Returns: New duplicated layer

◆ FillGaps()

void FillGaps	(	string	gapLabel,
		bool	onlySelectedSegments
	)

inline

Fills gaps in annotation

Parameters

gapLabel	The gap label.
onlySelectedSegments	true to only selected segments.

◆ GetSegmentRateGross() [1/3]

double GetSegmentRateGross ( )

inline

Calculates gross segment rate for selected Layer If any segments are selected rate will be calculated for them If no segments are selected rate will be calculated for all

Returns: Gross segment rate

◆ GetSegmentRateGross() [2/3]

double GetSegmentRateGross ( LayerObject layer )

inline

Calculates gross segment rate for layer given in parameter If any segments are selected rate will be calculated for them If no segments are selected rate will be calculated for all

Parameters

layer Layer to calculate rate

Returns: Gross segment rate

◆ GetSegmentRateGross() [3/3]

double GetSegmentRateGross	(	SegmentCollection	segments,
		bool	onlySelected
	)

inline

Calculates gross rate for segment collection

Parameters

segments	Segments collection to calculate rate
onlySelected	if true only selected segment will be included

Returns

◆ GetSegmentRateNetto() [1/3]

double GetSegmentRateNetto ( )

inline

Calculates netto segment rate for selected layer

Returns: Netto segment rate

◆ GetSegmentRateNetto() [2/3]

double GetSegmentRateNetto ( LayerObject layer )

inline

Calculates netto segment rate for layer given in parameter If any segments are selected rate will be calculated for them If no segments are selected rate will be calculated for all

Parameters

layer Layer to calculate rate

Returns

◆ GetSegmentRateNetto() [3/3]

double GetSegmentRateNetto	(	SegmentCollection	segments,
		bool	onlySelected
	)

inline

Calculates netto rate for segment collection

Parameters

segments	Segments collection to calculate rate
onlySelected	if true only selected segment will be included

Returns

◆ GetSegmentsStatus()

string GetSegmentsStatus ( )

inline

Gets total segments count and selected count as string

Returns

◆ Segmentate()

void Segmentate	(	SegmentationModuleObject	segmentationModule,
		bool	onlySelectedSegments,
		SegmentationMode	segmentationMode,
		ProgressBar	progressBar,
		CancellationToken	token
	)

inline

Segmentates annotation with given module and setup

Parameters

segmentationModule	The segmentation module.
onlySelectedSegments	true to only selected segments.
segmentationMode	The segmentation mode.
progressBar	Progress bar reference
token	Token for cancellation of segmentation

◆ SegmentateSegment()

bool SegmentateSegment	(	SegmentationModuleObject	segmentationModule,
		SegmentObject	segment,
		LayerObject	destinationLayer,
		SegmentationMode	segmentationMode
	)

inline

Segmentates segment with segmentation module

Parameters

segmentationModule	The segmentation module.
segment	The segment.
destinationLayer	Destination layer.
segmentationMode	The segmentation mode.

◆ SelectAllSegmentsOnLayer()

void SelectAllSegmentsOnLayer ( )

inline

Selects all segments on layer

◆ SelectNearestVisibleSegment()

void SelectNearestVisibleSegment	(	float	position,
		LayerObject	layer
	)

inline

Select nearest visible segment on given layer in position.

Parameters

position	Initial position
layer	Search segments only on given layer

◆ ShowSelectedSegments() [1/2]

void ShowSelectedSegments ( )

inline

Shows the selected segments

◆ ShowSelectedSegments() [2/2]

void ShowSelectedSegments	(	bool	onWaveform,
		bool	zoom,
		bool	showAllSegments
	)

inline

Shows the selected segments

Parameters

onWaveform	true to on waveform.
zoom	true to zoom.
showAllSegments	true to show, false to hide all segments.

◆ SpaceSegmentsEqually()

void SpaceSegmentsEqually ( )

inline

Space all or selected segment equally on selected layer

◆ SplitSegment()

void SplitSegment ( )

inline

Splits a segment

Property Documentation

◆ BackgroundColor

Color BackgroundColor

getset

Gets or sets the color of the background

The color of the background.

◆ CursorPosition

float CursorPosition = Color.DarkGray

getset

Gets or sets the cursor position.

The cursor position.

◆ EndViewPosition

float EndViewPosition

get

Gets the end view position

The end view position.

◆ HighQuality

bool HighQuality

getset

Gets or set if high quality drawing mode is enabled

High Quality mode state.

◆ LayersHeight

int LayersHeight

get

Gets the height of the layers

The height of the layers.

◆ RateExceptionList

List<string> RateExceptionList

getset

Gets or sets a list of rate exceptions

A List of rate exceptions.

◆ RullerBackColor

Color RullerBackColor

getset

Gets or sets the color of the ruller back

The color of the ruller back.

◆ RullerBackColorInactive

Color RullerBackColorInactive = Color.DarkGray

getset

Gets or sets the ruller back color inactive

The ruller back color inactive.

◆ RullerForeColor

Color RullerForeColor

getset

Gets or sets the color of the ruller foreground

The color of the ruller foreground.

◆ SelectedLayer

LayerObject SelectedLayer

get

Gets the selected layer

The selected layer.

◆ SelectedLayers

LayerCollection SelectedLayers

get

Gets the selected layers

The selected layers.

◆ SelectedSegment

SegmentObject SelectedSegment = new List<string>()

get

Gets the selected segment

The selected segment.

◆ SelectedSegments

SegmentCollection SelectedSegments

get

Gets the selected segments

The selected segments.

◆ SnapBorderDistance

int SnapBorderDistance = 10

getset

Gets or sets the snap border distance

The snap border distance.

◆ SnapDistance

int SnapDistance

getset

Gets or sets the snap distance

The snap distance.

◆ StartViewPosition

float StartViewPosition

getset

Gets or sets the start view position

The start view position.

◆ Synchronizer

Synchronizer Synchronizer

getset

Gets or sets the synchronizer

The synchronizer.

◆ VerticalOffset

int VerticalOffset

getset

Gets or sets the vertical offset

The vertical offset.

◆ VisibleLayers

LayerCollection VisibleLayers

get

Gets the visible layers

The visible layers.

◆ ZoomFactorX

float ZoomFactorX

getset

Gets or sets the zoom factor x coordinate

The zoom factor x coordinate.

Event Documentation

◆ LayersHeightChanged

ChangedHandler LayersHeightChanged

Event queue for all listeners interested in LayersHeightChanged events

◆ SegmentModified

SegmentModifiedHandler SegmentModified

Event fired after segment modified

The documentation for this class was generated from the following files:

AnnotationPro.Presentation/AnnotationLayers.cs
AnnotationPro.Presentation/AnnotationLayers.Designer.cs

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddNewLayer() [1/3]

◆ AddNewLayer() [2/3]

◆ AddNewLayer() [3/3]

◆ AddNewOrUpdateSegment() [1/2]

◆ AddNewOrUpdateSegment() [2/2]

◆ AddNewSegment() [1/2]

◆ AddNewSegment() [2/2]

◆ AutoAlign()

◆ AutoResizeSegment()

◆ AutoResizeSegments()

◆ ConsolidateSegments() [1/2]

◆ ConsolidateSegments() [2/2]

◆ Crop()

◆ Delete()

◆ Dispose()

◆ DuplicateLayer() [1/2]

◆ DuplicateLayer() [2/2]

◆ FillGaps()

◆ GetSegmentRateGross() [1/3]

◆ GetSegmentRateGross() [2/3]

◆ GetSegmentRateGross() [3/3]

◆ GetSegmentRateNetto() [1/3]

◆ GetSegmentRateNetto() [2/3]

◆ GetSegmentRateNetto() [3/3]

◆ GetSegmentsStatus()

◆ Segmentate()

◆ SegmentateSegment()

◆ SelectAllSegmentsOnLayer()

◆ SelectNearestVisibleSegment()

◆ ShowSelectedSegments() [1/2]

◆ ShowSelectedSegments() [2/2]

◆ SpaceSegmentsEqually()

◆ SplitSegment()

Property Documentation

◆ BackgroundColor

◆ CursorPosition

◆ EndViewPosition

◆ HighQuality

◆ LayersHeight

◆ RateExceptionList

◆ RullerBackColor

◆ RullerBackColorInactive

◆ RullerForeColor

◆ SelectedLayer

◆ SelectedLayers

◆ SelectedSegment

◆ SelectedSegments

◆ SnapBorderDistance

◆ SnapDistance

◆ StartViewPosition

◆ Synchronizer

◆ VerticalOffset

◆ VisibleLayers

◆ ZoomFactorX

Event Documentation

◆ LayersHeightChanged

◆ SegmentModified