Last updated

API / geotoolkit / widgets / MultiHistograms / MultiHistograms

Namespace: MultiHistograms

widgets.MultiHistograms.MultiHistograms

Table of contents

Type Aliases

Contents

Type Aliases

AddHistogramAxes

Ƭ AddHistogramAxes: Object

axes options

Type declaration

NameTypeDescription
xaxis?Optionsx axis for histogram, by default add axis with AdaptivetickGenerator, null means not add x axis
yaxis?Optionsy axis for histogram, by default add axis with HistogramTickGenerator, null means not add y axis

AxisOptions

Ƭ AxisOptions: { flip?: boolean ; length?: number ; tickgenerator?: TickGenerator | Options } | null

axis options


AxisOptionsOut

Ƭ AxisOptionsOut: { accumulative?: boolean ; flip?: boolean ; length?: number } & OptionsOut


AxisSelectionOptions

Ƭ AxisSelectionOptions: Object

options

Type declaration

NameTypeDescription
enabled?booleanflag to enable axis selection
highlightstyle?Typefillstyle for background of axis

AxisSelectionOptionsOut

Ƭ AxisSelectionOptionsOut: Object

Type declaration

NameTypeDescription
enabled?booleanget if enabled axis selection
highlightstyle?OptionsOutget highlight style options

EventMap

Ƭ EventMap: EventMap & { axisselected: { group: any ; histogram: any ; location: AnnotationLocation } ; binsselected: { bins: any ; histograms: any } ; dataupdated: { event: string ; src: any } ; histogramsselected: string | string[] | Histogram | Histogram[] }


GapsOptions

Ƭ GapsOptions: Object

options

Type declaration

NameTypeDescription
east?numberdesired width for axis in east annotation
south?numberdesired height for axis in south annotation
west?numberdesired width for axis in west annotation

Group

Ƭ Group: Object

to refer to group and related object

Type declaration

NameTypeDescription
groupid?stringgroup id

GroupAxisOptions

Ƭ GroupAxisOptions: Object

options of axis or axis instance

Type declaration

NameTypeDescription
accumulative?booleanset if the axis serve for showing accumulative value in histogram accumulative mode See AnnotatedNode#createAxis for other properties' definition.
axis?any-
baselinestyle?Type-
flip?booleanset if flip the axis
length?numberwidth or height of axis component
linestyle?Type-
textstyle?Type-
tickgenerator?any-
title?Options-

GroupId

Ƭ GroupId: Object

Type declaration

NameType
east?string
south?string
west?string

HeaderOptions

Ƭ HeaderOptions: Object

options

Type declaration

NameTypeDescription
title?Optionsobject to describe the properties for header text.For details, see setProperties method of Text object

HeaderOptionsOut

Ƭ HeaderOptionsOut: Object

header options

Type declaration

NameTypeDescription
titleOptionsOuttitle options

Options

Ƭ Options: Options & { annotationsgaps?: GapsOptions ; autoannotationsize?: boolean ; axisheight?: number ; axiswidth?: number ; header?: HeaderOptions ; tools?: ToolsOptions ; viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } }


OptionsBase

Ƭ OptionsBase: Object

options

Type declaration

NameTypeDescription
annotationsgaps?GapsOptionsoptions for setting gaps between annotations and center model, see details in setGaps method
annotationssizes?AnnotationSize-
autoannotationsize?booleanauto modify the size of annotation based on the total size of component in the annotation
axisheight?numberdefault height when adding new horizontal axis
axiswidth?numberdefault width when adding new vertical axis
header?HeaderOptionsoptions for setting header of widget
tools?ToolsOptionsoptions for tools setting, see details in setToolsOptions method

OptionsOut

Ƭ OptionsOut: OptionsOut & { autoannotationsize?: boolean ; axisheight?: number ; axiswidth?: number ; header?: HeaderOptionsOut ; tools?: ToolsOptionsOut & { axisselection?: AxisSelectionOptionsOut ; southscroll?: OptionsOut } }


ScrollBarOptions

Ƭ ScrollBarOptions: Object

options

Type declaration

NameTypeDescription
options?Optionsproperties for setting scroll bar
size?numberheight for horizontal scroll bar or width for vertical scroll bar
visible?booleanflag to set visibility of scroll bar

ToolsOptions

Ƭ ToolsOptions: ToolsOptions & { axisselection?: AxisSelectionOptions ; southscroll?: ScrollBarOptions }

options


ToolsOptionsOut

Ƭ ToolsOptionsOut: ToolsOptionsOut & { axisselection?: AxisSelectionOptionsOut ; southscroll?: OptionsOut }

tools options