Class WGL2DI

Constructors

constructor

Properties

__doc__ __draw3DCircles __draw3DHighlights __draw3DLines __drawCircles __drawHighlights __drawImages __drawLines __drawSquares _timer axisScales brush brush_moving camera canvas circle_properties circles config div_container dragging draw_labels draw_options draw_order handlers height hideOnFilter highlightPoints image_position image_properties imageMoved images isFiltered label_canvas label_context line_properties lines loop mode mouse_position movingImage object_clicked object_mouse_over object_types offset pickbuffer pointOpacity pointRadius pointScale poly_brush rectangle_properties rects regl square_properties squares width x_scale y_scale zoom_amount

Methods

_addHandlers _brushingStopped _drawObjects _drawPickBuffer _extendPolyBrush _finish _finishPolyBrush _getActualPosition _getCanvasCoords _getIndexFromRGB _getMousePosition _getObjectAtPosition _getRGBFromIndex _initDrawMethods _setUpBrush _setUpDocument _setUpPolyBrush addCircles addHandler addImage addLine addRectangle addSquares changeImage changeImageOpacity clearBrush colorPoints getCameraSettings getImageDetails getObjectsInRange getPointOpacity getPointRadius getRange moveImage refresh remove removeAllLines removeAllRectangles removeHandler removeImages resizeImage setBackGroundColor setCamera setCameraProperty setFilter setFilterAction setGlobalFilter setHideOnFilter setHighlightPoints setImagePosition setPointOpacity setPointRadius setSize updateSize zoom

Constructors

constructor

  • new WGL2DI(div: string | object, config: object): WGL2DI

  • Creates a new wg2di instance

    Parameters

    • div: string | object

      The id of the div to house the instance or jquery element

    • config: object

      (optional)

      • in_view_only - if true then only those objects in view will be drawn after panning/zooming.This will speed things up if maniluplating individual objects but slow down panning and zooming
      • allow_object_drag - if true individual objects can be dragged
      • default_brush - if true then brushing will be the default drag behavior - uses shift for panning Otherwise panning is default and shift used for brushing

    Returns WGL2DI

Properties

__doc__

__doc__: Document

__draw3DCircles

__draw3DCircles: undefined | DrawCommand

__draw3DHighlights

__draw3DHighlights: undefined | DrawCommand

__draw3DLines

__draw3DLines: undefined | DrawCommand

__drawCircles

__drawCircles: undefined | DrawCommand

__drawHighlights

__drawHighlights: undefined | DrawCommand

__drawImages

__drawImages: undefined | DrawCommand

__drawLines

__drawLines: undefined | DrawCommand

__drawSquares

__drawSquares: undefined | DrawCommand

_timer

_timer: undefined | Timeout

axisScales

axisScales: undefined | number[]

brush

brush:
    | undefined
    | null
    | { div: HTMLDivElement; origin: any; resizing: boolean }

brush_moving

brush_moving: undefined | boolean

camera

camera: undefined | Camera

canvas

canvas: undefined | HTMLCanvasElement

circle_properties

circle_properties: {
    color: number;
    globalFilter: number;
    localFilter: number;
    pick_color: number;
    x_pos: number;
    y_pos: number;
}

circles

circles: {}

config

config: object

div_container

div_container: null | object

dragging

dragging: boolean

draw_labels

draw_labels: boolean

draw_options

draw_options: any

draw_order

draw_order: number[]

handlers

handlers: {
    brush_stopped: {};
    object_clicked: {};
    object_out: {};
    object_over: {};
    pan_or_zoom: {};
    panning_stopped: {};
    zoom_stopped: {};
}

height

height: any

hideOnFilter

hideOnFilter: boolean

highlightPoints

highlightPoints:
    | undefined
    | null
    | {
        color: never[];
        indexes: any;
        length: any;
        x_pos: never[];
        y_pos: never[];
    }

image_position

image_position: undefined | number[][]

image_properties

image_properties: { color: number; opacity: number; position: number }

imageMoved

imageMoved:
    | undefined
    | null
    | { height: any; index: any; position: any[]; width: any }

images

images: {}

isFiltered

isFiltered: boolean

label_canvas

label_canvas: undefined | HTMLCanvasElement

label_context

label_context: undefined | null | CanvasRenderingContext2D

line_properties

line_properties: { color: number; opacity: number; position: number }

lines

lines: {}

loop

loop: undefined | null | Cancellable

mode

mode: any

mouse_position

mouse_position: null | any[]

movingImage

movingImage: number

object_clicked

object_clicked: any

object_mouse_over

object_mouse_over: any

object_types

object_types: (
    | {
        data: {};
        primitive: string;
        properties: {
            color: number;
            globalFilter: number;
            localFilter: number;
            opacity?: undefined;
            pick_color: number;
            position?: undefined;
            x_pos: number;
            y_pos: number;
        };
        vertices: number;
    }
    | {
        data: {};
        primitive: string;
        properties: {
            color: number;
            globalFilter?: undefined;
            localFilter?: undefined;
            opacity: number;
            pick_color?: undefined;
            position: number;
            x_pos?: undefined;
            y_pos?: undefined;
        };
        vertices: number;
    }
)[]

offset

offset: number[]

pickbuffer

pickbuffer: null | Framebuffer2D

pointOpacity

pointOpacity: number

pointRadius

pointRadius: number

pointScale

pointScale: number

poly_brush

poly_brush: undefined | null | { active: boolean; points: any[] }

rectangle_properties

rectangle_properties: { color: number; opacity: number; position: number }

rects

rects: {}

regl

regl: undefined | null | Regl

square_properties

square_properties: {
    color: number;
    globalFilter: number;
    localFilter: number;
    pick_color: number;
    x_pos: number;
    y_pos: number;
}

squares

squares: {}

width

width: any

x_scale

x_scale: number

y_scale

y_scale: number

zoom_amount

zoom_amount: number

Methods

_addHandlers

_brushingStopped

_drawObjects

_drawPickBuffer

_extendPolyBrush

  • _extendPolyBrush(pos: any, threshold?: number): void

  • Parameters

    • pos: any
    • threshold: number = 15

    Returns void

_finish

_finishPolyBrush

_getActualPosition

  • _getActualPosition(position: any): number[]

  • Parameters

    • position: any

    Returns number[]

_getCanvasCoords

_getIndexFromRGB

_getMousePosition

_getObjectAtPosition

  • _getObjectAtPosition(position: any): undefined | null | number

  • Parameters

    • position: any

    Returns undefined | null | number

_getRGBFromIndex

_initDrawMethods

_setUpBrush

_setUpDocument

  • _setUpDocument(width: any, height: any): void

  • Parameters

    • width: any
    • height: any

    Returns void

_setUpPolyBrush

addCircles

addHandler

  • addHandler(handler_type: any, handler: any, name: any): any

  • Parameters

    • handler_type: any
    • handler: any
    • name: any

    Returns any

addImage

  • addImage(image: any, config: any): number

  • Parameters

    • image: any
    • config: any

    Returns number

addLine

  • addLine(
        positionTo: any,
        positionFrom: any,
        color?: number[],
        opacity?: number,
    ): number

  • Parameters

    • positionTo: any
    • positionFrom: any
    • color: number[] = ...
    • opacity: number = 1

    Returns number

addRectangle

  • addRectangle(
        position: any,
        width: any,
        height: any,
        color?: number[],
        opacity?: number,
    ): number

  • Parameters

    • position: any
    • width: any
    • height: any
    • color: number[] = ...
    • opacity: number = 1

    Returns number

addSquares

changeImage

  • changeImage(image: any, config: any, index: any): void

  • Parameters

    • image: any
    • config: any
    • index: any

    Returns void

changeImageOpacity

  • changeImageOpacity(index: any, opacity: any): void

  • Parameters

    • index: any
    • opacity: any

    Returns void

clearBrush

colorPoints

getCameraSettings

  • getCameraSettings(): undefined | { distance: number; phi: any; theta: any }

  • Returns undefined | { distance: number; phi: any; theta: any }

getImageDetails

  • getImageDetails(
        index: any,
    ): { height: any; index: any; position: any[]; width: any }

  • Parameters

    • index: any

    Returns { height: any; index: any; position: any[]; width: any }

getObjectsInRange

  • getObjectsInRange(x: any, y: any, w: any, h: any): Set<any>

  • Parameters

    • x: any
    • y: any
    • w: any
    • h: any

    Returns Set<any>

getPointOpacity

getPointRadius

getRange

  • getRange(): {
        offset: number[];
        scale: number[];
        x_range: number[];
        y_range: number[];
    }

  • Returns { offset: number[]; scale: number[]; x_range: number[]; y_range: number[] }

moveImage

refresh

remove

removeAllLines

removeAllRectangles

removeHandler

  • removeHandler(handler_type: any, name: any): void

  • Parameters

    • handler_type: any
    • name: any

    Returns void

removeImages

resizeImage

  • resizeImage(factor: any, index: any): void

  • Parameters

    • factor: any
    • index: any

    Returns void

setBackGroundColor

setCamera

  • setCamera(distance: any, theta: any, phi: any): void

  • Parameters

    • distance: any
    • theta: any
    • phi: any

    Returns void

setCameraProperty

  • setCameraProperty(property: any, value: any): void

  • Parameters

    • property: any
    • value: any

    Returns void

setFilter

setFilterAction

setGlobalFilter

setHideOnFilter

setHighlightPoints

setImagePosition

  • setImagePosition(x: any, y: any, index: any): void

  • Parameters

    • x: any
    • y: any
    • index: any

    Returns void

setPointOpacity

setPointRadius

setSize

  • setSize(width: any, height: any, rescale?: null): void

  • Parameters

    • width: any
    • height: any
    • rescale: null = null

    Returns void

updateSize

  • updateSize(newSize: any, config: any): void

  • Parameters

    • newSize: any
    • config: any

    Returns void

zoom

Settings

Member Visibility

On This Page

Constructors
Properties
Methods