Class ReadViewCustomScripting

This class represents the API for custom scripting related to read views.

Hierarchy

  • CslBase
    • ReadViewCustomScripting

Properties

componentId

Accessors

componentConfig htmlElement viewConfig viewFields

Methods

translate

Properties

componentId

componentId: string = ''

The component id of the current view instance.

Accessors

componentConfig

  • get componentConfig(): Component

  • The configuration of the component to render.

    Returns Component

htmlElement

  • get htmlElement(): any

  • The rendered HTML of the view.

    Returns any

viewConfig

  • get viewConfig(): ContextManager | UpdateView | MultiRecordView | SingleRecordView | CreateView

  • The configuration of the view to render.

    Returns ContextManager | UpdateView | MultiRecordView | SingleRecordView | CreateView

viewFields

  • get viewFields(): ViewField[]

  • The viewFields of the view.

    Returns ViewField[]

Methods

translate

  • Get translation for the key provided. When the key is not found in the translation files (original or extended), the translate key is returned. Check the Translation for more information: https://docs.ometa.net/latest/public/articles/data-visualisation/views/translations/translations.html

    Returns

    The translation of the given key.

    Example

    // Get the save text in user's language.
    const saveText = CSL.translate('save');

    // Get the translation for a custom made key.
    const myTitle = CSL.translate('myProject.orderTitle');

    Parameters

    • translateKey: string

      The key of the translation to get.

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc