Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseCenteredAxisLayoutStrategy

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

The Base Layout Strategy for Central Axes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly isStacked

isStacked: boolean = false

Protected layoutAxisPartsStrategy

layoutAxisPartsStrategy: TLayoutAxisPartsWithStrategyFunc

The {@link LayoutAxisPartsStrategy} for current Axis Layout Strategy

Protected sciChartSurface

sciChartSurface: SciChartSurface

Readonly Abstract type

type: ELayoutStrategyType

Accessors

axisPosition

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

  • 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

  • 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

  • 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

  • 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

  • Gets or sets the id for the vertical or horizontal axis which is used for positioning the central axes

    Returns string

  • 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

Protected calculateTotalAxisWidth

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

Abstract layoutAxes

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

Protected layoutAxesFromBottomToTop

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

Protected layoutAxesFromLeftToRight

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

Protected layoutAxesFromRightToLeft

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

Protected layoutAxesFromTopToBottom

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

Abstract measureAxes

  • Measures required amount of space to place axes which are currently attached to the SciChartSurface SciChartSurface instance. For vertical axes - total required width of the area, for horizontal - total required height.

    Parameters

    Returns number

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void
  • 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

Abstract updateAreaSize

  • updateAreaSize(chartLayoutState: ChartLayoutState, requiredSize: number): void

  • Updates chart layout state accordingly to axes required space in axisSize dimension. Updates different areas based on strategy type.

    Parameters

    • chartLayoutState: ChartLayoutState
    • requiredSize: number

    Returns void

Protected updateAxisLayoutState

Protected updateLeftAndRightChartLayoutState

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

Protected updateTopAndBottomChartLayoutState

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

Generated using TypeDoc