Coveo Matrix Component (CoveoMatrix)

Index

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void

enable

  • enable(): void

getBindings

getCellElement

  • getCellElement(rowNumber: number, columnNumber: number): HTMLElement
  • Parameters

    • rowNumber: number
    • columnNumber: number

    Returns HTMLElement

    The associated HTMLElement.

getCellValue

  • getCellValue(rowNumber: number, columnNumber: number): string
  • Parameters

    • rowNumber: number
    • columnNumber: number

    Returns string

    The associated string.

getSelectedColumnValue

  • getSelectedColumnValue(): string

getSelectedRowValue

  • getSelectedRowValue(): string

selectCell

  • selectCell(rowNumber: number, columnNumber: number): void

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

Properties

bind

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

componentStateModel

componentStateModel: ComponentStateModel

data

data: Cell[][]

disabled

disabled: boolean

logger

logger: Logger

queryController

queryController: QueryController

queryStateModel

queryStateModel: QueryStateModel

root

root: HTMLElement

searchInterface

searchInterface: SearchInterface

selectedColumnValue

selectedColumnValue: any

selectedRowValue

selectedRowValue: string

Static ID

ID: string

Accessors

usageAnalytics

usageAnalytics:

Component Options

cellFontSize

cellFontSize: string
Markup configuration example(s) :
data-cell-font-size='foo'

columnField

columnField: IFieldOption
Markup configuration example(s) :
data-column-field='@foo'

columnFieldValues

columnFieldValues: string[]

columnHeader

columnHeader: string
Markup configuration example(s) :
data-column-header='foo'

columnLabels

columnLabels: string[]

computedField

computedField: IFieldOption
Markup configuration example(s) :
data-computed-field='@foo'

computedFieldFormat

computedFieldFormat: string
Markup configuration example(s) :
data-computed-field-format='foo'

computedFieldOperation

computedFieldOperation: string
Markup configuration example(s) :
data-computed-field-operation='foo'

enableColumnTotals

enableColumnTotals: boolean
Markup configuration example(s) :
data-enable-column-totals='true'
data-enable-column-totals='false'

enableHoverPreview

enableHoverPreview: boolean
Markup configuration example(s) :
data-enable-hover-preview='true'
data-enable-hover-preview='false'

enableRowTotals

enableRowTotals: boolean
Markup configuration example(s) :
data-enable-row-totals='true'
data-enable-row-totals='false'

maximumNumberOfRows

maximumNumberOfRows: number
Markup configuration example(s) :
data-maximum-number-of-rows='10'

maximumNumberOfValuesInGroupBy

maximumNumberOfValuesInGroupBy: number
Markup configuration example(s) :
data-maximum-number-of-values-in-group-by='10'

previewDelay

previewDelay: number
Markup configuration example(s) :
data-preview-delay='10'

previewMaxWidth

previewMaxWidth: string
Markup configuration example(s) :
data-preview-max-width='foo'

previewMinWidth

previewMinWidth: string
Markup configuration example(s) :
data-preview-min-width='foo'

previewSortCriteria

previewSortCriteria: string
Markup configuration example(s) :
data-preview-sort-criteria='foo'

previewSortField

previewSortField: IFieldOption
Markup configuration example(s) :
data-preview-sort-field='@foo'

previewTemplate

previewTemplate: Template

rowField

rowField: IFieldOption
Markup configuration example(s) :
data-row-field='@foo'

sortCriteria

sortCriteria: string
Markup configuration example(s) :
data-sort-criteria='foo'

title

title: string
Markup configuration example(s) :
data-title='foo'

Constructors

constructor