Class PickModule

拾取模块

Hierarchy (view full)

AppModuleBase
- PickModule

Implements

IAppModuleBase

Constructors

constructor

new PickModule(app?): PickModule
Parameters
- Optional app: App
Returns PickModule
Overrides AppModuleBase.constructor

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

`Static` moduleName

moduleName: string = "PickModule"

Accessors

app

get app(): App
Returns App
Inherited from AppModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from AppModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from AppModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from AppModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase.enabled

isFreeStatus

get isFreeStatus(): boolean
Returns boolean
set isFreeStatus(v): void
Parameters
- v: boolean
Returns void

isFreeStatusRef

get isFreeStatusRef(): Ref<boolean>
Returns Ref<boolean>

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from AppModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from AppModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from AppModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from AppModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from AppModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase._setActive

actionDrawEdit

actionDrawEdit(opts?): Promise<unknown>
Parameters
- Optional opts: IDrawEditEnterOptions
Returns Promise<unknown>

actionDrawLineSting

actionDrawLineSting(opts?): Promise<unknown>
Parameters
- Optional opts: IDrawLineEnterOptions
Returns Promise<unknown>

actionDrawPoint

actionDrawPoint(opts?): Promise<unknown>
Parameters
- Optional opts: IDrawPointEnterOptions
Returns Promise<unknown>

actionDrawPolygon

actionDrawPolygon(opts?): Promise<unknown>
Parameters
- Optional opts: IDrawPolygonEnterOptions
Returns Promise<unknown>

actionPickSelect

actionPickSelect(opts?): Promise<unknown>
Parameters
- Optional opts: PickEnterOptions
Returns Promise<unknown>

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.addDispose

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from AppModuleBase.applyMixinsTo

destroy

destroy(): void
Destroy self.

Returns void
Inherited from AppModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from AppModuleBase.dispatch

drawSelectBox

drawSelectBox(style?, shiftSelectBox?): Promise<unknown>
Parameters
- Optional style: Record<string, any>
- Optional shiftSelectBox: boolean
Returns Promise<unknown>

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from AppModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from AppModuleBase.eventNames

getDrawLayer

getDrawLayer(layerName?, noCreateStyle?): {
    addPointData: ((data, addToCommand?) => SymbolEntity);
    addPolygonData: ((data, addToCommand?) => PolygonsEntity);
    addPolylineData: ((data, addToCommand?) => PolylinesEntity);
    deletePointData: ((data, addToCommand?) => boolean);
    deletePolygonData: ((data, addToCommand?) => boolean);
    deletePolylineData: ((data, addToCommand?) => boolean);
    polygons: (() => PolygonsEntity);
    polylines: (() => PolylinesEntity);
    symbol: (() => SymbolEntity);
    updatePointData: ((data, addToCommand?) => boolean);
    updatePolygonData: ((data, addToCommand?) => boolean);
    updatePolylineData: ((data, addToCommand?) => boolean);
}
Parameters
- Optional layerName: string
- Optional noCreateStyle: Record<string, any>
Returns {
    addPointData: ((data, addToCommand?) => SymbolEntity);
    addPolygonData: ((data, addToCommand?) => PolygonsEntity);
    addPolylineData: ((data, addToCommand?) => PolylinesEntity);
    deletePointData: ((data, addToCommand?) => boolean);
    deletePolygonData: ((data, addToCommand?) => boolean);
    deletePolylineData: ((data, addToCommand?) => boolean);
    polygons: (() => PolygonsEntity);
    polylines: (() => PolylinesEntity);
    symbol: (() => SymbolEntity);
    updatePointData: ((data, addToCommand?) => boolean);
    updatePolygonData: ((data, addToCommand?) => boolean);
    updatePolylineData: ((data, addToCommand?) => boolean);
}
- addPointData: ((data, addToCommand?) => SymbolEntity)
  - - (data, addToCommand?): SymbolEntity
    - Parameters
      data: SymbolItemData
      Optional addToCommand: boolean
      Returns SymbolEntity
- addPolygonData: ((data, addToCommand?) => PolygonsEntity)
  - - (data, addToCommand?): PolygonsEntity
    - Parameters
      data: PolygonItemData
      Optional addToCommand: boolean
      Returns PolygonsEntity
- addPolylineData: ((data, addToCommand?) => PolylinesEntity)
  - - (data, addToCommand?): PolylinesEntity
    - Parameters
      data: PolylineItemData
      Optional addToCommand: boolean
      Returns PolylinesEntity
- deletePointData: ((data, addToCommand?) => boolean)
  - - (data, addToCommand?): boolean
    - Parameters
      data: SymbolItemData
      Optional addToCommand: boolean
      Returns boolean
- deletePolygonData: ((data, addToCommand?) => boolean)
  - - (data, addToCommand?): boolean
    - Parameters
      data: PolygonItemData
      Optional addToCommand: boolean
      Returns boolean
- deletePolylineData: ((data, addToCommand?) => boolean)
  - - (data, addToCommand?): boolean
    - Parameters
      data: PolylineItemData
      Optional addToCommand: boolean
      Returns boolean
- polygons: (() => PolygonsEntity)
  - - (): PolygonsEntity
    - Returns PolygonsEntity
- polylines: (() => PolylinesEntity)
  - - (): PolylinesEntity
    - Returns PolylinesEntity
- symbol: (() => SymbolEntity)
  - - (): SymbolEntity
    - Returns SymbolEntity
- updatePointData: ((data, addToCommand?) => boolean)
  - - (data, addToCommand?): boolean
    - Parameters
      data: SymbolItemData
      Optional addToCommand: boolean
      Returns boolean
- updatePolygonData: ((data, addToCommand?) => boolean)
  - - (data, addToCommand?): boolean
    - Parameters
      data: PolygonItemData
      Optional addToCommand: boolean
      Returns boolean
- updatePolylineData: ((data, addToCommand?) => boolean)
  - - (data, addToCommand?): boolean
    - Parameters
      data: PolylineItemData
      Optional addToCommand: boolean
      Returns boolean

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from AppModuleBase.hasEvent

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from AppModuleBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from AppModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.on

onAwake

onAwake(): void
Returns void
Implementation of IAppModuleBase.onAwake

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.once

pickEntity

pickEntity(opts?): Promise<unknown>
拾取实体
Parameters
- Optional opts: PickEntityOptions
Returns Promise<unknown>

pickPoint

pickPoint(opts?): Promise<unknown>
拾取一个点
Parameters
- Optional opts: PickPointOptions
Returns Promise<unknown>

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from AppModuleBase.removeAllEventListeners

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.removeDispose

setupUiConfig

setupUiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>

Class PickModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional app: App

Returns PickModule

Properties

Optional _app

Protected _destroyed

appRenderIndex

data

Type declaration

[key: string]: any

extData

Type declaration

[key: string]: any

Readonly instanceId

onSetApp

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

isFreeStatus

Returns boolean

Parameters

v: boolean

Returns void

isFreeStatusRef

Returns Ref<boolean>

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

value: boolean

Returns void

actionDrawEdit

Parameters

Optional opts: IDrawEditEnterOptions

Returns Promise<unknown>

actionDrawLineSting

Parameters

Optional opts: IDrawLineEnterOptions

Returns Promise<unknown>

actionDrawPoint

Parameters

Optional opts: IDrawPointEnterOptions

Returns Promise<unknown>

actionDrawPolygon

Parameters

Optional opts: IDrawPolygonEnterOptions

Returns Promise<unknown>

actionPickSelect

Parameters

Optional opts: PickEnterOptions

`Optional` app: App

`Optional` _app

`Protected` _destroyed

`Readonly` instanceId

`Static` moduleName

`Optional` opts: IDrawEditEnterOptions

`Optional` opts: IDrawLineEnterOptions

`Optional` opts: IDrawPointEnterOptions

`Optional` opts: IDrawPolygonEnterOptions

`Optional` opts: PickEnterOptions

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any

`Optional` style: Record<string, any>

`Optional` shiftSelectBox: boolean

`Optional` layerName: string

`Optional` noCreateStyle: Record<string, any>

`Optional` addToCommand: boolean

`Optional` addToCommand: boolean

`Optional` addToCommand: boolean

`Optional` addToCommand: boolean

`Optional` addToCommand: boolean

`Optional` addToCommand: boolean