CustomWidgetOptions

Defined in: layout/types.ts:338

Options for layout components.

Extends

• WidgetComponentOptions

Properties

widget

widget: "custom"

Defined in: layout/types.ts:339

X-intellij-html-description

Type of the widget to use.

\n

\n
• custom: Custom widget
\n
• donut: Donut chart
\n
• history: History chart
\n
• kanban: Kanban board
\n
• permissions: Permissions widget
\n
• scan: Scan widget
\n
• bar: Bar chart
\n
• column: Column chart
\n
• line: Line chart
\n
• progress: Progress widget
\n
• radar: Radar chart
\n

Overrides

WidgetComponentOptions.widget

---

component?

optional component?: string

Defined in: layout/types.ts:341

X-intellij-html-description

Name of a Vue component to use for the widget, if "custom" is selected.

---

view?

optional view?: string

Defined in: layout/types.ts:343

X-intellij-html-description

Name of a view entity to use for the widget, if "custom" is selected.

---

dynamic_height?

optional dynamic_height?: boolean

Defined in: layout/types.ts:303

Inherited from

WidgetComponentOptions.dynamic_height

---

hidden_from_frontend?

optional hidden_from_frontend?: boolean

Defined in: layout/types.ts:120

Inherited from

WidgetComponentOptions.hidden_from_frontend

---

show_in?

optional show_in?: DefinedModuleAction[]

Defined in: layout/types.ts:121

Inherited from

WidgetComponentOptions.show_in

---

recipes?

optional recipes?: LayoutElementRecipes | { widget: string; component?: string; view?: string; dynamic_height?: string; hidden_from_frontend?: string; show_in?: string; recipes?: string; }

Defined in: layout/types.ts:122

Union Members

LayoutElementRecipes

---

Type Literal

{ widget: string; component?: string; view?: string; dynamic_height?: string; hidden_from_frontend?: string; show_in?: string; recipes?: string; }

widget

widget: string

X-intellij-html-description

Type of the widget to use.

\n

\n
• custom: Custom widget
\n
• donut: Donut chart
\n
• history: History chart
\n
• kanban: Kanban board
\n
• permissions: Permissions widget
\n
• scan: Scan widget
\n
• bar: Bar chart
\n
• column: Column chart
\n
• line: Line chart
\n
• progress: Progress widget
\n
• radar: Radar chart
\n

component?

optional component?: string

X-intellij-html-description

Name of a Vue component to use for the widget, if "custom" is selected.

view?

optional view?: string

X-intellij-html-description

Name of a view entity to use for the widget, if "custom" is selected.

dynamic_height?

optional dynamic_height?: string

hidden_from_frontend?

optional hidden_from_frontend?: string

show_in?

optional show_in?: string

recipes?

optional recipes?: string

Inherited from

WidgetComponentOptions.recipes