RSX Code Reference
    Preparing search index...

    Class ComponentMetaData

    Contains the meta data for a component.

    Index
    constructor
    category description displayName helpURL icon isFatComponent isFavorite isProjectComponent isVisible priority type
    isMatchingSearchQuery
    category: string

    The category of the component.

    description: string

    The description of the component.

    displayName: string

    The display name of the component.

    helpURL: string

    The help URL.

    icon: { image: Image; type: EnumValue<StockIcon> }

    The icon image.

    isFatComponent: boolean

    Determines if the component is a FatComponent.

    isFavorite: boolean

    Determines if this is a user favorite.

    isProjectComponent: boolean

    Determines if the component is created by user-code in the current project.

    isVisible: boolean

    Determines if the component is visible in the UI.

    priority: number

    Components will be sorted by priority. Higher priorities will come first.

    type: Type

    The type of the component.

    • Determines if the meta data matches the specified query.

      Parameters

      • query: string

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods