Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GrimoireInterfaceImpl

Hierarchy

Implements

  • EventEmitter

Index

Constructors

constructor

Properties

addListener

addListener: function

Type declaration

    • (event: string | symbol, fn: ListenerFn, context?: any): this
    • Parameters

      • event: string | symbol
      • fn: ListenerFn
      • Optional context: any

      Returns this

componentDeclarations

componentDeclarations: NSDictionary<ComponentDeclaration> = new NSDictionary<ComponentDeclaration>()

componentDictionary

componentDictionary: object

Type declaration

converters

converters: NSDictionary<IAttributeConverterDeclaration> = new NSDictionary<IAttributeConverterDeclaration>()

debug

debug: boolean = true

emit

emit: function

Calls each of the listeners registered for a given event.

Type declaration

    • (event: string | symbol, ...args: Array<any>): boolean
    • Parameters

      • event: string | symbol
      • Rest ...args: Array<any>

      Returns boolean

eventNames

eventNames: function

Return an array listing the events for which the emitter has registered listeners.

Type declaration

    • (): Array<string | symbol>
    • Returns Array<string | symbol>

id

id: string

ID related to this instance to identify.

lib

lib: object

Type declaration

  • [key: string]: object
    • [key: string]: any
    • ___NAME__: string
    • ___VERSION__: string

Optional libraryPreference

libraryPreference: undefined | object

listeners

listeners: function & function

Return the listeners registered for a given event.

loadTasks

loadTasks: object[] = []

noConflictPreserve

noConflictPreserve: any

The object assigned to gr before loading grimoire.js

type

{any}

nodeDeclarations

nodeDeclarations: NSDictionary<NodeDeclaration> = new NSDictionary<NodeDeclaration>()

nodeDictionary

nodeDictionary: object

Type declaration

off

off: function

Type declaration

    • (event: string | symbol, fn?: ListenerFn, context?: any, once?: undefined | true | false): this
    • Parameters

      • event: string | symbol
      • Optional fn: ListenerFn
      • Optional context: any
      • Optional once: undefined | true | false

      Returns this

on

on: function

Add a listener for a given event.

Type declaration

    • (event: string | symbol, fn: ListenerFn, context?: any): this
    • Parameters

      • event: string | symbol
      • fn: ListenerFn
      • Optional context: any

      Returns this

once

once: function

Add a one-time listener for a given event.

Type declaration

    • (event: string | symbol, fn: ListenerFn, context?: any): this
    • Parameters

      • event: string | symbol
      • fn: ListenerFn
      • Optional context: any

      Returns this

removeAllListeners

removeAllListeners: function

Remove all listeners, or those of the specified event.

Type declaration

    • (event?: string | symbol): this
    • Parameters

      • Optional event: string | symbol

      Returns this

removeListener

removeListener: function

Remove the listeners of a given event.

Type declaration

    • (event: string | symbol, fn?: ListenerFn, context?: any, once?: undefined | true | false): this
    • Parameters

      • event: string | symbol
      • Optional fn: ListenerFn
      • Optional context: any
      • Optional once: undefined | true | false

      Returns this

rootNodes

rootNodes: object

Type declaration

Accessors

callInitializedAlready

  • get callInitializedAlready(): boolean

initializedEventHandler

  • get initializedEventHandler(): function[]

Methods

addRootNode

  • addRootNode(tag: HTMLScriptElement, rootNode: GomlNode): string
  • Add specified nodes as root node managed by Grimoire.js This method is typically used for internal.

    Parameters

    • tag: HTMLScriptElement

      the script element containing GOML source

    • rootNode: GomlNode

      root node of Goml

    Returns string

clear

  • clear(): void

extendGomlInterface

  • extendGomlInterface(name: string, func: Function): void

extendGrimoireInterface

  • extendGrimoireInterface(name: string, func: Function): void

extendNodeInterface

  • extendNodeInterface(name: string, func: Function): void

getCompanion

getRootNode

getTypeName

  • getTypeName(): string

initialize

  • initialize(): void

noConflict

  • noConflict(): void

notifyRegisteringPlugin

  • notifyRegisteringPlugin(namespace: string): void
  • use for notify GrimoireInterface of plugin namespace to be ragister. notified namespace will use when resolve loadTask of the plugin.

    Parameters

    • namespace: string

      namespace of plugin to be ragister.

    Returns void

ns

  • ns(ns: string): function

overrideDeclaration

queryRootNodes

  • queryRootNodes(query: string): GomlNode[]

register

  • register(loadTask: function): void

registerComponent

registerConverter

registerNode

resolvePlugins

  • resolvePlugins(): Promise<void>

toString

  • toString(): string
  • Obtain stringfied object. If this method was not overridden, this method return class name.

    Returns string

    stringfied object

Static getUniqueRandom

  • getUniqueRandom(length: number): string

Generated using TypeDoc