Class RenderOrderNode<E, T>

Type Parameters

E extends PubSubEvent = PubSubEvent
T extends Node<any, any> = Node<any, any>

Hierarchy

Node<E & RendererEventsType, T>
- RenderOrderNode
  - Layer
  - MxDbEntity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RenderOrderNode<E, T>(): RenderOrderNode<E, T>

Overrides Node.constructor
Type Parameters
- E extends PubSubEvent = PubSubEvent
- T extends Node<any, any, T> = Node<any, any>
Returns RenderOrderNode<E, T>

Properties

children

children: (T | RenderOrderNode<E, T>)[] = []

它的子节点集合

events

events: {}

Type declaration

[x: EventType]: Events[keyof Events][]

parent

parent: null | T | RenderOrderNode<E, T> = null

它的父节点

renderOrder

renderOrder: number = 30

显示顺序

Methods

add

add(...ages: (T | RenderOrderNode<E, T>)[]): RenderOrderNode<E, T>

Inherited from Node.add

添加子节点

Parameters
- Rest ...ages: (T | RenderOrderNode<E, T>)[]
Returns RenderOrderNode<E, T>

bottom

bottom(): void

bottom 同层级下最上层

Returns void

clear

clear(): RenderOrderNode<E, T>

Inherited from Node.clear

清除 children

Returns RenderOrderNode<E, T>

emit

emit<Key>(event: number | Key, ...data: Parameters<(E & RendererEventsType)[Key]>): void

Inherited from Node.emit

发布

Type Parameters
- Key extends string | number | symbol
Parameters
- event: number | Key
  
  — 事件名称
- Rest ...data: Parameters<(E & RendererEventsType)[Key]>
  
  — 载荷
Returns void

getNodeByProperty

getNodeByProperty<V>(name: string, value: V): undefined | T | RenderOrderNode<E, T>

Inherited from Node.getNodeByProperty
根据属性名称找到对应的Node节点
example
```
new Node().getNodeByProperty("id", "23548")
```
Type Parameters
- V = any
Parameters
- name: string
  
  属性名称
- value: V
  
  属性值
Returns undefined | T | RenderOrderNode<E, T>

getNodesByProperty

getNodesByProperty<V>(name: string, value: V): (T | RenderOrderNode<E, T>)[]

Inherited from Node.getNodesByProperty
根据属性名称找到对应的Node节点
example
```
new Node().getNodeByProperty("id", "23548")
```
Type Parameters
- V = any
Parameters
- name: string
  
  属性名称
- value: V
  
  属性值
Returns (T | RenderOrderNode<E, T>)[]

getRenderOrder

getRenderOrder(): number

得到显示顺序

Returns number
number

off

off<Key>(event: Key, callback?: (E & RendererEventsType)[keyof RendererEventsType | keyof E]): void

Inherited from Node.off

销毁事件

Type Parameters
- Key extends string | number | symbol
Parameters
- event: Key
  
  事件名称
- Optional callback: (E & RendererEventsType)[keyof RendererEventsType | keyof E]
  
  事件方法
Returns void

on

on<Key>(event: Key, callback: (E & RendererEventsType)[keyof RendererEventsType | keyof E]): void

Inherited from Node.on

订阅

Type Parameters
- Key extends string | number | symbol
Parameters
- event: Key
  
  事件名称
- callback: (E & RendererEventsType)[keyof RendererEventsType | keyof E]
  
  事件回调
Returns void

remove

remove(...ages: (T | RenderOrderNode<E, T>)[]): RenderOrderNode<E, T>

Inherited from Node.remove

移除子节点

Parameters
- Rest ...ages: (T | RenderOrderNode<E, T>)[]
Returns RenderOrderNode<E, T>

removeFromParent

removeFromParent(): RenderOrderNode<E, T>

Inherited from Node.removeFromParent

从父节点中移除

Returns RenderOrderNode<E, T>

restoreDefaultRenderOrder

restoreDefaultRenderOrder(): void

恢复默认显示顺序

Returns void

setRenderOrder

setRenderOrder(renderOrder: number): void

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

Parameters
- renderOrder: number
  
  显示顺序
Returns void

top

top(): void

top 同层级下最上层

Returns void

traverse

traverse(callback: ((node: RenderOrderNode<E, T>) => void)): void

Inherited from Node.traverse

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

Parameters
- callback: ((node: RenderOrderNode<E, T>) => void)
  
  回调函数
  - - (node: RenderOrderNode<E, T>): void
    - Parameters
      - node: RenderOrderNode<E, T>
      Returns void
Returns void

traverseParent

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

Inherited from Node.traverseParent

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

Type Parameters
- V extends Node<any, any, V> = RenderOrderNode<E, T>
Parameters
- callback: ((node: V) => boolean | void)
  
  回调函数，第一个参数是父节点, callback的返回值为false 将停止继续传递
  - - (node: V): boolean | void
    - Parameters
      - node: V
      Returns boolean | void
Returns void