오픈 API

Version 3.7 야후! 지도 AJAX API – 클래스 참조문서

이 문서는 야후! 지도 AJAX API version 3.7에 대한 클래스 참조문서 입니다. 야후! 지도 AJAX API의 사용법에 대해서 알고 싶으시면 야후!지도 시작 가이드를 참조 하십시오.

클래스

클래스(Class) 설명
YMap 지도 오브젝트를 정의하고 속성을 지정한다.
YMapTypeControl 지도 타입 콘트롤의 위치와 HTML을 관리한다.
YEvent 지도 API의 이벤트를 관리한다.
YPolyline 지도 위에 선을 그린다.
YCustomOverlay YGeoPoin나 YCoordPoint에 커스텀 오브젝트를 등록한다.
YCoordPoint 지도 영역의 좌상단부터의 픽셀 x,y 좌표를 구한다.
YGeoPoint 위도와 경도 좌표를 저장한다.
YMarker 지도상에 표시될 지점을 정의한다.
YImage 사용자 정의 이미지를 처리한다.
YGeoRSS XML 데이터를 이용한 오버레이를 하기위해 필요한 GeoRSS 오브젝트를 정의한다.
YSize 가로와 세로 길이를 처리한다.
YMapDistance 지도상의 거리를 관리한다
YAnnotation 지도에 대한 설명을 처리한다.

부가 클래스

클래스(Class) 설명
YLog 디버그 메시지를 사용자에게 보여주어 개발에 도움을 주는 클래스
YUtility 다양한 유틸리티 기능을 수행한다.

클래스 상세 설명

YMap( mapContainer, mapType, mapSize )

오버레이 마커를 포함하여 그리기, 패닝(panning)등 야후! 지도와 상호작용 하기 위한 ymap 클래스의 다양한 메소드에 대한 상세 설명.

파라미터 설명
mapContainer 지도를 포함하는 DIV 엘리먼트의 돔(DOM)아이디
mapType 지도에서 사용되는 현재 지도 데이터 타입: YAHOO_MAP_SAT, YAHOO_MAP_REG, YAHOO_MAP_HYB
mapSize 지도 컨테이너 넓이를 제어하는 YSize 오브젝트

메소드(Methods)

메소드 설명
setMapType(mapType)

현재의 지도 타입을 설정

파라미터들:

  • YAHOO_MAP_REG,YAHOO_MAP_SAT, YAHOO_MAP_HYB와 같이 getMapTypes()로부터 리턴되는 것과 같은 상수값

Return value: void

getCurrentMapType()

Return value: 현재의 지도 타입 상수값

getMapTypes()

Return value: 지도 타입들의 배열 [YAHOO_MAP_REG, YAHOO_MAP_SAT, YAHOO_MAP_HYB]

addTypeControl()

기본적으로 3가지 컨트롤들을 오버레이로 추가함

파라미터들:

  • 지도 타입 배열은 선택적(Optional)으로 사용할 수 있다.

Return value: void

addMarker(YGeoPoint, id)

지도 위에 지정된 특정 위치에 마커를 추가함

파라미터들:

  • 지도의 위도/경도 오브젝트인 YGeoPoint
  • 마커에 부여될 DOM 엘리먼트 id(선택사항).

Return value: void

addOverlay(Overlay)

지도 위에 오버레이 오브젝트를 추가하며 YGeoPoint와 YCoordPoint타입으로 된 오브젝트(마커,스마트윈도우,컨트롤)를 추가 할 수 있음.

파라미터들:

  • YCustomOverlay, YMarker와 같은 오버레이 오브젝트

Return value: void

addPanControl 지도 위에 팬(pan)컨트롤 위젯을 추가
addZoomLong 지도 위에 줌 슬라이더 컨트롤 위젯을 추가
addZoomShort 지도 위에 +/- 줌 버튼 컨트롤 위젯을 추가
convertLatLonXY(YGeoPoint)

lat/lon 오브젝트를 x/y 좌표 지점으로 변환

파라미터들:

  • 변환하고자 하는 lat/lon 의 YGeoPoint

Return value: YCoordPoint

convertXYLatLon(YCoordPoint)

x/y 좌표 지점을 lat/lon 오브젝트로 변환

파라미터들:

  • 변환하고자 하는 YCoordPoint - 오브젝트

Return value: YGeoPoint

disableDragMap 지도 위에서 드래그(Drag) 기능 제거
drawZoomAndCenter(
LocationType,
ZoomLevel
)

지도를 그려주는 메인 메소드.

파라미터들:

  • 지역타입 - YGeoPoint나 "서울","New York"과 같은 적합한 주소 문자열
  • 1~16사이중 원하는 줌레벨

Return value: void

enableDragMap 지도를 드래그 할 수 있도록 함
getBoundsLatLon

지도의 좌상단,우하단에 대한 lat/lon지점 값을 리턴해 줌.

Return value: LatMax, LonMax, LatMin, LonMin를 속성으로 하는 오브젝트

getCenterLatLon

지도의 중심에 해당하는 lat/lon 오브젝트를 리턴.

Return value: YGeoPoint 오브젝

getContainerSize 지도 컨테이너 오브젝트에 대한 사이즈를 리턴 {width, height}
getEventsList EventsList오브젝트에서 지원하는 현재의 이벤트 리스트들을 리턴.(YEvent class참조)
getInnerRadius 정수로 리턴됨 -- 지도 중심으로부터 가장자리까지 가장 가까운 거리에 해당하는 픽셀거리.
getMarkerIDs 현재 지도에 있는 모든 마커들의 id들에 대한 리스트를 배열형태로 리턴함.
getMarkerObject(MarkerID)

MarkerID에 의해 식별된 마커 오브젝트를 리턴함.

파라미터들:

  • MarkerID

Return value: YMarker 타입 오브젝트

getOuterRadius 정수로 리턴됨 -- 지도 중심으로부터 가장자리까지 가장 먼 거리에 해당하는 픽셀 거리.
getUnitsPerPixel(ZoomLevel)

지정된 줌레벨에서의 각 픽셀 사이의 거리를 리턴함.

파라미터들:

  • ZoomLevel1-16사이의 정수 (기본값은 현재의 줌 레벨)

Return value: miles, kilometers 오브젝트

getZoomLevel(input?)

input에 값이 없을 경우 현재의 줌 레벨을 리턴함

파라미터들:

  • input 선택사항. 아래와 같은 형식으로 입력 받을 수 있음.
    • 입력값이 YGeoPoint의 배열이라면 가장 적합한 줌 레벨이 리턴 됨.
    • 입력값이 YMapDistance 오브젝트라면 해당 거리에서 가장 적합한 줌 레벨이 리턴 됨.

Return value: 기본값은 1-16사이의 현재 줌 레벨이며, YGeoPoint들이 배열로 입력될 경우는 최적화된 줌레벨을 리턴함.

getBestZoomAndCenter(input)

줌 레벨과 YGeoPoint속성을 가지는 오브젝트를 리턴.

파라미터들:

  • input YGeoPoint 오브젝트들의 배열

Return value: 줌 레벨과 YGeoPoint 속성을 가지는 오브젝트

getZoomValidLevels 현재 지도API에서 사용할 수 있는 줌 레벨들에 대한 배열을 리턴
isDragMapEnabled 지도가 드래그 가능한 지에 대한 불린(boolean)값을 리턴
panToLatLon(YGeoPoint)

주어진 lat/lon위치로 지도를 이동

파라미터들:

  • YGeoPoint - 지도의 경위도 오브젝트

Return value: void

panToXY(YCoordPoint)

주어진 x/y 지점으로 지도를 이동

파라미터들:

  • YCoordPoint -

Return value: void

removeMarker(id)

주어진 ID로 마커를 제거함

파라미터들:

  • id - YMarker 오브젝트의 ID

Return value: void

removeMarkersAll 지도에서 모든 마커들을 제거
removeOverlay(overlayObject)

지도에서 지정된 오버레이 오브젝트를 제거함

파라미터들:

  • overlayObject - 오버레이 오브젝트

Return value: void

removePanControl 지도에서 팬 컨트롤 위젯을 제거함
removeZoomControl 지도에서 줌 컨트롤 위젯을 제거함
resizeTo(YSize)

주어진 YSize오브젝트로 지도를 새로운 크기로 리사이즈함

파라미터들:

  • YSize - width/height 오브젝트

Return value: void

setZoomLevel(zlevel) 주어진 줌 레벨로 현재 지도의 줌 레벨을 설정하고 지도를 새로 그림
setZoomRange(minZoomLevel,maxZoomLevel)

줌 선택 범위에 제약을 줌

파라미터들:

  • minZoomLevel - 적합한 범위 내에서의 정수
  • maxZoomLevel - 적합한 범위 내에서의 정수

Return value: void

showSmartWindow(
YGeoPoint,
InfoValue
)

정의된 YGeoPoint에 새로운 스마트 윈도우를 열게 한다. 스마트 윈도우는 InfoValue를 디스플레이 할 수 있고 InfoValue는 기존에 존재하는 DOM 오브젝트들을 사용 할 수 있음.

파라미터들:

  • YGeoPoint
  • InfoValue - 문자열 형태. Text, HTML또는 오브젝트로 설정할 수 있다.
setAnnotation(annotation)

정의된 맵 어노테이션 오브젝트를 설정함

파라미터들:

  • annotation - 타입의 오브젝트

Return value: void

getAnnotation()

주어진 맵 인스턴스에서 설정된 어노테이션 오브젝트를 리턴함.

Return value: YMapAnnotation타입의 어노테이션 오브젝트

exportFormat(type)

정의된 타입 포맷으로 현재의 지도에 대한 GEORSS XM을 제공함.

파라미터들:

  • type - 적합한 타입은 "GEORSS"

Return value: GeoRSS XML 문자열

addZoomScale() 지도 컨테이너에 줌 스케일을 추가함(기본).
removeZoomScale() 지도 컨테이너로부터 줌 스케일을 제거함.
disablePanOnDoubleClick() 더블클릭 액션을 사용하지 않도록 제거함
disableKeyControls() 키보드/마우스 휠 줌 기능 및 팬 컨트롤 기능을 사용하지 않도록 설정
getGeoBox(points)

YGeoPoint 오브젝트들의 배열을 입력하면 최소, 최대 위치를 리턴함.

파라미터들:

  • points - YGeoPoint 오브젝트들의 배열

Return value: 오브젝트 {min:YGeoPoint_MIN,max:YGeoPoint_MAX}

getPolylineIDs()

생성된 모든 폴리라인 ID들에 대한 리스트 배열을 리턴.

Return value: ID들의 배열

getPolylineObject(id)

주어진 ID에 해당되는 폴리라인 오브젝트를 리턴

파라미터들:

  • id - 폴리라인 세그먼트의 아이디

Return value: 오브젝트

YMapTypeControl(YCoordPoint)

파라미터 설명
CoordPoint YCoordPoint타입의 지점. 지도 타입 컨트롤의 커스텀 위치지정을 가능하게 함.

메소드(Methods)

메소드 설명
setControl(mapType, markup?, mapSize?) 가능한 컨트롤 타입들에 REG,SAT,HYB타입 컨트롤을 추가함. 각 컨트롤에 특정한 이미지를 사용할 수 있고 위치 및 크기를 지정할 수도 있음.
setVertical() 지도 타입을 수직으로 설정.
setHorizontal() 지도 타입을 수평으로 설정.

YEvent

이벤트 등록은 아래의 클래스를 통해서 등록할 수 있습니다.

메소드(Methods)

메소드 설명
Capture(
object ,
event ,
callback
)

지도나 마커들에 대한 이벤트 감지.

파라미터들:

  • 오브젝트 - Ymap이나 YMarker 오브젝트
  • 이벤트 - 감지할 이벤트(아래의 이벤트 리스트 참조)
  • 콜백 - 이벤트가 발생하여 감지되었을 때 호출될 함수
  • privateObject - 선택적인 private 컨텍스트 오브젝트

Return value: void

이벤트 파라미터는 이벤트리스트 오브젝트의 속성 중 하나여야 한다.(e.g. EventsList.MouseUp):

  • endMapDraw
  • changeZoom
  • startPan
  • onPan
  • endPan
  • endAutoPan
  • startAutoPan
  • MouseClick
  • MouseDown
  • MouseDoubleClick
  • MouseOut
  • MouseOver
  • MouseUp
  • KeyUp
  • KeyDown

YMarker에만 특화된 이벤트

  • openExpanded
  • closeExpanded
  • openSmartWindow
  • closeSmartWindow

YGeoRSS에만 특화된 이벤트

  • onEndGeoRSS

Ymap에만 특화된 이벤트

  • onEndGeoCode
  • polylineAdded
  • polylineRemoved
  • endMapDraw
  • onEndLocalSearch
  • onEndTrafficSearch

YPolyline(points, color?, width?, alpha?)

YPolyline은 지도 위에 선을 생성할 수 있도록 합니다.

파라미터 설명
points 선을 그리기 위한 YGeoPoint의 배열이며, 둘 또는 그 이상의 지점이 필요 합니다.
color 선택 사항, 선의 색상
width 선택 사항, 선의 픽셀 두께
alpha 선택 사항, 선의 투명도

YCustomOverlay(YGeoPoint,HTMLobject?)

YCustomOverlay는 커스텀 오브젝트들의 오버레이를 가능하게 합니다.

파라미터 설명
YGeoPoint 또는 YCoordPoint YGeoPoint(위치기반 지점) 또는 YCoordPoint(컨테이너 기반 지점)의 지점 오브젝트
HTMLobject 커스터마이즈된 지도 오버레이 HTML 오브젝트

YCoordPoint(x, y)

YCoordPoint는 x, y좌표 프라퍼티로 오브젝트를 생성합니다. x,y는 지도의 좌상단 (0,0)좌표로부터의 픽셀 거리 입니다.

파라미터 설명
x 지도의 x축 기준으로 좌상단 모서리로부터의 픽셀 거리.
y 지도의 y축 기준으로 좌상단 모서리로부터의 픽셀 거리.

프라퍼티(Properties)

프라퍼티 설명
x 지도의 x축 기준으로 좌상단 모서리로부터의 픽셀 거리.
y 지도의 y축 기준으로 좌상단 모서리로부터의 픽셀 거리.

메소드(Methods)

메소드 설명
distance(point)

좌표 지점들 사이의 거리를 리턴함.

파라미터들:

  • point YCoordPoint 오브젝트

Return value: float

translate(xcoord,ycoord)

원래의 좌상단 기준점을 다른 기준점으로 변환

파라미터들:

  • xcoord 적합한 x 지점 이름 (left, right)
  • ycoord 적합한 y 지점 이름 (top, bottom)

Return value: void

equal(point)

두 개의 지점이 같은지 확인함.

파라미터들:

  • point YCoordPoint 오브젝트.

Return value: boolean

YGeoPoint(lat, lon)

위도와 경도 속성을 가진 오브젝트를 정의하기 위한 객채

파라미터 설명
lat 위도
lon 경도

프라퍼티(Properties)

프라퍼티 설명
Lat 위도
Lon 경도

메소드(Methods)

메소드 설명
distance(point)

좌표 지점 사이의 거리를 리턴

파라미터들:

  • point YGeoPoint 오브젝트

Return value: 킬로미터, 마일, 픽셀 프라퍼티를 가지는 거리 오브젝트를 리턴한다.

middle(point)

두 좌표 지점간 중간 값을 리턴

파라미터들:

  • point YGeoPoint 오브젝트

Return value: YGeoPoint

equal(point)

두 지점이 같은지를 비교.

파라미터들:

  • point YGeoPoint 오브젝

Return value: boolean

YMarker(YGeoPoint, YImage?, ID?)

마커 오브젝트를 초기화하는 클래스.

파라미터 설명
YGeoPoint 위도/경도 값을 가지는 오브젝트
YImage 선택사항 - 커스텀 마커 정의를 가지는 오브젝트
ID

선택사항 - 마커를 DOM 오브젝트로 식별하는 스트링. 해당 문자열은 숫자 0-9 또는 소문자 a-z 사이의 문자여야 한다. 그리고, ID는 파라미터가 제공되지 않을 경우 자동으로 생성 된다.

추천사항 - 자동으로 API가 생성하는 것을 권장함.

메소드(Methods)

메소드 설명
addAutoExpand(InfoValue)

마우스 오버와 클릭 이벤트로 자동으로 닫을 수 있는 자동 확장 윈도우(또는 스마트 윈도우)를 추가 할 수 있다.

파라미터들:

  • InfoValue - HTML/Text 문자열. 스마트 윈도우에 사용 될 수 있는 콘텐츠를 보여주는 데 사용할 수 있는 문자열.
changeImage(YImage)

제공된 이미지로 마커 이미지를 변경.

openAutoExpand()

자동 확장 윈도우(있다면)를 열게 함.

closeAutoExpand()

자동 확장 윈도우(있다면)를 닫음.

hide()

지도 위에서 마커들을 숨김.

unhide()

지도 위에서 숨겨진 마커들을 보이게 함.

ishidden()

현재의 마커가 숨겨져 있는지를 점검.

Return value: boolean

setSmartWindowColor

스마트 윈도우 테두리 색상을 정의

파라미터들:

  • color 문자열. valid colors: [orange, blue, lightblue, brown, green, lightgreen, grey, black, maroon, ocre, purple]
setYGeoPoint

마커 오브젝트를 (재)설정함.

파라미터들:

  • YGeoPoint 오브젝트
addLabel

마커에 라벨을 추가함.

파라미터들:

  • label - 문자열. 마커에대한 HTML또는 Text.
reLabel

마커에 대한 라벨을 변경

파라미터들:

  • label - 문자열. 마커에대한 HTML또는 Text.
closeSmartWindow 마커의 스마트 윈도우를 닫음.
openSmartWindow(
InfoValue)

마커의 스마트 윈도우를 연다. 스마트 윈도우는 Infovalue를 보여준다. InfoValue파라미터는 기존에 존재하는 DOM 오브젝트일 수도 있다.

파라미터들:

  • InfoValue - 문자열. A new text,HTML또는 오브젝트.
updateSmartWindow(
InfoValue)

스마트 윈도우의 InfoValue를 갱신함.

파라미터들:

  • InfoValue - 문자열. A new text,HTML또는 오브젝트.
disableAutoContain 스마트 윈도우가 열려져 있다면, 스마트 윈도우를 포함하지 않도록 함.
enableAutoContain 스마트 윈도우가 열려져 있다면, 스마트 윈도우를 포함 하도록 함.
getCoordPoint 좌 상단 모서리에 해당하는 YCoordPint에 반하는 YCoordPoint를 리턴함.

YImage(srcImg?,sizeImg?,offsetSmartWindow?,offset)

이미지 오브젝트들을 생성하는 YImage클래스.Ymarker나 YCustomOverlay에 대한 커스텀 이미지를 생성하는데 사용됨.

프라퍼티 설명
srcImg 이미지가 위치하는 경로
sizeImg 이미지 사이즈를 정의하는 YSize(width,height) 오브젝트.
offsetSmartWindow 마커 이미지의 좌상단부터의 스마트 윈도우의 위치
offset 좌하단 좌표로부터의 이미지 위치

프라퍼티(Properties)

프라퍼티 설명
Width 지도의 정수 픽셀 넓이.
Height 지도의 정수 픽셀 높이.

 

YGeoRSS(URL)

YGeoRSS 오브젝트는 유효한 GeoRSS 형식의 파일로부터 데이터들을 자동으로 오버레이할 수 있게 합니다. 해당 XML파일은 공개적으로 접근 가능해야만 합니다.

파라미터 설명
URL 유효한 GeoRSS파일의 URL. 이 파일의 도메인은 지도 API를 포함한 페이지의 도메인과 동일해야 합니다.

이벤트 지원

Property 설명
onStartGeoRSS 자동 오버레이가 시작하기전에 동작할 콜벡을 등록한다. 예: YEvent.Capture(map,EventsList.onStartGeoRSS, myCallback);
onEndGeoRSS GeoRSS 오버레이가 끝난 뒤에 동작할 콜벡을 등록한다. 예: YEvent.Capture(map,EventsList.onEndGeoRSS, myCallback);

YSize(width, height)

width와 height속성을 가지는 오브젝트. 이 오브젝트는 YMap 컨스트럭터 또는 YMap resizeTo 메소드와 같은 호출시 파라미터로 사용 됩니다.

파라미터 설명
width 지도의 가로 너비에 대한 픽셀 값.
height 지도의 세로 높이에 대한 픽셀 값.

YMapDistance(distance, units?)

거리 오브젝트를 정의하는 클래스. 다양한 거리 단위로 맵을 세계화하는데 매우 유용한 클래스 입니다.

파라미터 설명
distance 거리 길이
units "miles"(기본)나 "kilometers"와 같은 거리 단위

YAnnotation(title, description, link)

지도에 대한 속성을 설명하기 위해 GeoRSS와 함께 사용되는 클래스

파라미터 설명
title 지도에 대한 제목
description 지도에 대한 요약
link 지도가 서비스 되는 링크 주소

Utilities

YLog

출력으로 표현된 디버그 메시지를 수집하는 클래스.

파라미터 설명
print(MESSAGE) 위젯에 메시지를 출력.
initPos(YCoordPoint) 선택사항. 로거의 위치를 초기화함.
initSize(YSize) 선택사항 로거의 높이와 너비를 초기화함.

YUtility

편리하고 다양한 메소드들을 지원하는 YUtility클래스. 이 메소드들은 컨테이너를 역동적으로 리사이즈하거나 DOM을 변형하는 등의 유용한 방법을 제시합니다.

메소드(Methods)

메소드 설명
containerResize(parentId,childId)

파라미터들:

  • parentId - 부모 객체의 아이디
  • childId - 자식 객체의 아이디

Constructor:

    YUtility.containerResize(parentId,childId);
createNode(type,id)

내부적으로 사용되는 document.createNode를 캡슐화한 편리한 메소드

파라미터들:

  • type - 적합한 HTML 요소 타입 ("div", "img")
  • id - HTML 요소 아이디
appendNode(parent,child)

내부적으로 사용되는 document.appendChild를 캡슐화한 편리한 메소드

파라미터들:

  • type - 적합한 HTML 요소 타입 ("div", "img")
  • id - HTML 요소 아이디

제약사항

야후! 지도 API는 한 IP당 1일 50,000회의 질의로 제한되어 있습니다.

개인정보/청소년보호 정책
책임의 한계와 법적고지
서비스 약관
서비스 제안/질문
야후! 지도 바로가기

Copyright © 2008 Yahoo! Korea LLC. All rights reserved.