Skip to main content
Version: v1

LocalReference Class

This API is deprecated and will be removed in a future release.
  • Use LocalReferencePosition

Signature​

export declare class LocalReference implements LocalReferencePosition

Implements: LocalReferencePosition

Constructors​

Constructor Alerts Description
(constructor)(client, initSegment, offset, refType, properties) Deprecated Constructs a new instance of the LocalReference class

Static Properties​

Property Alerts Type Description
DetachedPosition Deprecated number

Properties​

Property Alerts Modifiers Type Description
callbacks optional Partial<Record<"beforeSlide" | "afterSlide", () => void>> | undefined
offset Deprecated number
pairedRef Deprecated optional LocalReference
properties PropertySet | undefined
refType ReferenceType
segment Deprecated ISegment | undefined

Methods​

Method Alerts Return Type Description
addProperties(newProps, op) void
compare(b) Deprecated number
getClient() Deprecated Client
getOffset() number
getProperties() PropertySet | undefined
getRangeLabels() Deprecated string[] | undefined
getSegment() ISegment | undefined
getTileLabels() Deprecated string[] | undefined
hasRangeLabel(label) Deprecated boolean
hasRangeLabels() Deprecated boolean
hasTileLabel(label) Deprecated boolean
hasTileLabels() Deprecated boolean
isLeaf() boolean
max(b) Deprecated LocalReference
min(b) Deprecated LocalReference
toPosition() Deprecated number

Constructor Details​

(constructor)​

Constructs a new instance of the LocalReference class

This API is deprecated and will be removed in a future release.
  • use createReferencePosition
Signature​
constructor(client: Client, initSegment: ISegment, 
    offset?: number, refType?: ReferenceType, properties?: PropertySet);

Parameters​

Parameter Modifiers Type Description
client Client
initSegment ISegment
offset optional number
refType optional ReferenceType
properties optional PropertySet

Property Details​

callbacks​

Signature​
callbacks?: Partial<Record<"beforeSlide" | "afterSlide", () => void>> | undefined;

Type: Partial<Record<"beforeSlide" | "afterSlide", () => void>> | undefined

DetachedPosition​

This API is deprecated and will be removed in a future release.
  • use DetachedReferencePosition
Signature​
static readonly DetachedPosition: number;

Type: number

offset​

This API is deprecated and will be removed in a future release.
  • use getOffset
Signature​
offset: number;

Type: number

pairedRef​

This API is deprecated and will be removed in a future release.
  • use properties to store pair
Signature​
pairedRef?: LocalReference;

Type: LocalReference

properties​

Signature​
properties: PropertySet | undefined;

Type: PropertySet | undefined

refType​

Signature​
refType: ReferenceType;

Type: ReferenceType

segment​

This API is deprecated and will be removed in a future release.
  • use getSegment
Signature​
segment: ISegment | undefined;

Type: ISegment | undefined

Method Details​

addProperties​

Signature​
addProperties(newProps: PropertySet, op?: ICombiningOp): void;

Parameters​

Parameter Modifiers Type Description
newProps PropertySet
op optional ICombiningOp

compare​

This API is deprecated and will be removed in a future release.
  • use compareReferencePositions
Signature​
compare(b: LocalReference): number;

Parameters​

Parameter Type Description
b LocalReference

Returns​

Return type: number

getClient​

This API is deprecated and will be removed in a future release.
  • no longer supported
Signature​
getClient(): Client;

Returns​

Return type: Client

getOffset​

Signature​
getOffset(): number;

Returns​

Return type: number

getProperties​

Signature​
getProperties(): PropertySet | undefined;

Returns​

Return type: PropertySet | undefined

getRangeLabels​

This API is deprecated and will be removed in a future release.
  • use refGetRangeLabels
Signature​
getRangeLabels(): string[] | undefined;

Returns​

Return type: string[] | undefined

getSegment​

Signature​
getSegment(): ISegment | undefined;

Returns​

Return type: ISegment | undefined

getTileLabels​

This API is deprecated and will be removed in a future release.
  • use refGetTileLabels
Signature​
getTileLabels(): string[] | undefined;

Returns​

Return type: string[] | undefined

hasRangeLabel​

This API is deprecated and will be removed in a future release.
  • use refHasRangeLabel
Signature​
hasRangeLabel(label: string): boolean;

Parameters​

Parameter Type Description
label string

Returns​

Return type: boolean

hasRangeLabels​

This API is deprecated and will be removed in a future release.
  • use refHasRangeLabels
Signature​
hasRangeLabels(): boolean;

Returns​

Return type: boolean

hasTileLabel​

This API is deprecated and will be removed in a future release.
  • use refHasTileLabel
Signature​
hasTileLabel(label: string): boolean;

Parameters​

Parameter Type Description
label string

Returns​

Return type: boolean

hasTileLabels​

This API is deprecated and will be removed in a future release.
  • use refHasTileLabels
Signature​
hasTileLabels(): boolean;

Returns​

Return type: boolean

isLeaf​

Signature​
isLeaf(): boolean;

Returns​

Return type: boolean

max​

This API is deprecated and will be removed in a future release.
  • use maxReferencePosition
Signature​
max(b: LocalReference): LocalReference;

Parameters​

Parameter Type Description
b LocalReference

Returns​

Return type: LocalReference

min​

This API is deprecated and will be removed in a future release.
  • use minReferencePosition
Signature​
min(b: LocalReference): LocalReference;

Parameters​

Parameter Type Description
b LocalReference

Returns​

Return type: LocalReference

toPosition​

This API is deprecated and will be removed in a future release.
  • use getLocalReferencePosition
Signature​
toPosition(): number;

Returns​

Return type: number