Skip to main content

ODStartScreenPropertiesCategoryComponent 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 properties category component.

This component will render a properties category to the startscreen. This will list the properties in the category. An optional priority can be specified to choose the location of the component.

View Source

Properties​

Methods​

Other​

Properties​

inherited id class ➜ api.ODId​

The id of this data.

View Source

inherited name string ➜ string​

The name of this category.

View Source

inherited priority number ➜ number​

The priority of this component.

View Source

properties array ➜ api.ODStartScreenProperty[]​

The properties of this category component.

View Source

propertyHexColor string ➜ string​

The hex color for the key/name of all the properties.

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

inherited renderIfEmpty boolean ➜ boolean​

When enabled, this category will still be rendered when the contents are empty. (enabled by default)

View Source

Methods​

constructor() function ➜ api.ODStartScreenPropertiesCategoryComponent​

(no description)

View Parameters (6)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • priority: number ➜ number - Parameter Description Lorem Ipsum.
  • name: string ➜ string - Parameter Description Lorem Ipsum.
  • properties: array ➜ api.ODStartScreenProperty[] - Parameter Description Lorem Ipsum.
  • propertyHexColor: string ➜ string - Parameter Description Lorem Ipsum.
  • renderIfEmpty: boolean ➜ boolean - Parameter Description Lorem Ipsum.

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!