figureone
    Preparing search index...

    Class default

    FigureElementCollection representing an Axis.

    This object defines an axis with an axis line, tick marks, labels, grid lines and a title.

    See COL_Axis for the options that can be used when creating the axis.

    An axis is drawn to a length. It will have values along its length from start to stop. Ticks, grid lines and labels are all drawn at axis value positions. All other dimensions, such as line lengths, widths, positions, spaces and offsets are defined in draw space, or in the same space as the length of the axis.

    The object contains additional methods that convert between axis values and draw space positions, as well as a convenience method to report if a value is within an axis.

    To test examples below, append them to the boilerplate.

    For more examples of axis labels and axis ticks, see OBJ_AxisLabels and OBJ_AxisTicks.

    COL_Axis for parameter descriptions

    // By default an axis is an 'x' axis
    figure.add({
      make: 'collections.axis',
    });

    // An axis can also be created and then added to a figure
    // An axis can have specific start and stop values
    // An axis can be a y axis
    const axis = figure.collections.axis({
      axis: 'y',
      start: -10,
      stop: 10,
      step: 5,
    });
    figure.add('axis', axis);

    // An axis can have multiple sets of ticks and a title
    figure.add({
      make: 'collections.axis',
      step: [0.2, 0.05],
      ticks: [
        true,
        { length: 0.04, location: 'bottom' },
      ],
      title: 'time (s)',
    });

    // An axis line and ticks can be customized to be dashed
    // and have arrows
    figure.add({
      make: 'collections.axis',
      length: 2.5,
      start: -100,
      stop: 100,
      step: 25,
      line: {
        dash: [0.01, 0.01],
        arrow: 'barb',
      },
      ticks: { dash: [0.01, 0.01] },
      title: {
        font: { style: 'italic', family: 'Times New Roman' },
        text: 'x',
        location: 'right',
      },
    });

    // An axis can have grid lines extend from it, and
    // multi-line, formatted titles
    figure.add({
      make: 'collections.axis',
      stop: 2,
      step: [0.5, 0.1],
      grid: [
        { length: 1, color: [0.5, 0.5, 0.5, 1] },
        { length: 1, dash: [0.01, 0.01], color: [0.7, 0.7, 0.7, 1] },
      ],
      title: {
        font: { color: [0.4, 0.4, 0.4, 1] },
        text: [
          'Total Time',
          {
            text: 'in seconds',
            font: { size: 0.1 },
            lineSpace: 0.12,
          },
        ],
      },
    });

    Hierarchy (View Summary)

    Index

    Methods

    setScene setPosition setRotation setScale setTransform setScenario saveScenario getPath transformPoint spaceTransformMatrix getScale getRotation getPosition setFigurePosition setPositionToElement setTouchable setMove setMovable toggleShow getTransform isMoving toFront toBack add pulse getElement getElements get show hide getBorder setColor setDimColor undim dim getAllPrimitives getAllElements recreateAtlases getChildren isAnimating pan panDeltaValue panDeltaDraw zoom zoomValue zoomDelta valueToDraw drawToValue inAxis

    Methods

    • Conveniently set the first scale of the element's transform.

      Parameters

      • scaleOrX: number | TypeParsablePoint

        horizontal scale - either define as full x-y point, or as a number. If scaleOrX is a number and y is null, then both x and y will be equally scaled

      • y: number | null = null

        y coordinate if scaleOrX is a number (null)

      • z: number = 1

      Returns void

    • Transform a point between 'draw', 'local', 'figure', 'gl' and 'pixel' spaces.

      plane is only needed when converting from pixel space (a 2D space) to 'figure', 'local' or 'draw' spaces (a 3D space). A ray from the pixel is drawn into the screen and the intersection with the defined plane is returned.

      'pixel' to 'gl' is also a 2D to 3D transformation, but in this case the XY plane at z = 0 is used in gl space.

      Parameters

      • point: TypeParsablePoint
      • fromSpace: "figure" | "pixel" | "gl" | "local" | "draw"

        space to convert point from

      • toSpace: "figure" | "pixel" | "gl" | "local" | "draw"

        space to convert point to

      • toSpacePlane: TypeParsablePlane = ...

      Returns Point

    • Return the first rotation in the element's transform.

      Parameters

      • normalize: "" | "0to360" | "-180to180" = ''

        how to normalize the returned angle where '' returns the raw angle

      Returns number

      scale

    • Get position of element

      By default the first translation of the element's transform is returned. This is effectively the element's location in 'local' coordinates.

      The position of the element relative to its horizontal and vertical bounds can also be returned. Use xAlign to find the x coordinate of the left, center, right or percentage width from left of the element. Use yAlign to find the bottom, middle, top or percentage height from bottom of the element.

      Parameters

      • space: TypeCoordinateSpace = 'local'

        the space to return the position in

      • xAlign: number | "left" | "right" | "center" | "location" = 'location'

        horizontal alignment of position. Use a number to define the horizontal position in percentage width from the left.

      • yAlign: number | "top" | "bottom" | "middle" | "location" = 'location'

        vertical alignment of position. Use a number to define the vertical position in percentage height from the bottom.

      Returns Point

    • Add a figure element to this collection.

      If adding an array of elements, then the added elements will be returned in an array (even if only one element is added). If not adding an array, then that single element will be returned.

      Parameters

      Returns any

      added element, or array of added elements

      // Add name and element
      const collection = figure.add({ make: 'collection' });
      const element = figure.primitives.polygon({ radius: 1 });
      collection.add('name', element);

      // Element only (name will be autogenerated)
      const collection = figure.add({ make: 'collection' });
      const element = figure.primitives.polygon({ radius: 1 });
      collection.add(element);

      // Element definition (if no name is provided, then name will
      // be auto generated)
      const collection = figure.add({ make: 'collection' });
      collection.add({
        make: 'polygon',
        radius: 1,
      });

      // Array of elements
      const collection = figure.add({ make: 'collection' });
      const polygon1 = figure.primitives.polygon({ radius: 1 });
      collection.add([
        polygon1,
        {
          make: 'polygon',
          radius: 0.2,
          color: [0, 0, 1, 1],
        },
      ]);

    • Pulse element.

      An element can be pulsed in scale, a rotation or a translation.

      The scale pulse can either be a single pulse, or a number of copies with a range of scales - which has the effect of making regular polygons thick.

      Either pass in a callback, or an options object defining the pulse and callback.

      Parameters

      • optionsOrElementsOrDone:
            | (string | FigureElement)[]
            | OBJ_Pulse & { elements?: (string | FigureElement)[] }
            | ((arg: any) => void)
            | null
            | undefined = null
      • done: ((arg: any) => void) | null | undefined = null

      Returns void

    • Get element from an element path with '.' separators.

      For instance, if a collection has a child collection 'a', which has a child primitive 'b', then the path would be: 'a.b'.

      Parameters

      Returns any

      element at path. If elementPath is null, then this element is returned. If elementPath is invalid then null is returned.

      element.getElement

      // Get all the elements from a figure
      figure.add(
        {
          name: 'c',
          make: 'collection',
          elements: [
            {
              name: 'tri',
              make: 'triangle',
              height: 0.4,
              width: 0.4,
            },
            {
              name: 'text',
              make: 'text',
              text: 'triangle',
              position: [0, -0.4],
              xAlign: 'center',
            },
          ],
        },
      );

      const c = figure.getElement('c');
      // Elements within collections can be found with dot notation
      const tri = figure.getElement('c.tri');
      // Or the collection can be queried directly
      const text = c.getElement('text');

    • Get the border or touchBorder of a FigureElementCollection in a defined coordinate space.

      Parameters

      • space: Type3DMatrix | TypeCoordinateSpace = 'local'

        ('local)

      • border: "border" | "touchBorder" = 'border'

        ('border')

      • children: (string | FigureElement)[] | null | undefined = null

        choose specific children only - use null for all children (null)

      • shownOnly: boolean = true

        if true then only children that are shown will be used (true)

      Returns any[]

    • Zoom to some magnitude (mag), such that value is located at drawPosition on the axis.

      Parameters

      • value: number
      • drawPosition: number
      • mag: number

      Returns void

    • Zoom by a delta magnitude on a value already shown on the axis.

      Parameters

      • value: number
      • magDelta: number

      Returns void

    • Convert an axis value or values to a draw space position or positions.

      'x' axes have a draw space position of 0 on the left end of the axis and 'y' axes have a draw space position of 0 on the bottom end of the axis.

      Parameters

      • value: number

      Returns number

      draw space position

    • Convert an axis value or values to a draw space position or positions.

      'x' axes have a draw space position of 0 on the left end of the axis and 'y' axes have a draw space position of 0 on the bottom end of the axis.

      Parameters

      • value: number[]

      Returns number[]

      draw space position

    • Convert an axis draw space value or values to an axis value or values.

      'x' axes have a draw space position of 0 on the left end of the axis and 'y' axes have a draw space position of 0 on the bottom end of the axis.

      Parameters

      • drawValue: number

      Returns number

      draw space position

    • Convert an axis draw space value or values to an axis value or values.

      'x' axes have a draw space position of 0 on the left end of the axis and 'y' axes have a draw space position of 0 on the bottom end of the axis.

      Parameters

      • drawValue: number[]

      Returns number[]

      draw space position

    • Check if a value is within the axis.

      Parameters

      • value: number
      • precision: number = 8

      Returns boolean

      true if value is within length of axis.

    Settings

    Member Visibility

    On This Page

    Methods