English

Tài liệu tra cứu Vietbando Maps API

1. 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ợ.

a. 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.

b. Các phương thức

i. Cấu hình

ii. Điều khiển

iii. Trạng thái bản đồ

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

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

vi. Cửa sổ

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

viii. Các sự kiện

2. 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 đồ.

3. 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 đồ.

4. 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ị.

5. 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ổ.

6. 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ổ.

7. 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ổ.

8. 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().

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

b. Các phương thức

c. Các sự kiện

9. 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.

10. 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.

11. 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.

12. 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.

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

b. Các phương thức

c. Các sự kiện

13. 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.

14. Lớp VPolygon

Lớp này tương tự như lớp VPolyline.

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

b. Các phương thức

c. Các sự kiện

15. 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.

16. Lớp VIcon

Một icon xác định ảnh dùng để hiển thị cho marker trên bản đồ.

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

b. Constants

c. Các thuộc tính

d. Các phương thức

17. Lớp VPoint

VPoint biểu diễn 1 điểm (tọa độ màn hình) trên bản đồ.

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

b. Các phương thức

c. Các thuộc tính

18. 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.

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

b. Các phương thức

c. Các thuộc tính

19. Lớp VLatLng

VLatLng là 1 điểm trong thế giới thực tính theo kinh vĩ độ.

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

b. Các phương thức

20. Lớp VLatLngBounds

VLatLngBounds biểu diễn khung hình chữ nhật ở tọa độ thực.

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

b. Các phương thức

21. 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.

22. 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.

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

b. Các thuộc tính

c. Các phương thức

23. 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).

24. 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).

25. 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.

26. 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().

27. 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.

28. Lớp VDirections

Lớp này dùng để tìm đường đi và hiển thị kết quả trên bản đồ.

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

b. Các phương thức

c. Các sự kiện

29. 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.

a. Các thuộc tính

b. Các phương thức

30. 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.

31. 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.

32. 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.