DiviAreaItem.getData()

  1. Home
  2. Knowledge Base
  3. Codex
  4. JS API
  5. JS Functions
  6. DiviAreaItem.getData()
DiviAreaItem.getData(key)

Returns an area configuration value.

See DiviAreaItem.setData() for a full list of configuration values.

Params

key
(string, optional) The option name to retrieve. When no option is specified, a list of all options is returned.

Returns

Returns the configuration value which was previously set via DiviAreaItem.setData().

Examples

var area = DiviArea.getArea();

// Find the current Area position.
area.getData('position'); // Sample output: "top-center".

// Get an object with all Area settings
area.getData(');

Notes

No notes

Was this article helpful?

Related Articles