Skip to main content
Version: v1

ReferencePosition Interface

Signature​

export interface ReferencePosition

Properties​

Property Modifiers Type Description
properties optional PropertySet
refType ReferenceType

Methods​

Method Alerts Return Type Description
addProperties(newProps, op) void
getOffset() number
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

Property Details​

properties​

Signature​
properties?: PropertySet;

Type: PropertySet

refType​

Signature​
refType: ReferenceType;

Type: ReferenceType

Method Details​

addProperties​

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

Parameters​

Parameter Modifiers Type Description
newProps PropertySet
op optional ICombiningOp

getOffset​

Signature​
getOffset(): number;

Returns​

Return type: number

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