Type Alias UsePlotDimensionsValues

type UsePlotDimensionsValues = {
    margin: Margin;
    plotDimensions: Dimensions;
    registerPlotDimensionChangeHandler: (
        handler: PlotDimensionChangeHandler,
    ) => string;
    unregisterPlotDimensionChangeHandler: (handlerId: string) => void;
    updateDimensions: (dimensions: Dimensions) => void;
}

Index

Properties

margin plotDimensions registerPlotDimensionChangeHandler unregisterPlotDimensionChangeHandler updateDimensions

Properties

margin

margin: Margin

The plot margins for the border of main G

plotDimensions

plotDimensions: Dimensions

The width and height (in pixels) of this chart

registerPlotDimensionChangeHandler

registerPlotDimensionChangeHandler: (
handler: PlotDimensionChangeHandler,
) => string

unregisterPlotDimensionChangeHandler

unregisterPlotDimensionChangeHandler: (handlerId: string) => void

updateDimensions

updateDimensions: (dimensions: Dimensions) => void

Update the plot dimensions (for example, on a window resize)

Type Declaration

- (dimensions: Dimensions): void
- Parameters
  - dimensions: Dimensions
    the new dimensions of the plot
  Returns void