Perseus
    Preparing search index...

    Type Alias InteractiveGraphProps

    type InteractiveGraphProps = {
        backgroundImage?: PerseusImageBackground;
        correct?: PerseusGraphType;
        fullGraphAriaDescription?: string;
        fullGraphAriaLabel?: string;
        graph: PerseusGraphType;
        gridStep?: [x: number, y: number];
        labelLocation: AxisLabelLocation;
        labels: string[];
        lockedFigures: LockedFigure[];
        markings: MarkingsType;
        range: GraphRange;
        rulerLabel?: string;
        rulerTicks?: number;
        showAxisArrows: ShowAxisArrows;
        showProtractor: boolean;
        showRuler?: boolean;
        showTooltips?: boolean;
        snapStep?: [x: number, y: number];
        step: [number, number];
    }
    Index

    Properties

    backgroundImage? correct? fullGraphAriaDescription? fullGraphAriaLabel? graph gridStep? labelLocation labels lockedFigures markings range rulerLabel? rulerTicks? showAxisArrows showProtractor showRuler? showTooltips? snapStep? step

    Properties

    backgroundImage?: PerseusImageBackground

    An optional image to use in the background

    correct?: PerseusGraphType

    The correct answer for this widget.

    fullGraphAriaDescription?: string

    Aria description that applies to the entire graph.

    fullGraphAriaLabel?: string

    Aria label that applies to the entire graph.

    graph: PerseusGraphType

    The type of graph

    gridStep?: [x: number, y: number]

    Where the grid lines on the graph will render. default [1, 1]

    NOTE(kevinb): perseus_data.go defines this as Array

    labelLocation: AxisLabelLocation

    Where to put the axis labels on the graph. default: "onAxis"

    labels: string[]

    How to label the X and Y axis. default: ["x", "y"]

    lockedFigures: LockedFigure[]

    Shapes (points, chords, etc) displayed on the graph that cannot be moved by the user.

    markings: MarkingsType

    The type of markings to display on the graph.

    • axes: shows the axes without the gride lines
    • graph: shows the axes and the grid lines
    • grid: shows only the grid lines
    • none: shows no markings
    range: GraphRange

    The X and Y coordinate ranges for the view of the graph. default: [[-10, 10], [-10, 10]]

    NOTE(kevinb): perseus_data.go defines this as Array<Array>

    rulerLabel?: string

    The unit to show on the ruler. e.g. "mm", "cm", "m", "km", "in", "ft", "yd", "mi".

    • no longer used by the InteractiveGraph widget. The property is kept on this type to prevent its accidental reuse in future features, since it may appear in production data.
    rulerTicks?: number

    How many ticks to show on the ruler. e.g. 1, 2, 4, 8, 10, 16. Must be an integer.

    • no longer used by the InteractiveGraph widget. The property is kept on this type to prevent its accidental reuse in future features, since it may appear in production data.
    showAxisArrows: ShowAxisArrows

    Whether to show the arrows on the axis.

    showProtractor: boolean

    Whether to show the Protractor tool overlaid on top of the graph

    showRuler?: boolean

    Whether to show the Ruler tool overlaid on top of the graph.

    • no longer used by the InteractiveGraph widget. The property is kept on this type to prevent its accidental reuse in future features, since it may appear in production data.
    showTooltips?: boolean

    Whether to show tooltips on the graph

    snapStep?: [x: number, y: number]

    Where the graph points will lock to when they are dragged. default [0.5, 0.5]

    NOTE(kevinb): perseus_data.go defines this as Array

    step: [number, number]

    Where the little black axis lines & labels (ticks) should render. Also known as the tick step. default [1, 1]

    NOTE(kevinb): perseus_data.go defines this as Array

    Settings

    Member Visibility

    On This Page

    Properties