ignored_props - Dimensions

When viewing a model in , a dimension can list the parameters it hides from the layer below it (for example, a schema model or a shared model). Omni automatically adds this block when you delete a parameter - like a description or label - whose value was inherited from a lower layer.

Syntax

<dimension_name>:
  ignored_props:
    <parameter_name>: true|"shallow"

Properties

object[]

The name of the dimension.

Hide dimension_name properties

object

A map of parameter names to true or "shallow", such as description: true or label: "shallow".To show the inherited value again, delete the parameter from the block. For example, if you want to use an inherited description again, remove it from the block.

Hide ignored_props properties

boolean|string

<parameter_name> specifies the parameter being hidden, such as description or label. The value will be one of the following:

true - The parameter is hidden from every layer below
"shallow" - Branches only. Hides the parameter only from the layer directly below the branch, such as a shared extension model. If a lower layer, such as the shared model, also sets the parameter, that value shows instead. For example, if you delete a description in Merged mode that a shared extension model overrides, the shared model’s description shows again. To bring back the hidden value, delete the "shallow" entry.

Examples

In this example, the shared model and a shared extension model both set a description for {objectExample}. The value in the shared extension model overrides the value in the shared model:

Shared model

lifecycle_stage:
  description: Description from the shared model

Shared extension model

lifecycle_stage:
  description: Description from the shared extension model

In a branch of the shared extension model, you switch to Merged mode and delete the description. Omni adds a "shallow" entry to the branch. You can see the entry in Staged mode:

Branch - Staged mode

lifecycle_stage:
  ignored_props:
    description: "shallow"

The "shallow" entry removes only the override from the shared extension model. In each browse mode, the branch now shows:

Combined - description: Description from the shared model
Merged - No description
Staged - The ignored_props block above

To bring back the shared extension model’s description in the branch, delete the description: "shallow" line in Staged mode. You can also paste the description back in Combined or Merged mode.

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

ignored_props - Dimensions

Syntax

Properties

Examples

​Syntax

​Properties

​Examples

Syntax

Properties

Examples