Distance - Documentation

Distance

사용자가 설정한 지점들의 거리를 측정하기 위한 클래스로 측정 단위(meter, mile, nauticalmile)에 따라 구간별 거리가 표시된다.

Constructor

new Distance()

객체 초기 상태를 설정한다.

Methods

addCoordinates(geoCoordinates)

경위도(Degree) 좌표 배열값을 기준으로 거리 측정 결과를 표시한다.
입력 결과를 화면에 출력하기 위해서는 setUnit 함수를 호출해야 한다.

Example

//좌표입력하여 거리 측정
let geoCoordinates = [];
geoCoordinates.push([126,37]);
geoCoordinates.push([127,38]);
geoCoordinates.push([128,37]);
window.distance.addCoordinates(geoCoordinates);
window.distance.setUnit('meter');

Parameters:

Name	Type	Description
`geoCoordinates`	array	경위도 좌표 배열

createDistance() → {bool}

거리 측정 상태를 활성화하고 측정을 시작한다.

Example

window.eventManager.setMapMode('terrainAnalysis');
window.distance.createDistance();

Returns:

객체 생성 성공여부 반환

Type: bool

getBearing() → {bool}

방위각 표시상태를 반환한다.

Returns:

표시 여부(true/false)를 반환

Type: bool

getDistance() → {string}

상태바에 거리 측정 결과를 표시한다.

Returns:

거리 측정 결과값을 반환한다.

Type: string

getLineColor() → {color}

거리측정 선 색상 설정값을 반환한다.

Returns:

선 색상 반환

Type: color

getLineVisible() → {bool}

거리 측정시 표시여부 상태값을 반환한다.

Returns:

거리 측정 표시여부 반환

Type: bool

getLineWidth() → {number}

거리 측정시 선 두께 설정값을 반환한다.

Returns:

거리 측정 선두께 반환

Type: number

getSegmentLength() → {number}

거리 측정시 세그먼트 갯수를 반환한다.

Returns:

거리 측정 세그먼트 갯수 반환

Type: number

getSegmentTextVisible() → {bool}

거리 측정시 구간 거리 표시여부 상태값을 반환한다.

Returns:

거리 측정 구간거리 표시여부 반환

Type: bool

getSpeed() → {number}

현재 속도(km/h)를 반환한다.

Returns:

현재 속도 반환

Type: number

getTakeTime(distance, speed) → {string}

측정 거리와 속도를 입력하여 소요시간을 얻는다.

Parameters:

Name	Type	Description
`distance`	number	측정 거리
`speed`	number	속도

Returns:

소요시간 표시(시간/분)

Type: string

getTextVisible() → {bool}

거리 측정시 텍스트 표시여부 상태값을 반환한다.

Returns:

거리 측정 텍스트 표시여부 반환

Type: bool

getUnit() → {string}

거리 측정 단위를 반환한다.

Returns:

면적 측정 단위를 리턴(meter, mile, nauticalmile로 관리)한다.

Type: string

setBearing(val)

방위각 표시여부를 설정한다.

Example

window.distance.setBearing(true); //방위각 표시

Parameters:

Name	Type	Description
`val`	bool	방위각 표시(true/false)

setLineColor(val)

거리측정 선 색상을 설정한다.
처음부터 선 색상을 사용자가 정의한 색상으로 설정할 경우에는 createDistance()를 생성하기 전에 호출해야 한다.
만일 거리측정이 이미 처리된 상태에서 setLineColor를 호출하면 기존 생성된 객체에 선 색상이 모두 변경되며,
거리 측정 모드는 초기화 되므로 거리측정 메뉴를 다시 선택하여 거리측정을 처리해야 한다.

Example

window.distance.setLineColor('#ff0000'); //거리측정 라인 색상 설정

Parameters:

Name	Type	Description
`val`	number	거리 측정시 선 색상 설정('#ff0000'와 'rgba(255, 255, 0, 0.8)'로 설정 가능)

setLineVisible(val)

거리 측정시 선 표시여부를 설정한다.
처음부터 거리측정 표시 여부를 설정할 경우에는 createDistance()를 생성하기 전에 호출해야 한다.
만일 거리측정이 이미 처리된 상태에서 setLineVisible을 호출하면 기존 생성된 객체에 선 표시 여부가 모두 변경되며,
거리 측정 모드는 초기화 되므로 거리측정 메뉴를 다시 선택하여 거리측정을 처리해야 한다.

Example

window.distance.setLineVisible(true); //거리측정 표시 여부

Parameters:

Name	Type	Description
`val`	number	거리 측정 표시 여부 설정

setLineWidth(val)

거리 측정시 선 두께를 설정한다.

Parameters:

Name	Type	Description
`val`	number	거리 측정 선두께 설정

setSegmentRemove(index) → {undefined}

거리 측정 객체들 중에 해당 세그먼트만을 삭제한다.

Example

//0번째 객체 삭제 테스트
 let length = window.distance.getSegmentLength();
 if(length > 2) {
     window.distance.setSegmentRemove(0);
}

Parameters:

Name	Type	Description
`index`	number	거리 측정시 해당 세그먼트 인덱스 값 설정

Returns:

인덱스 범위를 초과할 경우 함수 종료

Type: undefined

setSegmentRemoveAll()

거리 측정시 모든 세그먼트를 삭제한다.

Example

//모든 객체 삭제
window.distance.setSegmentRemoveAll();

setSegmentTextVisible(val)

거리 측정시 구간 거리 표시여부를 설정한다.
처음부터 거리측정 구간 거리 표시 여부를 설정할 경우에는 createDistance()를 생성하기 전에 호출해야 한다.
만일 거리측정이 이미 처리된 상태에서 setSegmentTextVisible을 호출하면 기존 생성된 객체에 텍스트 표시 여부가 모두 변경되며,
거리 측정 모드는 초기화 되므로 거리측정 메뉴를 다시 선택하여 거리측정을 처리해야 한다.

Parameters:

Name	Type	Description
`val`	bool	거리 측정 구간거리 표시여부 설정

setSpeed(speed)

속도(km/h)를 설정한다. 설정한 속도를 기준으로 구간 소요 시간이 계산되어 표시된다.
속도가 0이면 소요시간은 표시되지 않는다.

Example

window.distance.setSpeed(60); //km/h

Parameters:

Name	Type	Description
`speed`	number	속도를 입력한다.

setTextVisible(val)

거리 측정시 텍스트 표시여부를 설정한다.
처음부터 거리측정 텍스트 표시 여부를 설정할 경우에는 createDistance()를 생성하기 전에 호출해야 한다.
만일 거리측정이 이미 처리된 상태에서 setTextVisible을 호출하면 기존 생성된 객체에 텍스트 표시 여부가 모두 변경되며,
거리 측정 모드는 초기화 되므로 거리측정 메뉴를 다시 선택하여 거리측정을 처리해야 한다.

Parameters:

Name	Type	Description
`val`	number	거리 측정 텍스트 표시여부 설정

setUnit(unit)

거리 측정 단위를 설정한다.

Example

window.distance.setUnit('meter'); //meter, mile, nautical mile 지원

Parameters:

Name	Type	Default	Description
`unit`	string	`meter`	측정 단위 설정(meter, mile, nauticalmile로 설정 가능)