Tài liệu tra cứu Vietbando Maps API
    Các lớp để hiển thị bản đồ.
    Các lớp để mở rộng chức năng của Vietbando API.
Lớp VMap
Đây là lớp chính của API dùng để tạo bản đồ. Các lớp còn lại là các lớp hỗ trợ.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VMap(container, opts?)

Tạo một bản đồ nằm trong container truyền vào, container là thẻ DIV. Nếu kích thước không được xác định thông qua opts.size trong đối số opts truyền vào, thì kích thước của container sẽ được dùng cho kích thước bản đồ. Nếu opts.size được sử dụng thì container sẽ được chỉnh sửa kích thước cho phù hợp. Bạn nên xem thêm lớp VMapOptions để biết chi tiết các tùy chọn.

Các phương thức
Cấu hình

Các phương thức

Giá trị trả về

Mô tả

enableDragging()

Không có

Bật chức năng cho phép kéo lê di chuyển bản đồ (mặc định).

disableDragging()

Không có

Tắt chức năng kéo lê di chuyển bản đồ (vẫn có thể di chuyển bản đồ bằng control).

draggingEnabled()

Boolean

Trả về true nếu bản đồ được bật tính năng cho phép kéo lê di chuyển.

enableInfoWindow()

Không có

Cho phép các thao tác liên quan đến cửa sổ (info window) trên bản đồ (mặc định).

disableInfoWindow()

Không có

Đóng cửa sổ nếu có, và không cho phép mở cửa sổ mới.

infoWindowEnabled()

Boolean

Trả về true nếu tính năng thao tác với cửa sổ được bật.

enableDoubleClickZoom()

Không có

Cho phép click đôi để phóng to thu nhỏ bản đồ (mặc định).

disableDoubleClickZoom()

Không có

Không cho phép click đôi để phóng to thu nhỏ bản đồ.

doubleClickZoomEnabled()

Boolean

Trả về true nếu tính năng click đôi phóng to thu nhỏ bản đồ được bật.

enableContinuousZoom()

Không có

Bật hiệu ứng mượt khi phóng to thu nhỏ bản đồ (mặc định).

disableContinuousZoom()

Không có

Tắt hiệu ứng mượt khi phóng to thu nhỏ bản đồ.

continuousZoomEnabled()

Boolean

Trả về true nếu hiệu ứng mượt khi phóng to thu nhỏ bản đồ được bật.

enableScrollWheelZoom()

Không có

Cho phép phóng to thu nhỏ bản đồ bằng nút cuộn.

disableScrollWheelZoom()

Không có

Không cho phép phóng to thu nhỏ bản đồ bằng nút cuộn.

scrollWheelZoomEnabled()

Boolean

Trả về true nếu tính năng phóng to thu nhỏ bản đồ bằng nút cuộn được bật.

Điều khiển

Các phương thức

Giá trị trả về

Mô tả

addControl(control, position?)

Không có

Thêm điều khiển vào bản đồ. Vị trí của điều khiển được xác định thông qua đối số position. Nếu đối số position rỗng, vị trí mặc định của điều khiền sẽ được sử dụng (có thể lấy vị trí mặc định của điều khiển thông qua phương thức VControl.getDefaultPosition()). Một điều khiển chỉ được thêm vào duy nhất một bản đồ.

removeControl(control)

Không có

Xóa điều khiển khỏi bản đồ. Sẽ không có gì xảy ra nếu điều khiển này chưa được thêm vào bản đồ.

getContainer()

Node

Trả về thẻ div chứa bản đồ, được dùng bởi phương thức VControl.initialize().

Trạng thái bản đồ

Các phương thức

Giá trị trả về

Mô tả

isLoaded()

Boolean

Trả về true nếu bản đồ đã nạp xong (Hàm setCenter() đã được gọi).

getCenter()

VLatLng

Trả về tọa độ địa lý của tâm bản đồ.

getBounds()

VLatLngBounds

Trả về khung bao bản đồ ở hệ tọa độ địa lý.

getBoundsZoomLevel(bounds)

Number

Trả về mức bản đồ mà khung hình chữ nhật bounds có thể được thấy hoàn toàn trong khung nhìn bản đồ.

getSize()

VSize

Trả về kích thước (pixel) của bản đồ.

getLevel()

Number

Trả về mức bản đồ hiện tại.

Thay đổi trạng thái bản đồ

Các phương thức

Giá trị trả về

Mô tả

setCenter(center, level?)

Không có

Thiết lập tâm và mức bản đồ.

panTo(center)

Không có

Di chuyển để center làm tâm bản đồ. Nếu điểm này nằm trong khung nhìn hiện hành thì sẽ có hiệu ứng mượt khi di chuyển.

panBy(distance)

Không có

Di chuyển bản đồ với khoản cách (pixel) truyền vào.

panDirection(dx, dy)

Không có

Di chuyển bản đồ với khoảng cách là một nửa chiều rộng và chiều cao của bản đồ. Lần lượt +1 là sang phải hoặc xuống dưới, -1 là sang trái hoặc đi lên.

zoomToLevel(level)

Không có

Thay đổi mức bản đồ (phóng to hoặc thu nhỏ).

zoomIn()

Không có

Phóng to bản đồ lên 1 mức.

zoomOut()

Không có

Thu nhỏ bản đồ xuống 1 mức.

saveCurrentPosition()

Không có

Lưu vị trí và mức hiện tại của bản đồ.

goToSavedPosition()

Không có

Đưa bản đồ trở lại vị trí và mức đã lưu bởi hàm saveCurrentPosition().

checkResize()

Không có

Sau khi thay đổi kích thước thẻ chứa bản đồ, bạn gọi phương thức này để bản đồ điều chỉnh cho phù hợp kích thước mới.

fitOverlays()

Không có

Đưa bản đồ về vị trí và mức mà có thể thấy được tất cả các overlay.

Các đối tượng phủ lên bản đồ (overlay)

Các phương thức

Giá trị trả về

Mô tả

addOverlay(overlay)

Không có

Thêm 1 overlay vào bản đồ và phát sinh sự kiện addoverlay.

removeOverlay(overlay)

Không có

Xóa overlay khỏi bản đồ và phát sinh sự kiện removeoverlay (nếu có overlay này trên bản đồ).

clearOverlays()

Không có

Xóa tất cả overlay khỏi bản đồ và phát sinh sự kiện clearoverlays.

getOverlayContainer()

Node

Trả về thẻ div chứa các đối tượng overlay, được gọi bởi phương thức VOverlay.initialize() để vẽ overlay lên bản đồ.

Cửa sổ

Các phương thức

Giá trị trả về

Mô tả

openInfoWindow(point, html, opts?)

Không có

Mở 1 cửa sổ ngay tại vị trí truyền vào. Bản đồ sẽ di chuyển sao cho có thể thấy toàn bộ cửa sổ. Nội dung truyền vào là chuỗi thường hoặc chuỗi HTML.

openInfoWindowTabs(point, tabs, opts?)

Không có

Mở 1 cửa sổ có tab ngay tại vị trí truyền vào. Bản đồ sẽ di chuyển sao cho có thể thấy toàn bộ cửa sổ. Nội dung truyền vào là chuỗi thường hoặc chuỗi HTML.

showMapBlowup(point, opts?)

Không có

Mở 1 cửa sổ ngay tại vị trí truyền vào, chứa bản đồ nhỏ hiển thị khung nhìn xung quanh điểm này. Bản đồ sẽ di chuyển sao cho có thể thấy toàn bộ cửa sổ.

updateInfoWindow(tabs, onupdate?)

Không có

Cập nhật nội dung của cửa sổ đang mở. Cửa sổ sẽ tự động điều chỉnh cho phù hợp với nội dung mới. Hàm onupdate sẽ được gọi sau cửa sổ thay đổi kích thước.

closeInfoWindow()

Không có

Đóng cửa sổ hiện hành.

getInfoWindow()

VInfoWindow

Trả về đối tượng cửa sổ của bản đồ.

Các phép biến đổi hệ tọa độ

Các phương thức

Giá trị trả về

Mô tả

fromLatLngToDivPixel(latlng)

VPoint

Chuyển đổi tọa độ thực sang tọa độ màn hình ở mức tương quan với các overlay. Bạn dùng hàm này để xác định vị trí overlay tự tạo của bạn.

fromLatLngToContainerPixel(latlng)

VPoint

Chuyển đổi tọa độ thực sang tọa độ màn hình ở mức tương quan với thẻ chứa bản đồ. Bạn dùng hàm này để xác định vị trí điều khiển tự tạo của bạn.

fromDivPixelToLatLng(pixel)

VLatLng

Chuyển đổi tọa độ màn hình ở mức tương quan với các overlay sang tọa độ thực. Hàm này hữu ích trong việc tương tác giữa các overlay tự tạo của bạn với bản đồ.

fromContainerPixelToLatLng(pixel)

VLatLng

Chuyển đổi tọa độ màn hình ở mức tương quan với thẻ chứa bản đồ sang tọa độ thực. Hàm này hữu ích trong việc tương tác giữa các điều khiển tự tạo của bạn với bản đồ.

Các sự kiện

Các sự kiện

Đối số

Mô tả

click

overlay, point

Sự kiện này phát sinh khi bản đồ bị click. Nếu click vào overlay thì đối tượng này sẽ được truyền vào đối số overlay, và sự kiện click của marker cũng được phát sinh. Ngược lại, tọa độ thực của điểm click chuột sẽ truyền vào đối số point.

dblclick

overlay, point

Sự kiện này phát sinh khi bản đồ bị click đôi. Nếu click đôi vào overlay thì đối tượng này sẽ được truyền vào đối số overlay, và sự kiện dblclick của marker cũng được phát sinh. Ngược lại, tọa độ thực của điểm click chuột sẽ truyền vào đối số point.

singlerightclick

overlay, point

Sự kiện này phát sinh khi sự kiện contextmenu (DOM) phát sinh. Nếu click vào overlay thì đối tượng này sẽ được truyền vào đối số overlay. Ngược lại, tọa độ thực của điểm click chuột sẽ truyền vào đối số point.

movestart

Không có

Sự kiện này phát sinh khi khung nhìn của bản đồ thay đổi. Khung nhìn bản đồ thay đổi khi kéo lê bản đồ (sẽ phát sinh sự kiện dragstart), hoặc do gọi các hàm thay đổi khung nhìn như di chuyển, phóng to, thu nhỏ bản đồ.

moving

Không có

Sự kiện này phát sinh (lặp lại nhiều lần) trong khi khung nhìn của bản đồ đang thay đổi.

moveend

Không có

Sự kiện này phát sinh sau khi khung nhìn của bản đồ ngưng thay đổi.

zoomend

oldLevel, newLevel

Sự kiện này phát sinh sau khi bản đồ thay đổi mức (phóng to hay thu nhỏ). Hàm xử lý sự kiện sẽ nhận được mức cũ và mức mới của bản đồ.

infowindowopen

Không có

Sự kiện này phát sinh khi cửa sổ mở.

infowindowbeforeclose

Không có

Sự kiện này phát sinh trước khi cửa sổ đóng.

infowindowclose

Không có

Sự kiện này phát sinh khi cửa sổ đóng.

addoverlay

overlay

Sự kiện này được phát sinh khi overlay được thêm vào bản đồ thông qua phương thức addOverlay(). Đối tượng overlay sẽ được trả ra thông qua đối số overlay của hàm xử lý sự kiện.

removeoverlay

overlay

Sự kiện này được phát sinh khi overlay bị xóa khỏi bản đồ thông qua phương thức removeOverlay(). Đối tượng overlay sẽ được trả ra thông qua đối số overlay của hàm xử lý sự kiện.

clearoverlays

Không có

Sự kiện này phát sinh khi phương thức clearOverlays() được gọi.

mouseover

latlng

Sự kiện này phát sinh khi người dùng đưa chuột vào bản đồ.

mouseout

latlng

Sự kiện này phát sinh khi người dùng đưa chuột ra khỏi bản đồ.

mousemove

latlng

Sự kiện này phát sinh khi người dùng di chuyển chuột trong bản đồ.

dragstart

Không có

Sự kiện này phát sinh khi người dùng bắt đầu kéo lê bản đồ bằng chuột.

dragging

Không có

Sự kiện này phát sinh (lặp lại nhiều lần) khi người dùng đang kéo lê bản đồ bằng chuột.

dragend

Không có

Sự kiện này phát sinh khi người dùng ngưng kéo lê bản đồ bằng chuột.

loaded

Không có

Sự kiện này phát sinh sau khi việc thiết lập bản đồ hoàn tất, và hàm isLoaded trả về giá trị true. Điều này có nghĩa là vị trí, mức bản đồ đều đã được khởi tạo.

Lớp VMapOptions
Lớp này dùng để xác định các thuộc tính cho phương thức khởi tạo của lớp VMap.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

size

VSize

Xác định kích thước (pixel) của bản đồ. Container truyền vào sẽ được điều chỉnh kích thước cho phù hợp. Mặc định, bản đồ sẽ dùng kích thước của container.

draggableCursor

String

Con trỏ chuột được dùng khi bản đồ được phép kéo lê.

draggingCursor

String

Con trỏ chuột được dùng khi kéo lê bản đồ.

Lớp VKeyboardHandler
Lớp này dùng để bật tính năng điều khiển bản đồ bằng phím.

Các phím

Mô tả

Các phím Trái, Phải, Lên, Xuống

Di chuyển bản đồ.

Các phím Home, End, Page Up, Page Down

Di chuyển bản đồ một đoạn bằng nửa kích thước bản đồ (tương tự như lúc bạn chọn các nút của điều khiển VLargeMapControl hoặc VSmallMapControl).

Các phím +, -, *

Phóng to, thu nhỏ, fit bản đồ (tương tự như lúc bạn chọn các nút của điều khiển VLargeMapControl hoặc VSmallMapControl).

Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VKeyboardHandler(map)

Khởi tạo bộ bắt sự kiện phím cho bản đồ.

Giao diện VOverlay

Giao diện này được cài đặt bởi các lớp VMarker, VPolylineVPolygon. Bạn có thể cài đặt giao diện này nếu bạn muốn tạo overlay của riêng bạn. Một thể hiện của VOverlay có thể đặt vào bản đồ thông qua phương thức VMap.addOverlay(). Sau đó lớp VMap sẽ gọi phương thức VOverlay.initialize() của overlay để đặt chính nó vào bản đồ. Bất cứ khi nào bản đồ thay đổi, VMap sẽ gọi VOverlay.redraw() để overlay có thể xác định lại vị trí của nó.

Các phương thức trừu tượng

Các phương thức trừu tượng

Giá trị trả về

Mô tả

initialize(map)

Không có

Phương thức này được gọi bởi bản đồ khi overlay được thêm vào bản đồ sử dụng phương thức VMap.addOverlay().

remove()

Không có

Phương thức này được gọi bởi bản đồ khi overlay bị xóa khỏi bản đồ sử dụng phương thức VMap.removeOverlay() hoặc VMap.clearOverlays().

copy()

VOverlay

Trả về bản sao để có thể thêm vào bản đồ.

redraw(force)

Không có

Phương thức này được gọi khi bản đồ thay đổi hiển thị.

Lớp VInfoWindow
VInfoWindow không có phương thức khởi tạo, được tạo bởi bản đồ và được truy cập bởi phương thức VMap.getInfoWindow(). Một bản đồ chỉ tồn tại một đối tượng VInfoWindow.
Các phương thức

Các phương thức

Giá trị trả về

Mô tả

selectTab(index)

Không có

Chọn tab được mở. Hành động này tương ứng với việc người dùng click lên tab.

hide()

Không có

Ẩn cửa sổ. Có thể hiện lại cửa sổ bằng phương thức show().

show()

Không có

Hiện lại cửa sổ nếu nó đang ẩn.

isHidden()

Boolean

Trả về true nếu cửa sổ đang ẩn.

reset(point, tabs, size, offset?, selectedTab?)

Không có

Thiết lập lại các thuộc tính cho cửa sổ.

getPoint()

VLatLng

Trả về tọa độ thực của điểm mà cửa sổ neo vào.

getPixelOffset()

VSize

Trả về giá trị độ dời (pixel) từ điểm neo cửa sổ.

getSelectedTab()

Number

Trả về tab được chọn.

getTabs()

Mảng VInfoWindowTab

Trả về mảng các tab của cửa sổ.

Lớp VInfoWindowTab
Một mảng các thể hiện của lớp này được dùng làm đối số tabs truyền vào phương thức VMap.openInfoWindowTabs()VMarker.openInfoWindowTabs(). Nếu mảng chứa nhiều hơn 1 phần tử, cửa sổ sẽ được hiển thị với nhiều tab. Mỗi tab chứa content xác định nội dung cửa sổ khi tab được chọn, và label xác định tiêu đề của tab.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VInfoWindowTab(label, content)

Tạo một cấu trúc tab của cửa sổ.

Lớp VInfoWindowOptions
Thể hiện của lớp này được sử dụng làm đối số opts? truyền vào phương thức openInfoWindow(), openInfoWindowTabs(), bindInfoWindow(), và showMapBlowup() của lớp VMapVMarker.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

selectedTab

Number

Chỉ ra tab được chọn (tính từ 0).

maxWidth

Number

Chiều rộng tối đa (pixel) của cửa sổ.

onOpenFn

Function

Hàm được gọi sau khi cửa sổ mở và nội dung đã được hiển thị.

onCloseFn

Function

Hàm được gọi khi cửa sổ đóng.

zoomLevel

Number

Chỉ dùng cho phương thức showMapBlowup(), chỉ ra mức của bản đồ trong cửa sổ.

Lớp VMarker
VMarker đánh dấu 1 vị trí trên bản đồ. Nó cài đặt giao diện VOverlay và được thêm vào bản đồ bằng phương thức VMap.addOverlay().
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VMarker(point, icon?, inert?)

Tạo 1 marker tại vị trí point với biểu tượng icon. Nếu inerttrue, thì marker sẽ không thể click, nắm kéo và không phát sinh bất kỳ sự kiện nào.

VMarker(latlng, opts?)

Tạo 1 marker tại vị trí latlng với thuộc tính được xác định bởi VMarkerOptions. Mặc định, marker sẽ có thể click được và lấy icon mặc định.

Các phương thức
Các phương thức này phải được gọi sau khi marker thêm vào bản đồ.

Các phương thức

Giá trị trả về

Mô tả

openInfoWindow(content, opts?)

Không có

Mở 1 cửa sổ gắn vào marker.

bindInfoWindow(content, opts?)

Không có

Thực hiện việc mở cửa sổ (với nội dung truyền vào) khi click chuột lên marker. Truyền vào content giá trị null để chấm dứt.

closeInfoWindow()

Không có

Đóng cửa sổ.

showMapBlowup(opts?)

Không có

Mở 1 cửa sổ gắn với marker, chứa bản đồ nhỏ hiển thị khung nhìn xung quanh điểm này. Bản đồ sẽ di chuyển sao cho có thể thấy toàn bộ cửa sổ.

getIcon()

VIcon

Trả về icon của marker.

setIcon(icon?)

Không có

Đổi icon của marker.

getTitle()

String

Trả về tiêu đề của marker.

getPoint()

VLatLng

Trả về tọa độ thực của điểm được marker gắn vào.

setPoint(point)

Không có

Thiết lập tọa độ thực của điểm mà marker gắn vào.

enableDragging()

Không có

Cho phép nắm kéo di chuyển marker xung quanh bản đồ.

disableDragging()

Không có

Không cho phép nắm kéo di chuyển marker xung quanh bản đồ.

draggable()

Boolean

Trả về true nếu marker được phép nắm kéo di chuyển.

hide()

Không có

Ẩn marker nếu nó đang hiện. Lưu ý rằng việc này sẽ làm phát sinh sự kiện VMarker.visibilitychanged.

show()

Không có

Hiện marker nếu nó đang ẩn. Lưu ý rằng việc này sẽ làm phát sinh sự kiện VMarker.visibilitychanged.

isHidden()

Boolean

Trả về true nếu marker đang ẩn. Ngược lại trả về false.

Các sự kiện

Các sự kiện

Đối số

Mô tả

click

Không có

Sự kiện này phát sinh khi marker bị click.

dblclick

Không có

Sự kiện này phát sinh khi marker bị click đôi.

mousedown

Không có

Sự kiện này phát sinh khi sự kiện mousedown của marker phát sinh.

mouseup

Không có

Sự kiện này phát sinh khi sự kiện mouseup của marker phát sinh.

mouseover

Không có

Sự kiện này phát sinh khi sự kiện mouseover của marker phát sinh.

mouseout

Không có

Sự kiện này phát sinh khi sự kiện mouseout của marker phát sinh.

infowindowopen

Không có

Sự kiện này phát sinh khi cửa sổ được mở thông qua marker.

infowindowbeforeclose

Không có

Sự kiện này phát sinh trước khi cửa sổ đóng.

infowindowclose

Không có

Sự kiện này phát sinh khi cửa sổ đóng.

remove

Không có

Sự kiện này phát sinh khi marker bị xóa khỏi bản đồ dùng phương thức VMap.removeOverlay() hoặc VMap.clearOverlays().

dragstart

Không có

Sự kiện này phát sinh khi marker bắt đầu được nắm kéo di chuyển.

dragging

Không có

Sự kiện này phát sinh khi marker đang được nắm kéo di chuyển.

dragend

Không có

Sự kiện này phát sinh khi marker ngưng nắm kéo di chuyển.

visibilitychanged

isVisible

Sự kiện này phát sinh khi trạng thái ẩn hiện của marker thay đổi. isVisible trả ra là trạng thái của marker sau khi thay đổi.

Lớp VMarkerOptions
Thể hiện của lớp này được dùng làm đối số opts trong phương thức khởi tạo của lớp VMarker.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

icon

VIcon

Chỉ ra icon sẽ được dùng cho marker. Nếu không xác định, icon mặc định sẽ được sử dụng.

alongText

Mảng string

Xác định chuỗi chữ gắn với marker.

textPosition

Mảng VTextPosition

Xác định vị trí của chuỗi chữ gắn với marker.

textStyle

Mảng VTextStyle

Xác định kiểu chuỗi chữ gắn với marker.

title

String

Chuỗi chữ xuất hiện làm chú thích của marker.

clickable

Boolean

Xác định marker có thể được click không. Giá trị mặc định là true.

draggable

Boolean

Xác định marker có thể được nắm kéo không. Giá trị mặc định là false.

Lớp VTextPosition
Lớp này được dùng để chỉ ra vị trí của văn bản gắn với marker.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

anchor

VAnchor

Chỉ ra vị trí của văn bản gắn với marker.

offset

VSize

Chỉ ra độ dời từ vị trí anchor.

Lớp VTextStyle
Lớp này được dùng để chỉ kiểu của văn bản gắn với marker.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

fontSize

Number

Chỉ ra kích thước của văn bản gắn với marker.

fontWeight

String

Chỉ ra độ đậm nhạt văn bản, gồm 2 giá trị 'normal', 'bold'.

color

String

Chỉ ra màu (#RRGGBB) của văn bản gắn với marker.

fontFamily

String

Chỉ ra phông chữ của văn bản gắn với marker.

Lớp VPolyline
Thêm 1 polyline vào bản đồ, sử dụng khả năng đồ họa vectơ của trình duyệt.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VPolyline(latlngs, lineColor?, lineWidth?, fillColor? opacity?, opts?)

Tạo polyline từ mảng các điểm. linecolor, fillcolor là chuỗi màu theo dạng số thập lục phân (#RRGGBB). lineWidth là chiều rộng (pixel) của đường thẳng. opacity là độ trong suốt (giá trị từ 0 đến 1).

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

getVertexCount()

Number

Trả về số đỉnh của polyline

getVertex(index)

VLatLng

Trả về 1 đỉnh của polyline.

hide()

Không có

Ẩn polyline nếu đang hiện. Điều này sẽ làm phát sinh sự kiện VPolyline.visibilitychanged.

isHidden()

Boolean

Trả về true nếu polyline đang ẩn. Ngược lại trả về false.

show()

Không có

Hiện polyline nếu đang ẩn. Điều này sẽ làm phát sinh sự kiện VPolyline.visibilitychanged.

Các sự kiện

Các sự kiện

Đối số

Mô tả

remove

Không có

Sự kiện này phát sinh khi polyline bị xóa khỏi bản đồ dùng phương thức VMap.removeOverlay() hoặc VMap.clearOverlays().

visibilitychanged

isVisible

Sự kiện này phát sinh khi polyline đổi trạng thái từ ẩn sang hiện hay ngược lại. isVisible trả ra là trạng thái của polyline sau khi thay đổi.

click

latlng

Sự kiện này phát sinh khi polyline bị click.

Lớp VPolylineOptions
Thể hiện của lớp này được dùng trong phương thức khởi tạo của lớp VPolyline, xác định thuộc tính cho polyline.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

clickable

Boolean

Xác định polyline có được click hay không.

Lớp VPolygon
Lớp này tương tự như lớp VPolyline.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VPolygon(latlngs, lineColor?, lineWidth?, fillColor? opacity?, opts?)

Tạo polyline từ mảng các điểm. linecolor, fillcolor là chuỗi màu theo dạng số thập lục phân (#RRGGBB). lineWidth là chiều rộng (pixel) của đường thẳng. opacity là độ trong suốt (giá trị từ 0 đến 1).

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

getVertexCount()

Number

Trả về số đỉnh của polygon.

getVertex(index)

VLatLng

Trả về 1 đỉnh của polygon.

hide()

Không có

Ẩn polygon nếu đang hiện. Điều này sẽ làm phát sinh sự kiện VPolygon.visibilitychanged.

isHidden()

Boolean

Trả về true nếu polygon đang ẩn. Ngược lại trả về false.

show()

Không có

Hiện polygon nếu đang ẩn. Điều này sẽ làm phát sinh sự kiện VPolygon.visibilitychanged.

Các sự kiện

Các sự kiện

Đối số

Mô tả

remove

Không có

Sự kiện này phát sinh khi polygon bị xóa khỏi bản đồ dùng phương thức VMap.removeOverlay() hoặc VMap.clearOverlays().

visibilitychanged

isVisible

Sự kiện này phát sinh khi polygon đổi trạng thái từ ẩn sang hiện hay ngược lại. isVisible trả ra là trạng thái của polygon sau khi thay đổi.

click

latlng

Sự kiện này phát sinh khi polygon bị click.

Lớp VPolygonOptions
Thể hiện của lớp này được dùng trong phương thức khởi tạo của lớp VPolygon, xác định thuộc tính cho polygon.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

clickable

Boolean

Xác định polygon có được click hay không.

Lớp VIcon
Một icon xác định ảnh dùng để hiển thị cho marker trên bản đồ.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VIcon(icon?, iconSize?)

Tạo mới icon với ảnh truyền vào với kích thước xác định.

Constants

Constants

Mô tả

V_DEFAULT_ICON

Icon mặc định được sử dụng bởi marker.

Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

image

String

Đường dẫn ảnh dùng làm icon.

shadow

String

Đường dẫn ảnh dùng làm bóng của icon.

iconSize

VSize

Kích thước ảnh dùng làm icon.

shadowSize

VSize

Kích thước ảnh dùng làm bóng icon.

Các phương thức

vType()

String

Trả về tên lớp.

Lớp VPoint
VPoint biểu diễn 1 điểm (tọa độ màn hình) trên bản đồ.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VPoint(x, y)

Tạo 1 đối tượng VPoint.

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

equals(other)

Boolean

Trả về true nếu 2 điểm trùng nhau.

toString()

String

Trả về chuỗi biểu diễn của điểm này.

Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

x

Number

Tọa độ x (tăng khi qua phải).

y

Number

Tọa độ y (tăng khi đi xuống).

Lớp VSize
VSize biễu diễn kích thước (pixel) của 1 vùng hình chữ nhật trên bản đồ, có 2 tham số widthheight.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VSize(width, height)

Tạo 1 đối tượng VSize.

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

equals(other)

Boolean

Trả về true nếu 2 kích thước bằng nhau.

toString()

String

Trả về chuỗi biễu diễn kích thước này.

Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

width

Number

Chiều rộng.

height

Number

Chiều cao.

Lớp VLatLng
VLatLng là 1 điểm trong thế giới thực tính theo kinh vĩ độ.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VLatLng(lat, lng, unbounded?)

Lưu ý thứ tự latitude và longitude tương ứng với y và x.

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

equals(other)

Boolean

Trả về true nếu 2 điểm trùng nhau.

Lớp VLatLngBounds
VLatLngBounds biểu diễn khung hình chữ nhật ở tọa độ thực.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VLatLngBounds(nw?, se?)

Thiết lập khung chữ nhật với điểm tây bắc và đông nam.

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

equals(other)

Boolean

Trả về true nếu 2 khung trùng nhau.

getNorthWest()

VLatLng

Trả về điểm tây bắc của khung chữ nhật.

getSouthEast()

VLatLng

Trả về điểm đông nam của khung chữ nhật.

Giao diện VControl

Giao diện này được cài bởi tất cả điều khiển. Bạn có thể cài đặt giao diện này đễ tạo ra điều khiển của bạn. Các điều khiển được thêm vào bản đồ sử dụng phương thức VMap.addControl(). Khác với overlay, các điều khiển là cố định và không bị di chuyển khi bản đồ di chuyển.

Các phương thức trừu tượng

Các phương thức này được gọi bởi bản đồ khi điều khiển đã được thêm vào bản đồ bằng phương thức VMap.addControl(). Các phương thức này không dành cho bạn gọi nhưng chúng phải được bạn cài đặt nếu bạn muốn tạo điều khiển riêng.

Các phương thức

Giá trị trả về

Mô tả

initialize(map)

Không có

Sẽ được gọi bởi bản đồ để gắn điều khiển này vào bản đồ.

redraw()

Không có

Sẽ được gọi bởi bản đồ khi bản đồ cần xác định lại vị trí của điều khiển (khi bản đồ thay đổi kích thước).

remove()

Không có

Sẽ được gọi bởi bản đồ để xóa điều khiển này khỏi bản đồ.

getDefaultPosition()

VControlPosition

Trả về vị trí mặc định của điều khiển.

vType()

String

Trả về tên lớp.

Lớp VControlPosition
Lớp này biểu diễn vị trí của điều khiển trên bản đồ. Nó chỉ ra vị trí của điều khiển.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VControlPosition(anchor, offset)

Tạo 1 đối tượng VControlPosition.

Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

anchor

VAnchor

Xác định vị trí của điểu khiển.

offset

VSize

Xác định độ dời từ vị trí anchor.

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

vType()

String

Trả về tên lớp.

enum VAnchor
Constants

Constants

Mô tả

V_ANCHOR_TOP_RIGHT

Chỉ ra vị trí góc trên phải.

V_ANCHOR_CENTER_RIGHT

Chỉ ra vị trí góc giữa phải (không áp dụng cho điều khiển).

V_ANCHOR_BOTTOM_RIGHT

Chỉ ra vị trí góc dưới phải.

V_ANCHOR_BOTTOM_CENTER

Chỉ ra vị trí góc dưới giữa (không áp dụng cho điều khiển).

V_ANCHOR_BOTTOM_LEFT

Chỉ ra vị trí góc dưới trái.

V_ANCHOR_CENTER_LEFT

Chỉ ra vị trí góc giữa trái (không áp dụng cho điều khiển).

V_ANCHOR_TOP_LEFT

Chỉ ra vị trí góc trên trái.

V_ANCHOR_TOP_CENTER

Chỉ ra vị trí góc trên giữa (không áp dụng cho điều khiển).

V_ANCHOR_CENTER_CENTER

Chỉ ra vị trí góc giữa giữa (không áp dụng cho điều khiển).

Các lớp điều khiển
Các lớp này đều cài đặt giao diện VControl.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VSmallMapControl()

Tạo điều khiển với các nút di chuyển bản đồ 4 hướng, phóng to, thu nhỏ.

VLargeMapControl()

Tạo điều khiển với các nút di chuyển bản đồ 4 hướng, phóng to, thu nhỏ và thước.

VSmallZoomControl()

Tạo điều khiển với các nút phóng to, thu nhỏ.

VScaleControl()

Tạo điều khiển hiển thị tỷ lệ bản đồ.

VOverviewMapControl()

Tạo điều khiển hiển thị bản đồ nhỏ (có thể tắt mở) ở góc bản đồ thể hiện tổng quan vị trí hiện tại (ở mức cao hơn).

Lớp VEvent
Lớp này gồm các hàm đăng ký hàm quản lý sự kiện.
Các phương thức tĩnh

Các phương thức

Giá trị trả về

Mô tả

addListener(source, event, handler)

VEventListener

Đăng ký hàm quản lý sự kiện của đối tượng source. Trả về handle để có thể gỡ bỏ nó.

addDOMListener(source, event, handler)

VEventListener

Đăng ký hàm quản lý sự kiện của đối tượng source. source là 1 DOM Node. Trả về handle để có thể gỡ bỏ nó.

removeListener(handle)

Không có

Gỡ bỏ hàm quản lý sự kiện được thiết lập bằng hàm addListener() hoặc addDOMListener().

vType()

String

Trả về tên lớp.

Lớp VEventListener
Lớp này không có phương thức. Nó được trả ra từ phương thức VEvent.addListener() hoặc VEvent.addDOMListener() và được dùng cho VEvent.removeListener().
Hàm toàn cục VBrowserIsCompatible
Hàm này xác định trình duyệt người dùng có hỗ trợ Vietbando API không.
Hàm

Hàm

Giá trị trả về

Mô tả

VBrowserIsCompatible()

Boolean

Trả về true nếu trình duyệt người dùng hỗ trợ được Vietbando API.

Lớp VDirections
Lớp này dùng để tìm đường đi và hiển thị kết quả trên bản đồ.
Phương thức khởi tạo

Phương thức khởi tạo

Mô tả

VDirections(map?, panel?)

Tạo một thể hiện mới của đối tượng tìm đường, gửi yêu cầu tìm đường lên máy chủ Vietbando và lưu lại kết quả trả về. Đối tượng này có thể tìm đường sử dụng phương thức VDirections.load(). Phương thức khởi tạo nhận đối số là đối tượng bản đồ (dùng để vẽ đường đi bằng đối tượng polyline) và thẻ DIV (dùng để hiển thị kết quả). Nếu có truyền đối số map thì khi tìm đường đối tượng polyline và marker sẽ được tự động thêm vào bản đồ để hiển thị kết quả tìm đường. Tương tự, khi truyền đối số panel thì kết quả tìm đường dạng văn bản sẽ được hiển thị trong khung này.

Các phương thức

Các phương thức

Giá trị trả về

Mô tả

load(query, queryOpts)

Không có

Phương thức này thực hiện mới 1 truy vấn tìm đường. Đối số query là chuỗi chứa câu truy vấn tìm đường hợp lệ, ví dụ "from: Tp Hồ Chí Minh to: Hà Nội" hoặc "From: 21 Nguyễn Văn Trỗi, Phú Nhuận To: Vũng Tàu". Khi kết quả tìm đường trả về thì kết quả cũ được xóa đi, được thay bằng kết quả mới đồng thời cập nhật bản đồ và khung kết quả. Kết quả tìm đường bao gồm nhiều lộ trình (route - đối tượng của lớp VRoute), là 1 cặp địa chỉ (hay điểm) được xác định bởi câu truy vấn query. Lộ trình (route) lại gồm nhiều đoạn ngắn (step - đối tượng của lớp VStep). Nếu truy vấn tìm đường chưa hoàn thành mà có 1 truy vấn mới thì truy vấn cũ sẽ bị hủy. Bạn có thể sử dụng 1 đối tượng VDirections để thực hiện tuần tự các truy vấn, nhưng để thực hiện cùng lúc nhiều truy vấn thì bạn phải sử dụng nhiều đối tượng VDirections.

loadFromWayPoints(waypoints, queryOpts)

Không có

Tương tự hàm trên nhưng nhận dữ liệu vào là mảng các điểm tọa độ thực.

clear()

Không có

Xóa kết quả tìm đường (xóa overlay khỏi bản đồ và xóa nội dung khung kết quả) và hủy bỏ các request đang chờ.

getStatus()

Boolean

Trả về true nếu đang chờ kết quả tìm đường.

getBounds()

VLatLngBounds

Trả về khung bao của kết quả tìm đường, là đối tượng của lớp VLatLngBounds. Nếu không kết quả thì trả về null.

getNumRoutes()

Number

Trả về số lộ trình (route) của kết quả tìm đường. Nếu không có kết quả thì trả về 0.

getRoute(i)

VRoute

Trả về lộ trình (route) thứ i trong kết quả tìm đường trả về.

getSummaryHTML()

String

Trả về chuỗi HTML kết quả tìm đường.

getDistance()

String

Trả về chuỗi biểu diễn độ dài của đường đi trả về.

getMarker(i)

VMarker

Trả về marker thứ i. Phương thức này chỉ trả về giá trị khác null sau khi kết quả tìm đường được trả về.

Các sự kiện

Các sự kiện

Đối số

Mô tả

loaded

Không có

Sự kiện này phát sinh sau khi tìm đường xong.

Lớp VDirectionsOptions
Thể hiện của lớp này được dùng làm đối số queryOpts trong các phương thức load()loadFromWayPoints() của lớp VDirections.
Các thuộc tính

Các thuộc tính

Kiểu

Mô tả

getPolyline

Boolean

Xác định kết quả tìm đường có hiển thị dạng polyline trên bản đồ không.

getSteps

Boolean

Xác định kết quả tìm đường có hiển thị dạng danh sách không.

preserveViewport

Boolean

Xác định bản đồ có được tự động đưa về mức có thể nhìn thấy toàn bộ đường đi (khi tìm đường xong) không.

avoidAlley

Boolean

Xác định tìm đường có tránh hẻm không.

avoidRoadConstruction

Boolean

Xác định tìm đường có tránh các rào chắn thi công trên đường không.

Các phương thức

vType()

String

Trả về tên lớp.

Lớp VRoute
Lớp này được tạo bởi lớp VDirections dùng để lưu thông tin về 1 lộ trình (route) của kết quả tìm đường.
Các phương thức

Các phương thức

Giá trị trả về

Mô tả

getNumSteps()

Number

Trả về số đoạn nhỏ (step) trong lộ trình (route) này.

getStep(i)

VStep

Trả về đối tượng VStep thứ i trong lộ trình này.

getEndLatLng()

VLatLng

Trả về tọa độ thực của điểm cuối cùng trong lộ trình này.

getDistance()

String

Trả về độ dài của lộ trình (route) này.

Lớp VStep
Lớp này được tạo bởi lớp VDirections dùng để lưu thông tin về 1 đoạn ngắn (step) trong 1 lộ trình (route) của kết quả tìm đường.
Các phương thức

Các phương thức

Giá trị trả về

Mô tả

getLatLng()

VLatLng

Trả về điểm đầu tiên của đoạn ngắn (step) này.

getPolylineIndex()

Number

Trả về chỉ số của polyline.

getDescriptionHTML()

String

Trả về chuỗi HTML chỉ dẫn.

getDirection()

String

Trả về hướng đi vào đường này.

getDistance()

Object

Trả về chuỗi biểu diễn độ dài của đoạn ngắn (step) này.

Lớp VClientGeocoder
Lớp này được dùng để lấy về tọa độ thực trên bản đồ của 1 địa chỉ.
Các phương thức

Các phương thức

Giá trị trả về

Mô tả

getLatLng(address, callback)

Không có

Gửi yêu cầu tìm địa chỉ lên máy chủ vietbando. Nếu tìm thấy thì tọa độ thực của địa chỉ này sẽ được trả về cho hàm callback của người dùng.