Class ViewportService

Hierarchy

  • Service
    • ViewportService

Constructors

constructor

Properties

colorScheme colorSchemeChange firstChild key lastChild layoutViewport layoutViewportChange load nextSibling observerType? orientation orientationChange parent previousSibling safeArea viewIdiom visualViewport visualViewportChange InsertChildFlags MountFlags ReinsertChildFlags RemoveChildFlags

Accessors

componentType insertChildFlags inserting mountFlags mounted reinsertChildFlags removeChildFlags removing

Methods

appendChild attachFastener bindFastener callObservers commonAncestor decohereFastener didAttachParent didDetachParent didInsertChild didMount didObserve didReinsertChild didRemoveChild didUnmount didUnobserve enqueueFastener equals forEachChild getAncestor getChild getFastener getFirstChild getLastChild getNextSibling getParentFastener getPreviousSibling getRoot getTargetChild hashCode insertChild isAncestorOf likeType? mount observe onAttachParent onDetachParent onInsertChild onMount onObserve onReinsertChild onRemoveChild onUnmount onUnobserve prependChild recohereFasteners reinsertChild remove removeChild removeChildren replaceChild requireUpdate set setChild setIntrinsic sortChildren tryFastener unmount unobserve willAttachParent willDetachParent willInsertChild willMount willObserve willReinsertChild willRemoveChild willUnmount willUnobserve create fromLike global

Constructors

constructor

  • Returns ViewportService

Properties

Readonly colorScheme

colorScheme: Property<ViewportService, ViewportColorScheme, [ViewportColorScheme]> & {
    detect() => ViewportColorScheme;
    update() => void;
}

Type declaration

  • detect:function
  • update:function
    • update(): void

    • Returns void

Readonly colorSchemeChange

colorSchemeChange: EventHandler<ViewportService, EventTarget>

Readonly firstChild

firstChild: Service

Readonly key

key: string

Readonly lastChild

lastChild: Service

Readonly layoutViewport

layoutViewport: Property<ViewportService, LayoutViewport, [LayoutViewport]> & {
    detect() => LayoutViewport;
    update() => void;
}

Type declaration

  • detect:function
  • update:function
    • update(): void

    • Returns void

Readonly layoutViewportChange

layoutViewportChange: EventTimer<ViewportService, EventTarget>

Readonly load

load: EventTimer<ViewportService, EventTarget>

Readonly nextSibling

nextSibling: Service

Optional Readonly observerType

observerType?: Class<ViewportServiceObserver<ViewportService>>

Readonly orientation

orientation: Property<ViewportService, ViewportOrientation, [ViewportOrientation]> & {
    detect() => ViewportOrientation;
    update() => void;
}

Type declaration

  • detect:function
  • update:function
    • update(): void

    • Returns void

Readonly orientationChange

orientationChange: EventHandler<ViewportService, EventTarget>

Readonly parent

parent: Service

Readonly previousSibling

previousSibling: Service

Readonly safeArea

safeArea: Property<ViewportService, ViewInsets, [ViewInsets]> & {
    detect() => ViewInsets;
    update() => void;
}

Type declaration

  • detect:function
    • detect(): ViewInsets

    • Returns ViewInsets

  • update:function
    • update(): void

    • Returns void

Readonly viewIdiom

viewIdiom: Property<ViewportService, ViewIdiom, [ViewIdiom]> & {
    detect() => ViewIdiom;
    update() => void;
}

Type declaration

  • detect:function
    • detect(): ViewIdiom

    • Returns ViewIdiom

  • update:function
    • update(): void

    • Returns void

Readonly visualViewport

visualViewport: Property<ViewportService, VisualViewport, [VisualViewport]> & {
    detect() => VisualViewport;
    update() => void;
}

Type declaration

  • detect:function
  • update:function
    • update(): void

    • Returns void

Readonly visualViewportChange

visualViewportChange: EventTimer<ViewportService, EventTarget>

Static Readonly InsertChildFlags

InsertChildFlags: number

Static Readonly MountFlags

MountFlags: number

Static Readonly ReinsertChildFlags

ReinsertChildFlags: number

Static Readonly RemoveChildFlags

RemoveChildFlags: number

Accessors

componentType

  • get componentType(): Class<Service>

  • Returns Class<Service>

insertChildFlags

  • get insertChildFlags(): number

  • Returns number

inserting

  • get inserting(): boolean

  • Returns boolean

mountFlags

  • get mountFlags(): number

  • Returns number

mounted

  • get mounted(): boolean

  • Returns boolean

reinsertChildFlags

  • get reinsertChildFlags(): number

  • Returns number

removeChildFlags

  • get removeChildFlags(): number

  • Returns number

removing

  • get removing(): boolean

  • Returns boolean

Methods

appendChild

  • Type Parameters

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

    Parameters

    • childFactory: F
    • Optional key: string

    Returns InstanceType<F>

  • Type Parameters

    • Child extends Service

    Parameters

    • child: Child | LikeType<Child>
    • Optional key: string

    Returns Child

  • Parameters

    • child: Service | {
          create?() => Service;
      }
    • Optional key: string

    Returns Service

attachFastener

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns void

Protected bindFastener

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns void

callObservers

  • 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

commonAncestor

  • Parameters

    • relative: Service

    Returns Service

decohereFastener

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns void

Protected didAttachParent

  • Parameters

    • parent: Service

    Returns void

Protected didDetachParent

  • Parameters

    • parent: Service

    Returns void

Protected didInsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

Protected didMount

  • Returns void

Protected didObserve

  • Parameters

    Returns void

Protected didReinsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

Protected didRemoveChild

  • Parameters

    • child: Service

    Returns void

Protected didUnmount

  • Returns void

Protected didUnobserve

  • Parameters

    Returns void

Protected enqueueFastener

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns void

equals

  • Parameters

    • that: unknown

    Returns boolean

forEachChild

  • Type Parameters

    • T

    Parameters

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

        • Parameters

          • child: Service

          Returns void | T

    Returns T

  • Type Parameters

    • T

    • S

    Parameters

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

        • Parameters

          • this: S
          • child: Service

          Returns void | T

    • thisArg: S

    Returns T

getAncestor

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • ancestorType: F

    Returns InstanceType<F>

  • Parameters

    • ancestorType: Class<Service>

    Returns Service

getChild

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • key: string
    • childType: F

    Returns InstanceType<F>

  • Parameters

    • key: string
    • Optional childType: Class<Service>

    Returns Service

getFastener

  • Type Parameters

    • F extends Fastener<any, any, any>

    Parameters

    • fastenerName: PropertyKey
    • Optional fastenerType: Proto<F>
    • Optional contextType: Proto<any>

    Returns F

getFirstChild

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • childType: F

    Returns InstanceType<F>

  • Parameters

    • childType: Class<Service>

    Returns Service

getLastChild

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • childType: F

    Returns InstanceType<F>

  • Parameters

    • childType: Class<Service>

    Returns Service

getNextSibling

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • siblingType: F

    Returns InstanceType<F>

  • Parameters

    • siblingType: Class<Service>

    Returns Service

getParentFastener

  • Type Parameters

    • F extends Fastener<any, any, any>

    Parameters

    • fastenerName: PropertyKey
    • Optional fastenerType: Proto<F>
    • Optional contextType: Proto<any>

    Returns F

getPreviousSibling

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • siblingType: F

    Returns InstanceType<F>

  • Parameters

    • siblingType: Class<Service>

    Returns Service

getRoot

  • Type Parameters

    • F extends Class<Service>

    Parameters

    • rootType: F

    Returns InstanceType<F>

  • Parameters

    • rootType: Class<Service>

    Returns Service

getTargetChild

  • Parameters

    • child: Service
    • comparator: Comparator<Service>

    Returns Service

hashCode

  • Returns number

insertChild

  • Type Parameters

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

    Parameters

    • childFactory: F
    • target: Service
    • Optional key: string

    Returns InstanceType<F>

  • Type Parameters

    • Child extends Service

    Parameters

    • child: Child | LikeType<Child>
    • target: Service
    • Optional key: string

    Returns Child

  • Parameters

    • child: Service | {
          create?() => Service;
      }
    • target: Service
    • Optional key: string

    Returns Service

isAncestorOf

  • Parameters

    • descendant: Service

    Returns boolean

Optional likeType

  • Parameters

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

        • Returns Service

    Returns void

mount

  • Returns void

observe

  • Parameters

    Returns void

Protected onAttachParent

  • Parameters

    • parent: Service

    Returns void

Protected onDetachParent

  • Parameters

    • parent: Service

    Returns void

Protected onInsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

Protected onMount

  • Returns void

Protected onObserve

  • Parameters

    Returns void

Protected onReinsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

Protected onRemoveChild

  • Parameters

    • child: Service

    Returns void

Protected onUnmount

  • Returns void

Protected onUnobserve

  • Parameters

    Returns void

prependChild

  • Type Parameters

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

    Parameters

    • childFactory: F
    • Optional key: string

    Returns InstanceType<F>

  • Type Parameters

    • Child extends Service

    Parameters

    • child: Child | LikeType<Child>
    • Optional key: string

    Returns Child

  • Parameters

    • child: Service | {
          create?() => Service;
      }
    • Optional key: string

    Returns Service

recohereFasteners

  • Parameters

    • Optional t: number

    Returns void

reinsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

remove

  • Returns void

removeChild

  • Type Parameters

    • Child extends Service

    Parameters

    • child: Child

    Returns Child

  • Parameters

    • child: Service

    Returns Service

  • Parameters

    • key: string | Service

    Returns Service

removeChildren

  • Returns void

replaceChild

  • Type Parameters

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

    Parameters

    • newChildFactory: F
    • oldChild: Service

    Returns Service

  • Type Parameters

    • Child extends Service

    Parameters

    • newChild: Service | {
          create?() => Service;
      }
    • oldChild: Child

    Returns Child

  • Parameters

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

    Returns Service

requireUpdate

  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

set

  • 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 ViewportService

setChild

  • Type Parameters

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

    Parameters

    • key: string
    • newChildFactory: F

    Returns Service

  • Parameters

    • key: string
    • newChild: Service | {
          create?() => Service;
      }

    Returns Service

setIntrinsic

  • 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 ViewportService

sortChildren

  • Parameters

    • comparator: Comparator<Service>

    Returns void

tryFastener

  • Type Parameters

    • K extends keyof ViewportService

    • F extends string | number | boolean | readonly Fastener<any, any, any>[] | {} | {} | {} | (() => void) | (() => void) | (() => void) | {} | (() => void) | {} | ((updateFlags, immediate?) => void) | (<F>(fastenerName, fastenerType?, contextType?) => F) | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((fastener) => void) | ((fastener) => void) | ((t?) => void) | (<O, K>(this, key, ...args) => void) | ((that) => boolean) | (() => number) | Service | ((like) => void) | Class<Service> | {} | {} | {} | {
          <F>(siblingType): InstanceType<F>;
          (siblingType): Service;
      } | {} | {
          <F>(siblingType): InstanceType<F>;
          (siblingType): Service;
      } | {} | {
          <F>(childType): InstanceType<F>;
          (childType): Service;
      } | {} | {
          <F>(childType): InstanceType<F>;
          (childType): Service;
      } | {} | {
          <T>(callback): T;
          <T, S>(callback, thisArg): T;
      } | Dictionary<Service> | {
          <F>(key, childType): InstanceType<F>;
          (key, childType?): Service;
      } | {
          <F>(key, newChildFactory): Service;
          (key, newChild): Service;
      } | {
          <F>(childFactory, key?): InstanceType<F>;
          <Child>(child, key?): Child;
          (child, key?): Service;
      } | {
          <F>(childFactory, key?): InstanceType<F>;
          <Child>(child, key?): Child;
          (child, key?): Service;
      } | {
          <F>(childFactory, target, key?): InstanceType<F>;
          <Child>(child, target, key?): Child;
          (child, target, key?): Service;
      } | {
          <F>(newChildFactory, oldChild): Service;
          <Child>(newChild, oldChild): Child;
          (newChild, oldChild): Service;
      } | {
          <Child>(child): Child;
          (child): Service;
          (key): Service;
      } | ((child, target) => void) | ((comparator) => void) | ((child, comparator) => Service) | {
          <F>(ancestorType): InstanceType<F>;
          (ancestorType): Service;
      } | {
          <F>(rootType): InstanceType<F>;
          (rootType): Service;
      } | ((descendant) => boolean) | ((relative) => Service) | Class<ViewportServiceObserver<ViewportService>> | (<K, F>(fastenerName) => F extends Fastener<any, any, any>
          ? F
          : never) | (<S>(this, properties, timing?) => ViewportService) | (<S>(this, properties, timing?) => ViewportService) | ReadonlySet<ViewportServiceObserver<ViewportService>> | ((observer) => void) | ((observer) => void) | Property<ViewportService, LayoutViewport, [LayoutViewport]> & {
          detect() => LayoutViewport;
          update() => void;
      } | EventTimer<ViewportService, EventTarget> | Property<ViewportService, VisualViewport, [VisualViewport]> & {
          detect() => VisualViewport;
          update() => void;
      } | Property<ViewportService, ViewInsets, [ViewInsets]> & {
          detect() => ViewInsets;
          update() => void;
      } | Property<ViewportService, ViewportOrientation, [ViewportOrientation]> & {
          detect() => ViewportOrientation;
          update() => void;
      } | EventHandler<ViewportService, EventTarget> | Property<ViewportService, ViewportColorScheme, [ViewportColorScheme]> & {
          detect() => ViewportColorScheme;
          update() => void;
      } | Property<ViewportService, ViewIdiom, [ViewIdiom]> & {
          detect() => ViewIdiom;
          update() => void;
      } = ViewportService[K]

    Parameters

    • fastenerName: K

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

unmount

  • Returns void

unobserve

  • Parameters

    Returns void

Protected willAttachParent

  • Parameters

    • parent: Service

    Returns void

Protected willDetachParent

  • Parameters

    • parent: Service

    Returns void

Protected willInsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

Protected willMount

  • Returns void

Protected willObserve

  • Parameters

    Returns void

Protected willReinsertChild

  • Parameters

    • child: Service
    • target: Service

    Returns void

Protected willRemoveChild

  • Parameters

    • child: Service

    Returns void

Protected willUnmount

  • Returns void

Protected willUnobserve

  • Parameters

    Returns void

Static create

  • Type Parameters

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

    Parameters

    • this: S

    Returns InstanceType<S>

Static fromLike

  • Type Parameters

    • S extends Class<Instance<S, Component<Component<any>>>>

    Parameters

    • this: S
    • value: InstanceType<S> | LikeType<InstanceType<S>>

    Returns InstanceType<S>

Static global

  • Type Parameters

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

    Parameters

    • this: S

    Returns InstanceType<S>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc