BaseAxisLayoutStrategy | API Documentation for SciChart.js

The Base Axis Layout Strategy

Hierarchy

BaseAxisLayoutStrategy

Index

Properties

Methods

Properties

Readonly isStacked

isStacked: boolean = false

Protected layoutAxisPartsStrategy

layoutAxisPartsStrategy: TLayoutAxisPartsWithStrategyFunc

The {@link LayoutAxisPartsStrategy} for current Axis Layout Strategy

Readonly Abstract type

type: ELayoutStrategyType

Methods

Protected calculateTotalAxisHeight

calculateTotalAxisHeight(axis: AxisBase2D, totalAxisAreaHeight: number): number

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- axis: AxisBase2D
- totalAxisAreaHeight: number
Returns number

Protected calculateTotalAxisWidth

calculateTotalAxisWidth(axis: AxisBase2D, totalAxisAreaHeight: number): number

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- axis: AxisBase2D
- totalAxisAreaHeight: number
Returns number

Abstract layoutAxes

layoutAxes(left: number, top: number, right: number, bottom: number, axes: AxisBase2D[]): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Perform layout on axes which use this layout strategy

Parameters
- left: number
  
  left position of area relative to parent SciChartSurface
- top: number
  
  top position of area relative to parent SciChartSurface
- right: number
  
  right position of area relative to parent SciChartSurface
- bottom: number
  
  bottom position of area relative to parent SciChartSurface
- axes: AxisBase2D[]
Returns void

Protected layoutAxesFromBottomToTop

layoutAxesFromBottomToTop(left: number, top: number, right: number, bottom: number, axes: AxisBase2D[]): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- left: number
- top: number
- right: number
- bottom: number
- axes: AxisBase2D[]
Returns void

Protected layoutAxesFromLeftToRight

layoutAxesFromLeftToRight(left: number, top: number, right: number, bottom: number, axes: AxisBase2D[]): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- left: number
- top: number
- right: number
- bottom: number
- axes: AxisBase2D[]
Returns void

Protected layoutAxesFromRightToLeft

layoutAxesFromRightToLeft(left: number, top: number, right: number, bottom: number, axes: AxisBase2D[]): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- left: number
- top: number
- right: number
- bottom: number
- axes: AxisBase2D[]
Returns void

Protected layoutAxesFromTopToBottom

layoutAxesFromTopToBottom(left: number, top: number, right: number, bottom: number, axes: AxisBase2D[]): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- left: number
- top: number
- right: number
- bottom: number
- axes: AxisBase2D[]
Returns void

Abstract measureAxes

measureAxes(sciChartSurface: SciChartSurface, chartLayoutState: ChartLayoutState, axes: AxisBase2D[]): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Measures required amount of space to place axes which are currently attached to the SciChartSurface SciChartSurface instance

Parameters
- sciChartSurface: SciChartSurface
- chartLayoutState: ChartLayoutState
- axes: AxisBase2D[]
Returns void

toJSON

toJSON(): { type: ELayoutStrategyType }

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Returns { type: ELayoutStrategyType }
- type: ELayoutStrategyType

Protected updateAxisLayoutState

updateAxisLayoutState(axis: AxisBase2D): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- axis: AxisBase2D
Returns void

Protected updateLeftAndRightChartLayoutState

updateLeftAndRightChartLayoutState(chartLayoutState: ChartLayoutState, additionalLeftSize: number, additionalRightSize: number): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- chartLayoutState: ChartLayoutState
- additionalLeftSize: number
- additionalRightSize: number
Returns void

Protected updateTopAndBottomChartLayoutState

updateTopAndBottomChartLayoutState(chartLayoutState: ChartLayoutState, additionalTopSize: number, additionalBottomSize: number): void

- Defined in src/Charting/LayoutManager/BaseAxisLayoutStrategy.ts
Parameters
- chartLayoutState: ChartLayoutState
- additionalTopSize: number
- additionalBottomSize: number
Returns void

Hierarchy

Index

Properties

Methods

Properties

Readonly isStacked

Protected layoutAxisPartsStrategy

Readonly Abstract type

Methods

Protected calculateTotalAxisHeight

Parameters

axis: AxisBase2D

totalAxisAreaHeight: number

Returns number

Protected calculateTotalAxisWidth

Parameters

axis: AxisBase2D

totalAxisAreaHeight: number

Returns number

Abstract layoutAxes

Parameters

left: number

top: number

right: number

bottom: number

axes: AxisBase2D[]

Returns void

Protected layoutAxesFromBottomToTop

Parameters

left: number

top: number

right: number

bottom: number

axes: AxisBase2D[]

Returns void

Protected layoutAxesFromLeftToRight

Parameters

left: number

top: number

right: number

bottom: number

axes: AxisBase2D[]

Returns void

Protected layoutAxesFromRightToLeft

Parameters

left: number

top: number

right: number

bottom: number

axes: AxisBase2D[]

Returns void

Protected layoutAxesFromTopToBottom

Parameters

left: number

top: number

right: number

bottom: number

axes: AxisBase2D[]

Returns void

Abstract measureAxes

Parameters

sciChartSurface: SciChartSurface

chartLayoutState: ChartLayoutState

axes: AxisBase2D[]

Returns void

toJSON

Returns { type: ELayoutStrategyType }

type: ELayoutStrategyType

Protected updateAxisLayoutState

Parameters

axis: AxisBase2D

Returns void

Protected updateLeftAndRightChartLayoutState

Parameters

chartLayoutState: ChartLayoutState

additionalLeftSize: number

additionalRightSize: number

Returns void

Protected updateTopAndBottomChartLayoutState

Parameters