API / geotoolkit / seismic / image / SeismicImage / SeismicImage
image.SeismicImage.SeismicImage
Defines seismic shape implementation as a rectangular shape to render data from seismic pipeline.
This shape can render seismic as a simple rectangular shape by using the SeismicPipeline. It can be added to any plot/group as a shape.
It will delegate rasterization to the pipeline itself so any configuration relative to the seismic rendering (Like Colormap,Interpolation, etc) should be done directly on the pipeline.
Seismic Map Image tutorial demonstrates the use of seismic image in the toolkit.
↳
SeismicImage
Constructors
| [new SeismicImage(options)](/solutions/geotoolkit/apis/classes/geotoolkit.seismic.image.seismicimage.seismicimage.md#new seismicimage(options)) | [new SeismicImage(pipeline, rect)](/solutions/geotoolkit/apis/classes/geotoolkit.seismic.image.seismicimage.seismicimage.md#new seismicimage(pipeline, rect)) | [new SeismicImage(pipeline, x1, y1, x2, y2)](/solutions/geotoolkit/apis/classes/geotoolkit.seismic.image.seismicimage.seismicimage.md#new seismicimage(pipeline, x1, y1, x2, y2)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
bottom | number | Y coordinate of the bottom right corner (if 'height' not specified) |
bounds | Rect | Bounds |
bounds-height | number | Height |
bounds-readonly | boolean | Readonly |
bounds-width | number | Width |
bounds-x | number | Left |
bounds-y | number | Top |
clipstyle | ClipStyle | Clipping style |
clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
clipstyle-geometry | GraphicsPath | Clipping geometry |
clipstyle-geometry-bounds | Rect | Bounds |
clipstyle | GraphicsPath | Clipping style |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
errimgsrc | string | Source for error image (it will be rendered if tile is not available) |
fillstyle | string | Style applied on fill |
fillstyle | FillStyle | Style applied on fill |
fillstyle-color | string | Color in CSS form |
fillstyle-evenoddmode | boolean | Even-odd fill mode |
fillstyle-fillpattern | Pattern | Pattern |
fillstyle-fillpattern-containername | string | An optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself |
fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
fillstyle-foreground | string | Foreground color |
fillstyle-pattern | Pattern | Pattern |
height | number | Height (if 'bottom' not specified) |
id | string | number | Id of the node, its a unique identifier |
left | number | X coordinate of the top left corner |
linestyle | string | Style applied on outline |
linestyle | LineStyle | Style applied on outline |
linestyle-color | string | Color in CSS form |
linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
linestyle-linecap | CapStyle | The line cap style |
linestyle-linedashoffset | number | Line dash offset of dashed line |
linestyle-linejoin | JoinStyle | The line join style |
linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
linestyle-scalable | boolean | True if width should depend on transformation |
linestyle-unit | string | Optional unit for the width |
linestyle-width | number | string | The line thickness |
loadertype | LoaderType | Type for tile loader |
localtransform | Transformation | Local transformation |
localtransform-dx | number | X axis translation |
localtransform-dy | number | Y axis translation |
localtransform-xx | number | X scale |
localtransform-xy | number | Xy skew |
localtransform-yx | number | Yx skew |
localtransform-yy | number | Y scale |
margins | number | string | It has properties for specifying the margins for each side |
maxnumreq | number | Maximum number of requests that can be sent at the same time |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
opacityblendmode | BlendMode | Node opacity mode to blend it |
pipeline | SeismicPipeline | Represents seismic data |
pipeline-clippingmode | ClippingMode | Clipping mode |
pipeline-colors | ColorMapOptions | Colors |
pipeline-colors-alpha | number | Alpha value |
pipeline-colors-colormap | string | Color map, predefined color map name, color map options or color map instance |
pipeline-colors-colormap | ColorMap | Color map, predefined color map name, color map options or color map instance |
pipeline-colors-colormap-max | number | |
pipeline-colors-colormap-min | number | |
pipeline-colors-colormap-name | string | Color map name |
pipeline-colors-colormap-negativefillstyle | string | Positive fill style |
pipeline-colors-colormap-negativefillstyle | FillStyle | Positive fill style |
pipeline-colors-colormap-positivefillstyle | string | Positive fill style |
pipeline-colors-colormap-positivefillstyle | FillStyle | Positive fill style |
pipeline-colors-colormap-scale | KnownScales | |
pipeline-colors-colormap-size | number | Color map size |
pipeline-colors-colormap-tracelinestyle | string | Trace line style |
pipeline-colors-colormap-tracelinestyle | LineStyle | Trace line style |
pipeline-colors-opacity | number | Opacity value |
pipeline-colors-reversed | boolean | Reversed color map |
pipeline-maximumtracesperpixel | number | Define maximum traces per pixel, which can be displayed in the image |
pipeline-name | string | Pipeline name |
pipeline-normalization | NormalizationOptions | Normalization options |
pipeline-normalization-bias | number | The bias value defines the start of the VA fill Bias can be null (default - means that fill starts from trace location), in swing model space from -1 to 1, or in normalization limits model space, see biastype option |
pipeline-normalization-biastype | BiasType | Bias type, default is BiasType.Relative |
pipeline-normalization-limits | Range | Normalization limits (min,max), which is used for NormalizationType.Limits only |
pipeline-normalization-limits-high | number | Upper range boundary |
pipeline-normalization-limits-low | number | Lower range boundary |
pipeline-normalization-limits-max | number | |
pipeline-normalization-limits-min | number | |
pipeline-normalization-scale | number | Scale factor |
pipeline-normalization-swing | number | The location in trace spacing units where the normalized value of data samples are mapped. This location can be modified by specifying a normalization scale factor |
pipeline-normalization-type | NormalizationType | Enum of normalization types |
pipeline-plot | PlotOptions | Plot options |
pipeline-plot-clippingfactor | number | Clipping factor for traces |
pipeline-plot-decimationspacing | number | Decimation spacing is the minimum spacing between seismic traces on a seismic image. It is a measured in device units (pixels). Decimation spacing is an important factor when interpreting seismic images, as it affects the resolution of the image. The greater the decimation spacing, the lower the resolution of the image. A higher resolution image will allow for more detail in the interpretation, while a lower resolution image will be less detailed |
pipeline-plot-densityclippingfactor | number | Clipping factor for density |
pipeline-plot-densitydecimation | boolean | Decimation for traces in density mode |
pipeline-plot-sampledecimation | DecimationType | Define samples decimation type |
pipeline-plot-type | PlotTypeOptions | Plot type |
pipeline-plot-type-interpolateddensity | boolean | Interpolated density |
pipeline-plot-type-negativecolorfill | boolean | Negative color fill |
pipeline-plot-type-negativefill | boolean | Negative fill |
pipeline-plot-type-positivecolorfill | boolean | Positive color fill |
pipeline-plot-type-positivefill | boolean | Positive fill |
pipeline-plot-type-reversed | boolean | Reversed amplitude direction |
pipeline-plot-type-simpledensity | boolean | Simple density |
pipeline-plot-type-wiggle | boolean | Wiggle |
pipeline-plot-wigglesantialiasing | boolean | Wiggles antialiasing flag |
pipeline-rasterizationlimitstype | RasterizationLimitsType | Rasterization limits type |
pipeline-renderingside | RenderingSide | Rendering side |
pipeline-statistics | Statistics | Statistics information |
pipeline-statistics-average | number | Average |
pipeline-statistics-max | number | Maximum |
pipeline-statistics-min | number | Minimum |
pipeline-statistics-rms | number | Rms |
pipeline-traceoffset | number | Original trace offset |
pipeline-version | string | Version |
right | number | X coordinate of the bottom right corner (if 'width' not specified) |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
tag | any | Custom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape |
timeout | number | Timeout of next request, if server isn't available |
timetowaitchanges | number | Time (ms) to wait changes of position or scale of seismic image. If position and scale remain the same, seismic image will request new tiles |
top | number | Y coordinate of the top left corner |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
tries | number | Tries of downloading image, if server isn't available |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
width | number | Width (if 'right' not specified) |
z-index | number | Define node z-index |
Constructors
• new SeismicImage(options?)
Creates image
| Name | Type | Description |
|---|---|---|
Optional options | Options | options object |
TiledShape<IServerSideRenderingProvider.CustomData&gt;.constructor
• new SeismicImage(pipeline?, rect?)
Creates image
| Name | Type | Description |
|---|---|---|
Optional pipeline | SeismicPipeline | pipeline |
Optional rect | Rect | rectangle of model coordinates. |
TiledShape<IServerSideRenderingProvider.CustomData&gt;.constructor
• new SeismicImage(pipeline?, x1?, y1?, x2?, y2?)
Creates image
| Name | Type | Description |
|---|---|---|
Optional pipeline | SeismicPipeline | Options | pipeline or options object |
Optional x1 | number | model coordinate in the parent object |
Optional y1 | number | model coordinate in the parent object. |
Optional x2 | number | model coordinate in the parent object. |
Optional y2 | number | model coordinate in the parent object. |
TiledShape<IServerSideRenderingProvider.CustomData&gt;.constructor
Methods
▸ addCssClass(cssclass): SeismicImage
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): SeismicImage
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
TiledShape.addInvalidateHandler
▸ Protected applyOpacity(context): SeismicImage
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
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
TiledShape.applyResponsiveStyle
▸ checkCollision(context): boolean
Check collision
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of rendering area
▸ clone(): SeismicImage
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): SeismicImage
Connects style.
This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ Protected copyConstructor(src, deepCopy?): SeismicImage
Copy constructor
| Name | Type | Description |
|---|---|---|
src | SeismicImage | seismic image src |
Optional deepCopy | boolean |
▸ disconnectStyle(style, type, callback): SeismicImage
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ Protected disposeBackgroundManager(): SeismicImage
TiledShape.disposeBackgroundManager
▸ enableEventPropagation(enable): SeismicImage
Enable event propagation from the node hierarchy from bottom to top
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.
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();| Name | Type | Description |
|---|---|---|
enable | boolean | enable |
this
TiledShape.enableEventPropagation
▸ execute(delegate): SeismicImage
Executes delegate and return the result. It allows us to keep all initialization calls in one place,
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");
});| Name | Type | Description |
|---|---|---|
delegate | (this: SeismicImage) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: SeismicImage) => T |
T
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
▸ getBounds(): Rect
Return bounds. Will also lock the bounds so they cannot be directly modified.
bounds
▸ getCenterX(): number
Returns the X coordinate of the center of the framing rectangle of this rectangular shape.
number
▸ getCenterY(): number
Returns the Y coordinate of the center of the framing rectangle of this rectangular shape.
number
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getCollectPerformanceInformation(): boolean
Gets collect performance information mode enabled
boolean
true if collection performance information mode enabled
TiledShape.getCollectPerformanceInformation
▸ getContentsTransform(): Transformation
Returns transformation
TiledShape.getContentsTransform
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
▸ getCssTransform(): string
Returns CSS transformation
string
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getHeight(): number
Returns the height of the framing rectangle.
number
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ Protected getImageToBoundsTransform(): Transformation
Transformation of inner contents to bounds
TiledShape.getImageToBoundsTransform
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
TiledShape.getInvalidateMethod
▸ getLayoutStyle(): LayoutStyle<string | number>
Return desired layout style
LayoutStyle<string | number>
▸ getLineStyle(): LineStyle
Return line style
lineStyle current line style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getModelArea(): Rect
Gets image size of the tiled shape
▸ getModelLimits(): Rect
Returns model limits
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
TiledShape.getOpacityBlendMode
▸ getOptions(): Options<CustomData>
Gets options
object with parameters
▸ getParent(): Node
Return parent node
parent node
▸ getPipeline(): SeismicPipeline
Returns pipeline
▸ getProperties(): OptionsOut
Returns properties
properties
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleOptions(): Required<ScaleOptions>
Returns scale options.
Required<ScaleOptions>
object
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
TiledShape.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTimeToWaitChanges(): number
Gets time to wait changes
number
time to wait changes
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getVisibleModelLimits(): Rect
Returns model visible limits
TiledShape.getVisibleModelLimits
▸ getWidth(): number
Returns the width of the framing rectangle.
number
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
transform the world transform.
▸ getX(): number
Returns the X coordinate of the left bottom corner of the framing rectangle.
number
▸ getY(): number
Returns the Y coordinate of the left bottom corner of the framing rectangle.
number
▸ getZIndex(): number
Returns node z-index (null if not set)
number
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ invalidate(bounds?, force?): SeismicImage
Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | true if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
this
▸ invalidateLayout(): SeismicImage
Notify that layout is invalidated. Send event Events.LayoutInvalidated
this
▸ invalidateParent(bounds?, force?): SeismicImage
Invalidate bounds
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
Optional force | boolean | flag indicating if the parent must be forcibly invalidated |
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
TiledShape.isEventPropagationEnabled
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
TiledShape.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): SeismicImage
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | TiledShape<CustomData> | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off<E>(type?, callback?): SeismicImage
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: SeismicImage, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): SeismicImage
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: SeismicImage, args: EventMap[E]) => void | to be called |
this
▸ Protected onAllTilesRendered(): void
All requested tiles are rendered
void
▸ Protected onParentChanged(node): SeismicImage
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
▸ Protected onRectChanged(newRect): SeismicImage
| Name | Type |
|---|---|
newRect | Rect |
▸ Protected onStartTilesLoading(): void
The first tile is started loading
void
TiledShape.onStartTilesLoading
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
TiledShape.onVisibilityChanged
▸ Protected postRendering(context): void
To be called after rendering. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
TiledShape.registerAnimationStyle
▸ removeCssClass(cssclass): SeismicImage
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): SeismicImage
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
TiledShape.removeInvalidateHandler
▸ render(context): void
Render method, overrides render method of the parent. Calculates tiles required for the invalidated area (all the calculations are made in device coordinates), renders existing ones, or requests non existing ones
| Name | Type | Description |
|---|---|---|
context | RenderingContext | a rendering context |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ rotate(theta, x, y): SeismicImage
Rotate bounds around a given coordinate
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
x | number | x coordinate to rotate around |
y | number | y coordinate to rotate around |
this
▸ scale(xx, yy): SeismicImage
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): SeismicImage
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setBounds(rect): SeismicImage
Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.
| Name | Type | Description |
|---|---|---|
rect | Rect | bounds rect |
this
▸ setBounds(x1, y1?, x2?, y2?): SeismicImage
Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.
| Name | Type | Description |
|---|---|---|
x1 | number | x coordinate of the top left corner |
Optional y1 | number | y coordinate of the top left corner |
Optional x2 | number | x coordinate of the bottom right corner |
Optional y2 | number | y coordinate of the bottom right corner |
this
▸ setClipStyle(style): SeismicImage
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCollectPerformanceInformation(collectPerformanceInfoEnabled): SeismicImage
Sets collect performance information mode enabled
| Name | Type | Description |
|---|---|---|
collectPerformanceInfoEnabled | boolean | true for collection performance information mode enabled |
this
TiledShape.setCollectPerformanceInformation
▸ setCss(style, merge?): SeismicImage
Sets CSS style. This style will be applied for all inserted elements
| Name | Type | Description |
|---|---|---|
style | Type | CSS style to be applied to inserted elements |
Optional merge | boolean | merge flag |
this
▸ setCssClass(name): SeismicImage
Sets css class name of the node to be used to apply CSS style
| Name | Type | Description |
|---|---|---|
name | string | css class name of the node |
this
▸ setCssTransform(transform): SeismicImage
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setFillStyle(fillStyle, merge?): SeismicImage
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ setId(id): SeismicImage
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setLayoutStyle(layoutStyle, merge?): SeismicImage
Specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style or layout style params |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
▸ setLineStyle(lineStyle, merge?): SeismicImage
Sets line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setLocalTransform(localTransform, force?): SeismicImage
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
▸ setMarginsStyle(margins, merge?): SeismicImage
Sets margins style
| Name | Type | Description |
|---|---|---|
margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
this
▸ setModelLimits(limits): SeismicImage
Sets model limits
| Name | Type | Description |
|---|---|---|
limits | Rect | limits of the pipeline |
▸ setName(name): SeismicImage
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): SeismicImage
set notification state
| Name | Type | Description |
|---|---|---|
notify | boolean | flag set to invalidate parent or not |
Optional force | boolean | true if parent should be invalidated immediately |
this
▸ setOpacity(opacity, blendMode?): SeismicImage
Sets node opacity
| Name | Type | Description |
|---|---|---|
opacity | number | node opacity from 0 to 1 |
Optional blendMode | BlendMode | opacity blend mode. If it is normal, opacity will be replaced. |
this
▸ setOptions(options): SeismicImage
Sets options
| Name | Type | Description |
|---|---|---|
options | Options<CustomData> | object with parameters |
this
▸ setPipeline(pipeline): SeismicImage
Sets pipeline
| Name | Type | Description |
|---|---|---|
pipeline | SeismicPipeline | Options | the Seismic Pipeline |
this
▸ setProperties(properties?): SeismicImage
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
▸ setProperty(name, value): SeismicImage
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRect(rect): SeismicImage
Sets the location and size of the framing rectangle of this rectangular shape to the specified values.
| Name | Type | Description |
|---|---|---|
rect | Rect | rect |
▸ setRect(params): SeismicImage
Sets the location and size of the framing rectangle of this rectangular shape to the specified values.
| Name | Type | Description |
|---|---|---|
params | Options | rect params |
▸ setRect(x1, y1, x2, y2): SeismicImage
Sets the location and size of the framing rectangle of this rectangular shape to the specified values.
| Name | Type | Description |
|---|---|---|
x1 | number | x coordinate of the top left corner |
y1 | number | y coordinate of the top left corner |
x2 | number | x coordinate of the bottom right corner |
y2 | number | y coordinate of the bottom right corner |
▸ setRenderingFilter(filter): SeismicImage
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
▸ setResponsiveStyle(style): SeismicImage
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
▸ setScaleOptions(scaleOptions): SeismicImage
Sets scale options.
| Name | Type | Description |
|---|---|---|
scaleOptions | ScaleOptions | scale options |
this
▸ setScaleScrollStrategy(strategy?): SeismicImage
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
TiledShape.setScaleScrollStrategy
▸ setSelectable(selectable): SeismicImage
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
▸ setSilent(bool): SeismicImage
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): SeismicImage
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
this
▸ setTimeToWaitChanges(timeToWaitChanges): SeismicImage
Sets time to wait changes
| Name | Type | Description |
|---|---|---|
timeToWaitChanges | number | time to wait changes |
this
▸ setVisible(value): SeismicImage
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setZIndex(value): SeismicImage
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): SeismicImage
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): SeismicImage
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
TiledShape.unregisterAnimationStyle
▸ updateSceneTransformation(): SeismicImage
Update scene transformation
this
TiledShape.updateSceneTransformation
▸ updateState(regions?, changes?): SeismicImage
Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles in the parent coordinates |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ Protected updateTimeStamp(): SeismicImage
Update time stamp to indicate that Node or Children has been changed.
this
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
TiledShape.enableSceneGraphNotification
▸ Static findParent<T>(node, classType, filter?): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
InstanceType<T>
▸ Static findParent(node, classType, filter?): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
▸ Static getClassName(): string
string
▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean
Check collision of the shape bounds with parent invalid area
| Name | Type | Description |
|---|---|---|
bounds | Rect | shape bounds |
localTransformation | Transformation | local transformation of the bounds |
parentInvalidArea | Rect | invalid parent area |
Optional expand | Dimension | optional expand the bounds in model coordinate |
boolean
true if bounds intersect the invalid area
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean