Class TrackedPointMap

gog

store

size

• get size(): number

  Number of named values being tracked

  Returns number

delete

• delete(id: string): void

  Remove a tracked value by id. Use reset to clear them all.

  Parameters

  • id: string

  Returns void

get

• get(
      id: string,
  ):
      | undefined
      | TrackerBase<
          Geometry.Point,
          Readonly<
              {
                  fromInitial: PointRelationResult;
                  fromLast: PointRelationResult;
                  fromMark: undefined
                  | PointRelationResult;
                  values: readonly Geometry.Point[];
              },
          >,
      >

  Returns a tracked value by id, or undefined if not found

  Parameters

  • id: string

  Returns
      | undefined
      | TrackerBase<
          Geometry.Point,
          Readonly<
              {
                  fromInitial: PointRelationResult;
                  fromLast: PointRelationResult;
                  fromMark: undefined
                  | PointRelationResult;
                  values: readonly Geometry.Point[];
              },
          >,
      >

has

• has(id: string): boolean

  Returns true if id is stored

  Parameters

  • id: string

  Returns boolean

ids

• ids(): Generator<string, void, unknown>

  Enumerate ids

  Returns Generator<string, void, unknown>

initialValues

• initialValues(): Generator<undefined | Geometry.Point, void, unknown>

  Enumerate starting values

  Returns Generator<undefined | Geometry.Point, void, unknown>

last

• last(): Generator<undefined | Geometry.Point, void, unknown>

  Enumerate last received values

  Returns Generator<undefined | Geometry.Point, void, unknown>

  Example: Calculate centroid of latest-received values

  const pointers = pointTracker();
  const c = Points.centroid(...Array.from(pointers.lastPoints()));
  Copy

reset

• reset(): void

  Remove all tracked values. Use delete to remove a single value by id.

  Returns void

seen

• seen(
      id: string,
      ...values: Geometry.Point[],
  ): Promise<
      Readonly<
          {
              fromInitial: PointRelationResult;
              fromLast: PointRelationResult;
              fromMark: undefined
              | PointRelationResult;
              values: readonly Geometry.Point[];
          },
      >,
  >

  For a given id, note that we have seen one or more values.

  Parameters

  • id: string

    Id
  • ...values: Geometry.Point[]

    Values(s)

  Returns Promise<
      Readonly<
          {
              fromInitial: PointRelationResult;
              fromLast: PointRelationResult;
              fromMark: undefined
              | PointRelationResult;
              values: readonly Geometry.Point[];
          },
      >,
  >

  Information about start to last value

tracked

• tracked(): Generator<PointTracker, void, unknown>

  Enumerate tracked values

  Returns Generator<PointTracker, void, unknown>

trackedByAge

• trackedByAge(): Generator<PointTracker, void, unknown>

  Iterates TrackedValues ordered with oldest first

  Returns Generator<PointTracker, void, unknown>

valuesByAge

• valuesByAge(): Generator<undefined | Geometry.Point, void, unknown>

  Iterates underlying values, ordered by age (oldest first) First the named values are sorted by their elapsed value, and then we return the last value for that group.

  Returns Generator<undefined | Geometry.Point, void, unknown>