TGOS MAP API推廣版參考手冊
TGOnlineMap Class
| Constructor |
|---|
| TGOnlineMap(Node mapDiv,TGCoordSys coordSys, TGMapOptions opts) | 地圖物件，提供於指定之網頁容器內並建立地圖。 |
| Methods |
|---|
| [Method] Node getDiv() | 取得網頁中地圖物件之Div標籤。 |
| [Method] TGCoordSys getCoordSys() | 設定初始化底圖坐標系統。 |
| [Method] setOptions(TGMapOptions mapOptions) | 提供修改地圖的設定選項。 |
| [Method] fitBounds(TGEnvelope envelope) | 可傳入矩形幾何圖形（TGEnvelope），使地圖範圍邊框符合圖形之範圍。 |
| [Method] TGEnvelope getBounds() | 取得目前地圖展示之邊框範圍。 |
| [Method] TGPoint getCenter() | 取得螢幕上地圖中心點坐標。 |
| [Method] setCenter(TGPoint center) | 設定地圖的中心點。 |
| [Method] number getZoom() | 取得地圖目前縮放等級。 |
| [Method] setZoom(number zoom) | 設定地圖目前縮放等級。 |
| [Method] string getBackgroundColor() | 取得圖台背景顏色。 |
| [Method] setBackgroundColor(string backgroundColor) | 設定圖台背景顏色。 |
| [Method] panBy(number x, number y) | 依據傳入之距離值(x與y值)，進行地圖平移。 |
| [Method] panToBounds(TGEnvelope envelope) | 使用一矩形圖形作為邊界範圍，對地圖進行平移。 |
| Events |
|---|
| [Event] bounds_changed | 地圖邊界改變時事件觸發。 |
| [Event] center_changed | 地圖中心點改變事件觸發。 |
| [Event] zoom_changed | 地圖縮放事件觸發。 |
| [Event] tilesloaded | 讀取地圖快取圖磚事件時觸發。 |
| [MouseEvent] click | 在地圖上點擊滑鼠按鍵時觸發。 |
| [MouseEvent] mousemove | 滑鼠在地圖上移動時觸發。 |
| [MouseEvent] mouseout | 滑鼠離開地圖容器時觸發。 |
| [MouseEvent] mouseover | 滑鼠位於地圖容器上時觸發。 |
| [Event] projection_changed | 投影坐標的改變而觸發。 |
| [Event] dragstart | 滑鼠開始拖曳地圖時觸發。 |
| [Event] drag | 滑鼠拖曳地圖時重複觸發。 |
| [Event] dragend | 滑鼠拖曳地圖結束時觸發。 |
| [Event] idle | 滑鼠於地圖平移或縮放後停滯時觸發。 |
| [Event] resize | 地圖縮放後觸發。 |
| [MouseEvent] dblclick | 滑鼠雙點擊時觸發(click事件會在之前引發)。 |
| [MouseEvent] rightclick | 於地圖上點擊滑鼠右鍵時觸發。 |
TGMapOptions
| Properties |
|---|
| [Property] string backgroundColor | 地圖初始化時之背景顏色。 |
| [Property] TGPoint center | 地圖初始化時之中心坐標。 |
| [Property] boolean disableDefaultUI | 開啟或關閉預設的使用者介面。 |
| [Property] boolean scrollwheel | 開啟或關閉允許使用滑鼠滾輪控制地圖放大縮小。 |
| [Property] boolean navigationControl | 開啟或關閉導覽控制工具。 |
| [Property] NavigationControlOptions navigationControlOptions | 導覽控制工具之選項。 |
| [Property] boolean scaleControl | 開啟或關閉比例尺控制項。 |
| [Property] TGScaleControlOptions scaleControlOptions | 比例尺控制項之選項。 |
| [Property] boolean indexViewControl | 開啟或關閉索引圖控制項。 |
| [Property] TGIndexViewControlOptions indexViewControlOptions | 索引圖控制項之選項。 |
| [Property] boolean draggable | 地圖是否可被拖曳，預設為可拖曳。 |
| [Property] boolean keyboardShortcuts | 是否允許由鍵盤控制地圖，預設為開啟。 |
| [Property] boolean dbClickZoomIn | 是否允許滑鼠雙擊放大地圖，預設為開啟。 |
| [Property] string draggableCursor | 當游標於可拖曳之地圖上時，顯示不同游標，以網址及檔名取得圖片。 |
| [Property] string draggingCursor | 當地圖被拖曳時，顯示不同游標，以網址及檔名取得圖片。 |
| [Property] number maxZoom | 圖台顯示的最大縮放層級。若省略或設為null值，則預設為該底圖圖磚可顯示的最大縮放層級。 |
| [Property] number minZoom | 圖台顯示的最小縮放層級。若省略或設為null值，則預設為該底圖圖磚可顯示的最小縮放層級。 |
| [Property] TGEvelope mapBounds | 圖台可瀏覽操作範圍設定。 |
TGCoordSys
| Constant |
|---|
| EPSG3826 | TWD97坐標系統(台灣)。 |
| EPSG3857 | Google坐標系統。 |
| EPSG3825 | TWD97坐標系統(澎湖)。 |
TGMapTypeId
| Constant |
|---|
| TGOSMAP | TGOS MAP。 |
TGControlPosition
| Constant |
|---|
| BOTTOM_CENTER | 下方中間。 |
| BOTTOM_LEFT | 下方左邊。 |
| BOTTOM_RIGHT | 下方右邊。 |
| LEFT_BOTTOM | 左下方。 |
| LEFT_CENTER | 左邊中間。 |
| LEFT_TOP | 左上方。 |
| RIGHT_BOTTOM | 右下方。 |
| RIGHT_CENTER | 右邊中間。 |
| RIGHT_TOP | 右上方。 |
| TOP_CENTER | 上方中間。 |
| TOP_LEFT | 上方左邊。 |
| TOP_RIGHT | 上方右邊。 |
TGScaleControlOptions
| Properties |
|---|
| [Property] TGControlPosition controlPosition | 比例尺工具位置。 |
| [Property] TGScaleControlStyle scaleControlStyle | 比例尺工具樣式。 |
TGScaleControlStyle
| Constant |
|---|
| DEFAULT | 預設樣式。 |
TGMaxZoomLevel Class
| Methods |
|---|
| [Method] getMaxZoomLevel(TGMapTypeId mapTypeID, TGCoordSys coordSys callback:function(MaxZoomResult)) | 取得圖磚服務之最大層級。 |
TGIndexViewControl Class
| Methods |
|---|
| [Method] show(boolean show) | 顯示/隱藏索引視窗 (若為最小化狀態,可自動還原成正常狀態)。 |
| [Method] minimize() | 索引視窗最小化。 |
TGIndexViewControlOptions
| Constant |
|---|
| NORMAL | 正常索引視窗。 |
| MINIMIZED | 最小化索引視窗 (只有「還原」按鈕)。 |
TGEvent Class
TGMapsEventListener
| Methods |
|---|
| [Method] addDomListener(object instance, string eventName, Function handler,boolean capture) | 跨瀏覽器事件處理程序。 |
| [Method] addDomListenerOnce(object instance, string eventName, Function handler, boolean capture) | 第一個事件發生後移除事件監測。 |
| [Method] addListener(object instance, string eventName, Function handler) | 增加監聽器功能，賦予物件事件名稱。 |
| [Method] addListenerOnce(object instance, string eventName, Function handler) | 與增加監聽器功能一樣，但於第一個事件後會移除。 |
| [Method] clearInstanceListeners(object instance) | 移除所有事件之全部監聽器。 |
| [Method] clearListeners(object instance, string eventName) | 移除某事件之全部監聽器。 |
| [Method] removeListener(MapsEventListener listener) | 移除監聽器。 |
| [Method] trigger(object instance, string eventName, var_args*...) | 觸發特定事件。 |
TGMouseEvent
| Methods |
|---|
| [Method] stop() | 防止事件反覆發生。 |
| Properties |
|---|
| [Property] TGPoint point | 事件發生時，滑鼠游標所在位置坐標。 |
| [Property] object target | 取得滑鼠事件監聽器所指定之物件。 |
TGPoint Class
| Constructor |
|---|
| TGPoint(number x, number y) | 點圖徵幾何圖形物件。 |
| Methods |
|---|
| [Method] boolean isEmpty() | 回傳此點圖徵是否為空值。 |
| [Method] setEmpty() | 設定點圖徵為空值。 |
| [Method] boolean isSimple() | 回傳幾何圖形是否有異常，對於正常點圖形而言，其回傳值為True。 |
| [Method] transform(number eM11, number eM12, number eM21, number eM22, number eDx, number eDy) | 可透過2*3的二維矩陣，針對x、y值進行數值的轉換。 |
| Properties |
|---|
| [Property] TGEnvelope envelope | 取得此幾何圖形的外框。 |
| [Property] number x | 點圖徵的 x 坐標。 |
| [Property] number y | 點圖徵的 y 坐標。 |
TGImage Class
| Constructor |
|---|
| TGImage(string url, TGSize size, TGPoint origin, TGPoint anchor, TGSize scaledSize) | 圖片物件設定，可作為TGMarker的圖示。 |
| Methods |
|---|
| [Method] setUrl(string url) | 設定圖片網址。 |
| [Method] string getUrl() | 取得圖片網址。 |
| Properties |
|---|
| [Property] TGSize size | 圖片大小。 |
| [Property] TGSize scaledSize | 圖片縮放大小。 |
| [Property] TGPoint origin | 圖片原點位置。 |
| [Property] TGPoint anchor | 圖片錨點位置。 |
TGMarker Class
| Constructor |
|---|
| TGMarker(TGOnlnieMap map, TGPoint position, string title, TGImage icon, TGMarkerOptions opts?) | 建立標記點及選項設定，可於地圖上加入標記點。 |
| Methods |
|---|
| [Method] Map getMap() | 取得地圖物件。 |
| [Method] setMap(TGOnlineMap map) | 設定地圖物件，若輸入null值則為移除此物件。 |
| [Method] string getTitle() | 取得標記點標題名稱。 |
| [Method] setTitle(string title) | 設定標記點標題名稱。 |
| [Method] TGPoint getPosition() | 取得標記物件在地圖上位置。 |
| [Method] setPosition(TGPoint position) | 設定標記物件在地圖上之位置。 |
| [Method] TGPoint getInfoAnchorPoint() | 取得標記物件顯示訊息視窗的位置。 |
| [Method] setInfoAnchorPoint(TGPoint anchor) | 設定標記物件顯示訊息視窗的位置。 |
| [Method] TGImage getIcon() | 取得標記點所使用的圖片。 |
| [Method] setIcon(TGImage icon) | 設定標記點所使用的圖片。 |
| [Method] boolean getClickable() | 取得標記點是否允許被使用者點擊。 |
| [Method] setClickable(boolean clickable) | 設定標記點是否允許被使用者點擊。 |
| [Method] boolean getVisible() | 取得標記點是否為顯示狀態。 |
| [Method] setVisible(boolean visible) | 設定標記點是否為顯示狀態。 |
| [Method] string getCursor() | 取得滑鼠移動到標記點上方時游標圖形。 |
| [Method] setCursor(string cursor) | 設定滑鼠移動到標記點上方時游標圖形。 |
| [Method] number getZIndex() | 取得標記點之堆疊順序。 |
| [Method] setZIndex(number zIndex) | 設定標記點之堆疊順序。 |
| [Method] boolean getDraggable() | 取得標記點是否允許被使用者拖曳。 |
| [Method] setDraggable(boolean draggable) | 設定標記點是否允許被使用者拖曳。 |
| [Method] boolean getFlat() | 取得標記點是否有陰影。 |
| [Method] setFlat(boolean flat) | 設定標記點是否有陰影。 |
| [Method] TGImage getShadow() | 取得標記點的陰影圖片。 |
| [Method] setShadow(TGImage shadow) | 設定標記點的陰影圖片。 |
| Events |
|---|
| [Event] clickable_changed | 當標記點點擊之屬性改變時觸發事件。 |
| [Event] icon_changed | 當標記點之圖片改變時觸發事件。 |
| [Event] position_changed | 當標記點之位置改變時觸發事件。 |
| [Event] title_changed | 當標記點之標題名稱改變時觸發事件。 |
| [Event] visible_changed | 當標記點之顯示狀態改變時觸發事件。 |
| [Event] zindex_changed | 當標記點之堆疊順序改變時觸發事件。 |
| [MouseEvent] click | 標記點上使用滑鼠點擊時觸發事件。 |
| [MouseEvent] mousedown | 標記點上按下滑鼠時觸發事件。 |
| [MouseEvent] mouseup | 標記點上放開滑鼠按鍵時觸發事件。 |
| [MouseEvent] mouseover | 標記點上滑鼠移動至標記點時觸發事件。 |
| [MouseEvent] mouseout | 標記點上滑鼠移動離開標記點時觸發事件。 |
| [Event] cursor_changed | 游標設定改變時觸發事件。 |
| [Event] draggable_changed | 標記點拖曳設定改變時觸發事件。 |
| [Event] flat_changed | 標記點陰影顯示狀態改變時觸發事件。 |
| [Event] shadow_changed | 標記點陰影圖片設定改變時觸發事件。 |
| [MouseEvent] dblclick | 標記點上雙擊滑鼠時觸發事件。 |
| [MouseEvent] rightclick | 標記點上點擊滑鼠右鍵時觸發事件。 |
TGMarkerOptions
| Properties |
|---|
| [Property] string title | 標記點名稱。 |
| [Property] TGPoint position | 標記點位置。 |
| [Property] TGPoint infoAnchor | 標記點顯示訊息視窗之位置。 |
| [Property] boolean clickable | 標記點是否允許被點擊。 |
| [Property] boolean visible | 標記點是否顯示。 |
| [Property] string cursor | 滑鼠移動到此標記點上方時游標圖形。 |
| [Property] number zIndex | 標記點的堆疊順序。 |
| [Property] boolean draggable | 標記點是否允許被拖曳。 |
| [Property] boolean flat | 標記點是否顯示標記陰影。 |
| [Property] TGImage icon | 標記點的圖片。 |
| [Property] TGImage shadow | 標記點的陰影圖片。 |
TGSize Class
| Constructor |
|---|
| TGSize(number width, number height) | 表達2D大小的物件。 |
| Methods |
|---|
| [Method] boolean isEmpty() | 回傳物件是否為空值 |
| [Method] setEmpty() | 設定物件為空值。 |
| Properties |
|---|
| [Property] number width | 物件的寬度。 |
| [Property] number height | 物件的高度。 |
TGInfoWindow Class
| Constructor |
|---|
| TGInfoWindow(string content, TGPoint position, TGInfoWindowOptions opts) | 顯示於地圖中之訊息視窗物件。 |
| Methods |
|---|
| [Method] setOptions(TGInfoWindowOptions options) | 訊息視窗設定選項。 |
| [Method] open(Map map, TGPoint position) | 於地圖上的指定坐標位置開啟訊息視窗。 |
| [Method] close() | 關閉訊息視窗。 |
| [Method] Node getContentPanel() | 取得訊息視窗內容的DOM節點。 |
| [Method] TGPoint getPosition() | 取得訊息視窗之坐標位置。 |
| [Method] setPosition(TGPoint position) | 設定訊息視窗之坐標位置。 |
| [Method] setContent(string content) | 設定訊息視窗之文字。 |
| [Method] putOpacity(number opacity) | 設定訊息視窗的透明度，其值介於 0 - 1 之間。 |
| [Method] number getZIndex() | 取得訊息視窗的堆疊順序。 |
| [Method] setZIndex(number zIndex) | 設定訊息視窗的堆疊順序。 |
| Events |
|---|
| [Event] closeclick | 點擊關閉視窗時觸發事件。 |
| [Event] content_changed | 訊息視窗內容改變時觸發事件。 |
| [Event] position_changed | 訊息視窗坐標位置改變時觸發事件。 |
| [Event] zindex_changed | 訊息視窗堆疊順序改變時觸發事件。 |
| [Event] domready | 瀏覽器畫面資源加載前觸發事件。 |
TGInfoWindowOptions
| Properties |
|---|
| [Property] number maxWidth | 訊息視窗最大寬度。 |
| [Property] TGPoint position | 訊息視窗之坐標位置。 |
| [Property] TGSize pixelOffset | 訊息視窗位置與標記位置之位移量。 |
| [Property] number zIndex | 訊息視窗之堆疊順序。 |
| [Property] boolean disableAutoPan | 訊息視窗自動平移功能啟用或關閉。 |
| [Property] number opacity | 訊息視窗的透明度，其值介於 0 - 1 之間。 |
TGEnvelope Class
| Constructor |
|---|
| TGEnvelope(number left, number top, number right, number bottom) | 矩形圖徵幾何圖形物件。 |
| Methods |
|---|
| [Method] boolean isEmpty() | 回傳此圖徵是否為空值。 |
| [Method] setEmpty() | 將圖徵設為空值。 |
| [Method] TGSize getSize() | 取得圖徵大小。 |
| [Method] number getWidth() | 取得圖徵寬度。 |
| [Method] number getHeight() | 取得圖徵高度。 |
| [Method] number getLeft() | 取得左邊界。 |
| [Method] setLeft(number) | 設定左邊界。 |
| [Method] number getTop() | 取得上邊界。 |
| [Method] setTop(number) | 設定上邊界。 |
| [Method] number getRight() | 取得右邊界。 |
| [Method] setRight(number) | 設定右邊界。 |
| [Method] number getBottom() | 取得下邊界。 |
| [Method] setBottom(number) | 設定下邊界。 |
