API / geotoolkit / contour / faults / ContourFaultList / ContourFaultList
faults.ContourFaultList.ContourFaultList
The ContourFaultList object is used to pass the fault data to the contour shape ready for rendering. It also performs some basic pre-processing calculations on the faults (validation/etc)
Constructors
- [new ContourFaultList()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.contour.faults.contourfaultlist.contourfaultlist.md#new contourfaultlist())
Methods
▸ addFault(xCoordinates, yCoordinates, left, right, closed): void
Adds a fault with explicit data to this fault list
Throws
Error fault has less than 2 point
| Name | Type | Description |
|---|---|---|
xCoordinates | Float64Array | array of x coordinates |
yCoordinates | Float64Array | array of y coordinates |
left | Float64Array | array of left values or boolean indicating if closed |
right | Float64Array | array of right values |
closed | boolean | is fault closed or not |
void
▸ addFault(xCoordinates, yCoordinates, closed): void
Adds a fault with explicit data to this fault list
Throws
Error fault has less than 2 point
| Name | Type | Description |
|---|---|---|
xCoordinates | Float64Array | array of x coordinates |
yCoordinates | Float64Array | array of y coordinates |
closed | boolean | is fault closed or not |
void
▸ getClassName(): string
string
▸ getFault(index): ContourFault
Gets a Fault from the fault list
| Name | Type | Description |
|---|---|---|
index | number | The index of the fault in the fault list |
fault The fault
▸ getSize(): number
Number of faults in list
number
▸ removeAll(): void
Removes all of the fault data from this fault list
void
▸ Static getClassName(): string
string