Class CustomOverlay

Hierarchy

  • Component
    • CustomOverlay

Methods

getOptions hide isVisible onAfterHide onAfterShow onBeforeHide onBeforeShow onLoaded patch setOptions show

Methods

getOptions

  • getOptions(): Options

  • Returns Options

hide

  • hide(): void

  • Returns void

isVisible

  • isVisible(): boolean

  • Returns boolean

onAfterHide

  • onAfterHide(f): void

  • Parameters

    • f: Function

    Returns void

onAfterShow

  • onAfterShow(f): void

  • Parameters

    • f: Function

    Returns void

onBeforeHide

  • onBeforeHide(f): void

  • Parameters

    • f: Function

    Returns void

onBeforeShow

  • onBeforeShow(f): void

  • Parameters

    • f: Function

    Returns void

onLoaded

  • onLoaded(f): void

  • Parameters

    • f: Function

    Returns void

patch

  • patch(nodeId, patch): void

  • Parameters

    • nodeId: string
    • patch: Partial<{
          align: "center" | "end" | "start" | "stretch";
          alpha: number;
          bottom: Length;
          centerX: Length;
          centerY: Length;
          cornerRadius: number;
          direction: "row" | "column";
          fill: number;
          gap: `${number}px`;
          height: Length;
          left: Length;
          margin: Padding;
          maxHeight: Length;
          maxWidth: Length;
          minHeight: Length;
          minWidth: Length;
          right: Length;
          style: Partial<TextStyle>;
          text: string;
          top: Length;
          visible: boolean;
          width: Length;
      }>

    Returns void

setOptions

  • setOptions(options?): void

  • Parameters

    Returns void

show

  • show(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

getOptionshideisVisibleonAfterHideonAfterShowonBeforeHideonBeforeShowonLoadedpatchsetOptionsshow