DiviArea.Utils.showOnViewport()

  1. Home
  2. Knowledge Base
  3. Codex
  4. JS API
  5. JS Functions
  6. DiviArea.Utils.showOnViewport()
DiviArea.Utils.showOnViewport(area)

Checks the viewport configuration of the Area agains the current viewport. Only the window-width is tested to determine whether the Area should be displayed or not.

If the parameter is a DiviAreaItem, the area.getData("onDEVICE") flags are used to determine the visibility state per device. When the parameter is an array, it is supposed to have 3 boolean items: [onDesktop, onTablet, onPhone]

Params

area
(DiviAreaItem|array, required) The Area, or viewport configuration to test.
The configuration array needs three elemens [onDesktop, onTablet, onMobile]

Returns

Returns true when the Area should be displayed on the current viewport.

Notes

No notes

Was this article helpful?

Related Articles