Menu

Hierarchy

  • CflEnvironment

Implemented by

Index

Other Methods

getter Methods

setter Methods

styling Methods

Other Methods

getData

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

    Returns CartesianDataCell

    CartesianDataCell

isMemberEqualOrParent

  • Parameters

    • parent: Member

      The potential parent Member

    • member: Member

      The member that should be checked

    • dimension: Dimension

      The dimension, both members reside in

    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

isRowResultCell

  • isRowResultCell(): boolean

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

    Returns boolean

    boolean

getter Methods

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

      the index of the column from which the width should be returned. If not set the width of the current cell will be returned.

    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

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

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

getProperty

  • getProperty(propertyName: string): unknown

  • Parameters

    • propertyName: string

      The Key of the property that should be returned

    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(): BaseCflStyles

  • Returns BaseCflStyles

    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

      The column index (not including header) of the desired Data cell

    • y: number

      The row index (not including header) of the desired Data cell

    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.

isResultCell

  • isResultCell(): boolean

  • Returns boolean

    True if the cell is an aggregated value

isSelectedBy

  • isSelectedBy(dataSelectionName: string): boolean

  • Parameters

    • dataSelectionName: string

      The name (description) of a DataSelection that should be matched against

    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).

setter Methods

addCssClass

  • addCssClass(cssClass: string): void

  • Appends a css class to the cell.

    Parameters

    • cssClass: string

      The class name that should be appended to the cell.

    Returns void

appendStyle

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

  • Appends styles.

    Parameters

    • classname: string

      The name of the Element that the style should be appended to

    • style: CSSProperties

      An Object with keys equal

    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

      the new styles which will be integrated into the current cellModel's existing cflStyles

    Returns void

setAxisScenario

  • setAxisScenario(scenarioId: string): void

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

    Parameters

    • scenarioId: string

      The scenarioID that should be applied

    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

      UTF-8 character that should be displayed

    Returns void

setScenario

  • setScenario(scenarioId: string): void

  • Sets The scenario of a cell

    Parameters

    • scenarioId: string

      The scenarioId that should be applied

    Returns void

setShowScenarioBar

  • setShowScenarioBar(showScenarioBar: boolean): void

  • Sets the visibility of the scenario Bar in the headers

    Parameters

    • showScenarioBar: boolean

      True if scenario bar should be displayed

    Returns void

setStyles

  • setStyles(styles: Record<string, BaseCflStyles>): void

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

    Parameters

    • styles: Record<string, BaseCflStyles>

      the new styles to replace current cellModel's member cflStyles

    Returns void

setText

  • setText(text: string): void

  • Sets the Text

    Parameters

    • text: string

      That should be displayed by Header

    Returns void

styling Methods

addCssClass

  • addCssClass(cssClass: string): void

  • Appends a css class to the cell.

    Parameters

    • cssClass: string

      The class name that should be appended to the cell.

    Returns void

Generated using TypeDoc