Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Overlay

Hierarchy

  • Overlay

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Overlay(a: Partial<{ alignment: { x: "left" | "top" | "bottom" | "right"; y: "left" | "top" | "bottom" | "right" }; anchor: { x: number; y: number }; offset: { x: number; y: number }; opacity: number; overlays: Partial<({ url: string; anchor: { x: number; y: number; }; position: { x: number; y: number; }; rotation: number; size: { x: number; y: number; }; offset: { x: number; y: number; }; visibility: boolean; opacity: number; scale: { ...; }; rescale: boolean; rescalePosition: boolean; alignment: { ...; }; overlays: Partial<...>[]...) & { animateRotation?: boolean; animations?: { type: string } }>[]; position: { x: number; y: number }; rescale: boolean; rescalePosition: boolean; rotation: number; scale: { x: number; y: number }; size: { x: number; y: number }; url: string; visibility: boolean } & { animateRotation?: boolean; animations?: { type: string } }>, b: Overlay): Overlay

  • Parameters

    • a: Partial<{ alignment: { x: "left" | "top" | "bottom" | "right"; y: "left" | "top" | "bottom" | "right" }; anchor: { x: number; y: number }; offset: { x: number; y: number }; opacity: number; overlays: Partial<({ url: string; anchor: { x: number; y: number; }; position: { x: number; y: number; }; rotation: number; size: { x: number; y: number; }; offset: { x: number; y: number; }; visibility: boolean; opacity: number; scale: { ...; }; rescale: boolean; rescalePosition: boolean; alignment: { ...; }; overlays: Partial<...>[]...) & { animateRotation?: boolean; animations?: { type: string } }>[]; position: { x: number; y: number }; rescale: boolean; rescalePosition: boolean; rotation: number; scale: { x: number; y: number }; size: { x: number; y: number }; url: string; visibility: boolean } & { animateRotation?: boolean; animations?: { type: string } }>
    • b: Overlay

    Returns Overlay

Properties

_offset

_offset: { x: number; y: number }

Type declaration

  • x: number
  • y: number

_sizeScale

_sizeScale: number

anchor

anchor: { x: number; y: number }

Type declaration

  • x: number
  • y: number

Optional animateVisibility

animateVisibility?: boolean

Optional animationVisibility

animationVisibility?: boolean

children

children: Overlay[]

definition

definition: { alignment: { x: "left" | "top" | "bottom" | "right"; y: "left" | "top" | "bottom" | "right" }; anchor: { x: number; y: number }; offset: { x: number; y: number }; opacity: number; overlays: Partial<({ url: string; anchor: { x: number; y: number; }; position: { x: number; y: number; }; rotation: number; size: { x: number; y: number; }; offset: { x: number; y: number; }; visibility: boolean; opacity: number; scale: { ...; }; rescale: boolean; rescalePosition: boolean; alignment: { ...; }; overlays: Partial<...>[]...) & { animateRotation?: boolean; animations?: { type: string } }>[]; position: { x: number; y: number }; rescale: boolean; rescalePosition: boolean; rotation: number; scale: { x: number; y: number }; size: { x: number; y: number }; url: string; visibility: boolean } & { animateRotation?: boolean; animations?: { type: string } }

iconFrame

iconFrame: { x: number; y: number }

Type declaration

  • x: number
  • y: number

opacity

opacity: number

overlay

overlay: cssTransform

parent

parent: Overlay

position

position: { x: number; y: number }

Type declaration

  • x: number
  • y: number

positionOffset

positionOffset: { x: number; y: number }

Type declaration

  • x: number
  • y: number

rotation

rotation: number

scale

scale: { x: number; y: number }

Type declaration

  • x: number
  • y: number

size

size: { x: number; y: number }

Type declaration

  • x: number
  • y: number

visibility

visibility: boolean

Methods

animate

  • animate(a: boolean): void

destroy

  • destroy(): void

place

  • place(a?: { x: number; y: number }): void

positionFromParentRotation

  • positionFromParentRotation(): { x: number; y: number }

rotate

  • rotate(a: number): void

scaleAllProperties

  • scaleAllProperties(a?: { x: number; y: number }): void

scaleAndPlace

  • scaleAndPlace(a?: { x: number; y: number }, b?: { x: number; y: number }, c?: boolean): void

  • Parameters

    • Optional a: { x: number; y: number }
      • x: number
      • y: number
    • Optional b: { x: number; y: number }
      • x: number
      • y: number
    • Optional c: boolean

    Returns void

scaleFromParent

  • scaleFromParent(a?: { x: number; y: number }): { x: number; y: number }

  • Parameters

    • Optional a: { x: number; y: number }
      • x: number
      • y: number

    Returns { x: number; y: number }

    • x: number
    • y: number

setOpacity

  • setOpacity(a: number): void

setText

  • setText(a: string): void

setTitle

  • setTitle(a: string): void

setVisibility

  • setVisibility(a: boolean): void

translateIcon

  • translateIcon(a: number, b: "X" | "Y"): void

Generated using TypeDoc