SynchronizedLayoutManager | API Documentation for SciChart.js

An {@link ILayoutManager} used by SciChartVerticalGroup to synchronise Layout accross mutltiple SciChartSurfaces in a group

Hierarchy

LayoutManager
- SynchronizedLayoutManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SynchronizedLayoutManager(verticalGroup?: SciChartVerticalGroup, horizontalGroup?: SciChartHorizontalGroup, options?: ILayoutManagerOptions): SynchronizedLayoutManager

Overrides LayoutManager.constructor
- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Parameters
- Optional verticalGroup: SciChartVerticalGroup
- Optional horizontalGroup: SciChartHorizontalGroup
- Optional options: ILayoutManagerOptions
Returns SynchronizedLayoutManager

Properties

Protected axesGroupedByLayoutStrategy

axesGroupedByLayoutStrategy: LayoutStrategyAxes = new LayoutStrategyAxes()

bottomInnerAxesLayoutStrategy

bottomInnerAxesLayoutStrategy: BaseCenteredAxisLayoutStrategy = new BottomAlignedInnerAxisLayoutStrategy()

Layout strategy for layout of bottom aligned inner axis

Protected bottomOuterAxesLayoutStrategyProperty

bottomOuterAxesLayoutStrategyProperty: BaseAxisLayoutStrategy = new BottomAlignedOuterAxisLayoutStrategy()

Layout strategy for layout of bottom aligned axis outside

Protected chartLayoutState

chartLayoutState: ChartLayoutState = new ChartLayoutState()

horizontalGroup

horizontalGroup: SciChartHorizontalGroup | undefined

Readonly id

id: string = generateGuid()

leftInnerAxesLayoutStrategy

leftInnerAxesLayoutStrategy: BaseCenteredAxisLayoutStrategy = new LeftAlignedInnerAxisLayoutStrategy()

Layout strategy for layout of left aligned inner axis

Protected leftOuterAxesLayoutStrategyProperty

leftOuterAxesLayoutStrategyProperty: BaseAxisLayoutStrategy = new LeftAlignedOuterAxisLayoutStrategy()

Layout strategy for layout of left aligned axis outside

rightInnerAxesLayoutStrategy

rightInnerAxesLayoutStrategy: BaseCenteredAxisLayoutStrategy = new RightAlignedInnerAxisLayoutStrategy()

Layout strategy for layout of right aligned inner axis

Protected rightOuterAxesLayoutStrategyProperty

rightOuterAxesLayoutStrategyProperty: BaseAxisLayoutStrategy = new RightAlignedOuterAxisLayoutStrategy()

Layout strategy for layout of right aligned axis outside

sciChartSurface

sciChartSurface: SciChartSurface

topInnerAxesLayoutStrategy

topInnerAxesLayoutStrategy: BaseCenteredAxisLayoutStrategy = new TopAlignedInnerAxisLayoutStrategy()

Layout strategy for layout of top aligned inner axis

Protected topOuterAxesLayoutStrategyProperty

topOuterAxesLayoutStrategyProperty: BaseAxisLayoutStrategy = new TopAlignedOuterAxisLayoutStrategy()

Layout strategy for layout of top aligned axis outside

type

type: ELayoutManagerType = ELayoutManagerType.Synchronised

verticalGroup

verticalGroup: SciChartVerticalGroup | undefined

Accessors

bottomOuterAxesLayoutStrategy

get bottomOuterAxesLayoutStrategy(): BaseAxisLayoutStrategy
set bottomOuterAxesLayoutStrategy(value: BaseAxisLayoutStrategy): void

Inherited from LayoutManager.bottomOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns BaseAxisLayoutStrategy
Inherited from LayoutManager.bottomOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- value: BaseAxisLayoutStrategy
Returns void

leftOuterAxesLayoutStrategy

get leftOuterAxesLayoutStrategy(): BaseAxisLayoutStrategy
set leftOuterAxesLayoutStrategy(value: BaseAxisLayoutStrategy): void

Inherited from LayoutManager.leftOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns BaseAxisLayoutStrategy
Inherited from LayoutManager.leftOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- value: BaseAxisLayoutStrategy
Returns void

rightOuterAxesLayoutStrategy

get rightOuterAxesLayoutStrategy(): BaseAxisLayoutStrategy
set rightOuterAxesLayoutStrategy(value: BaseAxisLayoutStrategy): void

Inherited from LayoutManager.rightOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns BaseAxisLayoutStrategy
Inherited from LayoutManager.rightOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- value: BaseAxisLayoutStrategy
Returns void

topOuterAxesLayoutStrategy

get topOuterAxesLayoutStrategy(): BaseAxisLayoutStrategy
set topOuterAxesLayoutStrategy(value: BaseAxisLayoutStrategy): void

Inherited from LayoutManager.topOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns BaseAxisLayoutStrategy
Inherited from LayoutManager.topOuterAxesLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- value: BaseAxisLayoutStrategy
Returns void

Methods

Protected findLastVisibleAxis

findLastVisibleAxis(axes: AxisBase2D[]): AxisBase2D | undefined

- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Returns the last visible axis in the array, or falls back to the last element when no visible axis exists. Used so the group-width surplus is deposited on the outermost visible axis rather than blindly on the last array element (which may be an isVisible=false axis with axisSize=0).

Parameters
- axes: AxisBase2D[]
Returns AxisBase2D | undefined

getAxisLayoutStrategy

getAxisLayoutStrategy(axis: AxisBase2D): BaseAxisLayoutStrategy

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

Protected groupAxesByLayoutStrategy

groupAxesByLayoutStrategy(): void

Inherited from LayoutManager.groupAxesByLayoutStrategy
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns void

layoutChart

layoutChart(viewportSize: Size, padding?: Thickness): Rect

Overrides LayoutManager.layoutChart
- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Parameters
- viewportSize: Size
- Optional padding: Thickness
Returns Rect

Protected layoutChartCenter

layoutChartCenter(left: number, top: number, right: number, bottom: number): void

Inherited from LayoutManager.layoutChartCenter
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- left: number
- top: number
- right: number
- bottom: number
Returns void

Protected measureBottomInnerAxes

measureBottomInnerAxes(): void

Inherited from LayoutManager.measureBottomInnerAxes
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns void

Protected measureBottomOuterAxes

measureBottomOuterAxes(): void

Overrides LayoutManager.measureBottomOuterAxes
- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Returns void

Protected measureLeftInnerAxes

measureLeftInnerAxes(): void

Inherited from LayoutManager.measureLeftInnerAxes
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns void

Protected measureLeftOuterAxes

measureLeftOuterAxes(): void

Overrides LayoutManager.measureLeftOuterAxes
- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Returns void

Protected measureRightInnerAxes

measureRightInnerAxes(): void

Inherited from LayoutManager.measureRightInnerAxes
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns void

Protected measureRightOuterAxes

measureRightOuterAxes(): void

Overrides LayoutManager.measureRightOuterAxes
- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Returns void

Protected measureTopInnerAxes

measureTopInnerAxes(): void

Inherited from LayoutManager.measureTopInnerAxes
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns void

Protected measureTopOuterAxes

measureTopOuterAxes(): void

Overrides LayoutManager.measureTopOuterAxes
- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Returns void

Protected resetAxes

resetAxes(axes: AxisBase2D[]): void

Inherited from LayoutManager.resetAxes
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- axes: AxisBase2D[]
Returns void

Protected setSeriesViewRect

setSeriesViewRect(left: number, top: number, right: number, bottom: number): void

Inherited from LayoutManager.setSeriesViewRect
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Parameters
- left: number
- top: number
- right: number
- bottom: number
Returns void

toJSON

toJSON(): TLayoutManagerDefinition

Inherited from LayoutManager.toJSON
- Defined in src/Charting/LayoutManager/LayoutManager.ts
Returns TLayoutManagerDefinition

trySynchronizeLayouts

trySynchronizeLayouts(): void

- Defined in src/Charting/LayoutManager/SynchronizedLayoutManager.ts
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional verticalGroup: SciChartVerticalGroup

Optional horizontalGroup: SciChartHorizontalGroup

Optional options: ILayoutManagerOptions

Returns SynchronizedLayoutManager

Properties

Protected axesGroupedByLayoutStrategy

bottomInnerAxesLayoutStrategy

Protected bottomOuterAxesLayoutStrategyProperty

Protected chartLayoutState

horizontalGroup

Readonly id

leftInnerAxesLayoutStrategy

Protected leftOuterAxesLayoutStrategyProperty

rightInnerAxesLayoutStrategy

Protected rightOuterAxesLayoutStrategyProperty

sciChartSurface

topInnerAxesLayoutStrategy

Protected topOuterAxesLayoutStrategyProperty

type

verticalGroup

Accessors

bottomOuterAxesLayoutStrategy

Returns BaseAxisLayoutStrategy

Parameters

value: BaseAxisLayoutStrategy

Returns void

leftOuterAxesLayoutStrategy

Returns BaseAxisLayoutStrategy

Parameters

value: BaseAxisLayoutStrategy

Returns void

rightOuterAxesLayoutStrategy

Returns BaseAxisLayoutStrategy

Parameters

value: BaseAxisLayoutStrategy

Returns void

topOuterAxesLayoutStrategy

Returns BaseAxisLayoutStrategy

Parameters

value: BaseAxisLayoutStrategy

Returns void

Methods

Protected findLastVisibleAxis

Parameters

axes: AxisBase2D[]

Returns AxisBase2D | undefined

getAxisLayoutStrategy

Parameters

axis: AxisBase2D

Returns BaseAxisLayoutStrategy

Protected groupAxesByLayoutStrategy

Returns void

layoutChart

Parameters

viewportSize: Size

Optional padding: Thickness

Returns Rect

Protected layoutChartCenter

Parameters

left: number

top: number

right: number

bottom: number

Returns void

Protected measureBottomInnerAxes

Returns void

Protected measureBottomOuterAxes

Returns void

Protected measureLeftInnerAxes

Returns void

Protected measureLeftOuterAxes