Interface IRouteOption

도착지

Example

{
  destination: {
    // poiId 또는 position 으로 경유지 위치를 설정할 수 있습니다.
    position: {
      x: number,
      y: number,
      z: number,
    },
    poiId: string,
    floorId: string,
  }
}
Copy

길찾기 옵션을 지정할 수 있음.

Example

{
  최소 이동수단 관련 속성
  길찾기 경로를 이동수단을 최소한으로 사용하여 찾는지 여부
  isMinimumTransfer?: boolean,

  선호하지 않는 층관련 속성 추가
  선호하지 않는 층 목록에 있으면 최대한 그 층을 피해서 길찾기 함
  notPreferredFloorIds?: string[],

  교통 약자를 위한 길안내 관련 속성
  node data의 isBarrierFree 속성을 보고 판단
  isBarrierFreeRoute?: boolean,

  경유지 최적 순서 정렬 관련 속성
  waypoints가 2개 이상일 때 방문 순서를 최적화함
  optimizeWaypoints?: boolean,

  도착지를 경유지 최적화 시 고정할지 여부
  optimizeWaypoints가 true일 때만 효과가 있습니다.
  false인 경우, 출발지만 고정되고 경유지와 도착지는 혼합되어 최단 경로로 재배치됩니다.
  true인 경우, 출발지와 도착지가 고정되고 경유지만 재배치됩니다.
  또한, 동일한 objectId (또는 동일한 position + floorId)를 가진 위치는
  최적화 전에 중복 제거됩니다.
  default: true
  fixDestination?: boolean,
}
Copy

출발지

Example

{
  origin: {
    // poiId 또는 position 으로 경유지 위치를 설정할 수 있습니다.
    position: {
      x: number,
      y: number,
      z: number,
    },
    poiId: string,
    floorId: string,
  }
}
Copy

층간이동 수단. 경로를 알고자하는 이동수단을 지정합니다. 복수개 가능하며 지정하지 않은 경우 디폴트는 recommendation입니다.

Example

{
  // 배열에 복수개로 지정시 이동수단별 해당 경로를 모두 알 수 있습니다.
  type: ["recommendation" | "stairs" | "escalator" | "elevator" | "stairs_preferred" | "escalator_preferred" | "elevator_preferred"]
}
Copy

경유지. 복수의 경유지가 가능합니다.

Example

{
  waypoints: [
    {
      // poiId 또는 position 으로 경유지 위치를 설정할 수 있습니다.
      position: {
        x: number,
        y: number,
        z: number,
      },
      poiId: string,
      floorId: string,
    },
    {
      // poiId 또는 position 으로 경유지 위치를 설정할 수 있습니다.
      position: {
        x: number,
        y: number,
        z: number,
      },
      poiId: string,
      floorId: string,
    }
  ]
}
Copy