Menu

This is the environment in the CFL, that every CFL-Rule can access

Hierarchy

Implements

Index

Methods

Methods

addCssClass

  • addCssClass(cssClass: string): void

  • Appends a css class to the cell.

    Parameters

    • cssClass: string

    Returns void

appendStyle

  • appendStyle(classname: AnyCflStyleName, style: CSSProperties): void

  • Appends styles.

    Parameters

    • classname: AnyCflStyleName
    • style: CSSProperties

    Returns void

appendStyles

  • appendStyles(styles: AnyCflStyles): void

  • Appends a whole styles object to the current cellModel. Integrates the passed styles definition into the cellModel's cflStyles by merging existing styles with the new ones.

    Parameters

    • styles: AnyCflStyles

    Returns void

Protected applyColumnHeaderScenarioStyling

  • applyColumnHeaderScenarioStyling(): void

  • When scenario is set for a column header cell, this rule sets styles and makes the renderer create the dt bar

    Returns void

getAddress

  • Returns Address

    Returns the current cell's data address

getAxisScenario

  • getAxisScenario(): undefined | Scenario

  • Returns undefined | Scenario

    Returns the AxisScenario of a ChartCell

getCellDimensionMetadata

getCellType

  • getCellType(): CellType

  • Returns CellType

    Returns the Type of the current Cell

getCflVariable

  • getCflVariable(key: string): unknown

  • Parameters

    • key: string

    Returns unknown

    Returns the value of a user defines Cfl Variable

getColumnHeaderCount

  • getColumnHeaderCount(): number

  • Returns number

    Returns the number of Columheader rows

getColumnWidth

  • getColumnWidth(columnIndex?: number): number

  • Returns the with of a column of the passed index in px

    Parameters

    • Optional columnIndex: number

    Returns number

    Returns the width in pixel of columns that are automaticaly sized

getCssClasses

  • getCssClasses(): string[]

  • Returns string[]

    Returns an array of the css classes of this cell

getData

  • Returns a CartesianDataCell that describes the data associated with the current cell.

    Returns CartesianDataCell

    CartesianDataCell

getDataColumnHierarchyLevel

  • getDataColumnHierarchyLevel(): number

  • Returns number

    Returns the column hierachy Level of current dataPoint (not including header)

getDataColumnIndex

  • getDataColumnIndex(): number

  • Returns number

    Returns the column index of current dataPoint (not including header)

getDataMetrics

  • getDataMetrics(): DataMetrics

  • Returns DataMetrics

    A Collection of various metrics about the whole DataSet. Mostly minima and maxima of diffent groups of data (columns, rows, selections etc.)

getDataRowHierarchyLevel

  • getDataRowHierarchyLevel(): number

  • Returns number

    Returns the row hierachy Level of current dataPoint (not including header)

getDataRowIndex

  • getDataRowIndex(): number

  • Returns number

    Returns the row index of current dataPoint (not including header)

getEditable

  • getEditable(): boolean

  • Returns boolean

    Returns true, if the cell is editable

getExplicitHierarchyMemberLevel

  • getExplicitHierarchyMemberLevel(): number

  • Returns number

getHeaderAxis

  • getHeaderAxis(): string

  • Returns string

    returns the header axis to which a header cell belongs.

getHierarchyLevel

  • getHierarchyLevel(): number

  • Returns number

    The Hierarchy Level of the header

getIndicatorSign

  • getIndicatorSign(): string

  • Returns string

    The character that is used to indicate that a row is collapsible

getMatrixColumnIndex

  • getMatrixColumnIndex(): number

  • Returns number

    Returns the column index of current cell (including header)

getMatrixData

getMatrixRowIndex

  • getMatrixRowIndex(): number

  • Returns number

    Returns the row index of current cell (including header)

getMaxColumnHierarchyLevel

  • getMaxColumnHierarchyLevel(): number

  • Returns number

    The maximum column hierachy level in the entire matrix

getMaxRowHierarchyLevel

  • getMaxRowHierarchyLevel(): number

  • Returns number

    The maximum row hierachy level in the entire matrix

getProperties

  • getProperties(): Readonly<MatrixProperties>

  • Returns Readonly<MatrixProperties>

getProperty

  • getProperty(propertyName: string): unknown

  • Parameters

    • propertyName: string

    Returns unknown

    Returns the value of a property of the matrix

getRowHeaderCount

  • getRowHeaderCount(): number

  • Returns number

    Returns the number of row header columns

getScenario

  • Returns undefined | Scenario

    Returns the Scenario of a Cell

getStyles

  • getStyles(): AnyCflStyles

  • Returns AnyCflStyles

    Returns object containing the css styles of the cell

getText

  • getText(): string

  • Returns string

    The Text of the Cell

getValue

  • getValue(): null | number

  • Returns null | number

    The Value of the current DataPoint

getValueByDataIndices

  • getValueByDataIndices(x: number, y: number): null | number

  • Parameters

    • x: number
    • y: number

    Returns null | number

    The value of a DataPoint

isCollapsed

  • isCollapsed(): boolean

  • Returns boolean

    True if a header cell is collapsed

isColumnResultCell

  • isColumnResultCell(): boolean

  • Returns boolean

    True if the current cell's column is a result column.

isMemberEqualOrParent

  • Parameters

    Returns boolean

    True if the members are euqal, of if the parent member is a parent in the explicit hierachy

isNextRowResultCell

  • isNextRowResultCell(): boolean

  • Returns if the next cell's row is a result row.

    Returns boolean

    boolean

isResultCell

  • isResultCell(): boolean

  • Returns boolean

    True if the cell is an aggregated value

isRowResultCell

  • isRowResultCell(): boolean

  • Returns if the current cell's row is a result row.

    Returns boolean

    boolean

isSelectedBy

  • isSelectedBy(dataSelectionName: string): boolean

  • Parameters

    • dataSelectionName: string

    Returns boolean

    Returns whether the cell is affected by a data selection (e.g. Scenario Assignment or Bar Chart Assignment) with the passed name (description).

setAxisScenario

  • setAxisScenario(scenarioID: string): void

  • Sets The scenario of the axis of a bar chart cell

    Parameters

    • scenarioID: string

    Returns void

setEditable

  • setEditable(isEditable: boolean): void

  • Parameters

    • isEditable: boolean

    Returns void

setIndicatorSign

  • setIndicatorSign(indicatorSign: string): void

  • Sets the Character that indicates the collapse state. Use with isCollapsed to set the signs for both states e.g.: this.setIndicatorSign(this.isCollapsed() ? "◸" : "◿");

    Parameters

    • indicatorSign: string

    Returns void

setScenario

  • setScenario(scenarioID: string): void

  • Sets The scenario of a cell

    Parameters

    • scenarioID: string

    Returns void

setShowScenarioBar

  • setShowScenarioBar(showScenarioBar: boolean): void

  • Sets the visibility of the scenario Bar in the headers

    Parameters

    • showScenarioBar: boolean

    Returns void

setStyles

  • setStyles(styles: AnyCflStyles): void

  • Replaces the current cellModel's cflStyles with the passed ones.

    Parameters

    • styles: AnyCflStyles

    Returns void

setText

  • setText(text: string): void

  • Sets the Text

    Parameters

    • text: string

    Returns void

Generated using TypeDoc