All
  • Public
  • Public/Protected
  • All

Class RVFormattingContext

Provides context information for a formatting request.

Hierarchy

  • RVFormattingContext

Index

Constructors

Accessors

Constructors

constructor

  • new RVFormattingContext(dashboardId: null | string, requestingInitialFormat: boolean): RVFormattingContext

  • Parameters

    • dashboardId: null | string
    • requestingInitialFormat: boolean

    Returns RVFormattingContext

Accessors

dashboardId

  • get dashboardId(): null | string
  • set dashboardId(value: null | string): void

  • The ID of the dashboard where the formatting is being done. It is null if the formatting is not being done in the context of a particular dashboard.

    Returns null | string

  • The ID of the dashboard where the formatting is being done. It is null if the formatting is not being done in the context of a particular dashboard.

    Parameters

    • value: null | string

    Returns void

requestingInitialFormat

  • get requestingInitialFormat(): boolean
  • set requestingInitialFormat(value: boolean): void

  • Returns true iif the field has no formatting assigned. This can be used to avoid providing a new format to a field that has a format that was customized by the user.

    Returns boolean

  • Returns true iif the field has no formatting assigned. This can be used to avoid providing a new format to a field that has a format that was customized by the user.

    Parameters

    • value: boolean

    Returns void