class RenderContexttype

type RenderContext​.PlacementOptions

Type definition for global rendering placement options.

type PlacementOptions = Readonly<{
  mode: PlacementMode;
  mountId?: string;
  ref?: Output;
  refOffset?: number | [number, number];
  shade?: boolean;
  background?: UIColor.BackgroundType;
}>;

Description

An object of this type can be provided when rendering a view object using app.render(), or RenderContext.ViewController. Typically, this object is provided by an activity, based on options passed to Activity.setRenderMode().

The following properties determine how root view elements are placed on the screen:

• mode — One of the RenderContext.PlacementMode options.
• mountId — The mount element ID (e.g. HTML element ID), if mode is set to mount.
• ref — The existing output element that determines the position of modal or overlay view output, if any.
• refOffset — The offset (in pixels) from the reference output element, if any. May be a single number or two numbers for X and Y, and may also be negative.
• shade — True if the modal element should be surrounded by a backdrop shade.
• background — The screen (or page) background color.

Related

• class RenderContext abstract
  An abstract class that supports global view rendering, part of the global application context.