gi-nx

---

gi-nx / getScenarioFeatures

function getScenarioFeatures(rawSections: 
  | (
  | RawPoint & {
  temporary?: never;
}
  | RawMultiPoint & {
  temporary?: never;
}
  | RawLineString & {
  temporary?: never;
}
  | RawMultiLineString & {
  temporary?: never;
}
  | RawPolygon & {
  temporary?: never;
}
  | RawMultiPolygon & {
  temporary?: never;
})[]
  | Record<string, 
  | RawPoint & {
  temporary?: never;
}
  | RawMultiPoint & {
  temporary?: never;
}
  | RawLineString & {
  temporary?: never;
}
  | RawMultiLineString & {
  temporary?: never;
}
  | RawPolygon & {
  temporary?: never;
}
  | RawMultiPolygon & {
  temporary?: never;
}>, scenarioId: string): (
  | RawPoint & {
  temporary?: never;
}
  | RawMultiPoint & {
  temporary?: never;
}
  | RawLineString & {
  temporary?: never;
}
  | RawMultiLineString & {
  temporary?: never;
}
  | RawPolygon & {
  temporary?: never;
}
  | RawMultiPolygon & {
  temporary?: never;
})[];

Get all features belonging to a specific scenario.

Parameters

Parameter	Type	Description
rawSections	| ( | RawPoint & { temporary?: never; } | RawMultiPoint & { temporary?: never; } | RawLineString & { temporary?: never; } | RawMultiLineString & { temporary?: never; } | RawPolygon & { temporary?: never; } | RawMultiPolygon & { temporary?: never; })[] | Record<string, | RawPoint & { temporary?: never; } | RawMultiPoint & { temporary?: never; } | RawLineString & { temporary?: never; } | RawMultiLineString & { temporary?: never; } | RawPolygon & { temporary?: never; } | RawMultiPolygon & { temporary?: never; }>	-
scenarioId	string	ID of the scenario to get features from

Returns

( | RawPoint & { temporary?: never; } | RawMultiPoint & { temporary?: never; } | RawLineString & { temporary?: never; } | RawMultiLineString & { temporary?: never; } | RawPolygon & { temporary?: never; } | RawMultiPolygon & { temporary?: never; })[]

Promise resolving to an array of features in the scenario

Example

const features = await rpc.invoke("getScenarioFeatures", ["scenario-123"]);
console.log(`Scenario has ${features.length} features`);