Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphController<X, Y>

Type parameters

  • X = unknown

  • Y = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    • X = unknown

    • Y = unknown

    Returns GraphController<X, Y>

Properties

Readonly childMap

childMap: null | Dictionary<Controller>

Readonly children

children: readonly Controller[]

Optional Readonly contextType

contextType: Class<ControllerContext>

Readonly decoherent

decoherent: null | readonly Fastener<unknown>[]

Readonly executeProvider

Optional Readonly familyType

familyType: Class<Controller>

Readonly fasteners

fasteners: null | {}

Readonly flags

flags: number

Readonly graph

graph: TraitViewRef<GraphController<X, Y>, GraphTrait<X, Y>, GraphView<X, Y>>

Readonly historyProvider

Readonly key

key: undefined | string

Optional Readonly observerType

observerType: Class<GraphControllerObserver<X, Y, GraphController<X, Y>>>

Readonly observers

observers: readonly GraphControllerObserver<X, Y, GraphController<X, Y>>[]

Readonly parent

parent: null | Controller

Readonly plots

Readonly storageProvider

Readonly uid

uid: number

Static Readonly CompileMask

CompileMask: number

Static Readonly CompilingFlag

CompilingFlag: number

Static Readonly ContextualFlag

ContextualFlag: number

Static Readonly ExecuteMask

ExecuteMask: number

Static Readonly ExecutingFlag

ExecutingFlag: number

Static Readonly FlagMask

FlagMask: number

Static Readonly FlagShift

FlagShift: number

Static Readonly InsertChildFlags

InsertChildFlags: number

Static Readonly MountFlags

MountFlags: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly NeedsAssemble

NeedsAssemble: number

Static Readonly NeedsCompile

NeedsCompile: number

Static Readonly NeedsCompute

NeedsCompute: number

Static Readonly NeedsExecute

NeedsExecute: number

Static Readonly NeedsGenerate

NeedsGenerate: number

Static Readonly NeedsResolve

NeedsResolve: number

Static Readonly NeedsRevise

NeedsRevise: number

Static Readonly RemoveChildFlags

RemoveChildFlags: number

Static Readonly RemovingFlag

RemovingFlag: number

Static Readonly StatusMask

StatusMask: number

Static Readonly TraversingFlag

TraversingFlag: number

Static Readonly UpdateMask

UpdateMask: number

Static Readonly UpdatingMask

UpdatingMask: number

Static Readonly graph

graph: FastenerClass<TraitViewRef<GraphController<unknown, unknown>, GraphTrait<unknown, unknown>, GraphView<unknown, unknown>>>

Static Readonly plots

plots: FastenerClass<TraitViewControllerSet<GraphController<unknown, unknown>, PlotTrait<unknown, unknown>, PlotView<unknown, unknown>, PlotController<unknown, unknown>>>

Static uid

uid: () => number

Type declaration

    • (): number
    • Returns number

Accessors

childCount

  • get childCount(): number
  • Returns number

compiling

  • get compiling(): boolean
  • Returns boolean

controllerContext

  • Returns ControllerContextType<this>

executing

  • get executing(): boolean
  • Returns boolean

insertChildFlags

  • get insertChildFlags(): number
  • Returns number

mountFlags

  • get mountFlags(): number
  • Returns number

mounted

  • get mounted(): boolean
  • Returns boolean

removeChildFlags

  • get removeChildFlags(): number
  • Returns number

superControllerContext

  • Returns ControllerContext

traversing

  • get traversing(): boolean
  • Returns boolean

updating

  • get updating(): boolean
  • Returns boolean

Methods

appendChild

  • appendChild<C>(child: C, key?: string): C
  • appendChild<F>(factory: F, key?: string): InstanceType<F>
  • appendChild(child: AnyController<Controller>, key?: string): Controller
  • Type parameters

    Parameters

    • child: C
    • Optional key: string

    Returns C

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Controller

Protected attachFastener

  • attachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

attachParent

Protected bindChildFastener

Protected bindChildFasteners

Protected bindFastener

  • bindFastener(fastener: Fastener<unknown>): void
  • Parameters

    Returns void

callObservers

  • Type parameters

    • O

    • K: string | number | symbol

    Parameters

    Returns void

cascadeCompile

  • cascadeCompile(compileFlags: number, baseControllerContext: ControllerContext): void

cascadeExecute

  • cascadeExecute(executeFlags: number, baseControllerContext: ControllerContext): void

cascadeInsert

  • Parameters

    Returns void

cascadeMount

  • cascadeMount(): void
  • Returns void

cascadeUnmount

  • cascadeUnmount(): void

Protected compileChild

Protected compileChildren

decohereFastener

  • decohereFastener(fastener: Fastener<unknown>): void

Protected detachFastener

  • detachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

detachParent

Protected didAssemble

Protected didAttachFastener

  • didAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didAttachParent

Protected didCompile

  • Parameters

    Returns void

Protected didCompute

Protected didDetachFastener

  • didDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didDetachParent

Protected didExecute

  • Parameters

    Returns void

Protected didGenerate

Protected didInsertChild

Protected didMount

  • didMount(): void
  • Returns void

Protected didObserve

Protected didRemoveChild

Protected didResolve

Protected didRevise

Protected didUnmount

  • didUnmount(): void
  • Returns void

Protected didUnobserve

equals

  • equals(that: unknown): boolean
  • Parameters

    • that: unknown

    Returns boolean

Protected executeChild

Protected executeChildren

extendControllerContext

firstChild

forEachChild

  • forEachChild<T>(callback: (child: Controller) => void | T): undefined | T
  • forEachChild<T, S>(callback: (child: Controller) => void | T, thisArg: S): undefined | T
  • Type parameters

    • T

    Parameters

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    Returns undefined | T

forEachObserver

getBase

  • getBase<F>(baseBound: F): null | InstanceType<F>
  • Type parameters

    Parameters

    • baseBound: F

    Returns null | InstanceType<F>

getChild

  • getChild<F>(key: string, childBound: F): null | InstanceType<F>
  • getChild(key: string, childBound?: new (...args: any[]) => Controller): null | Controller
  • Type parameters

    Parameters

    • key: string
    • childBound: F

    Returns null | InstanceType<F>

  • Parameters

    • key: string
    • Optional childBound: new (...args: any[]) => Controller

    Returns null | Controller

getFastener

  • getFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>
  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getLazyFastener

  • getLazyFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getLazyFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>
  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getSuper

  • getSuper<F>(superBound: F): null | InstanceType<F>
  • Type parameters

    Parameters

    • superBound: F

    Returns null | InstanceType<F>

getSuperFastener

  • getSuperFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getSuperFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>
  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

hasFastener

  • hasFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): boolean
  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns boolean

hashCode

  • hashCode(): number
  • Returns number

init

  • Parameters

    Returns void

insertChild

  • Type parameters

    Parameters

    • child: C
    • target: null | Controller
    • Optional key: string

    Returns C

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • target: null | Controller
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Controller

Protected insertChildMap

lastChild

mount

  • mount(): void
  • Returns void

Protected mountChildren

  • mountChildren(): void
  • Returns void

Protected mountFasteners

  • mountFasteners(): void

Protected needsCompile

Protected needsExecute

Protected needsUpdate

  • needsUpdate(updateFlags: number, immediate: boolean): number
  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns number

nextChild

observe

Protected onAssemble

Protected onAttachFastener

  • onAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onAttachParent

Protected onCompile

  • Parameters

    Returns void

Protected onCompute

Protected onDetachFastener

  • onDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onDetachParent

Protected onExecute

  • Parameters

    Returns void

Protected onGenerate

Protected onInsertChild

Protected onMount

  • onMount(): void
  • Returns void

Protected onObserve

Protected onRemoveChild

Protected onResolve

Protected onRevise

Protected onUnmount

  • onUnmount(): void
  • Returns void

Protected onUnobserve

prependChild

  • prependChild<C>(child: C, key?: string): C
  • prependChild<F>(factory: F, key?: string): InstanceType<F>
  • prependChild(child: AnyController<Controller>, key?: string): Controller
  • Type parameters

    Parameters

    • child: C
    • Optional key: string

    Returns C

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Controller

previousChild

recohereFasteners

  • recohereFasteners(t?: number): void
  • Parameters

    • Optional t: number

    Returns void

remove

  • remove(): void
  • Returns void

removeChild

  • removeChild(key: string): null | Controller
  • removeChild<C>(child: C): C
  • Parameters

    • key: string

    Returns null | Controller

  • Type parameters

    Parameters

    • child: C

    Returns C

Protected removeChildMap

removeChildren

  • removeChildren(): void
  • Returns void

replaceChild

Protected replaceChildMap

requestUpdate

  • requestUpdate(target: Controller, updateFlags: number, immediate: boolean): void
  • Parameters

    • target: Controller
    • updateFlags: number
    • immediate: boolean

    Returns void

requireUpdate

  • requireUpdate(updateFlags: number, immediate?: boolean): void
  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

setChild

  • Type parameters

    Parameters

    • key: string
    • newChild: C

    Returns null | Controller

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • key: string
    • factory: F

    Returns null | Controller

  • Parameters

    Returns null | Controller

setFastener

  • setFastener(fastenerName: string, newFastener: null | Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • newFastener: null | Fastener<unknown>

    Returns void

setFlags

  • setFlags(flags: number): void
  • Parameters

    • flags: number

    Returns void

setKey

  • setKey(key: undefined | string): void
  • Parameters

    • key: undefined | string

    Returns void

Protected unbindChildFastener

Protected unbindChildFasteners

Protected unmountChildren

  • unmountChildren(): void
  • Returns void

Protected unmountFasteners

  • unmountFasteners(): void

unobserve

Protected willAssemble

Protected willAttachFastener

  • willAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willAttachParent

Protected willCompile

Protected willCompute

Protected willDetachFastener

  • willDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void
  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willDetachParent

Protected willExecute

Protected willGenerate

Protected willInsertChild

Protected willMount

  • willMount(): void
  • Returns void

Protected willObserve

Protected willRemoveChild

Protected willResolve

Protected willRevise

Protected willUnmount

  • willUnmount(): void
  • Returns void

Protected willUnobserve

Static create

  • create<S>(): InstanceType<S>
  • Type parameters

    • S: new () => InstanceType<S>

    Returns InstanceType<S>

Static fromAny

  • fromAny<S>(value: AnyController<InstanceType<S>>): InstanceType<S>
  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Parameters

    Returns InstanceType<S>

Static fromInit

  • fromInit<S>(init: InitType<InstanceType<S>>): InstanceType<S>
  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Parameters

    Returns InstanceType<S>

Generated using TypeDoc