Class: DataSheet

• [new DataSheet(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.datasheet.datasheet.datasheet.md#new datasheet(options))

• new DataSheet(options?)

Create data sheet

BaseWidget.constructor

▸ addBaseLayer(baseLayer): DataSheet

Add baseLayer to container

DataSheet

this

BaseWidget.addBaseLayer

▸ addChild(node): DataSheet

Add a child node

DataSheet

this

BaseWidget.addChild

▸ addColumn(columnData): DataSheet

Add a new column at the end of DataSheet

DataSheet

this

▸ addCssClass(cssclass): DataSheet

Adds new css class to node

DataSheet

this

BaseWidget.addCssClass

▸ addInvalidateHandler(handler): DataSheet

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

DataSheet

this

BaseWidget.addInvalidateHandler

▸ addOverlay(overlay): DataSheet

Add overlay to container

DataSheet

this

BaseWidget.addOverlay

▸ addRow(rowData): DataSheet

Add a new row at the end of DataSheet

DataSheet

this

▸ adjustPosition(area?, vAlign?, hAlign?): DataSheet

Adjust position of node to specified area

DataSheet

this

BaseWidget.adjustPosition

▸ Protected applyOpacity(context): DataSheet

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

DataSheet

this

BaseWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

BaseWidget.applyResponsiveStyle

▸ changeBaseLayerOrder(overlay, order, anchor?): DataSheet

Changes the z-order of the baseLayer.

DataSheet

this

BaseWidget.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): DataSheet

changes the z-order of the nodes being rendered.

DataSheet

this

BaseWidget.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): DataSheet

Changes the z-order of the overlay.

DataSheet

this

BaseWidget.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

BaseWidget.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): DataSheet

Remove all child baseLayers from group

DataSheet

this

BaseWidget.clearBaseLayers

▸ clearCache(): DataSheet

Clear cache

DataSheet

this

BaseWidget.clearCache

▸ clearChildren(disposeChildren?): DataSheet

Remove all child nodes from this composite group

DataSheet

this

BaseWidget.clearChildren

▸ clearOverlays(disposeOverlays?): DataSheet

Remove all child overlays from group

DataSheet

this

BaseWidget.clearOverlays

▸ clone(): Group<Node&gt;

All subclasses should override copyConstructor or provide custom implementation for this method

Group<Node&gt;

clone

BaseWidget.clone

▸ connectStyle(style, type, callback): DataSheet

Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> And automatically un-subscribes listener if node is disposed to prevent memory leaks

DataSheet

this

BaseWidget.connectStyle

▸ connectTool(tool): DataSheet

Connect a new tool with a toolname to the widget

DataSheet

this

BaseWidget.connectTool

▸ Protected copyConstructor(src, deepCopy?): DataSheet

Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>

DataSheet

this

BaseWidget.copyConstructor

▸ disconnectStyle(style, type, callback): DataSheet

Disconnect style <br> This convenience method un-subscribes a listener to given style for the specified type.<br>

DataSheet

this

BaseWidget.disconnectStyle

▸ disconnectTool(tool): DataSheet

Disconnect the tool from the widget

DataSheet

this

BaseWidget.disconnectTool

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

BaseWidget.dispose

▸ Protected drawBorder(localContext, bounds?): DataSheet

Draws a rectangle at the bounding box (in parent coordinates)

DataSheet

this

BaseWidget.drawBorder

▸ enableClipping(doClip): DataSheet

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

DataSheet

this

BaseWidget.enableClipping

▸ enableEventPropagation(enable): DataSheet

Enable event propagation from the node hierarchy from bottom to top <p> This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance. </p>

Example

import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

DataSheet

this

BaseWidget.enableEventPropagation

▸ enablePickingChildren(enable): DataSheet

Enables or disables picking children

DataSheet

this

BaseWidget.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

BaseWidget.enumerateNodes

▸ execute(delegate): DataSheet

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> and we do not need to scroll up or down in IDE to find how and where it was initialized.

Example

// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});

DataSheet

The result if any or this

BaseWidget.execute

▸ execute<T&gt;(delegate): T

T

BaseWidget.execute

▸ Protected filter(context): boolean

Filter node

boolean

flag filter flag ("true" to render node; "false" otherwise)

BaseWidget.filter

▸ getActiveCell(): Cell

Get active cell

Cell

Active cell

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

BaseWidget.getAnimationStyle

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

BaseWidget.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

BaseWidget.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

BaseWidget.getBaseLayer

▸ getBaseLayers<S&gt;(predicate, modify?): Iterator<Node&gt;

Return iterator by baseLayers nodes

Iterator<Node&gt;

BaseWidget.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node&gt;

An iterator for child overlays.

BaseWidget.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

BaseWidget.getBaseLayersCount

▸ getBounds(): Rect

Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.

Rect

current bounds

BaseWidget.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

BaseWidget.getCache

▸ getCell(row, column): Cell

Get cell

Cell

Cell

▸ getChild(i): Node

Return node by index

Node

BaseWidget.getChild

▸ getChildren<S&gt;(predicate, modify?): Iterator<S&gt;

Return iterator by child nodes

Iterator<S&gt;

BaseWidget.getChildren

▸ getChildren(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<Node&gt;

An iterator for child nodes.

BaseWidget.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

BaseWidget.getChildrenCount

▸ getClassName(): string

string

BaseWidget.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

BaseWidget.getClipStyle

▸ getColumn(column): Column

Get a specific column

Column

Column

▸ getColumnData(column): (string | number)[]

Get data of a specific column

(string | number)[]

Data of column

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

BaseWidget.getContentOrientation

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

BaseWidget.getContentsArea

▸ getContentsTransform(): Transformation

<code>getContentsTransform()</code> retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

BaseWidget.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

BaseWidget.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

BaseWidget.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

BaseWidget.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

BaseWidget.getCssTransform

▸ getData(data?): object

get options

object

BaseWidget.getData

▸ getDataSet(): number[][] | string[][]

Get current content data of the table

number[][] | string[][]

data

▸ getDataSheetLimits(): Rect

Get DataSheet limits

Rect

DataSheet model limits

▸ getDataSheetVisibleModelLimits(): Rect

Get DataSheet visible model limits

Rect

DataSheet visible model limits

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

BaseWidget.getDesiredHeight

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

BaseWidget.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

BaseWidget.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

BaseWidget.getFillStyle

▸ getHighlightedColumn(): number

Get highlighted column

number

Column index

▸ getHighlightedRow(): number

Get highlighted row

number

Row index

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

BaseWidget.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

BaseWidget.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher&gt;

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

BaseWidget.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

BaseWidget.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number&gt;

return desired layout style

LayoutStyle<string | number&gt;

BaseWidget.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

BaseWidget.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

BaseWidget.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number&gt;

Return margins style

SpaceStyle<string | number&gt;

BaseWidget.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

BaseWidget.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

BaseWidget.getName

▸ getNumberOfColumns(): number

Get number of columns

number

Number of columns

▸ getNumberOfRows(): number

Get number of rows

number

Number of rows

▸ getOpacity(): number

Returns current node opacity

number

opacity

BaseWidget.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

BaseWidget.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

BaseWidget.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

BaseWidget.getOverlayAt

▸ getOverlayLayer(): Layer<Node&gt;

Returns manipulator overlay to draw shapes that should move with the model

Layer<Node&gt;

BaseWidget.getOverlayLayer

▸ getOverlays<S&gt;(predicate, modify?): Iterator<Node&gt;

Return iterator by overlays nodes

Iterator<Node&gt;

BaseWidget.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node&gt;

An iterator for child overlays.

BaseWidget.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

BaseWidget.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number&gt;

Return padding style

SpaceStyle<string | number&gt;

padding

BaseWidget.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

BaseWidget.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

BaseWidget.getPreferredSize

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object See Group.getProperties for details Keep in mind that widgets does not return scene-graph information

OptionsOut

properties

BaseWidget.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

BaseWidget.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

BaseWidget.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

BaseWidget.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

BaseWidget.getResponsiveStyle

▸ getRoot(): Node

Returns root node. <br> If node doesn't have parent then it returns itself.

Node

the root node

BaseWidget.getRoot

▸ getRow(row): Row

Get a specific row

Row

Row

▸ getRowData(row): string[] | number[]

Get data of a specific row

string[] | number[]

Data of row

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

BaseWidget.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

BaseWidget.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

BaseWidget.getTag

▸ getTool(): CompositeTool

Returns root tool associated to this widget

CompositeTool

BaseWidget.getTool

▸ getToolByName<T&gt;(toolName): Tools[T]

Returns the tool matching the given name.<br> This function also accepts tool 'path' instead of absolute name.<br> For example:<br> getToolByName("compositeTool.panningTools.trackPanning.TrackPanning")<br> Would return the same tool as <br> getToolByName("TrackPanning")<br> As long as there is only one tool named "TrackPanning" in this composite<br> See listToolsNames()<br>

Tools[T]

BaseWidget.getToolByName

▸ getToolByType(toolType): AbstractTool

Returns the tool matching the given type. or null if nothing is matching the tool type<br> For example:<br> getToolByType(geotoolkit.controls.tools.Selection)<br> Would return the same tool as<br> getToolByName("pick")<br>

AbstractTool

BaseWidget.getToolByType

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

BaseWidget.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

BaseWidget.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

BaseWidget.getVisibleModelLimits

▸ getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Transformation

BaseWidget.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

BaseWidget.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

BaseWidget.hasCssClass

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

BaseWidget.hasEventListener

▸ hideColumns(columns): DataSheet

Hide columns

DataSheet

this

▸ hideRows(rows): DataSheet

Hide rows

DataSheet

this

▸ indexOfBaseLayer(baseLayer): number

Return index of overlay ( index of the specified child or -1 if baseLayer is not found)

number

BaseWidget.indexOfBaseLayer

▸ indexOfChild(node): number

Return index of child ( index of the specified child or -1 if node is not found)

number

BaseWidget.indexOfChild

▸ indexOfOverlay(overlay): number

Return index of overlay ( index of the specified child or -1 if overlay is not found)

number

BaseWidget.indexOfOverlay

▸ Protected initializeTools(options?): DataSheet

function call in the constructor to initialize tools in the widget

DataSheet

this

BaseWidget.initializeTools

▸ insertBaseLayer(index, baseLayer): DataSheet

Insert child baseLayer at specified index

DataSheet

this

BaseWidget.insertBaseLayer

▸ insertChild(index, node): DataSheet

Insert child node at specified index

DataSheet

this

BaseWidget.insertChild

▸ insertColumn(index, columnData, columnTitle?): DataSheet

Insert a new column at a specified index in DataSheet

DataSheet

this

▸ insertOverlay(index, overlay): DataSheet

Insert child overlay at specified index

DataSheet

this

BaseWidget.insertOverlay

▸ insertRow(index, rowData, rowTitle?): DataSheet

Insert a new row at a specified index in DataSheet

DataSheet

this

▸ invalidate(bounds?, force?): DataSheet

Invalidate node

DataSheet

this

BaseWidget.invalidate

▸ invalidateLayout(propagate?): DataSheet

Notify that layout is invalidated. Send event Events.LayoutInvalidated

DataSheet

this

BaseWidget.invalidateLayout

▸ invalidateParent(bounds?, force?): DataSheet

Invalidate parent area

DataSheet

this

BaseWidget.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

BaseWidget.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

BaseWidget.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

BaseWidget.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

BaseWidget.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

BaseWidget.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

BaseWidget.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

BaseWidget.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

BaseWidget.isSelectable

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

BaseWidget.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

BaseWidget.isVerticalFlip

▸ listToolsNames(): string[]

List all the tools contained in this composite. Prepend their parent tools parent using a '.'.

string[]

BaseWidget.listToolsNames

▸ loadTemplate(template, registry?): void

Load template loads the saved visual properties of the current template. It is only a visual representation of the current widget. It does not contain any data

void

BaseWidget.loadTemplate

▸ mergeCells(firstCell, lastCell): MergedCell

Merge cells

MergedCell

Merged cell

▸ moveTo(area, vAlign?, hAlign?): DataSheet

MoveTo position of node to specified area

DataSheet

this