Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DialTrait

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly key

key: undefined | string

Readonly label

label: TraitProperty<DialTrait, null | DialLabel, never>

Readonly legend

legend: TraitProperty<DialTrait, null | DialLegend, never>

Readonly limit

limit: TraitProperty<DialTrait, number, never>

Readonly model

model: null | Model

Readonly traitConsumers

traitConsumers: readonly unknown[]

Readonly traitDownlinks

traitDownlinks: null | {}

Readonly traitFasteners

traitFasteners: null | {}

Readonly traitFlags

traitFlags: number

Readonly traitModels

traitModels: null | {}

Readonly traitObservers

traitObservers: readonly DialTraitObserver<DialTrait>[]

Readonly traitProperties

traitProperties: null | {}

Readonly traitServices

traitServices: null | {}

Readonly value

value: TraitProperty<DialTrait, number, never>

Readonly warpRef

warpRef: ModelProperty<Model, null | WarpRef, never>

Readonly warpService

warpService: TraitService<DialTrait, WarpManager<Model>>

Static Readonly ConsumingFlag

ConsumingFlag: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly PoweredFlag

PoweredFlag: number

Static Readonly insertChildFlags

insertChildFlags: number

Static Readonly insertTraitFlags

insertTraitFlags: number

Static Readonly mountFlags

mountFlags: number

Static Readonly powerFlags

powerFlags: number

Static Readonly removeChildFlags

removeChildFlags: number

Static Readonly removeTraitFlags

removeTraitFlags: number

Static Readonly startConsumingFlags

startConsumingFlags: number

Static Readonly stopConsumingFlags

stopConsumingFlags: number

Accessors

childModelCount

  • get childModelCount(): number

  • Returns number

childModels

  • get childModels(): readonly Model[]

  • Returns readonly Model[]

insertChildFlags

  • get insertChildFlags(): number

  • Returns number

insertTraitFlags

  • get insertTraitFlags(): number

  • Returns number

modelContext

modelFlags

  • get modelFlags(): number

  • Returns number

mountFlags

  • get mountFlags(): number

  • Returns number

parentModel

  • get parentModel(): null | Model

  • Returns null | Model

powerFlags

  • get powerFlags(): number

  • Returns number

removeChildFlags

  • get removeChildFlags(): number

  • Returns number

removeTraitFlags

  • get removeTraitFlags(): number

  • Returns number

startConsumingFlags

  • get startConsumingFlags(): number

  • Returns number

stopConsumingFlags

  • get stopConsumingFlags(): number

  • Returns number

traitCount

  • get traitCount(): number

  • Returns number

traits

  • get traits(): readonly Trait[]

  • Returns readonly Trait[]

Methods

addTraitConsumer

  • addTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

addTraitObserver

Protected analyzeChildModels

  • analyzeChildModels(analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void, analyzeChildModels: (analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void) => void): void

  • Parameters

    • analyzeFlags: number
    • modelContext: ModelContext
    • analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void
    • analyzeChildModels: (analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void) => void
        • (analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void): void

        • Parameters

          Returns void

    Returns void

appendChildModel

  • appendChildModel(childModel: Model, key?: string): void

  • Parameters

    • childModel: Model
    • Optional key: string

    Returns void

appendTrait

  • appendTrait(trait: Trait, key?: string): void

  • Parameters

    • trait: Trait
    • Optional key: string

    Returns void

Protected attachModel

  • attachModel(newModel: Model): void

  • Parameters

    Returns void

Protected attachParentModel

  • attachParentModel(parentModel: Model): void

Protected attachTraitServices

  • attachTraitServices(): void

Protected detachModel

  • detachModel(oldModel: Model): void

  • Parameters

    Returns void

Protected detachParentModel

  • detachParentModel(parentModel: Model): void

Protected detachTraitServices

  • detachTraitServices(): void

Protected didAddTraitConsumer

  • didAddTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected didAddTraitObserver

Protected didAggregate

Protected didAnalyze

  • didAnalyze(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didAnalyzeChildModel

  • didAnalyzeChildModel(childModel: Model, analyzeFlags: number, modelContext: ModelContext): void

Protected didAnalyzeChildModels

  • didAnalyzeChildModels(analyzeFlags: number, modelContext: ModelContext): void

Protected didCorrelate

Protected didInsertChildModel

  • didInsertChildModel(childModel: Model, targetModel: null | Model): void

Protected didInsertTrait

  • didInsertTrait(trait: Trait, targetTrait: null | Trait): void

  • Parameters

    Returns void

Protected didMount

  • didMount(): void

  • Returns void

Protected didMutate

Protected didObserve

Protected didPower

  • didPower(): void

  • Returns void

Protected didReconcile

Protected didRefresh

  • didRefresh(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didRefreshChildModel

  • didRefreshChildModel(childModel: Model, refreshFlags: number, modelContext: ModelContext): void

Protected didRefreshChildModels

  • didRefreshChildModels(refreshFlags: number, modelContext: ModelContext): void

Protected didRemoveChildModel

  • didRemoveChildModel(childModel: Model): void

Protected didRemoveTrait

  • didRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected didRemoveTraitConsumer

  • didRemoveTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected didRemoveTraitObserver

Protected didRequestUpdate

  • didRequestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

Protected didRequireUpdate

  • didRequireUpdate(updateFlags: number, immediate: boolean): void

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns void

Protected didSetLabel

  • Parameters

    Returns void

Protected didSetLegend

  • Parameters

    Returns void

Protected didSetLimit

  • didSetLimit(newLimit: number, oldLimit: number): void

  • Parameters

    • newLimit: number
    • oldLimit: number

    Returns void

Protected didSetModel

  • didSetModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Protected didSetParentModel

  • didSetParentModel(newParentModel: null | Model, oldParentModel: null | Model): void

  • Parameters

    • newParentModel: null | Model
    • oldParentModel: null | Model

    Returns void

Protected didSetValue

  • didSetValue(newValue: number, oldValue: number): void

  • Parameters

    • newValue: number
    • oldValue: number

    Returns void

Protected didStartConsuming

  • didStartConsuming(): void

Protected didStopConsuming

  • didStopConsuming(): void

Protected didUnmount

  • didUnmount(): void

  • Returns void

Protected didUnpower

  • didUnpower(): void

  • Returns void

Protected didValidate

doMount

  • doMount(): void

  • Returns void

doPower

  • doPower(): void

  • Returns void

doUnmount

  • doUnmount(): void

  • Returns void

doUnpower

  • doUnpower(): void

  • Returns void

firstChildModel

  • firstChildModel(): null | Model

firstTrait

  • firstTrait(): null | Trait

  • Returns null | Trait

forEachChildModel

  • forEachChildModel<T>(callback: (childModel: Model) => void | T): undefined | T
  • forEachChildModel<T, S>(callback: (childModel: Model) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (childModel: Model) => void | T
        • (childModel: Model): void | T

        • Parameters

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (childModel: Model) => void | T
        • (childModel: Model): void | T

        • Parameters

          Returns void | T

    • thisArg: S

    Returns undefined | T

forEachTrait

  • forEachTrait<T>(callback: (trait: Trait) => void | T): undefined | T
  • forEachTrait<T, S>(callback: (trait: Trait) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (trait: Trait) => void | T
        • (trait: Trait): void | T

        • Parameters

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (trait: Trait) => void | T
        • (trait: Trait): void | T

        • Parameters

          Returns void | T

    • thisArg: S

    Returns undefined | T

formatLabel

  • formatLabel(value: number, limit: number): undefined | string

  • Parameters

    • value: number
    • limit: number

    Returns undefined | string

formatLegend

  • formatLegend(value: number, limit: number): undefined | string

  • Parameters

    • value: number
    • limit: number

    Returns undefined | string

getBaseModel

  • getBaseModel<M>(modelClass: ModelClass<M>): null | M

  • Type parameters

    Parameters

    Returns null | M

getBaseTrait

  • getBaseTrait<R>(traitClass: TraitClass<R>): null | R

  • Type parameters

    Parameters

    Returns null | R

getChildModel

  • getChildModel(key: string): null | Model

  • Parameters

    • key: string

    Returns null | Model

getLazyModelDownlink

getLazyTraitFastener

getLazyTraitModel

getLazyTraitProperty

getLazyTraitService

getModelDownlink

getModelProperty

getSuperModel

  • getSuperModel<M>(modelClass: ModelClass<M>): null | M

getSuperTrait

  • getSuperTrait<R>(traitClass: TraitClass<R>): null | R

getTrait

  • Parameters

    • key: string

    Returns null | Trait

  • Type parameters

    Parameters

    Returns null | R

  • Parameters

    Returns null | Trait

getTraitFastener

getTraitModel

getTraitProperty

getTraitService

hasModelDownlink

  • hasModelDownlink(downlinkName: string): boolean

  • Parameters

    • downlinkName: string

    Returns boolean

hasModelProperty

  • hasModelProperty(propertyName: string): boolean

  • Parameters

    • propertyName: string

    Returns boolean

hasTraitFastener

  • hasTraitFastener(fastenerName: string): boolean

  • Parameters

    • fastenerName: string

    Returns boolean

hasTraitModel

  • hasTraitModel(fastenerName: string): boolean

  • Parameters

    • fastenerName: string

    Returns boolean

hasTraitProperty

  • hasTraitProperty(propertyName: string): boolean

  • Parameters

    • propertyName: string

    Returns boolean

hasTraitService

  • hasTraitService(serviceName: string): boolean

  • Parameters

    • serviceName: string

    Returns boolean

insertChildModel

  • insertChildModel(childModel: Model, targetModel: null | Model, key?: string): void

  • Parameters

    • childModel: Model
    • targetModel: null | Model
    • Optional key: string

    Returns void

insertTrait

  • insertTrait(trait: Trait, targetTrait: null | Trait, key?: string): void

  • Parameters

    • trait: Trait
    • targetTrait: null | Trait
    • Optional key: string

    Returns void

Protected insertTraitFastener

  • insertTraitFastener(trait: Trait, targetTrait: null | Trait): void

Protected insertTraitModel

  • insertTraitModel(childModel: Model, targetModel: null | Model): void

  • Parameters

    Returns void

isAnalyzing

  • isAnalyzing(): boolean

  • Returns boolean

isConsuming

  • isConsuming(): boolean

  • Returns boolean

isMounted

  • isMounted(): boolean

  • Returns boolean

isPowered

  • isPowered(): boolean

  • Returns boolean

isRefreshing

  • isRefreshing(): boolean

  • Returns boolean

isTraversing

  • isTraversing(): boolean

  • Returns boolean

isUpdating

  • isUpdating(): boolean

  • Returns boolean

lastChildModel

  • lastChildModel(): null | Model

lastTrait

  • lastTrait(): null | Trait

  • Returns null | Trait

Protected mountTraitDownlinks

  • mountTraitDownlinks(): void

Protected mountTraitFasteners

  • mountTraitFasteners(): void

Protected mountTraitModels

  • mountTraitModels(): void

  • Returns void

Protected mountTraitProperties

  • mountTraitProperties(): void

mutateTraitProperties

  • mutateTraitProperties(): void

needsAnalyze

  • needsAnalyze(analyzeFlags: number, modelContext: ModelContext): number

  • Parameters

    Returns number

needsRefresh

  • needsRefresh(refreshFlags: number, modelContext: ModelContext): number

  • Parameters

    Returns number

nextChildModel

  • nextChildModel(targetModel: Model): null | Model

nextTrait

  • Parameters

    Returns null | Trait

Protected onAddTraitConsumer

  • onAddTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected onAddTraitObserver

Protected onAggregate

Protected onAnalyze

  • onAnalyze(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onAnalyzeChildModel

  • onAnalyzeChildModel(childModel: Model, analyzeFlags: number, modelContext: ModelContext): void

Protected onAnalyzeChildModels

  • onAnalyzeChildModels(analyzeFlags: number, modelContext: ModelContext): void

Protected onCorrelate

Protected onInsertChildModel

  • onInsertChildModel(childModel: Model, targetModel: null | Model): void

  • Parameters

    Returns void

Protected onInsertTrait

  • onInsertTrait(trait: Trait, targetTrait: null | Trait): void

  • Parameters

    Returns void

Protected onMount

  • onMount(): void

  • Returns void

Protected onMutate

  • Parameters

    Returns void

Protected onPower

  • onPower(): void

  • Returns void

Protected onReconcile

  • Parameters

    Returns void

Protected onRefresh

  • onRefresh(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onRefreshChildModel

  • onRefreshChildModel(childModel: Model, refreshFlags: number, modelContext: ModelContext): void

Protected onRefreshChildModels

  • onRefreshChildModels(refreshFlags: number, modelContext: ModelContext): void

Protected onRemoveChildModel

  • onRemoveChildModel(childModel: Model): void

  • Parameters

    Returns void

Protected onRemoveTrait

  • onRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected onRemoveTraitConsumer

  • onRemoveTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected onRemoveTraitObserver

Protected onRequestUpdate

  • onRequestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

Protected onRequireUpdate

  • onRequireUpdate(updateFlags: number, immediate: boolean): void

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns void

Protected onSetLabel

  • Parameters

    Returns void

Protected onSetLegend

  • Parameters

    Returns void

Protected onSetLimit

  • onSetLimit(newLimit: number, oldLimit: number): void

  • Parameters

    • newLimit: number
    • oldLimit: number

    Returns void

Protected onSetModel

  • onSetModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Protected onSetParentModel

  • onSetParentModel(newParentModel: null | Model, oldParentModel: null | Model): void

  • Parameters

    • newParentModel: null | Model
    • oldParentModel: null | Model

    Returns void

Protected onSetValue

  • onSetValue(newValue: number, oldValue: number): void

  • Parameters

    • newValue: number
    • oldValue: number

    Returns void

Protected onStartConsuming

  • onStartConsuming(): void

  • Returns void

Protected onStopConsuming

  • onStopConsuming(): void

  • Returns void

Protected onUnmount

  • onUnmount(): void

  • Returns void

Protected onUnpower

  • onUnpower(): void

  • Returns void

Protected onValidate

prependChildModel

  • prependChildModel(childModel: Model, key?: string): void

  • Parameters

    • childModel: Model
    • Optional key: string

    Returns void

prependTrait

  • prependTrait(trait: Trait, key?: string): void

  • Parameters

    • trait: Trait
    • Optional key: string

    Returns void

previousChildModel

  • previousChildModel(targetModel: Model): null | Model

previousTrait

Protected reconcileTraitDownlinks

  • reconcileTraitDownlinks(): void

Protected refreshChildModels

  • refreshChildModels(refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void, refreshChildModels: (refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void) => void): void

  • Parameters

    • refreshFlags: number
    • modelContext: ModelContext
    • refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void
    • refreshChildModels: (refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void) => void
        • (refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void): void

        • Parameters

          Returns void

    Returns void

remove

  • remove(): void

  • Returns void

removeChildModel

  • removeChildModel(key: string): null | Model
  • removeChildModel(childModel: Model): void

removeTrait

  • removeTrait(key: string): null | Trait
  • removeTrait(trait: Trait): void

  • Parameters

    • key: string

    Returns null | Trait

  • Parameters

    Returns void

removeTraitConsumer

  • removeTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected removeTraitFastener

  • removeTraitFastener(trait: Trait): void

Protected removeTraitModel

  • removeTraitModel(childModel: Model): void

  • Parameters

    Returns void

removeTraitObserver

requestUpdate

  • requestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

requireUpdate

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

  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

setChildModel

  • setChildModel(key: string, newChildModel: null | Model): null | Model

  • Parameters

    • key: string
    • newChildModel: null | Model

    Returns null | Model

setKey

  • setKey(key: undefined | string): void

  • Parameters

    • key: undefined | string

    Returns void

setModel

  • setModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

setModelDownlink

setModelFlags

  • setModelFlags(modelFlags: number): void

  • Parameters

    • modelFlags: number

    Returns void

setModelProperty

  • setModelProperty(propertyName: string, newModelProperty: null | ModelProperty<Model, unknown, never>): void

  • Parameters

    Returns void

setTrait

  • setTrait(key: string, newTrait: null | Trait): null | Trait

  • Parameters

    • key: string
    • newTrait: null | Trait

    Returns null | Trait

setTraitFastener

setTraitFlags

  • setTraitFlags(traitFlags: number): void

  • Parameters

    • traitFlags: number

    Returns void

setTraitModel

  • setTraitModel(fastenerName: string, newTraitModel: null | TraitModel<DialTrait, any, never>): void

  • Parameters

    Returns void

setTraitProperty

  • setTraitProperty(propertyName: string, newTraitProperty: null | TraitProperty<DialTrait, unknown, never>): void

setTraitService

Protected startConsuming

  • startConsuming(): void

  • Returns void

Protected startConsumingTraitDownlinks

  • startConsumingTraitDownlinks(): void

Protected stopConsuming

  • stopConsuming(): void

  • Returns void

Protected stopConsumingTraitDownlinks

  • stopConsumingTraitDownlinks(): void

Protected unmountTraitDownlinks

  • unmountTraitDownlinks(): void

Protected unmountTraitFasteners

  • unmountTraitFasteners(): void

Protected unmountTraitModels

  • unmountTraitModels(): void

Protected unmountTraitProperties

  • unmountTraitProperties(): void

Protected willAddTraitConsumer

  • willAddTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected willAddTraitObserver

Protected willAggregate

Protected willAnalyze

  • willAnalyze(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willAnalyzeChildModel

  • willAnalyzeChildModel(childModel: Model, analyzeFlags: number, modelContext: ModelContext): void

Protected willAnalyzeChildModels

  • willAnalyzeChildModels(analyzeFlags: number, modelContext: ModelContext): void

Protected willCorrelate

Protected willInsertChildModel

  • willInsertChildModel(childModel: Model, targetModel: null | Model): void

Protected willInsertTrait

  • willInsertTrait(trait: Trait, targetTrait: null | Trait): void

Protected willMount

  • willMount(): void

  • Returns void

Protected willMutate

Protected willObserve

Protected willPower

  • willPower(): void

  • Returns void

Protected willReconcile

Protected willRefresh

  • willRefresh(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willRefreshChildModel

  • willRefreshChildModel(childModel: Model, refreshFlags: number, modelContext: ModelContext): void

Protected willRefreshChildModels

  • willRefreshChildModels(refreshFlags: number, modelContext: ModelContext): void

Protected willRemoveChildModel

  • willRemoveChildModel(childModel: Model): void

Protected willRemoveTrait

  • willRemoveTrait(trait: Trait): void

Protected willRemoveTraitConsumer

  • willRemoveTraitConsumer(traitConsumer: unknown): void

Protected willRemoveTraitObserver

Protected willRequestUpdate

  • willRequestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

Protected willRequireUpdate

  • willRequireUpdate(updateFlags: number, immediate: boolean): void

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns void

Protected willSetLabel

  • Parameters

    Returns void

Protected willSetLegend

  • Parameters

    Returns void

Protected willSetLimit

  • willSetLimit(newLimit: number, oldLimit: number): void

  • Parameters

    • newLimit: number
    • oldLimit: number

    Returns void

Protected willSetModel

  • willSetModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Protected willSetParentModel

  • willSetParentModel(newParentModel: null | Model, oldParentModel: null | Model): void

  • Parameters

    • newParentModel: null | Model
    • oldParentModel: null | Model

    Returns void

Protected willSetValue

  • willSetValue(newValue: number, oldValue: number): void

  • Parameters

    • newValue: number
    • oldValue: number

    Returns void

Protected willStartConsuming

  • willStartConsuming(): void

Protected willStopConsuming

  • willStopConsuming(): void

Protected willUnmount

  • willUnmount(): void

  • Returns void

Protected willUnpower

  • willUnpower(): void

  • Returns void

Protected willValidate

Static decorateTraitFastener

Static decorateTraitModel

Static decorateTraitProperty

Static decorateTraitService

Static getModelPropertyConstructor

Static getTraitFastenerConstructor

Static getTraitModelConstructor

Static getTraitPropertyConstructor

Static getTraitServiceConstructor

Generated using TypeDoc