API Docs for:
Show:

Isoline Class

Extends Shape
Defined in: js/isoline.js:21
Module: gallery-isoline

Constructor

Isoline

(
  • config
)

Defined in js/isoline.js:21

Parameters:

Methods

_draw

() protected

Defined in js/isoline.js:36

redraw

() chainable

Defined in js/isoline.js:28

Attributes

dataCellHeight

Number

Defined in js/isoline.js:144

Default: 1

Fires event dataCellHeightChange

Fires when the value for the configuration attribute dataCellHeight is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataCellSize

Number

Defined in js/isoline.js:152

Setting dataCellSize will set dataCellHeight and dataCellWidth to the same value. It is just here as a convenience for setting a square cell size.

Fires event dataCellSizeChange

Fires when the value for the configuration attribute dataCellSize is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataCellWidth

Number

Defined in js/isoline.js:167

Default: 1

Fires event dataCellWidthChange

Fires when the value for the configuration attribute dataCellWidth is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataFn

Function

Defined in js/isoline.js:175

This function defines a two-dimensional scalar field and the threshold at which the isoline is drawn. This function will be passed x and y as arguments. This function should return either true or false.

Fires event dataFnChange

Fires when the value for the configuration attribute dataFn is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataMaxX

Number

Defined in js/isoline.js:188

The maximum X value to process. If set to null, the data will be processed up the the edge of this shape.

Default: null

Fires event dataMaxXChange

Fires when the value for the configuration attribute dataMaxX is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataMaxY

Number

Defined in js/isoline.js:198

The maximum Y value to process. If set to null, the data will be processed up the the edge of this shape.

Default: null

Fires event dataMaxYChange

Fires when the value for the configuration attribute dataMaxY is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataMinX

Number

Defined in js/isoline.js:208

The minimum X value to process. If set to null, the data will be processed up the the edge of this shape.

Default: null

Fires event dataMinXChange

Fires when the value for the configuration attribute dataMinX is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataMinY

Number

Defined in js/isoline.js:218

The minimum Y value to process. If set to null, the data will be processed up the the edge of this shape.

Default: null

Fires event dataMinYChange

Fires when the value for the configuration attribute dataMinY is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.