Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layer

图层管理

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Layer(name?: string): Layer

Properties

Private _database

_database: MxDbDatabase

children

children: (MxDbEntity | Layer)[] = []

它的子节点集合

events

events: {}

Type declaration

isLayer

isLayer: boolean = true

name

name: string

parent

parent: null | MxDbEntity | Layer = null

它的父节点

renderOrder

renderOrder: number = 30

显示顺序

Accessors

visible

  • get visible(): boolean
  • set visible(val: boolean): void

  • Returns boolean

  • Parameters

    • val: boolean

    Returns void

Methods

add

  • 将MxDbEntity添加到层

    example
    new Layer().add(new MxDbLine(), new MxDbLine(), 3)

    Parameters

    • Rest ...entityList: MxDbEntity[]

      可以是id也可以是MxDbEntity实例

    Returns Layer

bottom

  • bottom(): void

Private callLayerContextFun

  • callLayerContextFun<T>(fun: Function): Promise<T>

  • Type Parameters

    • T = any

    Parameters

    • fun: Function

    Returns Promise<T>

clear

emit

getAllEntity

  • 获取该层包含的所有MxDbEntity

    Returns MxDbEntity[]

Private getCurrentName

  • getCurrentName(): any

  • Returns any

Private getDatabase

Private getEntityMap

  • getEntityMap(): Map<string, { userObject: MxDbEntity }>

Private getLayer

Private getLayerMap

  • getLayerMap(): Map<string, { group: Group; name: string }>

  • Returns Map<string, { group: Group; name: string }>

getNames

  • getNames(): string[]

  • 获取该数据库下的所有层的名称

    Returns string[]

getNodeByProperty

  • getNodeByProperty<V>(name: string, value: V): undefined | MxDbEntity | Layer

  • 根据属性名称找到对应的Node节点

    example
    new Node().getNodeByProperty("id", "23548")

    Type Parameters

    • V = any

    Parameters

    • name: string

      属性名称

    • value: V

      属性值

    Returns undefined | MxDbEntity | Layer

getNodesByProperty

  • 根据属性名称找到对应的Node节点

    example
    new Node().getNodeByProperty("id", "23548")

    Type Parameters

    • V = any

    Parameters

    • name: string

      属性名称

    • value: V

      属性值

    Returns (MxDbEntity | Layer)[]

getRenderOrder

  • getRenderOrder(): number

getRootLayerName

  • getRootLayerName(): string

  • 默认的层名称

    Returns string

off

  • off<Key>(event: Key, callback?: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)): void

  • 销毁事件

    Type Parameters

    Parameters

    • event: Key

      事件名称

    • Optional callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)

      事件方法

    Returns void

on

  • on<Key>(event: Key, callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)): void

  • 订阅

    Type Parameters

    Parameters

    • event: Key

      事件名称

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

      事件回调

    Returns void

remove

removeFromParent

  • removeFromParent(): Layer

restoreDefaultRenderOrder

  • restoreDefaultRenderOrder(): void

setRenderOrder

  • setRenderOrder(renderOrder: number): void

  • 设置显示顺序 (通过显示顺序控制图层)

    Parameters

    • renderOrder: number

      显示顺序

    Returns void

setVisible

  • setVisible(val: boolean): void

  • 设置层是否可见

    Parameters

    • val: boolean

    Returns void

top

  • top(): void

traverse

  • traverse(callback: ((node: Layer) => void)): void

  • 遍历它的所有子节点包括孙子节点，直到它包含的节点全部遍历完成并都执行传入的方法

    Parameters

    • callback: ((node: Layer) => void)

      回调函数

        • Parameters

          Returns void

    Returns void

traverseParent

  • traverseParent<V>(callback: ((node: V) => boolean | void)): void

  • 让它的父节点依次冒泡执行传入的方法的方法

    Type Parameters

    Parameters

    • callback: ((node: V) => boolean | void)

      回调函数，第一个参数是父节点, callback的返回值为false 将停止继续传递

        • (node: V): boolean | void

        • Parameters

          • node: V

          Returns boolean | void

    Returns void