Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

BackendFacetType

BackendFacetType: "SIMPLE" | "TAG" | "FACTSHEETTYPE" | "FACTSHEETSUBTYPE" | "RELATION" | "LIFECYCLE" | "SUBSCRIPTIONS" | "EXTERNAL_ID" | "HIERARCHY"

Valid GraphQL FacetType; constants defined in facets.const.ts

ChangeSet

DataModelFieldDefinition

DataModelFieldType

DataModelFieldType: "DOUBLE" | "INTEGER" | "LIFECYCLE" | "LOCATION" | "MULTIPLE_SELECT" | "SINGLE_SELECT" | "STRING" | "EXTERNAL_ID" | "PROJECT_STATUS" | "AGGREGATED" | "READ_ACCESS_CONTROL_LIST" | "WRITE_ACCESS_CONTROL_LIST" | "RELATION" | "TAGS" | "SUBSCRIPTIONS" | "DATE_TIME" | "COMPLETION" | "QUALITYSEALSTATUS"

DateFilterType

DateFilterType: "POINT" | "TODAY" | "END_OF_MONTH" | "END_OF_YEAR" | "RANGE" | "RANGE_STARTS" | "RANGE_ENDS"

DefaultFactSheetType

DefaultFactSheetType: "Default"

DropdownEntryLabel

DropdownEntryLabel: string | DropdownEntryIconLabel

DropdownEntryLabel is either a plain text attribute, or a DropdownEntryIconLabel.

EnvironmentName

EnvironmentName: "prod" | "dev" | "test"

ExportData

FacetType

FactSheetQualityState

FactSheetQualityState: "APPROVED" | "BROKEN" | "DISABLED"

FactSheetStatusState

FactSheetStatusState: "ACTIVE" | "ARCHIVED"

FactSheetViewMetaData

FactSheetViewMetaData: Record<string, FieldViewMetaData>

FactSheetViewModelSectionTabs

FactSheetViewModelSectionTabs: "default" | "subscriptions"

FactSheetViewModelTemplateType

FactSheetViewModelTemplateType: "fields" | "relation" | "projectStatus" | "properties" | "relationDiagram"

FieldMetaData

FieldMetaData: Record<string, FieldViewMetaData | FactSheetViewMetaData>

FieldViewMetaData

FormModalContainerDirection

FormModalContainerDirection: "vertical" | "horizontal"

FormModalField

FormModalFields

FormModalFields: Record<string, FormModalField>

FormModalMessage

FormModalValue

FormModalValue: null | boolean | string | string[] | FormModalValues

FrontendFacetType

FrontendFacetType: "FACT_SHEET_ID" | "FULLTEXTSEARCH" | "SINGLE_SELECT" | "UNKNOWN" | "AGGREGATION"

Pseudo-FacetTypes implemented only in front-end; constants defined in facets.const.ts

ImageExportData

Language

Language: "en" | "de" | "es" | "fr" | "pt"

MtmContractType

MtmContractType: "REGULAR" | "TRIAL"
internal

MtmPermissionRole

MtmPermissionRole: "MEMBER" | "ADMIN" | "VIEWER" | "CONTACT" | "TRANSIENT"

MtmPermissionStatus

MtmPermissionStatus: "ACTIVE" | "INVITED" | "NOTINVITED" | "ARCHIVED" | "REQUESTED" | "ANONYMIZED" | "!ACTIVE" | "!INVITED" | "!NOTINVITED" | "!ARCHIVED" | "!REQUESTED"

MtmWorkspaceStatus

MtmWorkspaceStatus: "ACTIVE" | "BLOCKED"
internal

MtmWorkspaceType

MtmWorkspaceType: "LIVE" | "DEMO" | "SANDBOX"
internal

NumericUnit

NumericUnit: "percentage"

PageContext

PageContextType

PageContextType: PageContext["type"]

PaperFormat

PaperFormat: "A0" | "A1" | "A2" | "A3" | "A4" | "Letter"

PaperOrientation

PaperOrientation: "portrait" | "landscape"

Path

PermissibleAction

PermissibleAction: "READ" | "UPDATE" | "CREATE" | "DELETE" | "ARCHIVE" | "IMPORT" | "EXPORT" | "INLINE_EDIT" | "UNLOCK" | "CHANGE_OWNER" | "MANAGE_PREDEFINED"

ProjectionAttribute

ProjectionAttributeType

ProjectionAttributeType: "field" | "relationField" | "targetField" | "path" | "timing"

ProjectionFilter

ProjectionFilterDirection

ProjectionFilterDirection: "FROM" | "TO"

ProjectionFilterType

ProjectionFilterType: ProjectionFilter["type"]

ProjectionItemTags

ProjectionItemTags: string[]

ProjectionItemValue

ProjectionItemValueMap

ProjectionItemValueMap<T>: Record<string, T>

Type parameters

RelationConstraint

RelationConstraint: "TYPE_EQUAL" | "CYCLES_ALLOWED" | "FACT_SHEET_UNIQUE_LAX"

ReportFactSheetPermissibleAction

ReportFactSheetPermissibleAction: "READ" | "CREATE" | "UPDATE" | "DELETE" | "ARCHIVE" | "INLINE_EDIT"

ReportTableConfigAttribute

ReportTableConfigAttribute: string | ReportTableColumn

Represents a Fact Sheet attribute to be displayed in a table. The attribute can be either the field name, as string, or a table column for more advanced fields.

SidePaneAlignment

SidePaneAlignment: "left" | "center" | "right"

SidePaneContainerDirection

SidePaneContainerDirection: "vertical" | "horizontal"

Direction how elements are placed next to each other within a container. Defaults to: 'vertical'

beta

SidePaneElement

Element which can be placed on the SidePane.

beta

SidePaneElements

SidePaneElements: Record<string, SidePaneElement>

SidePaneTableCell

SidePaneTableCell: string | number | Icon
beta

SortingMode

SortingMode: "BY_FIELD" | "BY_LIFECYCLE_LAST_PHASE"

SortingOrder

SortingOrder: "asc" | "desc"

SubscriptionType

SubscriptionType: "RESPONSIBLE" | "OBSERVER" | "ACCOUNTABLE"

TableColumnAlign

TableColumnAlign: "LEFT" | "RIGHT" | "CENTER" | "JUSTIFY"

TagGroupMode

TagGroupMode: "SINGLE" | "MULTIPLE"

TagModel

TagModel: Record<string, TagGroupDefinition[]>

TagStatus

TagStatus: "ACTIVE" | "ARCHIVED"

TemplateOptions

Type parameters

  • T

TimeUnit

TimeUnit: "SECONDS" | "MINUTES" | "HOURS" | "DAYS"

TimelineBookmarkSelection

TimelineBookmarkSelection: ImpactSelection | DateSelection

TimelineStep

TimelineStep: number | "today" | DateStep | MilestoneStep

TimelineStep defines a selection in the {@link UIImpactTimeline | UIImpactTimeline} element. The TimelineStep value can be of different types.

The numeric value defines a single interval step in the timeline, used for relative timelines. The 'today' value defines the current point in time. {@link DateStep | DateStep} value defines a single date. {@link MilestoneStep | MilestoneStep} defines a point referenced by a Milestone of the BTM Fact Sheet.

ToastrType

ToastrType: "warning" | "info" | "success" | "error"

UIButtonLabel

UIButtonLabel: { icon?: string; text?: string }

UIButtonLabel defines the label for a UIButton. It can have text and an icon.

Type declaration

  • Optional icon?: string
  • Optional text?: string

UIDefaultTimelineDate

UIDefaultTimelineDate: "today" | string

UIDefaultTimelineDate defines the possible values used in the {@link UIDefaultTimeline | UIDefaultTimeline}. For the current point in time, use "today". Otherwise, use a date string using the ISO format ("YYYY-MM-DD").

UIElement

UIElement defines the different types of UI elements that are available to be defined in the Reports page.

UIElementType

UIElementType: "container" | "dropdown" | "groupDropdown" | "factSheetDropdown" | "buttonGroup" | "button" | "impactSourcePicker" | "zoom" | "hierarchyDepth"

UIElementType is a identificator for each type of UI element that is used.

UIElementValues

UIElementValues: Record<string, unknown>

UIElementValues defines a key-value collection of values that each UIElement has assigned. UIElementValues expects as a key the id property defined for a given UIElement. The type of value is dependent on the type of UIElement being used.

UIImpactSourcePickerValue

Object, describing value of {@link UIImpactSourcePicker | UIImpactSourcePicker}

beta

UITimeline

UITimeline defines the configuration of a timeline element, displayed on top of the report toolbar. The timeline can be defined without any scope, and display simply a plain date timeline (UIDefaultTimeline), or in the scope of a BTM Fact Sheet UIImpactTimeline.

ViewConstraintType

ViewConstraintType: "MAPPING_PER_YEAR"

ViewInfoType

ViewInfoType: "TAG" | "FIELD" | "FIELD_RELATION" | "FIELD_TARGET_FS" | "BUILT_IN"

ViewModelFieldType

ViewModelFieldType: "text" | "number" | "externalId" | "textarea" | "multipleSelect" | "status" | "costs" | "lifecycle" | "location" | "date" | "percentage" | "acl"

Variables

Const lxCustomReportLib

lxCustomReportLib: LxCustomReportLib

Functions

cloneDeep

  • cloneDeep(obj: object): object
  • Parameters

    • obj: object

    Returns object

difference

  • difference<T>(from: Array<T>, to: Array<T>): Array<T>
  • Type parameters

    • T

    Parameters

    • from: Array<T>
    • to: Array<T>

    Returns Array<T>

flatten

  • flatten<T>(input: Array<any>): Array<T>
  • Type parameters

    • T

    Parameters

    • input: Array<any>

    Returns Array<T>

get

  • get<T>(obj: Object, path: string, defaultValue?: any): T | undefined
  • Type parameters

    • T

    Parameters

    • obj: Object
    • path: string
    • Optional defaultValue: any

    Returns T | undefined

isFunction

  • isFunction(functionToCheck: any): boolean

isObjectLike

  • isObjectLike(objectToCheck: any): boolean

isUndefined

  • isUndefined(valueToCheck: any): boolean
  • Check if value is undefined

    Parameters

    • valueToCheck: any

    Returns boolean

pickBy

  • pickBy(object: any, callback?: (value: any) => boolean): object

unset

  • unset(obj: any, path: string): void
  • Parameters

    • obj: any
    • path: string

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc