JS Functions

  1. Home
  2. Knowledge Base
  3. Codex
  4. JS API
  5. JS Functions

DiviArea.getArea()

Returns the area that is associated with the ID. Params Returns Returns a DiviAreaItem object for the requested Area. When...
  • 0
  • 4

DiviArea.Utils.showOnViewport()

Checks the viewport configuration of the Area agains the current viewport. Only the window-width is tested to determine whether the...
  • 0
  • 4

DiviArea.removeAction()

Removes a previously registered action hook.
  • 0
  • 4

DiviArea.addActionOnce()

Same as addAction() but the callback is unhooked again when the action is called the next time. This function ensures,...
  • 0
  • 4

DiviAreaItem.addFilter()

Register a new hook that only handles filters of this Area
  • 0
  • 4

DiviArea.markClosed()

Mark an area as "closed" for a certain number of minutes.
  • 0
  • 4

DiviAreaItem.setVisible()

Mark the area as visible or not-visible.
  • 0
  • 4

DiviArea.Hooks.addActionOnce()

This is an alias of DiviArea.addActionOnce().
  • 0
  • 4

DiviAreaItem.removeFilter()

Removes a previously registered filter hook.
  • 0
  • 4

DiviAreaItem.hasId()

Tests, whether the area is identified by the given ID.
  • 0
  • 4

DiviArea.Utils.toBool()

Utility that tests, if a value equals to boolean true. See below for a list of values that are considered...
  • 0
  • 4

DiviAreaItem.inDom()

Tests, whether the Area is attached to the document
  • 0
  • 4

DiviAreaItem.isType()

Tests, whether the matches the expected type string.
  • 0
  • 5

DiviArea.Data.getAllIds()

Returns a list of available Area-IDs
  • 0
  • 5

DiviArea.Utils.compareCssSpecificity()

Determines, which CSS specificity is more specific
  • 0
  • 5

DiviArea.Debug.verbose()

Params Returns The function does not return anything. Examples Notes This method does nothing when JS verbose debugging is disabled....
  • 0
  • 5

DiviArea.applyFilters()

Applies all previously registered filter hooks and returns the filtered value. Params Returns Returns the filtered value. Notes No notes
  • 0
  • 5

DiviArea.Debug.debug()

Output debug info in the JS console, when JS debugging is enabled
  • 0
  • 5

DiviArea.Utils.getLocalData()

Retrieve previously stored information from localStorage or a Cookie. Params Returns A string with the previously saved value, or false...
  • 0
  • 5

DiviArea.doAction()

Runs all previously registered action hooks. Params Returns The function does not return anything. Notes No notes
  • 0
  • 5

DiviArea.Debug.info()

Output info in the JS console, when JS debugging is enabled
  • 0
  • 5

DiviAreaItem.detach()

Detach the current Area from the DOM tree (hide it)
  • 0
  • 5

DiviAreaItem.applyFilters()

Runs a JS filter via DiviArea.applyFilters() with the given hook name. This function will call two filters: One exactly as...
  • 0
  • 5

DiviAreaItem.findHook()

Finds and returns the hook-tag of this Area.
  • 0
  • 5

DiviAreaItem.addAction()

Register a new hook that only listens to actions of this Area
  • 0
  • 5

DiviArea.isClosed()

Check, whether a area is marked as “closed” for a certain time span. This function returns true when the area...
  • 0
  • 5

DiviAreaItem.theId()

Returns the full Area-ID, including the `#` prefix
  • 0
  • 5

DiviAreaItem.setTriggerEvent()

Sets the trigger element for a Hover Area.
  • 0
  • 5

DiviAreaItem.removeAction()

Removes a previously registered action hook.
  • 0
  • 5

DiviArea.Core.attachArea()

Attach the given area to the DOM and add it to the list of visible Areas.
  • 0
  • 5

DiviAreaItem.isVisible()

Tests, if the Area is visible.
  • 0
  • 5

DiviArea.UI.initializeAreaAnimation()

Initialize/configure animation details of the Divi Area
  • 0
  • 5

DiviAreaItem.addActionOnce()

Same as addAction, but the callback is only called once and then is unhooked again
  • 0
  • 5

DiviAreaItem.theType()

Returns the Area-type
  • 0
  • 5

DiviAreaItem.hasClass()

Shortcut to `jQuery.hasClass()` on the Area.
  • 0
  • 5

DiviAreaItem.get()

Returns a jQuery element of the current area.
  • 0
  • 6

DiviAreaItem.getData()

Returns an area configuration value.
  • 0
  • 6

DiviArea.Utils.setLocalData()

Save the given information for a specified number of minutes Params Returns The function does not return anything. Notes No...
  • 0
  • 6

DiviArea.Core.enableBodyScroll()

Enables scrolling of the body again.
  • 0
  • 6

DiviArea.Core.reOrderAreas()

Sets the z-index of all Areas, including the modal overlay.
  • 0
  • 6

DiviArea.Debug.error()

Display an error in the JS console
  • 0
  • 6

DiviArea.Hooks.addFilter()

This is an alias of DiviArea.addFilter().
  • 0
  • 6

DiviArea.Utils.getCookie()

Return the value of a cookie.
  • 0
  • 6

DiviArea.Debug.sysInfo()

Display details about the current system
  • 0
  • 6

DiviArea.Data.sanitizeId()

Sanitize an area ID string: Return a ID with leading hash.
  • 0
  • 6

DiviArea.getOverlay()

Returns the jQuery element of the modal overlay.
  • 0
  • 6

DiviAreaItem.theKey()

Returns the Areas hook-key which is used for action/filter names
  • 0
  • 6

DiviArea.Utils.toMilliseconds()

Converts a CSS timing value into a millisecond value.
  • 0
  • 6

DiviArea.Utils.getStyleDef()

Returns the defined CSS value for the given property of an element.
  • 0
  • 6

DiviAreaItem.getSize()

Returns size details of the Area
  • 0
  • 7
Next Page »