Type Definitions
Object
# Angle
3d 모드에서 화면에 보여줄 초기 각도와 각도고정 여부
Properties:
Name | Type | Description |
---|---|---|
vertical |
number
|
vertical 각도. 유효한 범위: 0~80 (각도) |
horizontal |
number
|
horizontal 각도. 유휴한 범위: -18 ~18 (각도) |
fixed |
boolean
|
각고정 여부. true로 설정시 각이 고정되므로 마우스등으로 회전 불가 |
- See:
Example
// default value
angle: {
vertical : 0,
horizontal : 0,
fixed : false
}
Object
# AnimateOption
내 위치 마커의 아이콘의 애니메이션 옵션
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
color |
string
|
<optional> |
"#96c4e1" | 애니메이션의 색상. 색상값 16진수 문자열 |
opacity |
number
|
<optional> |
0.8 | 애니메이션의 시작 투명도값. 1에서 0사이의 값 |
desireScale |
number
|
<optional> |
3.0 | 내위치 마커 크기 대비 최종 확대 배수. 소숫점 1자리까지 가능. |
Example
animate: { //내위치 마커 애니메이션 효과 속성
color: "#ff00ff", //내위치 마커의 색상
opacity: 0.3, //내위치 마커의 투명도
desireScale: 3.5 //내위치 마커의 최대 크기
}
Object
# AuthorizationOption
인증 정보 옵션
Properties:
Name | Type | Description |
---|---|---|
clientId |
string
|
클라이언트 아이디 |
clientSecret |
string
|
클라이언트 시크릿 |
Example
let authorization = new indoorMapApi.Authorization({
clientId: "28AXw_veA2YbNKDP6poTpT",
clientSecret: "70c540c169af62808f4da3709e988e06"});
Object
# CameraMode
카메라 설정
Properties:
Name | Type | Description |
---|---|---|
camera |
CameraType
|
2d 또는 3d로 지도의 카메라 모드 설정 |
- See:
Example
camera: "3d"
string
# CameraType
카메라 종류
Properties:
Type | Description |
---|---|
"2d"
|
"3d"
|
화면에 그릴 지도의 카메라 모드를 설정 (2d/3d 둘 중 선택) |
Example
camera: "3d"
Object
# ControlDrag
지도를 드래그할 때 사용할 마우스 버튼 설정 지정하지 않으면 3d는 "right"로 2d는 "left"로 설정됩니다.
Properties:
Name | Type | Description |
---|---|---|
"3d" |
"right"
|
"left"
|
3d 모드에서 드래그로 이용할 마우스 버튼 default는 "right" |
"2d" |
"right"
|
"left"
|
2d 모드에서 드래그로 이용할 마우스 버튼 default는 "left" |
- See:
Example
controlDrag: {
"3d" : "left", // 왼쪽 클릭으로 지도이동
"2d" : "right" // 오른쪽 클릭으로 지도이동
}
Object
# ConvertPositionOption
좌표 변환
Properties:
Name | Type | Description |
---|---|---|
position |
Position2d
|
변환하고자 하는 대상 좌표값 |
degree |
number
|
대상 지도가 다비오 지도(원도)를 기준으로 몇도 틀어져있는지(시계방향이 +, 시계 반대방향이 -) |
zeroPoint |
Position2d
|
대상 지도의 영점이 다비오 지도(원도)를 기준으로 어떤포인트인지 좌표 |
xDirection |
number
|
원도와 비교 한 x 축 진행방향. 순방향이면 1, 역방향이면 -1 |
yDirection |
number
|
원도와 비교 한 y 축 진행 방향. 순방향이면 1, 역방향이면 -1 |
Example
var convertPositionOption = {
position: {
x: 100,
y: 200
},
degree: -5.27,
zeroPoint: {
x: -284,
y: 286.5
},
xDirection: 1,
yDirection: -1
};
Object
# FloorInfo
층정보
Properties:
Name | Type | Description |
---|---|---|
defaultYn |
boolean
|
디폴트 층 해당 여부 |
floorId |
string
|
층 아이디 |
name |
Array.<TitleByLang>
|
Example
[
{
"id": "FL-qhndqjlqhu7p3894",
"name": [
{
"lang": "ko",
"text": "11F"
}
],
"defaultYn": true
}
]
Object
# IconOption
길찾기 및 모의주행 아이콘에 관한 옵션 설정
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
iconUrl |
string
|
<optional> |
아이콘의 위치. URL. 빈값일 때는 아이콘 노출 안됨 |
width |
number
|
<optional> |
아이콘의 넓이 |
height |
number
|
<optional> |
아이콘의 높이 |
Object
# ImageConvertOption
지도를 다운로드할 때 옵션 지정
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
useMapOption |
boolean
|
<optional> |
false | true로 설정시 MapView의 옵션으로 다운로드됩니다.(canvasSize, zoom, center, angle) false인 경우 지도의 원 크기대로 다운로드됩니다. |
Object
# LangInfo
언어 정보
Properties:
Name | Type | Description |
---|---|---|
defaultYn |
boolean
|
디폴트 언어 해당 여부 |
lang |
LangType
|
언어 타입 |
name |
string
|
언어 이름 |
name_en |
string
|
언어 이름 (영문) |
Example
[ {
"lang":"ko",
"name":"한국어",
"name_en":"Korean",
"defaultYn":true
}
]
string
# LangType
언어 종류
Properties:
Type | Description |
---|---|
"ko"
|
"zh"
|
"en"
|
"ja"
|
한국어, 중국어, 영어, 일본어 설정값은 ISO_639-1_codes 참조 |
Object
# Location
위치 정보. poi의 좌표 또는 id
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
position |
Position3d
|
<optional> |
좌표 정보 (3d) |
poId |
string
|
<optional> |
poi 아이디 |
floorId |
string
|
층 아이디 |
Examples
{ // 좌표로 입력하는경우
position : { x: 1795.07054740437, y: 1519.36098544918, z: 0 },
floorId: "FL-qhndqjlqhu7p3894"
}
{ // poi의 id를 입력하는 경우
poiId : poiId,
floorId: "FL-qhndqjlqhu7p3894"
}
# MapCordInfo
지도 좌표계에 대한 정보
Properties:
Name | Type | Description |
---|---|---|
fixedPosition |
Position3d
|
지도 영점 |
scaleCm |
number
|
지도축척비 |
xaxisDirection |
number
|
x축 증가방향 1과 -1 |
yaxisDirection |
number
|
y축 증가 방향 1과 -1 |
size |
Size
|
size 지도 사이즈 |
Example
{
"fixedPosition": { // 지도 영점
"x": 0,
"y": 0,
"z": 0
},
"scaleCm": 10, // 지도 축척비
"xaxisDirection": 1, // x 증가방향
"yaxisDirection": 1, // y 증가방향
"size": { // 지도 사이즈
"width": 1600,
"height": 2200
}
}
Object
# MapOption
맵을 그리기 위한 초기 맵 옵션
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
authorization |
Authorization
|
다비오지도를 사용하기 위한 인증정보 |
||
floor |
string
|
<optional> |
화면에 그릴 층 아이디, 지정하지 않는 경우 지도에 설정된 default층으로 설정됨. |
|
theme |
number
|
<optional> |
화면에 그릴 테마 아이디, 지정하지 않는 경우 지도에 설정된 default 테마로 설정됨. |
|
language |
LangType
|
<optional> |
"ko" | 화면에 표현할 poi의 언어 설정. 지정하지 않는 경우 한국어로 설정된다. |
camera |
CameraType
|
<optional> |
"3d" | 화면에 그릴 지도의 카메라 모드를 설정 (2d/3d 둘 중 선택) 지정하지 않을 경우 3d 모드로 설정됨. |
zoom |
number
|
<optional> |
100 | 지도의 줌값 설정. 지정하지 않을 경우 100%임. 지정한 캔버스 사이즈에 전체 지도가 fit되어 보임. |
maxZoom |
number
|
<optional> |
최대 줌 설정 값. |
|
minZoom |
number
|
<optional> |
최소 줌 설정 값. |
|
showPoi |
boolean
|
<optional> |
true | poi 표시 여부 설정. 지정하지 않을 경우 poi가 표출됨. |
isPoiSprite |
boolean
|
<optional> |
false | 3d에서 지도회전시 poi를 항상 정면으로 표출시킬지 여부. 지정하지 않을 경우 false가 됨 |
poiLevel |
PoiLevelZoom
|
<optional> |
poi 중요도에 따라 표출할 줌값, 상 중 하,세개의 값을 가질 수 있음. |
|
canvasSize |
Size
|
<optional> |
지도를 그릴 영역의 크기. 지정하지 않는 경우 화면 전체 사이즈로 설정됨. 지도를 그릴 돔영역의 크기를 무시함. |
|
center |
Position2d
|
<optional> |
지도가 그려질 영역의 중심으로 설정할 지도의 좌표. 지정하지 않는 경우 지도의 중심좌표로 설정됨. |
|
angle |
Angle
|
<optional> |
3d 모드에서 화면에 보여줄 초기 각도와 각도고정 여부 |
|
tiltLimitAngle |
number
|
<optional> |
80 | 3d 지도에서 지도의 vertical angle limit 설정. default: 80. 0~80까지 가능 |
controlDrag |
ControlDrag
|
<optional> |
지도 이동시 마우스 버튼 설정 |
|
controlZoom |
boolean
|
<optional> |
true | 마우스휠을 사용한 지도줌의 활성화 /비활성화 설정. 지정하지 않을 경우 활성화됨 |
rotationTouch2d |
boolean
|
<optional> |
true | 2d 모드일때 터치로 회전기능의 활성화 /비활성화 설정. 지정하지 않을 경우 활성화됨 |
rotationMouse2d |
boolean
|
<optional> |
true | 2d 모드일때 마우스로 회전기능의 활성화 /비활성화 설정. 지정하지 않을 경우 활성화됨 |
northReference |
number
|
<optional> |
지정한 각만큼 지도의 방위각을 변경하여 지도를 회전시킴. 단위는 각도임. 90도 회전시키고자 할 때 90임. 지정시 다비오 플랫폼에서 설정한 지도의 방위각 설정을 무시함. |
|
panningPercent |
number
|
<optional> |
1.0 | 지도를 드래그시 카메라가 움직일 수 있는 최대 영역 설정. 전체 오브젝트 사이즈 대비 카메라가 움직이는 비율임. 최대값은 1.0 최소값은 0.05. 자세한 설명은 튜토리얼 참조 |
isUseTag |
boolean
|
<optional> |
false | marker, poi와 연동되는 tag를 생성을 원할 경우 true값으로 전환하여 사용합니다. 태그를 사용할 경우 map위에 또다른 component를 적용하신다면 필히 zIndex값을 줘야 합니다. |
- See:
Example
{
authorization: {clientId: '6Lwuu9wa4wta0NiHwy1fO5', clientSecret: '93ab5dbaf7fa6c9017cf9cb9ef4dc8fd'}
camera: "3d"
controlDrag: {3d: 'right', 2d: 'left'}
controlZoom: true
floor: "default"
isPoiSprite: false
language: "ko"
panningPercent: 1
poiLevel: [NaN, NaN, NaN]
rotationMouse2d: true
rotationTouch2d: true
showPoi: true
splitScreen: 1
theme: "default"
tiltLimitAngle: 80
zoom: 100
}
Object
# MapRedrawOption
지도를 다시 그릴 때 사용하는 옵션입니다.
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
floor |
string
|
<optional> |
층 아이디 |
theme |
number
|
<optional> |
테마 아이디 |
Object
# Marker
각 마커의 좌표와 속성 지정 TagInfo를 사용하기 위해서는 MapView 생성시 isUseTag를 true로 설정해야 합니다.
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
position |
Position3d
|
마커를 표시할 x, y, z 좌표 |
||
image |
string
|
<optional> |
마커로 사용할 아이콘 |
|
size |
Size
|
<optional> |
아이콘의 크기 |
|
floorId |
string
|
<optional> |
마커를 표시할 층 지정. 지정하지 않을 경우 현재층 |
|
data |
any
|
<optional> |
마커 클릭시 반환할 정보 |
|
async |
boolean
|
<optional> |
false | 지도의 줌 배율과 관계없이 동일한 크기로 보여줄지 결정. true인 경우 항상 동일한 크기로 표시. |
tagInfo |
TagInfo
|
<optional> |
추가적으로 표시하고 싶은 HTMLElement |
Object
# MarkerOption
내 위치 관련한 옵션 설정
Properties:
Name | Type | Description |
---|---|---|
animate |
AnimateOption
|
boolean
|
애니메이션 옵션을 설정하거나 true로만 설정시 디폴트 애니메이션 값 적용 |
icon |
myLocationIcon
|
애니메이션 아이콘에 관한 설정. 지정하지 않는 경우에는 디폴트 아이콘이 적용됨. |
Object
# Metadata
poi 메타데이터.
Properties:
Name | Type | Description |
---|---|---|
lang |
LangType
|
각국 언어 설정. 예 "ko" |
metadatas |
Array.<MetadataText>
|
언어별 텍스트 |
Object
# myLocationIcon
내 위치 마커의 아이콘 옵션
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
image |
string
|
<optional> |
사용자 지정 아이콘 경로. 지정하지 않는 경우 디폴트 아이콘 제공 |
size |
Size
|
<optional> |
아이콘의 크기 설정. 지정하지 않는 경우 지도의 크기에 맞게 디폴트로 지정됨. |
Object
# NavigationOption
길찾기 및 모의주행 아이콘에 관한 옵션 설정
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
lineColor |
string
|
<optional> |
"#f05329" | 길찾기 경로 선의 색상을 지정. |
lineZ |
number
|
<optional> |
2 | default는 2 길찾기 경로 선의 z축값 지정 |
solidLineEnabled |
boolean
|
<optional> |
false | default는 false. 길찾기 경로 선의 속성을 결정. false일 때는 점선, true일 때 실선으로 그려짐. |
solidLineWidth |
number
|
<optional> |
1 | 길찾기 경로 실선의 굵기 |
lineSpotSize |
number
|
<optional> |
길찾기 경로 점선의 점 굵기 지정. 지정하지 않을 경우 지도 크기에 맞게 자동 계산 |
|
lineSpotInterval |
number
|
<optional> |
길찾기 경로 점선의 점간격 지정. 숫자가 커질수록 실선에 가깝게 보임. |
|
speedRate |
number
|
<optional> |
1 | 모의주행 속도 지정. 1.5로 지정한 경우 default대비 1.5배 속도 |
iconUrl |
string
|
<optional> |
모의주행 아이콘 지정. 지정하지 않을 경우 디폴트 아이콘이 사용됨. |
|
movingWidth |
number
|
<optional> |
모의주행 아이콘의 width. 지정하지 않을 경우 아이콘의 크기로 지정됨. |
|
movingHeight |
number
|
<optional> |
모의주행 아이콘의 height. 지정하지 않을 경우 아이콘의 크기로 지정됨. |
|
moveIconZ |
number
|
<optional> |
모의주행 아이콘의 z축 높이. 지정하지 않을 경우 자동으로 설정됨. |
|
visibleIcon |
boolean
|
<optional> |
true | 길찾기 경로를 표시할 때 출발지와 도착지 아이콘의 이미지를 보이거나 숨기는 옵션. |
originPositionZ |
number
|
<optional> |
출발지 아이콘의 z축값을 지정 |
|
destinationPositionZ |
number
|
<optional> |
도착지 아이콘의 z축값을 지정합니다. |
|
origin |
IconOption
|
<optional> |
출발지 아이콘의 속성 |
|
destination |
IconOption
|
<optional> |
도착지 아이콘의 속성 |
Object
# ObjectInfo
오브젝트 정보
Properties:
Name | Type | Description |
---|---|---|
id |
string
|
오브젝트 아이디 |
title |
string
|
오브젝트 명 |
poiData |
PoiInfo
|
오브젝트에 연결된 poi 정보 |
poiDataArr |
Array.<PoiInfo>
|
여러개의 poi가 연결되어 있는 경우 오브젝트에 연결된 복수개의 poi 정보 |
Object
# ObjectOption
오브젝트 색상 및 애니메이션 옵션
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
activeDest |
boolean
|
<optional> |
false | active 여부. 디폴트는 false이며 false인 경우 오브젝트 애니메이션 적용안됨. 이 속성은 RouteAnimateOption에서 호출시에만 적용됨. |
color |
string
|
<optional> |
"#ff0000" | 변경하고자 하는 색상값. 16진수로 표현. 예: "#ff00ff". 디폴트는 "#ff0000" 붉은색. |
opacity |
number
|
<optional> |
1 | 투명도 0에서 1사이의 실수. 0은 투명, 1은 붙투명임. 디폴트는 1임(불투명). isAnimate가 true인 경우 opacity 0.5를 권장함. |
isAnimate |
boolean
|
<optional> |
false | 색상 애니메이션 효과 적용 여부. 디폴트는 false임(애니메이션 효과없음) |
duration |
boolean
|
<optional> |
1000 | 애니메이션의 주기. 밀리세컨드단위임. 디폴트는 1000(1초). |
isRepeat |
boolean
|
<optional> |
false | 애니메이션 반복 여부. default는 false로 반복안함. |
isYoyo |
boolean
|
<optional> |
false | 반복 방법, true 이경우 역순진행 되며 default false |
ids |
Array.<string>
|
<optional> |
애니메이션 효과를 주고 싶은 오브젝트 아이디 또는 poi 아이디. 지정하지 않는 경우 자동으로 도착지의 poi에 연결된 오브젝트로 설정됨. poi 아이디를 주는 경우 해당 poi에 연결된 오브젝트에 효과가 적용됨. |
Object
# PoiCategory
poi 카테고리 정보
Properties:
Name | Type | Description |
---|---|---|
id |
string
|
카테고리 아이디 |
childList |
Array.<PoiCategory>
|
자식 카테고리 배열 |
code |
string
|
카테고리 코드 |
level |
number
|
카테고리 레벨 |
parentCode |
string
|
부모 카테고리 코드 |
parentId |
string
|
부모 카테고리 아이디 |
title |
string
|
카테고리 대표 타이틀 |
titleByLanguages |
Array.<TitleByLang>
|
언어별 카테고리 타이틀 |
Example
[
{
"id":"PC-1hvb0j1qh0bc36692",
"code":"1",
"level":1,
"title":"편의시설",
"parentId":null,
"parentCode":null,
"titleByLanguages":[
{
"lang":"ko",
"text":"편의시설"
},
{
"lang":"en",
"text":"Convenience"
}
],
"childList":[
{
"id":"PC-vb6bkd9gg8qe0622",
"code":"1-1",
"level":2,
"title":"화장실(여)",
"parentId":null,
"parentCode":null,
"titleByLanguages":[
{
"lang":"ko",
"text":"화장실(여)"
},
{
"lang":"en",
"text":"Toilet(w)"
}
],
"childList":[
]
},
{
"id":"PC-1iv0zx28uyvcn6399",
"code":"1-2",
"level":2,
"title":"화장실(남)",
"parentId":null,
"parentCode":null,
"titleByLanguages":[
{
"lang":"ko",
"text":"화장실(남)"
},
{
"lang":"en",
"text":"Toilet(m)"
}
],
"childList":[
]
},
{
"id":"PC-ubgb2mmh58hl3786",
"code":"1-3",
"level":2,
"title":"엘리베이터",
"parentId":null,
"parentCode":null,
"titleByLanguages":[
{
"lang":"ko",
"text":"엘리베이터"
},
{
"lang":"en",
"text":"Elevator"
}
],
"childList":[
]
}
]
},
]
Object
# PoiInfo
poi 정보
Properties:
Name | Type | Description |
---|---|---|
id |
string
|
poi 아이디 |
floorId |
string
|
poi가 위치한 층 아이디 |
categoryCode |
string
|
poi 카테고리 코드 |
metadatas |
Array.<Metadata>
|
poi의 메타데이터 |
position |
Position3d
|
poi의 지도상의 좌표 |
title |
string
|
poi 대표 타이틀 |
titleByLanguages |
Array.<TitleByLang>
|
언어별 poi 타이틀 |
Example
[{
"id": "PO-4JvSQCWHC2270",
"floorId": "FL-qhndqjlqhu7p3894",
"title": "남자화장실",
"categoryCode": "",
"icoUrl": "https://assets.dabeeomaps.com/upload/poiMarker/MansToilet.png",
"position": {
"x": 3937.7355807664,
"y": 756.651784816092,
"z": 0
},
"metadatas": [
{
"lang": "ko",
"metadatas": []
}
],
"titleByLanguages": [
{
"lang": "ko",
"text": "남자화장실"
}
]
}]
Array.<number>
# PoiLevelZoom
poi 중요도에 따른 표출 기준이 되는 줌값 설정
Properties:
Type | Description |
---|---|
number
|
poi중요도 상 줌 설정값 |
number
|
poi중요도 중 줌 설정값 |
number
|
poi중요도 하 줌 설정값 |
- See:
Example
poiLevel: [50, 100, 200] // 상(level1), 중(level2), 하(level3)
//poi 상(level 1) : 줌 50 이상부터 보이게 설정
//poi 중(level 2) : 줌 100 이상부터 보이게 설정
//poi 하(level 3) : 줌 200 이상부터 보이게 설정
Object
# PoiTag
POI Tag 설정
Properties:
Name | Type | Description |
---|---|---|
poiId |
string
|
poi의 아이디 |
tagInfo |
TagInfo
|
tag 속성 |
Object
# Position2d
지도의 좌표
Properties:
Name | Type | Description |
---|---|---|
x |
number
|
지도의 x 좌표 |
y |
number
|
지도의 y 좌표 |
- See:
# RequestCallback(response)
Parameters:
Name | Type | Description |
---|---|---|
response |
Response
|
지도 그리기 위한 요청에 대한 응답. 지도에 대한 정보 및 지도 렌더링에 필요한 메소드를 사용할 수 있는 클래스를 반환함. 예를 들어 poi정보 등. |
- See:
Object
# RouteAnimationOption
모의주행 옵션
Properties:
Name | Type | Description |
---|---|---|
zoom |
number
|
설정된 줌만큼 화면이 확대되며 모의주행중 카메라가 자동으로 이동됩니다. |
changeFloorDelay |
number
|
층이동하기 전에 지정한만큼의 지연시간이 생깁니다. 이 시간을 이용하여 사용자에게 층이동에 대한 팝업등의 알림을 할 수가 있습니다. |
destOption |
ObjectOption
|
모의주행 도착지 오브젝트의 색상 투명도, 색상 애니메이션의 효과를 줄 수 있습니다. |
Object
# RouteInfo
길찾기 정보
Properties:
Name | Type | Description |
---|---|---|
totalDistance |
number
|
도착지까지의 거리 (cm) |
totalTime |
number
|
도착지까지의 시간 (miliseconds) |
Object
# RouteInfoByTrans
경로별 길찾기 정보
Properties:
Name | Type | Description |
---|---|---|
elevator |
RouteInfo
|
엘리베이터로 이동시 길찾기 정보 |
escalator |
RouteInfo
|
에스컬레이터로 이동시 길찾기 정보 |
recommendation |
RouteInfo
|
이동수단 상관없이 추천 길찾기 정보 |
stairs |
RouteInfo
|
계단으로 이동시 길찾기 정보 |
Example
{
elevator: {totalTime: 14123.48266130216, totalDistance: 151441.53594482222},
escalator: {totalTime: 14723.48266130216, totalDistance: 151441.53594482222},
recommendation: {totalDistance: 14723.48266130216, totalTime: 151441.53594482222},
stairs: {totalDistance: 14723.48266130216, totalTime: 151441.53594482222
}
Object
# RoutePath
길찾기 경로 목록 배열의 각 항목은 경로상의 각 지점을 의미합니다. 항목에서 move()를 사용하면 카메라를 해당지점의 위치로 이동시킬 수 있습니다. 이동수단을 이용하여 층이 변경된 경우 배열의 항목에서 distance가 number가 아닌 층 object로 표현됩니다.
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
floorId |
string
|
해당지점의 층아이디 |
|
position: |
Position3d
|
해당지점의 좌표(3d) |
|
distance |
number
|
Object
|
해당지점까지 층간 이동수단을 사융하는 경우는 Object 타입임. 그 외 경우는 이전 항목과의 거리 ( cm 단위 ) |
|
direction |
"RIGHT"
|
"LEFT"
|
"STRAIGHT"
|
다음 지점까지의 방향. 다음경로까지 방향없는 경우는 null(최종 도착지나 층간 이동일 경우) |
|
move: |
function
|
ƒ () // 현재 지점으로 이동하는 함수 |
|
isDestination |
boolean
|
현재 지점이 시작점이거나 경유지, 도착지인경우 true, 이동경로일때는 false |
|
transCode |
TransCode
|
<optional> |
isDestination이 false인 경우 현재 지점까지의 이동수단. 에스컬레이터 상향, 에스컬레이터 하향, 기타 이동 수단, null 인 경우 걷기. |
poiId |
string
|
<optional> |
현재지점에 연결된 poi가 있는 경우 poi id |
title |
string
|
<optional> |
현재지점에 연결된 poi가 있는 경우 poi title |
categoryCode |
string
|
<optional> |
현재지점에 연결된 poi가 있는 경우 poi 카테고리 코드 |
icoUrl |
string
|
<optional> |
현재지점에 연결된 poi가 있는 경우 poi iconUrl |
metadatas |
Array.<Metadata>
|
<optional> |
현재지점에 연결된 poi가 있는 경우 poi metadatas |
titleByLanguages |
Array.<TitleByLang>
|
<optional> |
현재지점에 연결된 poi가 있는 경우 poi title ByLanguages |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#navigation
Examples
// isDestination이 true인 경우
categoryCode: "02"
direction: null
distance: 0
floorId: "FL-qhndqjlqhu7p3894"
icoUrl: "https://assets.dabeeomaps.com/upload/poiMarker/MansToilet.png"
id: "PO-4JvSQCWHC2270"
isDestination: true
metadatas: (2) [{…}, {…}]
move: ƒ ()
position: {x: 3943.999500588226, y: 744.1239451724396, z: 0}
title: "남자\n화장실(하)"
titleByLanguages: (2) [{…}, {…}]
// isDestination이 false인 경우 (연결된 poi가 있는 경우)
categoryCode: "01"
direction: "RIGHT"
distance: 183
floorId: "FL-qhndqjlqhu7p3894"
icoUrl: "https://assets.dabeeomaps.com/upload/poiCustomMarker/210819072602726039089.png"
id: "PO-M02DvTVjp8449"
isDestination: false
metadatas: (2) [{…}, {…}]
move: ƒ ()
position: {x: 3525.30961754959, y: 1445.2068488670923, z: 0}
title: "회의실1(하)"
titleByLanguages: (2) [{…}, {…}]
transCode: null
Object
# SectionInfo
섹션 정보
Properties:
Name | Type | Description |
---|---|---|
id |
string
|
섹션 아이디 |
floorId |
string
|
섹션이 속한 층 아이디 |
position |
Position3d
|
섹션의 중심 좌표 |
title |
string
|
대표 타이틀 |
Example
[{
{
"id": "SC-e0F2gHmSGh8957",
"floorId": "FL-qhndqjlqhu7p3894",
"title": "ROAD",
"position": {
"x": 3398.6336669921893,
"y": 1365.3215332031261,
"z": 0
},
}
}]
Object
# ShowPoiOption
poi를 보이거나 숨기도록 설정하는 옵션
Properties:
Name | Type | Description |
---|---|---|
showPoi |
boolean
|
true로 설정시 poi 표출. false로 설정시 poi 숨김 |
Object
# TagInfo
HTML Element를 설정합니다. TagInfo를 사용하기 위해서는 MapView에서 mapOption으로 isUseTag를 true로 설정해야 합니다.
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
tag |
HTMLElement
|
HTML Element |
||
width |
number
|
HTML Element의 넓이 |
||
height |
number
|
HTML Element의 높이 |
||
pos |
"TOP"
|
"BOTTOM"
|
"LEFT"
|
"RIGHT"
|
마커를 표시할 상대 위치 |
||
isResize |
boolean
|
<optional> |
false | 지도의 줌과 회전에 따라 반응형으로 동작할 지 여부. false인 경우 항상 동일한 위치와 크기 유지 |
Example
let tagInfo = {
tag: dom,
width: '200',
height: '70',
pos: "BOTTOM",
isResize: false
}
Object
# ThemeInfo
테마 정보
Properties:
Name | Type | Description |
---|---|---|
defaultYn |
boolean
|
디폴트 테마 해당 여부 |
id |
number
|
테마 아이디 |
name |
string
|
테마 이름 |
Example
[
{
"id": 1915,
"name": "다비오 테마",
"defaultYn": false
}
]
Object
# TitleByLang
언어별 타이틀
Properties:
Name | Type | Description |
---|---|---|
lang |
LangType
|
각국 언어 설정 한국어인 경우 "ko" |
text |
string
|
해당 언어에 해당하는 텍스트 |
string
# TransCode
층간 이동수단
Properties:
Type | Description |
---|---|
"OB-STAIRS"
|
"OB-ELEVATOR"
|
"OB-ESCALATOR"
|
"OB-ESCALATOR_UP"
|
"OB-ESCALATOR_DOWN"
|
"OB_OTHER_TRANSPORT"
|
이동수단. 계단, 엘리베이터, 에스컬레이터 양방향, 에스컬레이터 상향, 에스컬레이터 하향, 연결통로 등 기타이동 수단 |
Events
Object
# floor-changed
모의주행이나 카메라 이동 등으로 지도 api 호출중에 자동으로 층이 바뀌는 경우가 있습니다. 이때 층이 바뀐 정보가 event로 내려옵니다. 바뀐 층에 맞게 화면에 표시해주면 됩니다.
Properties:
Name | Type | Description |
---|---|---|
detail |
string
|
변경된 층아이디 |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#navigation
Example
document.addEventListener("floor-changed", (e) => {
let floorId = e.detail;
console.log(floorId);
document.querySelector(".floor-on").classList.remove("floor-on");
document.getElementById(floorId).classList.add("floor-on");
});
Object
# get-pos
마우스 클릭 좌표를 받아와 현재 지점에서의 좌표를 반환해준다
Properties:
Name | Type | Description |
---|---|---|
detail |
Position2d
|
현재 클릭된 지점의 2d 좌표 |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#clickEvent
Example
document.querySelector('#map').addEventListener('get-pos', (e) => {
console.log(e.detail);
document.querySelector(".mouse-pos").innerHTML = `x: ${parseInt(e.detail.x)}, y: ${parseInt(e.detail.y)}`;
})
Object
# marker-click
지도에서 marker 클릭시 선택된 marker의 정보를 반환합니다. 반환되는 정보는 배열형태입니다. 반환되는 정보는 setMaker시에 data option으로 지정한 정보입니다.
Properties:
Name | Type | Description |
---|---|---|
detail |
Object
|
setMarker() 호출시 넘겼던 데이터 |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#clickEvent
Example
document.querySelector("#map").addEventListener("marker-click", (e) => { // 캔버스가 그려지는 엘리먼트
console.log(e.detail);
});
Object
# navi-complete
모의주행이 완료된 경우 모의주행이 완료되었다는 이벤트가 발생합니다
Properties:
Name | Type | Description |
---|---|---|
detail |
string
|
정상종료된 경우 "OK" |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#navigation
Example
document.addEventListener("navi-complete", (e) => {
console.log(e.detail);
});
Object
# object-click
지도에서 object를 클릭하면 obejct의 정보와 연결된 poi 정보를 반환합니다. 반환되는 정보는 배열형태입니다. 이는 클릭한 좌표에 여러개의 object가 연결될 수 있기 때문입니다. 한 개의 object에 연결된 poi가 하나인 경우는 poiData로 반환되며 poi가 여러개인 경우를 위하여 poiDataArr 배열형태로도 반환합니다.
Properties:
Name | Type | Description |
---|---|---|
detail |
Array.<ObjectInfo>
|
오브젝트 정보 |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#clickEvent
Example
document.querySelector("#map").querySelector("#map").addEventListener("object-click", (e) => { //캔버스가 그려지는 element
console.log(e.detail);
});
Object
# poi-click
지도에서 poi를 클릭하면 해당 poi의 정보를 담아 이벤트가 내려옵니다. poi는 항상 배열형태입니다. 이를 이용하여 클릭된 poi의 정보를 화면에 표시해줄 수 있습니다.
Properties:
Name | Type | Description |
---|---|---|
detail |
Array.<PoiInfo>
|
poi 정보 |
- See:
-
- 실행 및 전체 코드 보기 https://dabeeo.github.io/web_api/example/#clickEvent
Example
document.querySelector("#map").addEventListener("poi-click", (e) => { // 캔버스가 그려지는 container
console.log(e.detail); // 해당하는 poi 정보가 array 로 리턴
});
Object
# will-floor-change
모의주행 중 층이 변경되는 경우 이벤트가 발생합니다 mapDraw.startRouteAnimation({changeFloorDelay:3000})에서 옵션과 같이 사용하면 모의주행 중 층변경 시점에 층변경 딜레이를 이용하여 층변경을 명시적으로 알려주는 데 사용할 수 있습니다.
Properties:
Name | Type | Description |
---|---|---|
floor |
FloorChangeInfo
|
층 변경 이전과 이후의 각 층 정보 |
transCode |
TransCode
|
층 변경시 이동수단 |
- See:
Example
document.addEventListener("will-floor-change", (e) => {
console.log(e.detail);
});