Class PipelineLayer

管線圖層

Hierarchy

Accessors

boundary debugBoundingVolume debugNodeId name show tooltipSetting

Methods

addClipPolygon addEventListener enableOrderIndependentTransparency getAllClipPolygon getAttr getAttrs getColAndAttrs getHeader getOpacity getOrgFilter getPipelineAttrName getPipelineOrgName getTypeFilter goto makeProfile removeClipPolygon removeEventListener searchByDistance searchByInclude searchBySQL setAllowHoverEntity setAllowSelectEntity setDepthFunc setDrawAllFlow setDrawSelectedEntityOutline setEntityColor setEntityFlow setEntitySelected setExposure setFadeNearFar setFlowColorWeight setFlowSpeed setFlowTextureMaxDensity setFlowTypeFilter setFlowUseTexture setFreezeAdjust setFreezeCollapse setGamma setHide setHoverEntityHighlightColor setIsUnderground setLightAmbientColor setLightColor setOffset setOnClickEntity setOpacity setOrgFilter setOutlineColor setResolutionScale setRotate setScale setSelectedEntityHighlightColor setSelectedEntityOutlineWidth setShowUnderGroundCube setTooltipAttrName setTypeFilter setUnderGroundCubeTypeColor setUseFade setUseLight setZScale

Accessors

boundary

  • get boundary(): GeoBoundary

  • 取得圖層邊界。

    Returns GeoBoundary

debugBoundingVolume

  • get debugBoundingVolume(): boolean

  • 取得是否顯示除錯包圍體。

    Returns boolean

  • set debugBoundingVolume(value): void

  • 設定是否顯示除錯包圍體。

    Parameters

    • value: boolean

    Returns void

debugNodeId

  • get debugNodeId(): boolean

  • 取得是否顯示除錯節點Id。

    Returns boolean

  • set debugNodeId(value): void

  • 設定是否顯示除錯節點Id。

    Parameters

    • value: boolean

    Returns void

name

  • get name(): string

  • 取得圖層名稱 。

    Returns string

show

  • get show(): boolean

  • 取得是否顯示圖層。

    Returns boolean

  • set show(value): void

  • 設定是否顯示圖層。

    Parameters

    • value: boolean

    Returns void

tooltipSetting

Methods

addClipPolygon

  • addClipPolygon(polygon, mode): boolean

  • 在圖層上加入要裁切的區域。

    Parameters

    Returns boolean

    是否加入成功。

addEventListener

enableOrderIndependentTransparency

  • enableOrderIndependentTransparency(enable): void

  • 透明度是否使用 OIT 演算法，正確性較高但效能會降低。

    Parameters

    • enable: boolean

      啟用 OIT 透明。

    Returns void

getAllClipPolygon

  • getAllClipPolygon(): null | {
        mode: CLIP_MODE[];
        polygon: GeoPolygon[];
    }

  • 取得所有在圖層上的裁切區域。

    Returns null | {
        mode: CLIP_MODE[];
        polygon: GeoPolygon[];
    }

    裁切多邊形資訊。

    See

    addClipPolygon

getAttr

  • getAttr(param): void

  • 取得指定管線的指定屬性值。

    Parameters

    • param: {
          callback: ((attr) => void);
          fieldName: string;
          id: number;
      }

      參數。

      • callback: ((attr) => void)
          • (attr): void

          • 取得屬性後的回呼。

            Parameters

            • attr: unknown

            Returns void

      • fieldName: string

        欲取得的欄位。

      • id: number

        指定管線的ID。

    Returns void

getAttrs

  • getAttrs(param): void

  • 取得指定管線的所有屬性值。

    Parameters

    • param: {
          callback: ((attrs) => void);
          id: number;
      }

      參數。

      • callback: ((attrs) => void)
          • (attrs): void

          • 取得屬性後的回呼。

            Parameters

            • attrs: object

            Returns void

      • id: number

        指定管線的ID。

    Returns void

getColAndAttrs

  • getColAndAttrs(param): void

  • 取得指定圖素的所有屬性欄位名稱和屬性值。

    Parameters

    • param: {
          callback: ((ret) => void);
          id: number;
      }

      參數。

      • callback: ((ret) => void)
      • id: number

        指定建物的ID。

    Returns void

getHeader

  • getHeader(callback): void

  • 取得圖層標頭物件。

    Parameters

    • callback: ((header) => void)

      請求標頭物件的回呼，不給則同步回傳(不保證回傳速度)。

        • (header): void

        • Parameters

          • header: null | object

          Returns void

    Returns void

getOpacity

  • getOpacity(): number

  • 取得當前圖層不透明度。

    Returns number

    圖層不透明度 (0~1)。

getOrgFilter

  • getOrgFilter(): {
        [name: string]: boolean;
    }

  • 取得圖層管線管理單位篩選狀態。

    Returns {
        [name: string]: boolean;
    }

    圖層管線管理單位篩選狀態。

    • [name: string]: boolean

getPipelineAttrName

  • getPipelineAttrName(): string[]

  • 取得圖層屬性欄位名稱。

    Returns string[]

    圖層屬性欄位名稱清單。

getPipelineOrgName

  • getPipelineOrgName(): string[]

  • 取得圖層管理單位。

    Returns string[]

    圖層管理單位清單。

getTypeFilter

  • getTypeFilter(type): boolean

  • 取得圖層管線指定類型篩選狀態。

    Parameters

    • type: number

      指定的類型代碼。

    Returns boolean

    圖層指定管線類型篩選狀態。

goto

  • goto(callback?): void

  • 飛到圖層的位置。

    Parameters

    • Optional callback: (() => void)

      移動完成後執行的回呼。

        • (): void

        • Returns void

    Returns void

makeProfile

  • makeProfile(polyline, callback): void

  • 取得與指定線段相交的幾何剖面數據。

    Parameters

    Returns void

removeClipPolygon

  • removeClipPolygon(index?): boolean

  • 移除先前在圖層上的裁切區域。

    Parameters

    • Optional index: number

      索引，不填則全刪。

    Returns boolean

    是否刪除成功。

removeEventListener

searchByDistance

  • searchByDistance(epsg, geo, distance, sql, callback): void

  • 查詢在指定幾何範圍以內的圖素，並以SQL篩選。

    Parameters

    • epsg: number

      幾何的EPSG。

    • geo: GeoPolygon

      指定幾何。

    • distance: number

      指定距離，單位公尺。

    • sql: string

      SQL篩選條件

    • callback: PipelineSearchCallback

      查詢的回呼。

    Returns void

searchByInclude

  • searchByInclude(epsg, geo, sql, callback): void

  • 查詢被指定幾何包圍的圖素，並以SQL篩選。

    Parameters

    Returns void

searchBySQL

  • searchBySQL(sql, callback): void

  • 以SQL條件查詢圖層中的圖素。

    Parameters

    Returns void

setAllowHoverEntity

  • setAllowHoverEntity(allow): void

  • 設定圖層的圖素是否能Hover。

    Parameters

    • allow: boolean

      是否能Hover。

    Returns void

setAllowSelectEntity

  • setAllowSelectEntity(allow): void

  • 設定圖層的圖素是否能被選取。

    Parameters

    • allow: boolean

      是否能被點選。

    Returns void

setDepthFunc

  • setDepthFunc(depthFunc): void

  • 設置圖層深度測試的方式。

    Parameters

    • depthFunc: DEPTH_FUNC

      深度測試的方式。

    Returns void

setDrawAllFlow

  • setDrawAllFlow(enableDrawAll): void

  • 設定開啟流向全畫功能。

    Parameters

    • enableDrawAll: boolean

      是否開啟流向全畫功能。

    Returns void

setDrawSelectedEntityOutline

  • setDrawSelectedEntityOutline(isDraw): void

  • 設定圖層的圖素是否顯示outline。

    Parameters

    • isDraw: boolean

      是否顯示。

    Returns void

setEntityColor

  • setEntityColor(entityId, color?, mix?): void

  • 設定指定管線顏色。

    Parameters

    • entityId: number

      指定管線Id。

    • Optional color: null | ov.Color

      指定的顏色。

    • Optional mix: number

      指定的混色比例。

    Returns void

    Example

    pipelineLayer.setEntityColor(1234, "#FFFFFF", 1.0);    //管線變白色
    pipelineLayer.setEntityColor(1234, "#FFFFFF", 0.5);    //管線變原本的顏色與白色各半混色，比如這樣，管線會看起來有些像高亮
    pipelineLayer.setEntityColor(1234, null);              //清除管線的顏色設定
    pipelineLayer.setEntityColor(-1);                      //清除整張圖層的顏色設定

setEntityFlow

  • setEntityFlow(entityId, isDrawFlow?): void

  • 設定指定管線是否畫出流向，如有設定全畫ov.PipelineLayer#setDrawAllFlow則以全畫為主。

    Parameters

    • entityId: number

      指定管線Id。

    • isDrawFlow: boolean = false

      是否畫出流向。

    Returns void

    Example

    layer.setEntityFlow(9527, true);             //開啟指定管線的流向作畫
    layer.setEntityFlow(9527, false);            //關閉指定管線的流向作畫
    layer.setEntityFlow(-1);                     //清除整張圖層的流向設定

setEntitySelected

  • setEntitySelected(entityID): void

  • 設定圖素選取狀態。

    未選取則變成選取狀態。

    選取則變成未選取狀態。

    -1清除所有選取狀態。

    Parameters

    • entityID: number

      圖素ID。

    Returns void

setExposure

  • setExposure(exposure): void

  • 設定顏色曝光度。

    Parameters

    • exposure: number

      曝光度。

    Returns void

setFadeNearFar

  • setFadeNearFar(near, far): boolean

  • 設定圖層開始淡出與完全消失的距離。

    Parameters

    • near: number

      開始淡出的距離。

    • far: number

      完全消失的距離。

    Returns boolean

    設定是否成功，當 near > far 時，會失敗。

setFlowColorWeight

  • setFlowColorWeight(r, g, b): void

  • 設定流向箭頭顏色(0~1之間)。

    Parameters

    • r: number

      R通道值。

    • g: number

      G通道值。

    • b: number

      B通道值。

    Returns void

setFlowSpeed

  • setFlowSpeed(flowSpeed): void

  • 設定流向速度(預設1)。

    Parameters

    • flowSpeed: number

      流向速度。

    Returns void

setFlowTextureMaxDensity

  • setFlowTextureMaxDensity(x, y): void

  • 設定流向標示每根管線X，Y方向上貼圖數的最大值，設完後各管線可能會不等速流動。

    Parameters

    • x: number

      x方向貼圖數的最大值。

    • y: number

      y方向貼圖數的最大值。

    Returns void

setFlowTypeFilter

  • setFlowTypeFilter(enable, type): void

  • 設定流向管線指定類型篩選狀態。

    Parameters

    • enable: boolean

      設定這個管線類型的篩選狀態。

    • type: number

      指定的類型代碼。

    Returns void

setFlowUseTexture

  • setFlowUseTexture(flowUseTexture): void

  • 設定流向是否使用箭頭圖片。

    Parameters

    • flowUseTexture: boolean

      是否使用箭頭圖片。

    Returns void

setFreezeAdjust

  • setFreezeAdjust(freezeAdjust): void

  • 設定圖層是否暫停分裂。

    Parameters

    • freezeAdjust: boolean

      是否暫停分裂。

    Returns void

setFreezeCollapse

  • setFreezeCollapse(freezeCollapse): void

  • 設定圖層是否暫停收斂。

    Parameters

    • freezeCollapse: boolean

      是否暫停收斂。

    Returns void

setGamma

  • setGamma(gamma): void

  • 設定顏色伽碼值。

    Parameters

    • gamma: number

      伽碼值。

    Returns void

setHide

  • setHide(mode): void

  • 設定圖層隱藏模式。

    Parameters

    • mode: HIDE

      隱藏模式。

    Returns void

setHoverEntityHighlightColor

  • setHoverEntityHighlightColor(color, opacity): void

  • 設定圖層圖素的Hover高亮顏色。

    Parameters

    • color: ov.Color

      Hover高亮的顏色。

    • opacity: number

      不透明度。

    Returns void

setIsUnderground

  • setIsUnderground(isUnderground): void

  • 此設定影響圖資與地形的作畫順序

    Parameters

    • isUnderground: boolean

      是否在地底

    Returns void

setLightAmbientColor

  • setLightAmbientColor(lightAmbientColor): void

  • 設定環境光顏色。

    Parameters

    • lightAmbientColor: ov.Color

      環境光顏色。

    Returns void

setLightColor

  • setLightColor(lightColor): void

  • 設定光線顏色。

    Parameters

    • lightColor: ov.Color

      光線顏色。

    Returns void

setOffset

  • setOffset(x, y, z): boolean

  • 設定圖層的公尺平移量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。

    Parameters

    • x: number

      向東西方向偏移，單位為公尺。

    • y: number

      向南北方向偏移，單位為公尺。

    • z: number

      向垂直於地表方向偏移，單位為公尺。

    Returns boolean

    變換是否成功，某些圖層不支持此操作時返回false。

setOnClickEntity

  • setOnClickEntity(callback): void

  • 設定此圖層圖素被點擊時的回呼。

    Parameters

    • callback: ((id, pos) => void)

      圖素被點擊時的回呼，若輸入非function將被忽略，輸入null則清除設定。

        • (id, pos): void

        • Parameters

          Returns void

    Returns void

setOpacity

  • setOpacity(opacity): void

  • 設置圖層不透明度。

    Parameters

    • opacity: number

      圖層不透明度 (0~1)。

    Returns void

setOrgFilter

  • setOrgFilter(enable, org): void

  • 設定圖層管線管理單位篩選狀態

    Parameters

    • enable: boolean

      設定這張管線圖層是否要啟用管理單位篩選。

    • org: string

      指定要顯示的管理單位，最多16個。

    Returns void

setOutlineColor

  • setOutlineColor(visibleColor, hiddenColor): void

  • 設定選取圖層圖素的Outline顏色。

    Parameters

    • visibleColor: ov.Color

      outline可視的顏色。

    • hiddenColor: ov.Color

      outline不可視的顏色。

    Returns void

setResolutionScale

  • setResolutionScale(resolutionScale): void

  • 設定圖層解析度條件的 Scale 比例。

    Parameters

    • resolutionScale: number

      解析度條件的Scale比例(初始值 1，越大越容易分裂，模型越細緻)。

    Returns void

    是否設定成功。

setRotate

  • setRotate(degree): boolean

  • 設定圖層的旋轉量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。

    Parameters

    • degree: number

      旋轉角度。

    Returns boolean

    變換是否成功，某些圖層不支持此操作時返回 false。

setScale

  • setScale(scale): boolean

  • 設定圖層的縮放量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。

    Parameters

    • scale: number

      縮放比例。

    Returns boolean

    變換是否成功，某些圖層不支持此操作時返回false。

setSelectedEntityHighlightColor

  • setSelectedEntityHighlightColor(color, opacity): void

  • 設定圖層圖素的選取高亮顏色。

    Parameters

    • color: ov.Color

      選取高亮的顏色。

    • opacity: number

      不透明度。

    Returns void

setSelectedEntityOutlineWidth

  • setSelectedEntityOutlineWidth(width): void

  • 設定選取圖層圖素的Outline線寬。

    Parameters

    • width: number

      線寬。

    Returns void

setShowUnderGroundCube

  • setShowUnderGroundCube(enable): void

  • 設定是否繪製地下人手孔立方體光柱。

    Parameters

    • enable: boolean

      是否繪製。

    Returns void

setTooltipAttrName

  • setTooltipAttrName(name): void

  • 設定管線Tooltip要直接使用屬性欄位顯示，會取代Tooltip前處理函數。

    Parameters

    • name: string

      Tooltip要使用的屬性欄位名稱。

    Returns void

setTypeFilter

  • setTypeFilter(enable, type): void

  • 設定圖層管線指定類型篩選狀態。

    Parameters

    • enable: boolean

      設定這個管線類型的篩選狀態。

    • type: number

      指定的類型代碼。

    Returns void

setUnderGroundCubeTypeColor

  • setUnderGroundCubeTypeColor(type, color?, opacity?): void

  • 設定地下人手孔類型立方體光柱顏色。

    Parameters

    • type: number

      指定的類型代碼。

    • Optional color: ov.Color

      顏色。

    • Optional opacity: number

      不透明度。

    Returns void

setUseFade

  • setUseFade(useFade): void

  • 設定圖層是否開啟淡出功能。

    Parameters

    • useFade: boolean

      淡出開關。

    Returns void

setUseLight

  • setUseLight(useLight): void

  • 設定是否使用光線。

    Parameters

    • useLight: boolean

      是否使用光線。

    Returns void

setZScale

  • setZScale(zScale): boolean

  • 設定圖層的 ZScale。

    ZScale越小圖層越不會被遮擋。

    Parameters

    • zScale: number

      值。

    Returns boolean

    是否設定成功。

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc