Class SpreadsheetPane

Provides information about a visualization of a group of rows and columns in a [[Worksheet]]

Hierarchy

PropertyChangeNotifierExtended
- SpreadsheetPane

Constructors

constructor

new SpreadsheetPane(a, b, c, d): SpreadsheetPane
Overrides PropertyChangeNotifierExtended.constructor
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:904
Parameters
- a: SpreadsheetRowScrollRegion
- b: SpreadsheetColumnScrollRegion
- c: ((arg1) => SpreadsheetSelection)
  - - (arg1): SpreadsheetSelection
    - Parameters
      - arg1: SpreadsheetPane
      Returns SpreadsheetSelection
- d: ISpreadsheetPaneOwner
Returns SpreadsheetPane

Properties

$type

$type: Type

propertyChanged

propertyChanged: ((sender, e) => void)

Type declaration

- (sender, e): void
- Parameters
  - sender: any
  - e: PropertyChangedEventArgs
  Returns void

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Accessors

columnScrollRegion

get columnScrollRegion(): SpreadsheetColumnScrollRegion
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:908
Returns the [[SpreadsheetColumnScrollRegion]] that contains the pane.

Returns SpreadsheetColumnScrollRegion

rowScrollRegion

get rowScrollRegion(): SpreadsheetRowScrollRegion
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:912
Returns the [[SpreadsheetRowScrollRegion]] that contains the pane.

Returns SpreadsheetRowScrollRegion

selection

get selection(): SpreadsheetSelection
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:917
Returns an object that represents the selection within the pane.

Note: Only the selection of the active pane is rendered.
Returns SpreadsheetSelection

visibleRange

get visibleRange(): SpreadsheetCellRange
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:921
Returns a range that represents the current visible range.

Returns SpreadsheetCellRange

Methods

addListener

addListener(a, b): void
Inherited from PropertyChangeNotifierExtended.addListener
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:14
Parameters
- a: ITypedPropertyChangeListener$2<any, string>
- b: boolean
Returns void

d

d(a, b, c): void
Inherited from PropertyChangeNotifierExtended.d
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:15
Parameters
- a: any
- b: string
- c: any
Returns void

e

e(a, b, c): void
Inherited from PropertyChangeNotifierExtended.e
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:16
Parameters
- a: any
- b: string
- c: any
Returns void

equals

equals(other): boolean
Inherited from PropertyChangeNotifierExtended.equals
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:10
Parameters
- other: any
Returns boolean

getHashCode

getHashCode(): number
Inherited from PropertyChangeNotifierExtended.getHashCode
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:17
Returns number

memberwiseClone

memberwiseClone(): Base
Inherited from PropertyChangeNotifierExtended.memberwiseClone
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:19
Returns Base

onPropertyValueChanged

onPropertyValueChanged(a, b, c): void
Inherited from PropertyChangeNotifierExtended.onPropertyValueChanged
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:18
Parameters
- a: any
- b: string
- c: any
Returns void

removeListener

removeListener(a): void
Inherited from PropertyChangeNotifierExtended.removeListener
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:17
Parameters
- a: ITypedPropertyChangeListener$2<any, string>
Returns void

scrollCellIntoView

scrollCellIntoView(cell): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:1022
Used to ensure that a specified cell is fully in view within the [[visibleRange]].

Parameters
- cell: SpreadsheetCell
  The cell that is to be brought into view
Returns void
scrollCellIntoView(cellAddress): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:1027
Used to ensure that a specified cell is fully in view within the [[visibleRange]].

Parameters
- cellAddress: string
  The A1 style address of the cell that is to be brought into view
Returns void

scrollColumnIntoView

scrollColumnIntoView(index): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:1041
Used to ensure that a specified column is fully in view within the [[visibleRange]].

Throws
[[ArgumentOutOfRangeException]] The 'index' must be 0 or greater.

Parameters
- index: number
  0 based index of the column to be brought into view.
Returns void

scrollRangeIntoView

scrollRangeIntoView(range): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:1046
Used to ensure that a specified cell is fully in view within the [[visibleRange]].

Parameters
- range: SpreadsheetCellRange
  The cell range that is to be brought into view
Returns void
scrollRangeIntoView(rangeAddress): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:1051
Used to ensure that a specified cell is fully in view within the [[visibleRange]].

Parameters
- rangeAddress: string
  The A1 style address of the cell range that is to be brought into view
Returns void

scrollRowIntoView

scrollRowIntoView(index): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:1065
Used to ensure that a specified row is fully in view within the [[visibleRange]].

Throws
[[ArgumentOutOfRangeException]] The 'index' must be 0 or greater.

Parameters
- index: number
  0 based index of the row to be brought into view.
Returns void

`Static` compare

compare(item1, item2): number
Inherited from PropertyChangeNotifierExtended.compare
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

compareSimple(item1, item2): number
Inherited from PropertyChangeNotifierExtended.compareSimple
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:13
Parameters
- item1: any
- item2: any
Returns number

`Static` equalsSimple

equalsSimple(item1, item2): boolean
Inherited from PropertyChangeNotifierExtended.equalsSimple
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:12
Parameters
- item1: any
- item2: any
Returns boolean

`Static` equalsStatic

equalsStatic(a, b): boolean
Inherited from PropertyChangeNotifierExtended.equalsStatic
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:11
Parameters
- a: any
- b: any
Returns boolean

`Static` getArrayOfProperties

getArrayOfProperties(obj): any[]
Inherited from PropertyChangeNotifierExtended.getArrayOfProperties
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:22
Parameters
- obj: any
Returns any[]

`Static` getArrayOfValues

getArrayOfValues(obj): any[]
Inherited from PropertyChangeNotifierExtended.getArrayOfValues
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:21
Parameters
- obj: any
Returns any[]

`Static` getHashCodeStatic

getHashCodeStatic(obj): number
Inherited from PropertyChangeNotifierExtended.getHashCodeStatic
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:18
Parameters
- obj: any
Returns number

`Static` referenceEquals

referenceEquals(a, b): boolean
Inherited from PropertyChangeNotifierExtended.referenceEquals
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

Class SpreadsheetPane

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

a: SpreadsheetRowScrollRegion

b: SpreadsheetColumnScrollRegion

c: ((arg1) => SpreadsheetSelection)

Parameters

arg1: SpreadsheetPane

Returns SpreadsheetSelection

d: ISpreadsheetPaneOwner

Returns SpreadsheetPane

Properties

$type

propertyChanged

Type declaration

Parameters

sender: any

e: PropertyChangedEventArgs

Returns void

Static $t

Static nextHashCode

Accessors

columnScrollRegion

Returns SpreadsheetColumnScrollRegion

rowScrollRegion

Returns SpreadsheetRowScrollRegion

selection

Returns SpreadsheetSelection

visibleRange

Returns SpreadsheetCellRange

Methods

addListener

Parameters

a: ITypedPropertyChangeListener$2<any, string>

b: boolean

Returns void

d

Parameters

a: any

b: string

c: any

Returns void

e

Parameters

a: any

b: string

c: any

Returns void

equals

Parameters

other: any

Returns boolean

getHashCode

Returns number

memberwiseClone

Returns Base

onPropertyValueChanged

Parameters

a: any

b: string

c: any

Returns void

removeListener

Parameters

a: ITypedPropertyChangeListener$2<any, string>

Returns void

scrollCellIntoView

Parameters

cell: SpreadsheetCell

Returns void

Parameters

cellAddress: string

Returns void

`Static` $t

`Static` nextHashCode

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` referenceEquals