API / geotoolkit / seismic / widgets / SeismicViewWidget / SeismicViewWidget
widgets.SeismicViewWidget.SeismicViewWidget
Type Aliases
Type Aliases
Ƭ AxesHeadersOptions: Object
| Name | Type | Description |
|---|---|---|
direction? | Direction | - |
fields? | HeaderField[] | array of trace headers axes, should contains object with 'name', 'visible', 'title' and 'minimumSpan' properties |
location? | AnnotationLocation | - |
options? | { color?: string | RgbaColor ; cssclass?: string ; direction?: Direction ; formatter?: LabelFormatHandler ; location?: AnnotationLocation ; minimumspan?: number ; size?: number } | default options for all axes |
options.color? | string | RgbaColor | - |
options.cssclass? | string | - |
options.direction? | Direction | default axes direction, can be 'toptobottom' or 'bottomtotop' |
options.formatter? | LabelFormatHandler | - |
options.location? | AnnotationLocation | default axes location, can be 'north' or 'south' |
options.minimumspan? | number | minimum span for header tick generator |
options.size? | number | default axis size |
size? | number | - |
Ƭ AxesOptions: Object
| Name | Type | Description |
|---|---|---|
headers? | AxesHeadersOptions | seismic headers axes options |
samples? | AxesSamplesOptions | specify properties of vertical axis |
Ƭ AxesSamplesOptions: Object
| Name | Type | Description |
|---|---|---|
cssclass? | string | defines cssclass of samples axis |
instance? | Axis | defines instance of sample axis |
location? | AnnotationLocation | defines location of sample axis |
size? | number | defines size in pixels of samples axis |
ticks? | Options | objects which defines ticks options of the axis. |
title? | Title | defines title options of sample axis |
visible? | boolean | defines visibility of sample axis |
Ƭ ColorBarOptions: Object
options of colorbar
| Name | Type | Description |
|---|---|---|
alignment? | Alignment | alignment |
linestyle? | Type | line style |
margin? | Options | string | defines colorbar margin |
maxheight? | number | string | maximum height |
pipeline? | SeismicPipeline | seismic pipeline to properties for colorbar if it is null then default pipeline is used |
width? | number | colorbar width |
Ƭ ColorBarOptionsOut: Object
| Name | Type | Description |
|---|---|---|
alignment | Alignment | alignment |
cssclass | string | css class |
pipeline | SeismicPipeline | seismic pipeline to properties for colorbar if it is null then default pipeline is used |
visible | boolean | defines visibility of colorbar |
Ƭ DataOptions: Object
options
| Name | Type | Description |
|---|---|---|
pipeline? | Options | pipeline options |
scale? | ScaleOptions | scale options |
Ƭ DataOptionsOut: Object
options
| Name | Type | Description |
|---|---|---|
pipeline | Options | pipeline options |
scale | ScaleOptionsOut | scale options |
Ƭ EventMap: EventMap & EventMap & { PipelineSet: { new: SeismicPipeline ; old: SeismicPipeline } ; VisibleLimitsChanged: { deviceLimits: Rect ; modelLimits: Rect ; visibleModelLimits: Rect } }
Ƭ ExportToPdfOptions: Object
option to specify paper parameters and header and footer
| Name | Type | Description |
|---|---|---|
deviceunit? | string | define how many depth units in one device unit. |
documentfooter? | FooterComponent | an optional document PDF footer |
documentheader? | HeaderComponent | an optional document PDF header |
embededfonts? | EmbededFont[] | array of embedded fonts |
exportscale? | ScaleOptions | scale options for SeismicImage |
footer? | FooterComponent | an optional PDF footer |
header? | HeaderComponent | an optional PDF header |
horizonpickervisible? | boolean | true if horizon picker need to be exported to pdf |
imagecompression? | { mode?: ImageCompression ; quality?: number ; speed?: SpeedCompression } | options to specify the image compression |
imagecompression.mode? | ImageCompression | image compression method used to exporting pdf. |
imagecompression.quality? | number | quality range from 0 to 1 that will express the jpeg image compression quality, available for jpeg mode only. |
imagecompression.speed? | SpeedCompression | speed referring to the png compression speed, available for png mode only. |
imagescalefactor? | number | options to specify the image scale factor, right now 8 is maximum, Math.floor(600 / 72) |
limits? | Rect | export depth or time limits |
output? | string | define optional output filename |
pdfstream? | IWritable | optional user-customized Stream object |
printsettings? | DocumentExportSettings | define optional paper and export parameters |
progress? | (currentPage: number, totalPages: number) => void | Callback to show export progress |
save? | boolean | flag to save the pdf directly to file or open dialog |
scale? | number | export scale from model index unit to pixels by default as is |
streamcompression? | boolean | enable or disable pdf output compression |
truescale? | boolean | enable true scale |
Ƭ HVOptions: Object
| Name | Type | Description |
|---|---|---|
cssclass? | string | specify scroll bar cssclass name |
options? | Options | - |
type? | string | class name of scroll bar |
visible? | boolean | specify scroll bar visibility |
Ƭ HeaderField: Object
| Name | Type |
|---|---|
color? | string |
cssclass? | string |
formatter? | LabelFormatHandler |
minimumspan? | number |
name? | string |
title? | string |
visible? | boolean |
Ƭ Options: Options & OptionsBase
options or seismic pipeline
Ƭ OptionsBase: Object
| Name | Type | Description |
|---|---|---|
annotationssizes? | AnnotationSize | JSON to hold (width or height) of the annotation |
autoseismiclimits? | boolean | sets model limits of the center group based on the pipeline limits. If limits sets to false |
axes? | AxesOptions | specify set of axes |
colorbar? | ColorBarOptions & Options | json defining color bar |
freezeupdate? | boolean | freeze updating widget until new seismic data is loaded and rendered for visible area |
layouttype? | string | type of layout 'default' or 'inside' |
orientation? | Orientation | seismic trace orientation |
pipeline? | SeismicPipeline | seismic pipeline |
scale? | ScaleOptions | scale options |
scroll? | ScrollOptions | specify scroll bar properties |
title? | Title | defines title options of widget |
tools? | ToolsOptions | tools options. |
Ƭ OptionsBaseOut: Object
| Name | Type | Description |
|---|---|---|
annotationssizes? | AnnotationSize | JSON to hold (width or height) of the annotation |
autoseismiclimits? | boolean | sets model limits of the center group based on the pipeline limits. If limits sets to false |
axes? | AxesOptions | specify set of axes |
colorbar | ColorBarOptionsOut | json defining color bar |
freezeupdate? | boolean | freeze updating widget until new seismic data is loaded and rendered for visible area |
layouttype? | string | type of layout 'default' or 'inside' |
orientation | Orientation | seismic trace orientation |
pipeline | SeismicPipeline | seismic pipeline |
scale | ScaleOptionsOut | scale options |
scroll? | ScrollOptions | specify scroll bar properties |
title? | Title | defines title options of widget |
tools? | ToolsOptionsOut | tools options |
Ƭ OptionsOut: OptionsOut & OptionsBaseOut
options or seismic pipeline
Ƭ ScrollOptions: Object
| Name | Type | Description |
|---|---|---|
horizontal? | HVOptions | specify horizontal scroll bar properties |
vertical? | HVOptions | specify vertical scroll bar properties |
Ƭ Title: Object
title
| Name | Type | Description |
|---|---|---|
alignment? | AnchorType | alignment |
cssclass? | string | CSS style of the title |
location? | AnnotationLocation | defines location |
size? | number | size of the title in pixels |
text? | string | title text |
textstyle? | Type | text style |
visible? | boolean | visibility |
Ƭ Tools: Tools & { HorizontalScroll: HorizontalScroll ; VerticalScroll: VerticalScroll ; centerCompositeTool: CompositeTool ; colorbar: FloatingColorBarTool ; comparator: Comparator ; cross-hair: CrossHair ; horizon-picker: HorizonPicker ; panning: Panning ; pick: Selection ; rubberband: RubberBand ; zoom: Zoom }
Ƭ ToolsOptions: Object
tools options
| Name | Type | Description |
|---|---|---|
colorbar? | OptionsBase | Floating olor bar tool options. |
comparator? | OptionsType | Comparator options. |
crosshair? | Options | Crosshair cursor options. |
horizonpicker? | Options | Horizon picker options. |
panning? | Options | Panning options. |
rubberbandzoom? | Options | Rubber band zoom options. |
zoom? | Options | Zoom options. |
Ƭ ToolsOptionsOut: Object
tools options
| Name | Type | Description |
|---|---|---|
colorbar? | OptionsBase | Floating olor bar tool options. |
comparator? | OptionsOut | Comparator options. |
crosshair? | Options | Crosshair cursor options. |
horizonpicker? | Options | Horizon picker options. |
panning? | Options | Panning options. |
rubberbandzoom? | Options | Rubber band zoom options. |
zoom? | Options | Zoom options. |
Ƭ TraceHeaderAxis: Object
helper, information about shapes associated with header