Class OSegment

Hierarchy (View Summary)

OItem
- OSegment

Implements

Serializable<ISegment, OSegment>

Index

Constructors

Properties

id labels sampleDur sampleStart type

Methods

clone deserialize getFirstLabelWithoutName isEqualWith replaceFirstLabelWithoutName serialize deserialize

Constructors

constructor

new OSegment(
    id: number,
    sampleStart: number,
    sampleDur: number,
    labels?: OLabel[],
): OSegment
Parameters
- id: number
- sampleStart: number
- sampleDur: number
- Optionallabels: OLabel[]
Returns OSegment
Overrides OItem.constructor
- Defined in annotjson.ts:365

Properties

id

id: number = 0

labels

labels: OLabel[]

sampleDur

sampleDur: number = 0

sampleStart

sampleStart: number = 0

`Readonly`type

type: "segment" | "event" | "item" = 'item'

Methods

clone

clone(id?: number): OSegment
Parameters
- Optionalid: number
Returns OSegment
Overrides OItem.clone
- Defined in annotjson.ts:401

deserialize

deserialize(jsonObject: ISegment): OSegment
Parameters
- jsonObject: ISegment
Returns OSegment
Implementation of Serializable.deserialize
Overrides OItem.deserialize
- Defined in annotjson.ts:385

getFirstLabelWithoutName

getFirstLabelWithoutName(notName: string): undefined | OLabel
Parameters
- notName: string
Returns undefined | OLabel
Inherited from OItem.getFirstLabelWithoutName
- Defined in annotjson.ts:310

isEqualWith

isEqualWith(other: OItem): boolean
Parameters
- other: OItem
Returns boolean
Inherited from OItem.isEqualWith
- Defined in annotjson.ts:339

replaceFirstLabelWithoutName

replaceFirstLabelWithoutName(
notName: string,
replace: (value: string) => string,
): undefined | OLabel
Parameters
- notName: string
- replace: (value: string) => string
Returns undefined | OLabel
Inherited from OItem.replaceFirstLabelWithoutName
- Defined in annotjson.ts:314

serialize

serialize(): ISegment
Returns ISegment
Implementation of Serializable.serialize
Overrides OItem.serialize
- Defined in annotjson.ts:376

`Static`deserialize

deserialize(jsonObject: ISegment, sampleRate?: number): OSegment
Parameters
- jsonObject: ISegment
- OptionalsampleRate: number
Returns OSegment
Overrides OItem.deserialize
- Defined in annotjson.ts:389