Skip to content

gi-nx


gi-nx / getScenarioFeatures

ts
function getScenarioFeatures(rawSections: 
  | (
  | RawPoint
  | RawMultiPoint
  | RawLineString
  | RawMultiLineString
  | RawPolygon
  | RawMultiPolygon)[]
  | Record<string, 
  | RawPoint
  | RawMultiPoint
  | RawLineString
  | RawMultiLineString
  | RawPolygon
  | RawMultiPolygon>, scenarioId: string): (
  | RawPoint
  | RawMultiPoint
  | RawLineString
  | RawMultiLineString
  | RawPolygon
  | RawMultiPolygon)[];

Get all features belonging to a specific scenario.

Parameters

ParameterTypeDescription
rawSections| ( | RawPoint | RawMultiPoint | RawLineString | RawMultiLineString | RawPolygon | RawMultiPolygon)[] | Record<string, | RawPoint | RawMultiPoint | RawLineString | RawMultiLineString | RawPolygon | RawMultiPolygon>-
scenarioIdstringID of the scenario to get features from

Returns

( | RawPoint | RawMultiPoint | RawLineString | RawMultiLineString | RawPolygon | RawMultiPolygon)[]

Promise resolving to an array of features in the scenario

Example

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