IRelativePosition Interface
A position specified relative to a segment.
Signature
export interface IRelativePosition
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| before | optional |
boolean | If true, insert before the specified segment. If false or not defined, insert after the specified segment. |
| id | optional |
string | String identifier specifying a segment. |
| offset | optional |
number | A positive number \>= 1. If before is false, offset is added to the position. If before is true, offset is subtracted from the position. |
Property Details
before
If true, insert before the specified segment. If false or not defined, insert after the specified segment.
Signature
before?: boolean;
Type: boolean
id
String identifier specifying a segment.
Signature
id?: string;
Type: string
offset
A positive number >= 1. If before is false, offset is added to the position. If before is true, offset is subtracted from the position.
Signature
offset?: number;
Type: number