cve-connector/types/controllers/point.d.ts

UE Web 开发套件

import type { PointData, PointStyle } from '../features/point'
import type { Selector } from '../features/query'
import type { UIDescriptor } from '../utils/matchmaker'

export type PointCommand =
  | 'AddPointTag'
  | 'CreatePoint'
  | 'DeletePoint'
  | 'HidePoint'
  | 'RemovePointTag'
  | 'RemovePointAllTags'
  | 'SelectPoint'
  | 'ShowPoint'
  | 'UpdatePoint'
  | 'UnselectPoint'

/** Point 控制 */
export interface PointController {
  /** 为 Point 添加Tag */
  addTag: (params: Selector, key: string, val: string) => Promise<UIDescriptor>

  /** 生成 Point */
  create: (points: PointData<PointStyle>[]) => Promise<UIDescriptor>

  /** 删除指定的 Point */
  delete: (params: Selector) => Promise<UIDescriptor>

  /** 隐藏指定的 Point */
  hide: (params: Selector) => Promise<UIDescriptor>

  /** 移除 Point 的Tag */
  removeTag: (params: Selector, key: string) => Promise<UIDescriptor>

  /** 移除 Point 的所有Tag */
  removeAllTags: (params: Selector) => Promise<UIDescriptor>

  /** 选择指定的 Point，注意同时只能选中一个 */
  select: (params: Selector) => Promise<UIDescriptor>

  /** 显示指定的 Point */
  show: (params: Selector) => Promise<UIDescriptor>

  /** 取消选择的 Point */
  unselect: () => Promise<UIDescriptor>

  /** 更新 Point 的补充参数 */
  update: (points: PointData<PointStyle>[]) => Promise<UIDescriptor>
}

export declare const PointController: PointController