Class HCoord

Haystack coord.

Implements

HVal

Index

Accessors

latitude longitude

Methods

compareTo equals getKind inspect isKind matches newCopy toAxon toDict toFilter toGrid toJSON toJSONString toJSONUint8Array toJSONv3 toList toString toZinc make

Accessors

latitude

get latitude(): number
Returns number
The latitude value.
- Defined in src/core/HCoord.ts:96
set latitude(latitude: number): void
Parameters
- latitude: number
Returns void
- Defined in src/core/HCoord.ts:100

longitude

get longitude(): number
Returns number
The longitude value.
- Defined in src/core/HCoord.ts:107
set longitude(longitude: number): void
Parameters
- longitude: number
Returns void
- Defined in src/core/HCoord.ts:111

Methods

compareTo

compareTo(value: unknown): number
Compares two coords.
Parameters
- value: unknown
  The value to compare against.
Returns number
The sort order as negative, 0, or positive
Implementation of HVal.compareTo
- Defined in src/core/HCoord.ts:201

equals

equals(value: unknown): boolean
Value equality check.
Parameters
- value: unknown
  The value to compare.
Returns boolean
True if the value is the same.
Implementation of HVal.equals
- Defined in src/core/HCoord.ts:187

getKind

getKind(): Kind
Returns Kind
The value's kind.
Implementation of HVal.getKind
- Defined in src/core/HCoord.ts:118

inspect

inspect(message?: string): this
Dump the value to the local console output.
Parameters
- Optionalmessage: string
  An optional message to display before the value.
Returns this
The value instance.
Implementation of HVal.inspect
- Defined in src/core/HCoord.ts:149

isKind

isKind(kind: Kind): boolean
Compares the value's kind.
Parameters
- kind: Kind
  The kind to compare against.
Returns boolean
True if the kind matches.
Implementation of HVal.isKind
- Defined in src/core/HCoord.ts:128

matches

matches(filter: string | Node, cx?: Partial<EvalContext>): boolean
Returns true if the haystack filter matches the value.
Parameters
- filter: string | Node
  The filter to test.
- Optionalcx: Partial<EvalContext>
  Optional haystack filter evaluation context.
Returns boolean
True if the filter matches ok.
Implementation of HVal.matches
- Defined in src/core/HCoord.ts:139

newCopy

newCopy(): HCoord
Returns HCoord
Returns the value instance.
Implementation of HVal.newCopy
- Defined in src/core/HCoord.ts:260

toAxon

toAxon(): string
Returns string
An Axon encoded string of the value.
Implementation of HVal.toAxon
- Defined in src/core/HCoord.ts:253

toDict

toDict(): HDict
Returns HDict
The value as a dict.
Implementation of HVal.toDict
- Defined in src/core/HCoord.ts:281

toFilter

toFilter(): string
Encodes to an encoded zinc value that can be used in a haystack filter string.

A dict isn't supported in filter so throw an error.

Returns string
The encoded value that can be used in a haystack filter.
Implementation of HVal.toFilter
- Defined in src/core/HCoord.ts:168

toGrid

toGrid(): HGrid
Returns HGrid
The value as a grid.
Implementation of HVal.toGrid
- Defined in src/core/HCoord.ts:267

toJSON

toJSON(): HaysonCoord
Returns HaysonCoord
A JSON reprentation of the object.
Implementation of HVal.toJSON
- Defined in src/core/HCoord.ts:221

toJSONString

toJSONString(): string
Returns string
A string containing the JSON representation of the object.
Implementation of HVal.toJSONString
- Defined in src/core/HCoord.ts:232

toJSONUint8Array

toJSONUint8Array(): Uint8Array
Returns Uint8Array
A byte buffer that has an encoded JSON string representation of the object.
Implementation of HVal.toJSONUint8Array
- Defined in src/core/HCoord.ts:239

toJSONv3

toJSONv3(): `c:${string}`
Returns `c:${string}`
A JSON v3 representation of the object.
Implementation of HVal.toJSONv3
- Defined in src/core/HCoord.ts:246

toList

toList(): HList<HCoord>
Returns HList<HCoord>
The value as a list.
Implementation of HVal.toList
- Defined in src/core/HCoord.ts:274

toString

toString(): string
Returns string
A string representation of the value.
Implementation of HVal.toString
- Defined in src/core/HCoord.ts:156

toZinc

toZinc(): string
Encodes to an encoding zinc value.

Returns string
The encoded zinc string.
Implementation of HVal.toZinc
- Defined in src/core/HCoord.ts:177

`Static`make

make(value: HaysonCoord | CoordObj | HCoord): HCoord
Factory method for a new haystack coord.
Parameters
- value: HaysonCoord | CoordObj | HCoord
  An object with latitude and longitude or a Hayson coordinate object.
Returns HCoord
A haystack coordinate.

Throws
An error if the latitude or longitude are invalid.
- Defined in src/core/HCoord.ts:85