JSPoint

지도 내 POI 객체를 생성 및 설정하기 위한 API 입니다.

Module.createPoint() API를 생성합니다.

var object = Module.createPoint("ID");

Function

getAltitude() → number

POI 객체의 중심 좌표 중 고도를 반환합니다.

  • Return

    • number: 반환 성공(meters 단위).

getFontColor() → JSColor

POI 객체를 구성하는 문자의 색상을 반환합니다.

  • Return

    • JSColor: 반환 성공.

    • null: 반환 실패.

getFontName() → string

POI 객체를 구성하는 문자의 폰트를 반환합니다.

  • Return

    • string: 반환 성공.

    • null: 반환 실패.

getFontOutColor() → JSColor

POI 객체를 구성하는 문자의 외각선 색상을 반환합니다.

  • Return

    • (JSColor): 반환 성공.

    • null: 반환 실패.

getFontSize() → number

POI 객체를 구성하는 문자의 크기를 반환합니다.

  • Return

    • number (0 or higher): 반환 성공.

    • number (-1): 반환 실패.

getFontWeight() → number

POI 객체를 구성하는 문자의 두께를 반환합니다.

  • Return

    • number (0 or higher): 반환 성공.

    • number (-1): 반환 실패.

getHighlightIcon() → JSIcon

POI 객체를 구성하는 하이라이트 이미지를 반환합니다.

getIcon() → JSIcon

POI 객체를 구성하는 이미지를 반환합니다.

getId() → string

객체의 고유 명칭을 반환 합니다.

  • Return

    • string: 객체 설명 문자열이 성공적으로 반환.

    • null: 객체가 null인 경우.

getLatitude() → number

POI 객체의 중심 좌표 중 위도를 반환합니다.

  • Return

    • number: 반환 성공(degrees 단위).

getLongitude() → number

POI 객체의 중심 좌표 중 경도를 반환합니다.

  • Return

    • number: 반환 성공(degrees 단위).

getPosition() → JSVector3D

POI 객체의 중심 좌표(경도, 위도, 고도)를 반환합니다.

  • Return

getVisibleRangeActivate() → boolean

POI 객체의 가시 범위 값을 사용 유무를 반환합니다.

가시 범위 값이 비활성화 되면 POI 객체의 가시 범위는 POI 객체가 소속된 레이어의 가시 범위값을 참조 받습니다.

서비스 레이어를 통해 생성된 POI 객체는 가시 범위값을 설정할 수 없습니다.

  • Return

    • true: 가시 범위 사용.

    • false: 레이어 가시 범위 사용.

    • 실패 조건

      • 서비스 레이어를 통해 생성된 POI 객체인 경우.

      • POI 객체가 생성되지 않은 경우.

getVisibleRangeMax() → number

POI 객체의 최대 가시범위 값을 반환합니다.

  • Return

    • number: 반환 성공.

    • 실패 조건

      • -999.0: POI 객체가 생성되지 않은 경우.

      • -998.0: POI 객체가 서비스 레이어에서 생성 된 경우.

      • -997.0: 가시범위 설정이 비활성화 상태인 경우.

getVisibleRangeMin() → number

POI 객체의 최소 가시범위 값을 반환합니다.

  • Return

    • number: 반환 성공.

    • 실패 조건

      • -999.0: POI 객체가 생성되지 않은 경우.

      • -998.0: POI 객체가 서비스 레이어에서 생성 된 경우.

      • -997.0: 가시범위 설정이 비활성화 상태인 경우.

isExistHighlightIcon() → boolean

POI 객체를 구성하는 하이라이트 이미지 설정 유무를 반환합니다.

  • Return

    • true: 하이라이트 이미지 설정.

    • false: 하이라이트 이미지 미설정.

isExistIcon() → boolean

POI 객체를 구성하는 이미지 설정 유무를 반환합니다.

  • Return

    • true: 이미지 설정.

    • false: 이미지 미설정.

setAltitude(alt) → boolean

POI 객체의 고도를 설정합니다.

POI 객체의 중심 좌표(경도, 위도)는 유지합니다.

NameTypeDescription

alt

number

해발고도(meters 단위).

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

setFontStyle(name, size, weight, fill_color, outline_color) → boolean

POI 객체를 구성하는 문자 스타일을 설정합니다.

폰트, 크기, 두께, 색상을 설정합니다.

NameTypeDescription

name

string

폰트 이름.

size

number

텍스트 크기.

weight

number

텍스트 굵기.

fill_color

텍스트 색상.

outline_color

텍스트 외곽 색상.

setHighlightIcon(icon) → boolean

POI 객체를 구성하는 하이라이트 이미지 설정합니다.

NameTypeDescription

icon

아이콘.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

setIcon(icon) → boolean

POI 객체를 구성하는 이미지 설정합니다.

NameTypeDescription

icon

아이콘.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

setImage(data, width, height) → boolean

POI 객체를 구성하는 이미지 설정합니다.

입력 변수값(data)은 Uint8Array 기반의 바이너리 배열 데이터 입니다.

입력 변수값(width, height)은 이미지의 실제 크기를 입력 받습니다.

NameTypeDescription

data

array

이미지 픽셀 값 배열.

width

number

이미지 너비.

height

number

이미지 높이.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

    • 실패 조건

      • 입력 변수값(data) 값이 null인 경우.

      • 입력 변수값(width, height) 값이 0 보다 작은 경우.

  • Sample

setLatitude(lat) → boolean

POI 객체의 위도를 설정합니다.

POI 객체의 중심 좌표(경도, 고도)는 유지합니다.

NameTypeDescription

lat

number

경도(degrees 단위).

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

setLongitude(lon) → boolean

POI 객체의 경도를 설정합니다.

POI 객체의 중심 좌표(위도, 고도)는 유지합니다.

NameTypeDescription

lon

number

위도(degrees 단위).

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

setLonLat(lon, lat) → boolean

POI 객체의 경도, 위도를 설정합니다.

POI 객체의 중심 좌표(고도)는 유지합니다.

NameTypeDescription

lon

number

위도(degrees 단위).

lat

number

경도(degrees 단위).

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

setPosition(position) → boolean

POI 객체의 중심 좌표(경도, 위도, 고도)를 설정합니다.

NameTypeDescription

position

중심 좌표(경도, 위도, 고도).

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

  • Sample

setPositionLine(length, color) → boolean

POI 객체 중심좌표 방향으로 지형에서 수직한 직선 객체를 생성합니다.

입력 변수값(length)으로 직선을 길이가 생성됩니다.

입력 변수값(length)은 0보다 큰값이 설정합니다.

NameTypeDescription

length

number

직선을 길이.

color

직선을 색상.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

    • 실패 조건

      • 입력 변수값(length)이 0보다 작은 값이 설정된 경우.

  • Sample

setRenderToTerrainTexture(type) → boolean

POI 객체를 RTT 가시화 방법으로 설정합니다.

NameTypeDescription

type

boolean

true: RTT 가시화. false: 일반 가시화.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

  • Sample

setText(text) → boolean

POI 객체를 구성하는 문자를 설정합니다.

NameTypeDescription

text

string

POI 문자.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

  • Sample

setVisibleRange(enable, min, max) → boolean

POI 객체의 가시 범위 값 설정합니다.

최소값이 최대값보다 크면 자동으로 작은 값을 최소값으로, 큰 값을 최대값으로 자동 전환합니다.

서비스 레이어를 통해 생성된 POI 객체는 가시 범위값을 설정할 수 없습니다.

NameTypeDescription

enable

boolean

값 활성화 유무.

min

number

최소 가시거리.

max

number

최대 가시거리.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

    • 실패 조건

      • 서비스 레이어를 통해 생성된 POI 객체인 경우.

      • POI 객체가 생성되지 않은 경우.

Getter / Setter

getDescription(), setDescription(desc) → string

객체에 대한 설명을 설정합니다.

NameTypeDescription

desc

string

설명 문자열.

  • Return

    • string: 객체 설명 문자열이 성공적으로 반환.

    • null: 객체가 null인 경우.

getHighlight(), setHighlight(highlight) → boolean

POI 객체를 구성하는 하이라이트 이미지 사용 유무를 설정합니다.

NameTypeDescription

highlight

boolean

true: 하이라이트 이미지 사용. false: 하이라이트 이미지 미사용.

  • Return

    • true: 설정 성공.

    • false: 설정 실패.

    • 실패 조건

      • POI 오브젝트가 null인 경우.

      • Highlight 타입으로 설정된 아이콘이 없는 경우.

getName(), setName(name) → string

객체 이름을 설정합니다.

NameTypeDescription

name

string

객체 이름.

  • Return

    • string: 객체 이름을 성공적을 반환

    • null: 객체가 null인 경우.

getVisible(), setVisible(visible) → boolean

객체의 가시화 유무를 설정합니다.

NameTypeDescription

visible

boolean

true: 객체 가시화. false: 객체 비가시화.

  • Return

    • true: 객체 가시화 상태.

    • false: 객체 비가시화 상태.

Last updated