API / geotoolkit / widgets / AnnotatedWidget / AnnotatedWidget
widgets.AnnotatedWidget.AnnotatedWidget
Type Aliases
Type Aliases
Ƭ AnnotationSize: Object
JSON to hold (width or height) of the annotation
| Name | Type | Description |
|---|---|---|
east? | string | number | preferred width of east annotation size |
north? | string | number | preferred height of north annotation size |
south? | string | number | preferred height of south annotation size |
west? | string | number | preferred width of west annotation size |
Ƭ EventMap: EventMap & { ModelVisibleLimitsChanged: Rect }
Ƭ ExportElementOptions: Object
options
| Name | Type | Description |
|---|---|---|
documentfooter? | Group | an optional document PDF footer |
documentheader? | Group | an optional document PDF header |
scale? | ExportScale | export scale by default as is |
Ƭ ExportScale: null | { x: number ; y: number }
scale
Ƭ ExportToPdfOptions: ExportElementOptions & { embeddedfonts?: EmbeddedFont[] ; embededfonts?: EmbededFont[] ; footer?: FooterComponent ; header?: HeaderComponent ; imagecompression?: { mode?: ImageCompression ; quality?: number ; speed?: SpeedCompression } ; modellimits?: Rect ; output?: string ; pdfstream?: IWritable ; printsettings?: DocumentExportSettings ; progress?: (currentPage: number, totalPages: number) => void ; save?: boolean ; streamcompression?: boolean }
option to specify paper parameters and header and footer
Ƭ Options: Merge<AnnotationOptions, Options & { annotationitemswrap?: boolean ; annotationssizes?: AnnotationSize ; applicationid?: string ; border?: Type ; model?: Group ; tools?: ToolsOptions } & Options>
The widget options see initializeLayout() for details
Ƭ OptionsOut: OptionsOut & { annotationitemswrap: boolean ; annotationssizes: AnnotationSize ; border: LineStyle | null ; tools: ToolsOptionsOut }
properties
Ƭ PanAnimationOptions: Omit<Options, "attributename">
PanModelTo animation options
Ƭ ScrollBarOptions: Partial<ScrollBarOptionsOut> & { enabled?: boolean ; name?: string }
Ƭ ScrollBarOptionsOut: Object
| Name | Type | Description |
|---|---|---|
floating | boolean | flag to set floating mode |
options? | any | internal options |
size | number | string | scroll bar size |
type | string | scroll bar type |
visible | boolean | scroll bar visibility |
Ƭ TitleOptions: Options & { location?: AnnotationLocation }
title options
Ƭ Tools: { colorbar: FloatingColorBarTool ; cross-hair: CrossHair ; crosshair: CrossHair ; floatingannotation: FloatingAnnotationTool ; manipulatorTools: CompositeTool ; panning: Panning ; pick: Selection ; rubberband: RubberBand ; zoom: Zoom } & Tools
Ƭ ToolsOptions: Object
JSON which defines tools options
| Name | Type | Description |
|---|---|---|
crosshair? | Options | JSON which defines crosshair cursor. See CrossHair#setProperties for details |
horizontalscroll? | ScrollBarOptions | horizontal scroll bar options |
panning? | Options | JSON which defines panning tool. See Panning#setProperties for details |
rubberbandzoom? | Options | JSON which defines rubber band zoom. See RubberBand#setSettings for details |
selection? | Options & { resetselection?: boolean } | JSON which defines selection. See Selection#setOptions for details |
verticalscroll? | ScrollBarOptions | vertical scroll bar options |
zoom? | Options | JSON which defines zoom. See Zoom#setProperties for details |
Ƭ ToolsOptionsOut: Object
JSON which defines tools options
| Name | Type | Description |
|---|---|---|
crosshair? | OptionsOut | JSON which defines crosshair cursor. See CrossHair#setProperties for details |
horizontalscroll? | ScrollBarOptionsOut | horizontal scroll bar options |
panning? | OptionsOut | JSON which defines panning tool. See Panning#setProperties for details |
verticalscroll? | ScrollBarOptionsOut | vertical scroll bar options |
zoom? | OptionsOut | JSON which defines zoom. See Zoom#setProperties for details |