Interface IconView

Readonly firstChild

Readonly key

Readonly lastChild

Readonly mood

Readonly moodModifier

Readonly nextSibling

Optional Readonly observerType

Readonly parent

Readonly previousSibling

Readonly styler

Readonly theme

Readonly themeModifier

Readonly updater

clientBounds

• get clientBounds(): R2Box

• Returns R2Box

clientTransform

• get clientTransform(): Transform

• Returns the transformation from viewport coordinates to view coordinates.

  Returns Transform

componentType

• get componentType(): Class<View>

• Returns Class<View>

culled

• get culled(): boolean

• Returns boolean

displaying

• get displaying(): boolean

• Returns boolean

edgeInsets

• get edgeInsets(): Property<this, ViewInsets, [ViewInsets]>

• Returns Property<this, ViewInsets, [ViewInsets]>

hidden

• get hidden(): boolean

• Returns true if this view is ineligible for rendering and hit testing, and should be excluded from its parent's layout and hit bounds.

  Returns boolean

insertChildFlags

• get insertChildFlags(): number

• Returns number

inserting

• get inserting(): boolean

• Returns boolean

intangible

• get intangible(): boolean

• Returns boolean

layoutViewport

• get layoutViewport(): LayoutViewport

• Returns LayoutViewport

mountFlags

• get mountFlags(): number

• Returns number

mounted

• get mounted(): boolean

• Returns boolean

pageBounds

• get pageBounds(): R2Box

• Returns R2Box

pageTransform

• get pageTransform(): Transform

• Returns the transformation from page coordinates to view coordinates.

  Returns Transform

parentTransform

• get parentTransform(): Transform

• Returns the transformation from the parent view coordinates to view coordinates.

  Returns Transform

popoverFrame

• get popoverFrame(): R2Box

• Returns the bounding box, in page coordinates, the edges to which attached popovers should point.

  Returns R2Box

processing

• get processing(): boolean

• Returns boolean

reinsertChildFlags

• get reinsertChildFlags(): number

• Returns number

removeChildFlags

• get removeChildFlags(): number

• Returns number

removing

• get removing(): boolean

• Returns boolean

solver

• get solver(): Provider<this, SolverService>

• Returns Provider<this, SolverService>

unbounded

• get unbounded(): boolean

• Returns boolean

uncullFlags

• get uncullFlags(): number

• Returns number

unhideFlags

• get unhideFlags(): number

• Returns number

updateTime

• get updateTime(): number

• Returns number

updating

• get updating(): boolean

• Returns boolean

viewIdiom

• get viewIdiom(): ViewIdiom

• Returns ViewIdiom

viewport

• get viewport(): Provider<this, ViewportService>

• Returns Provider<this, ViewportService>

visualViewport

• get visualViewport(): VisualViewport_2

• Returns VisualViewport_2

addConstraint

• addConstraint(constraint): void

• Parameters

  • constraint: Constraint

  Returns void

addConstraintVariable

• addConstraintVariable(constraintVariable): void

• Parameters

  • constraintVariable: ConstraintVariable

  Returns void

addEventListener

• addEventListener(type, listener, options?): void

• Parameters

  • type: string

  • listener: EventListenerOrEventListenerObject

  • Optional options: boolean | AddEventListenerOptions

  Returns void

appendChild

• appendChild<F>(childFactory, key?): InstanceType<F>

• Type Parameters

  • F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>

  Parameters

  • childFactory: F

  • Optional key: string

  Returns InstanceType<F>

• appendChild<Child>(child, key?): Child

• Type Parameters

  • Child extends View

  Parameters

  • child: Child | LikeType<Child>

  • Optional key: string

  Returns Child

• appendChild(child, key?): View

• Parameters

  • child: View | {
        create?() => View;
    }

  • Optional key: string

  Returns View

attachFastener

• attachFastener(fastener): void

• Parameters

  • fastener: Fastener<any, any, any>

  Returns void

callObservers

• callObservers<O, K>(this, key, ...args): void

• Type Parameters

  • O

  • K extends string | number | symbol

  Parameters

  • this: {
        observerType?: Class<O>;
    }

    • Optional Readonly observerType?: Class<O>

  • key: K

  • Rest ...args: ObserverParameters<O, K>

  Returns void

cascadeDisplay

• cascadeDisplay(displayFlags): void

• Parameters

  • displayFlags: number

  Returns void

cascadeProcess

• cascadeProcess(processFlags): void

• Parameters

  • processFlags: number

  Returns void

cascadeUnhide

• cascadeUnhide(): void

• Returns void

commonAncestor

• commonAncestor(relative): View

• Parameters

  • relative: View

  Returns View

constraint

• constraint(lhs, relation, rhs?, strength?): Constraint

• Parameters

  • lhs: ConstraintExpressionLike

  • relation: ConstraintRelation

  • Optional rhs: ConstraintExpressionLike

  • Optional strength: ConstraintStrengthLike

  Returns Constraint

constraintVariable

• constraintVariable(name, value?, strength?): ConstraintProperty<unknown, number, [number]>

• Parameters

  • name: string

  • Optional value: number

  • Optional strength: ConstraintStrengthLike

  Returns ConstraintProperty<unknown, number, [number]>

decohereFastener

• decohereFastener(fastener): void

• Parameters

  • fastener: Fastener<any, any, any>

  Returns void

dispatchEvent

• dispatchEvent(event): boolean

• Parameters

  • event: Event

  Returns boolean

equals

• equals(that): boolean

• Parameters

  • that: unknown

  Returns boolean

forEachChild

• forEachChild<T>(callback): T

• Type Parameters

  • T

  Parameters

  • callback: ((child) => void | T)

    • • (child): void | T

      • Parameters

        • child: View

        Returns void | T

  Returns T

• forEachChild<T, S>(callback, thisArg): T

• Type Parameters

  • T

  • S

  Parameters

  • callback: ((this, child) => void | T)

    • • (this, child): void | T

      • Parameters

        • this: S

        • child: View

        Returns void | T

  • thisArg: S

  Returns T

getAncestor

• getAncestor<F>(ancestorType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • ancestorType: F

  Returns InstanceType<F>

• getAncestor(ancestorType): View

• Parameters

  • ancestorType: Class<View>

  Returns View

getChild

• getChild<F>(key, childType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • key: string

  • childType: F

  Returns InstanceType<F>

• getChild(key, childType?): View

• Parameters

  • key: string

  • Optional childType: Class<View>

  Returns View

getFastener

• getFastener<F>(fastenerName, fastenerType?, contextType?): F

• Type Parameters

  • F extends Fastener<any, any, any>

  Parameters

  • fastenerName: PropertyKey

  • Optional fastenerType: Proto<F>

  • Optional contextType: Proto<any>

  Returns F

getFirstChild

• getFirstChild<F>(childType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • childType: F

  Returns InstanceType<F>

• getFirstChild(childType): View

• Parameters

  • childType: Class<View>

  Returns View

getLastChild

• getLastChild<F>(childType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • childType: F

  Returns InstanceType<F>

• getLastChild(childType): View

• Parameters

  • childType: Class<View>

  Returns View

getLook

• getLook<T>(look, mood?): T

• Type Parameters

  • T

  Parameters

  • look: Look<T>

  • Optional mood: MoodVector<Feel>

  Returns T

getLookOr

• getLookOr<T, E>(look, elseValue): T | E

• Type Parameters

  • T

  • E

  Parameters

  • look: Look<T>

  • elseValue: E

  Returns T | E

• getLookOr<T, E>(look, mood, elseValue): T | E

• Type Parameters

  • T

  • E

  Parameters

  • look: Look<T>

  • mood: MoodVector<Feel>

  • elseValue: E

  Returns T | E

getNextSibling

• getNextSibling<F>(siblingType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • siblingType: F

  Returns InstanceType<F>

• getNextSibling(siblingType): View

• Parameters

  • siblingType: Class<View>

  Returns View

getParentFastener

• getParentFastener<F>(fastenerName, fastenerType?, contextType?): F

• Type Parameters

  • F extends Fastener<any, any, any>

  Parameters

  • fastenerName: PropertyKey

  • Optional fastenerType: Proto<F>

  • Optional contextType: Proto<any>

  Returns F

getPreviousSibling

• getPreviousSibling<F>(siblingType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • siblingType: F

  Returns InstanceType<F>

• getPreviousSibling(siblingType): View

• Parameters

  • siblingType: Class<View>

  Returns View

getRoot

• getRoot<F>(rootType): InstanceType<F>

• Type Parameters

  • F extends Class<View>

  Parameters

  • rootType: F

  Returns InstanceType<F>

• getRoot(rootType): View

• Parameters

  • rootType: Class<View>

  Returns View

getTargetChild

• getTargetChild(child, comparator): View

• Parameters

  • child: View

  • comparator: Comparator<View>

  Returns View

getTransition

• getTransition(fastener): Timing

• Parameters

  • fastener: Fastener<any, any, any>

  Returns Timing

hasConstraint

• hasConstraint(constraint): boolean

• Parameters

  • constraint: Constraint

  Returns boolean

hasConstraintVariable

• hasConstraintVariable(constraintVariable): boolean

• Parameters

  • constraintVariable: ConstraintVariable

  Returns boolean

hashCode

• hashCode(): number

• Returns number

insertChild

• insertChild<F>(childFactory, target, key?): InstanceType<F>

• Type Parameters

  • F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>

  Parameters

  • childFactory: F

  • target: View

  • Optional key: string

  Returns InstanceType<F>

• insertChild<Child>(child, target, key?): Child

• Type Parameters

  • Child extends View

  Parameters

  • child: Child | LikeType<Child>

  • target: View

  • Optional key: string

  Returns Child

• insertChild(child, target, key?): View

• Parameters

  • child: View | {
        create?() => View;
    }

  • target: View

  • Optional key: string

  Returns View

intersectsViewport

• intersectsViewport(): boolean

• Returns boolean

isAncestorOf

• isAncestorOf(descendant): boolean

• Parameters

  • descendant: View

  Returns boolean

Optional likeType

• likeType(like): void

• Parameters

  • like: {
        create?() => View;
    }

    • create?:function

      • create(): View

      • Returns View

  Returns void

modifyMood

• modifyMood(feel, updates, timing?): void

• Parameters

  • feel: Feel

  • updates: MoodVectorUpdates<Feel>

  • Optional timing: boolean | TimingLike

  Returns void

modifyTheme

• modifyTheme(feel, updates, timing?): void

• Parameters

  • feel: Feel

  • updates: MoodVectorUpdates<Feel>

  • Optional timing: boolean | TimingLike

  Returns void

• modifyTheme(cols, timing?): void

• Parameters

  • cols: [feel: Feel, updates: MoodVectorUpdates<Feel>][]

  • Optional timing: boolean | TimingLike

  Returns void

observe

• observe(observer): void

• Parameters

  • observer: ViewObserver<View>

  Returns void

prependChild

• prependChild<F>(childFactory, key?): InstanceType<F>

• Type Parameters

  • F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>

  Parameters

  • childFactory: F

  • Optional key: string

  Returns InstanceType<F>

• prependChild<Child>(child, key?): Child

• Type Parameters

  • Child extends View

  Parameters

  • child: Child | LikeType<Child>

  • Optional key: string

  Returns Child

• prependChild(child, key?): View

• Parameters

  • child: View | {
        create?() => View;
    }

  • Optional key: string

  Returns View

reinsertChild

• reinsertChild(child, target): void

• Parameters

  • child: View

  • target: View

  Returns void

remove

• remove(): void

• Returns void

removeChild

• removeChild<Child>(child): Child

• Type Parameters

  • Child extends View

  Parameters

  • child: Child

  Returns Child

• removeChild(child): View

• Parameters

  • child: View

  Returns View

• removeChild(key): View

• Parameters

  • key: string | View

  Returns View

removeChildren

• removeChildren(): void

• Returns void

removeConstraint

• removeConstraint(constraint): void

• Parameters

  • constraint: Constraint

  Returns void

removeConstraintVariable

• removeConstraintVariable(constraintVariable): void

• Parameters

  • constraintVariable: ConstraintVariable

  Returns void

removeEventListener

• removeEventListener(type, listener, options?): void

• Parameters

  • type: string

  • listener: EventListenerOrEventListenerObject

  • Optional options: boolean | EventListenerOptions

  Returns void

replaceChild

• replaceChild<F>(newChildFactory, oldChild): View

• Type Parameters

  • F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>

  Parameters

  • newChildFactory: F

  • oldChild: View

  Returns View

• replaceChild<Child>(newChild, oldChild): Child

• Type Parameters

  • Child extends View

  Parameters

  • newChild: View | {
        create?() => View;
    }

  • oldChild: Child

  Returns Child

• replaceChild(newChild, oldChild): View

• Parameters

  • newChild: View | {
        create?() => View;
    }

  • oldChild: View

  Returns View

requestUpdate

• requestUpdate(target, updateFlags, immediate): void

• Parameters

  • target: View

  • updateFlags: number

  • immediate: boolean

  Returns void

requireUpdate

• requireUpdate(updateFlags, immediate?): void

• Parameters

  • updateFlags: number

  • Optional immediate: boolean

  Returns void

set

• set<S>(this, properties, timing?): IconView

• Type Parameters

  • S

  Parameters

  • this: S

  • properties: {
        [K in string | number | symbol as S[K] extends {
                set(value) => any;
            }
            ? K
            : never]?: S[K] extends {
                set(value) => any;
            }
            ? T
            : never
    }

  • Optional timing: boolean | TimingLike

  Returns IconView

setChild

• setChild<F>(key, newChildFactory): View

• Type Parameters

  • F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>

  Parameters

  • key: string

  • newChildFactory: F

  Returns View

• setChild(key, newChild): View

• Parameters

  • key: string

  • newChild: View | {
        create?() => View;
    }

  Returns View

setCulled

• setCulled(culled): void

• Parameters

  • culled: boolean

  Returns void

setHidden

• setHidden(hidden): void

• Makes this view ineligible for rendering and hit testing, and excludes this view from its parent's layout and hit bounds, when hidden is true. Makes this view eligible for rendering and hit testing, and includes this view in its parent's layout and hit bounds, when hidden is false.

  Parameters

  • hidden: boolean

  Returns void

setIntangible

• setIntangible(intangible): void

• Parameters

  • intangible: boolean

  Returns void

setIntrinsic

• setIntrinsic<S>(this, properties, timing?): IconView

• Type Parameters

  • S

  Parameters

  • this: S

  • properties: {
        [K in string | number | symbol as S[K] extends {
                setIntrinsic(value) => any;
            }
            ? K
            : never]?: S[K] extends {
                setIntrinsic(value) => any;
            }
            ? T
            : never
    }

  • Optional timing: boolean | TimingLike

  Returns IconView

setUnbounded

• setUnbounded(unboundedFlag): void

• Parameters

  • unboundedFlag: boolean

  Returns void

sortChildren

• sortChildren(comparator): void

• Parameters

  • comparator: Comparator<View>

  Returns void

tryFastener

• tryFastener<K, F>(fastenerName): F extends Fastener<any, any, any>
      ? F
      : never

• Type Parameters

  • K extends keyof IconView

  • F extends string | number | boolean | readonly Fastener<any, any, any>[] | {} | {} | (() => void) | (() => void) | {} | {} | (<F>(fastenerName, fastenerType?, contextType?) => F) | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((fastener) => void) | ((fastener) => void) | (<O, K>(this, key, ...args) => void) | ((that) => boolean) | (() => number) | Transform | R2Box | View | LayoutViewport | ((like) => void) | Class<ViewObserver<View>> | Class<View> | {} | {} | {} | {
        <F>(siblingType): InstanceType<F>;
        (siblingType): View;
    } | {} | {
        <F>(siblingType): InstanceType<F>;
        (siblingType): View;
    } | {} | {
        <F>(childType): InstanceType<F>;
        (childType): View;
    } | {} | {
        <F>(childType): InstanceType<F>;
        (childType): View;
    } | {} | {
        <T>(callback): T;
        <T, S>(callback, thisArg): T;
    } | Dictionary<View> | {
        <F>(key, childType): InstanceType<F>;
        (key, childType?): View;
    } | {
        <F>(key, newChildFactory): View;
        (key, newChild): View;
    } | {
        <F>(childFactory, key?): InstanceType<F>;
        <Child>(child, key?): Child;
        (child, key?): View;
    } | {
        <F>(childFactory, key?): InstanceType<F>;
        <Child>(child, key?): Child;
        (child, key?): View;
    } | {
        <F>(childFactory, target, key?): InstanceType<F>;
        <Child>(child, target, key?): Child;
        (child, target, key?): View;
    } | {
        <F>(newChildFactory, oldChild): View;
        <Child>(newChild, oldChild): Child;
        (newChild, oldChild): View;
    } | {} | {
        <Child>(child): Child;
        (child): View;
        (key): View;
    } | ((child, target) => void) | ((comparator) => void) | ((child, comparator) => View) | {
        <F>(ancestorType): InstanceType<F>;
        (ancestorType): View;
    } | {
        <F>(rootType): InstanceType<F>;
        (rootType): View;
    } | ((descendant) => boolean) | ((relative) => View) | {} | {} | ((updateFlags, immediate?) => void) | {} | ReadonlySet<ViewObserver<View>> | ((lhs, relation, rhs?, strength?) => Constraint) | ((constraint) => boolean) | ((constraint) => void) | ((constraint) => void) | ((name, value?, strength?) => ConstraintProperty<unknown, number, [number]>) | ((constraintVariable) => boolean) | ((constraintVariable) => void) | ((constraintVariable) => void) | {} | {} | {} | {} | {} | (<T>(look, mood?) => T) | {
        <T, E>(look, elseValue): T | E;
        <T, E>(look, mood, elseValue): T | E;
    } | ((type, listener, options?) => void) | ((event) => boolean) | ((type, listener, options?) => void) | ReadonlySet<Constraint> | ReadonlySet<ConstraintVariable> | VisualViewport_2 | {} | ((feel, updates, timing?) => void) | {
        (feel, updates, timing?): void;
        (cols, timing?): void;
    } | ((fastener) => Timing) | ((culled) => void) | {} | {} | ((hidden) => void) | {} | (() => void) | ((unboundedFlag) => void) | ((intangible) => void) | ((target, updateFlags, immediate) => void) | ((processFlags) => void) | ((displayFlags) => void) | {} | {} | (() => boolean) | Animator<IconView, IconLayout, [IconLayout]> | ThemeAnimator<IconView, Color, [Color | Look<Color>]> | ThemeAnimator<IconView, Graphics, [Graphics | Look<Graphics>]> | Provider<IconView, DisplayerService> | Provider<IconView, StylerService> | Property<IconView, MoodVector<Feel>, [MoodVector<Feel>]> & {} | Property<IconView, ThemeMatrix, [ThemeMatrix]> & {} | Property<IconView, MoodMatrix<Feel, Feel>, [MoodMatrix<Feel, Feel>]> | (<K, F>(fastenerName) => F extends Fastener<any, any, any>
        ? F
        : never) | (<S>(this, properties, timing?) => IconView) | Provider<IconView, ViewportService> | Provider<IconView, SolverService> | Property<IconView, ViewInsets, [ViewInsets]> | (<S>(this, properties, timing?) => IconView) | ((observer) => void) | ((observer) => void) = IconView[K]

  Parameters

  • fastenerName: K

  Returns F extends Fastener<any, any, any>
      ? F
      : never