interface IRouteOption {
    destination: IRoute;
    option?: {
        isMinimumTransfer?: boolean;
        notPreferredFloorIds?: string[];
    };
    origin: IRoute;
    type?: TRANSPORTATION_REQUEST_TYPE[];
    waypoints?: IRoute[];
}

Properties

destination: IRoute

도착지

Example

{
destination: {
// poiId 또는 position 으로 경유지 위치를 설정할 수 있습니다.
position: {
x: number,
y: number,
z: number,
},
poiId: string,
floorId: string,
}
}
option?: {
    isMinimumTransfer?: boolean;
    notPreferredFloorIds?: string[];
}

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

Type declaration

  • Optional isMinimumTransfer?: boolean

    최소 이동수단 관련 속성 길찾기 경로를 이동수단을 최소한으로 사용하여 찾는지 여부 default: false

  • Optional notPreferredFloorIds?: string[]

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

Example

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

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

출발지

Example

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

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

Example

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

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

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,
}
]
}