RightAlignedInnerAxisLayoutStrategy | API Documentation for SciChart.js

The default LayoutStrategy for Right Inner Axis

Hierarchy

BaseCenteredAxisLayoutStrategy
- RightAlignedInnerAxisLayoutStrategy

Constructors

constructor

new RightAlignedInnerAxisLayoutStrategy(options?: IInnerAxisLayoutStrategyOptions): RightAlignedInnerAxisLayoutStrategy

Overrides BaseCenteredAxisLayoutStrategy.constructor
- Defined in src/Charting/LayoutManager/RightAlignedInnerAxisLayoutStrategy.ts
Parameters
- Optional options: IInnerAxisLayoutStrategyOptions
Returns RightAlignedInnerAxisLayoutStrategy

Properties

Readonly isStacked

isStacked: boolean = false

Protected layoutAxisPartsStrategy

layoutAxisPartsStrategy: TLayoutAxisPartsWithStrategyFunc

The {@link LayoutAxisPartsStrategy} for current Axis Layout Strategy

Protected sciChartSurface

sciChartSurface: SciChartSurface

Readonly type

type: RightInner = ELayoutStrategyType.RightInner

Accessors

axisPosition

get axisPosition(): number
set axisPosition(value: number): void

Inherited from BaseCenteredAxisLayoutStrategy.axisPosition
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
Gets or sets the coordinate of the Layout Area anchor point

remarks

The axisPosition obeys coordinateMode which defines whether it is a pixel, data-value or relative coordinate

Returns number
Inherited from BaseCenteredAxisLayoutStrategy.axisPosition
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
Gets or sets the coordinate of the Layout Area anchor point

remarks

The axisPosition obeys coordinateMode which defines whether it is a pixel, data-value or relative coordinate

Parameters
- value: number
Returns void

coordinateMode

get coordinateMode(): number
set coordinateMode(value: number): void

Inherited from BaseCenteredAxisLayoutStrategy.coordinateMode
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
The Coordinate mode. See EInnerAxisPlacementCoordinateMode for a list of values

remarks

Want to display an annotation stretching across the entire width (or height) or the SciChartSurface? The EInnerAxisPlacementCoordinateMode enum has options which allow for relative, absolute or pixel coordinates which define annotation placement.

Returns number
Inherited from BaseCenteredAxisLayoutStrategy.coordinateMode
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
The Coordinate mode. See EInnerAxisPlacementCoordinateMode for a list of values

remarks

Want to display an annotation stretching across the entire width (or height) or the SciChartSurface? The EInnerAxisPlacementCoordinateMode enum has options which allow for relative, absolute or pixel coordinates which define annotation placement.

Parameters
- value: number
Returns void

orthogonalAxisId

get orthogonalAxisId(): string
set orthogonalAxisId(value: string): void

Inherited from BaseCenteredAxisLayoutStrategy.orthogonalAxisId
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
Gets or sets the id for the vertical or horizontal axis which is used for positioning the central axes

Returns string
Inherited from BaseCenteredAxisLayoutStrategy.orthogonalAxisId
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
Gets or sets the id for the vertical or horizontal axis which is used for positioning the central axes

Parameters
- value: string
Returns void

Methods

Protected calculateTotalAxisHeight

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

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

Protected calculateTotalAxisWidth

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

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

layoutAxes

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

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

Protected layoutAxesFromBottomToTop

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

Inherited from BaseAxisLayoutStrategy.layoutAxesFromBottomToTop
- 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

Inherited from BaseAxisLayoutStrategy.layoutAxesFromLeftToRight
- 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

Inherited from BaseAxisLayoutStrategy.layoutAxesFromRightToLeft
- 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

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

measureAxes

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

Overrides BaseAxisLayoutStrategy.measureAxes
- Defined in src/Charting/LayoutManager/RightAlignedInnerAxisLayoutStrategy.ts
Parameters
- sciChartSurface: SciChartSurface
- chartLayoutState: ChartLayoutState
- axes: AxisBase2D[]
Returns void

Protected notifyPropertyChanged

notifyPropertyChanged(propertyName: string): void

Inherited from BaseCenteredAxisLayoutStrategy.notifyPropertyChanged
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
summary

Notifies subscribers that a property has changed and the chart requires redrawing

description

SciChart provides fully reactive components, changing any property or changing data will cause the SciChartSurface to redraw where necessary.

Parameters
- propertyName: string
  
  The name of the property which has changed
Returns void

toJSON

toJSON(): { options: {}; type: ELayoutStrategyType }

Inherited from BaseCenteredAxisLayoutStrategy.toJSON

Overrides BaseAxisLayoutStrategy.toJSON
- Defined in src/Charting/LayoutManager/BaseCenteredAxisLayoutStrategy.ts
Returns { options: {}; type: ELayoutStrategyType }
- options: {}
- type: ELayoutStrategyType

Protected updateAxisLayoutState

updateAxisLayoutState(axis: AxisBase2D): void

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

Protected updateLeftAndRightChartLayoutState

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

Inherited from BaseAxisLayoutStrategy.updateLeftAndRightChartLayoutState
- 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

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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: IInnerAxisLayoutStrategyOptions

Returns RightAlignedInnerAxisLayoutStrategy

Properties

Readonly isStacked

Protected layoutAxisPartsStrategy

Protected sciChartSurface

Readonly type

Accessors

axisPosition

Returns number

Parameters

value: number

Returns void

coordinateMode

Returns number

Parameters

value: number

Returns void

orthogonalAxisId

Returns string

Parameters

value: string

Returns void

Methods

Protected calculateTotalAxisHeight

Parameters

axis: AxisBase2D

totalAxisAreaHeight: number

Returns number

Protected calculateTotalAxisWidth

Parameters

axis: AxisBase2D

totalAxisAreaHeight: number

Returns number

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