`obj_mode(path)`

Returns the display mode of the object at the given path. (Available as of version 10.23)

Syntax

obj_mode(path)

Input

Argument Type Description

Argument	Type	Description
`path`	text	A path to an object (e.g., table, folder, query) The `path` parameter can be a scalar value (e.g., pub.demo.retail.item) or the name of a column containing paths to objects. If `path` is the empty string (e.g., `''`), the function returns information corresponding to the root-level folder, which contains all of the top-level folders (e.g., pub, default, uploads).

path

text

A path to an object (e.g., table, folder, query)

The path parameter can be a scalar value (e.g., pub.demo.retail.item) or the name of a column containing paths to objects.

If path is the empty string (e.g., ''), the function returns information corresponding to the root-level folder, which contains all of the top-level folders (e.g., pub, default, uploads).

Return Value

Returns a text value corresponding to the display mode of the object at the specified path.

The display mode determines how a particular object is displayed in the web interface of the 1010data Insights Platform. This mode only applies to the web interface in releases of the 1010data Insights Platform prior to Version 10 or in Compatibility Mode in releases thereafter.

The display mode can be one of the following:

data: Open the object as a query.
nodata: Open the object as a library.
happy: Open the object as a QuickApp.

Note: This mode will be ignored when using the web interface introduced in 1010data Insights Platform Version 10.

Returns an empty string if the path does not exist.

Example

The following example demonstrates the behavior of obj_mode(path) using the values in the example_path column specified via the <table> element.

<table cols="example_path">pub.demo.retail;
  pub.demo.retail.item;
  pub.demo.retail.selectionlib;
  pub.demo.retail.foo;
  default.doc.interactive.trsgsg_qa;
  default.doc.interactive.doc_lib;
  foo;
  ;
</table>
<col name="example_path" format="width:35"/>
<willbe name="obj_mode_result" value="obj_mode(example_path)"/>

Note: When the value of the path parameter is equal to the empty string, the function returns information corresponding to the root-level folder in the 1010data Insights Platform, which contains all of the top-level folders (e.g., pub, default, uploads).