ODStartScreenCategoryComponent class
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 category component.
This component will render a category to the startscreen. This will only render the category name. You'll need to provide your own renderer for the contents. An optional priority can be specified to choose the location of the component.
Properties
inherited id class ➜ api.ODId
The id of this data.
name string ➜ string
The name of this category.
inherited priority number ➜ number
The priority of this component.
inherited render type ➜ api.ODStartScreenComponentRenderCallback
The render function which will render the contents of this component.
inherited renderAfter type ➜ null|api.ODStartScreenComponentRenderCallback
An optional render function which will be inserted behind the default renderer.
inherited renderBefore type ➜ null|api.ODStartScreenComponentRenderCallback
An optional render function which will be inserted before the default renderer.
renderIfEmpty boolean ➜ boolean
When enabled, this category will still be rendered when the contents are empty. (enabled by default)
Methods
constructor() function ➜ api.ODStartScreenCategoryComponent
(no description)
View Parameters (5)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.priority: number ➜number- Parameter Description Lorem Ipsum.name: string ➜string- Parameter Description Lorem Ipsum.render: type ➜api.ODStartScreenComponentRenderCallback- Parameter Description Lorem Ipsum.renderIfEmpty: boolean ➜boolean- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
inherited changed() function ➜ void
(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
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.
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!