Skip to main content

Version: Next

recognizeCoordinateString

Callable

recognizeCoordinateString(value: string | number | null | undefined, expectedKind?: CoordinateFormatKind): RecognizedCoordinate | undefined

Recognizes the shape of a single coordinate string. This is the only place that knows the accepted grammar; both sniffCoordinateDescriptor and parseCoordinateValue go through it so that a format we can parse is never a format we fail to recognize, and vice versa.
Parameters
- value: string | number | null | undefined
- optionalexpectedKind: CoordinateFormatKind
  what the column's units say the values are. Supplying sexagesimal is what unlocks the separator-free compact form, which is otherwise indistinguishable from a decimal value: "205405.689" is 20h54m05.689s or 205405.689 degrees, and only the metadata can say which.
Returns RecognizedCoordinate | undefined