Marker Class
Signature
export declare class Marker extends BaseSegment implements ReferencePosition
Extends: BaseSegment
Implements: ReferencePosition
Constructors
| Constructor | Description |
|---|---|
| (constructor)(refType) | Constructs a new instance of the Marker class |
Static Properties
| Property | Type | Description |
|---|---|---|
| type |
Static Methods
| Method | Return Type | Description |
|---|---|---|
| fromJSONObject(spec) | Marker | undefined | |
| is(segment) | segment is Marker | |
| make(refType, props) | Marker |
Properties
| Property | Type | Description |
|---|---|---|
| refType | ReferenceType | |
| type |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| append() | void | ||
| canAppend(segment) | boolean | ||
| clone() | Marker | ||
| createSplitSegmentAt(pos) | undefined | ||
| getId() | string | undefined | ||
| getOffset() | number | ||
| getProperties() | PropertySet | undefined | ||
| getRangeLabels() | Deprecated | string[] | undefined | |
| getSegment() | this | ||
| getTileLabels() | Deprecated | string[] | undefined | |
| hasRangeLabel(label) | Deprecated | boolean | |
| hasRangeLabels() | Deprecated | boolean | |
| hasSimpleType(simpleTypeName) | boolean | ||
| hasTileLabel(label) | Deprecated | boolean | |
| hasTileLabels() | Deprecated | boolean | |
| toJSONObject() | IJSONMarkerSegment | ||
| toString() | string |
Constructor Details
(constructor)
Constructs a new instance of the Marker class
Signature
constructor(refType: ReferenceType);
Parameters
| Parameter | Type | Description |
|---|---|---|
| refType | ReferenceType |
Property Details
refType
Signature
refType: ReferenceType;
Type: ReferenceType
type
Signature
readonly type = "Marker";
type
Signature
static readonly type = "Marker";
Method Details
append
Signature
append(): void;
canAppend
Signature
canAppend(segment: ISegment): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| segment | ISegment |
Returns
Return type: boolean
clone
Signature
clone(): Marker;
Returns
Return type: Marker
createSplitSegmentAt
Signature
protected createSplitSegmentAt(pos: number): undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| pos | number |
Returns
Return type: undefined
fromJSONObject
Signature
static fromJSONObject(spec: any): Marker | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| spec | any |
Returns
Return type: Marker | undefined
getId
Signature
getId(): string | undefined;
Returns
Return type: string | undefined
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(): this;
Returns
Return type: this
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
hasSimpleType
Signature
hasSimpleType(simpleTypeName: string): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| simpleTypeName | string |
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
is
Signature
static is(segment: ISegment): segment is Marker;
Parameters
| Parameter | Type | Description |
|---|---|---|
| segment | ISegment |
Returns
Return type: segment is Marker
make
Signature
static make(refType: ReferenceType, props?: PropertySet): Marker;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| refType | ReferenceType | ||
| props | optional | PropertySet |
Returns
Return type: Marker
toJSONObject
Signature
toJSONObject(): IJSONMarkerSegment;
Returns
Return type: IJSONMarkerSegment
toString
Signature
toString(): string;
Returns
Return type: string