Skip to main content

ODStartScreenHeaderComponent class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview​

This is an Open Ticket startscreen header component.

This component will render a header to the startscreen. Properties can be aligned left, right or centered. An optional priority can be specified to choose the location of the component.

View Source

Properties​

Methods​

Other​

Properties​

align type ➜ null|api.ODStartScreenHeaderAlignmentSettings​

The alignment settings of this header component.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

inherited priority number ➜ number​

The priority of this component.

View Source

properties array ➜ api.ODStartScreenProperty[]​

All properties of this header component.

View Source

inherited render type ➜ api.ODStartScreenComponentRenderCallback​

The render function which will render the contents of this component.

View Source

inherited renderAfter type ➜ null|api.ODStartScreenComponentRenderCallback​

An optional render function which will be inserted behind the default renderer.

View Source

inherited renderBefore type ➜ null|api.ODStartScreenComponentRenderCallback​

An optional render function which will be inserted before the default renderer.

View Source

spacer string ➜ string​

The spacer used between properties.

View Source

Methods​

constructor() function ➜ api.ODStartScreenHeaderComponent​

(no description)

View Parameters (5)

View Source

inherited protected _change() function ➜ void​

Trigger an onChange() event in the parent ODManager of this class.

View Source

inherited changed() function ➜ void​

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)
  • callback: type ➜ null|(() => void) - Parameter Description Lorem Ipsum.

View Source

inherited renderAll() function ➜ Promise​

Render this component and combine it with the renderBefore & renderAfter contents.

View Parameters (1)
  • location: number ➜ number - Parameter Description Lorem Ipsum.

View Source

Defaults​

under construction

We're still working on this part of the documentation!

Examples​

under construction

We're still working on this part of the documentation!