Class Stencil

constructor

• new Stencil(eulerEngine: EulerGraph): Stencil

  Parameters

  • eulerEngine: EulerGraph

  Returns Stencil

ReadonlyeulerEngine

ReadonlyitemsMap

ReadonlylibGroups

draggingItem

• get draggingItem(): StencilItem | null

  Returns StencilItem | null

• set draggingItem(draggingItem: StencilItem | null): void

  Parameters

  • draggingItem: StencilItem | null

  Returns void

libs

• get libs(): Library<typeof BaseCell | typeof BaseLinear>[]

  Returns Library<typeof BaseCell | typeof BaseLinear>[]

createElement

• createElement(
      libName: string,
      name: string,
      options?: GraphicElementOptions & Record<string, unknown>,
  ): BaseCell | BaseLinear | null

  В указанной библиотеке находит и создает элемент, заданный в функции создания StencilItem.createLibElement. Перед началом работы с элементами библиотеки, их предварительно нужно загрузить методом Stencil.loadItemsByName()

  Parameters

  • libName: string
  • name: string
  • Optionaloptions: GraphicElementOptions & Record<string, unknown>

  Returns BaseCell | BaseLinear | null

dispose

• dispose(): void

  Returns void

getItemByName

• getItemByName(name: string): StencilItem | undefined

  Возвращает элемент по имени из всех загруженных библиотек. Библиотеку прдварительно нужно загрузить методом loadItemsByName()

  Parameters

  • name: string

  Returns StencilItem | undefined

getLibByName

• getLibByName(
      name: string,
  ): Library<typeof BaseCell | typeof BaseLinear> | undefined

  Parameters

  • name: string

  Returns Library<typeof BaseCell | typeof BaseLinear> | undefined

getRegisteredLibNames

• getRegisteredLibNames(): string[]

  Returns string[]

getSortedLibGroups

• getSortedLibGroups(): StencilGroup[]

  Returns StencilGroup[]

loadItemsByName

• loadItemsByName(name: string): Promise<void>

  Загружает массив items для отображения в библиотеке. Если либа предполагает загрузку и парсинг или что-то еще, это реализовывается в методе Library.load()

  Parameters

  • name: string

  Returns Promise<void>

loadLibs

• loadLibs(names?: string[]): void

  Загрузка библиотек. Если не переданы имена, загружаются зарегистрированные библиотеки.

  При этом items у них пустые, для загрузки items нужно использовать loadItemsByName(). Этот метод может быть тяжелым, поэтому есть смысл грузить только когда они нужны, например когда открыли аккордеон в UI или собрались пользоваться библиотекой

  Parameters

  • Optionalnames: string[]

  Returns void

register

• register(lib: Library<any>): void

  Регистрация библиотеки. Регистрируются в движке элементы из библиотеки, библиотека добавляется в общий набор, становится доступной для загрузки items, происходит сортировка в соответствии с Library.sortNumber.

  Этим методом подключается внешняя библиотека

  Parameters

  • lib: Library<any>

  Returns void

unloadLibs

• unloadLibs(names: string[]): void

  Parameters

  • names: string[]

  Returns void