getState

returns the reactive state object of Desktop

object

state object

Example

const state = $$("mydesktop").getState();

The returned state object contains the following properties:

{
    box: {
        ...
    },
    grid: true,
    systemParams: {
        ...
    },
    tileAlign: "left top"
    tileLayout: "y"
}

Properties

• systemParams - (object) contains custom parameters to be passed to the launch method;
• tileLayout - (string) defines the direction of the layout of apps to a row or a column. Possible options are "x" for rows and "y" for columns.
• tileAlign - (string) defines tiles alignments. Possible options are:
  • "left top" (default)
  • "left bottom"
  • "right top"
  • "right bottom"
• grid - (boolean) defines whether the tile position is set with respect to the grid during the drag-and-drop;
• box - (object) contains size and absolute position of tiles area.

Back to top