Perseus
    Preparing search index...

    Type Alias PerseusInteractionGraph

    type PerseusInteractionGraph = {
        backgroundImage?: PerseusImageBackground;
        box: Size;
        editableSettings?: ("canvas" | "graph")[];
        gridStep: [number, number];
        labels: string[];
        markings: MarkingsType;
        range: [Interval, Interval];
        rulerLabel?: string;
        rulerTicks?: number;
        showProtractor?: boolean;
        showRuler?: boolean;
        snapStep?: [number, number];
        tickStep: [number, number];
        valid?: boolean | string;
    }
    Index

    Properties

    backgroundImage? box editableSettings? gridStep labels markings range rulerLabel? rulerTicks? showProtractor? showRuler? snapStep? tickStep valid?

    Properties

    backgroundImage?: PerseusImageBackground

    An optional background image to use

    box: Size

    The Grid Canvas size. e.g. [400, 140]

    editableSettings?: ("canvas" | "graph")[]

    "canvas", "graph"

    gridStep: [number, number]

    The steps in the grid. default [1, 1]

    labels: string[]

    The Axis labels. e.g. ["x", "y"]

    markings: MarkingsType

    The type of markings to display on the graph.

    range: [Interval, Interval]

    The Axis ranges. e.g. [[-10, 10], [-10, 10]]

    rulerLabel?: string

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

    rulerTicks?: number

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

    showProtractor?: boolean

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

    showRuler?: boolean

    Whether to show the Ruler tool overlayed on top of the graph

    snapStep?: [number, number]

    The snap steps. default [0.5, 0.5]

    tickStep: [number, number]

    This controls the number (and position) of the tick marks for the X and Y axis. e.g. [1, 1]

    valid?: boolean | string

    Whether the grid is valid or not. Do the numbers all make sense? NOTE(jeremy) The editor for this widget sometimes stores the graph editor validation error message into this field. It seems innocuous because it looks like many of these usages don't actually use the graph at all.

    Settings

    Member Visibility

    On This Page

    Properties