Last updated

API / geotoolkit / controls / shapes / ColorBar / ColorBar

Namespace: ColorBar

shapes.ColorBar.ColorBar

Table of contents

Type Aliases

Contents

Type Aliases

AxisBaselineType

Ƭ AxisBaselineType: Object

Type declaration

NameTypeDescription
linestyle?Typebaseline linestyle
visible?booleanbaseline visibility

AxisType

Ƭ AxisType: Object

Type declaration

NameTypeDescription
baseline?AxisBaselineTypeaxis baseline
item?Axisaxis object instance
labelrotation?numberaxis label rotation in radians
size?numberaxis area desired size
title?Title | stringaxis title

ColorBoxType

Ƭ ColorBoxType: Object

Type declaration

NameTypeDescription
independentrange?booleancolorbox independent range
linestyle?Typecolorbox outline rectangle linestyle
marker?Options & MarkerTypeColor box marker options
size?number | stringcolorbox area desired size
visible?booleancolorbox visibility

ComponentSizesType

Ƭ ComponentSizesType: Object

Type declaration

NameTypeDescription
axis?numberaxis area desired size
colorbox?number | stringcolorbox area desired size
namedcolors?number | stringnamed colors desired size
title?numbertitle area desired size

EventMap

Ƭ EventMap: EventMap & { LocationChanged: ColorBarLocation }


MarkerType

Ƭ MarkerType: Object

Type declaration

NameTypeDescription
position?MarkerPositionmarker positions

NamedColorsType

Ƭ NamedColorsType: Object

Type declaration

NameTypeDescription
size?number | stringnamed colors desired size
visible?booleannamed colors visibility

Options

Ƭ Options: Options & OptionsBase & { axis?: Options & AxisType ; colorbox?: ColorBoxType ; componentsizes?: ComponentSizesType ; namedcolors?: NamedColorsType ; range?: RangeType ; title?: TitleType }


OptionsBase

Ƭ OptionsBase: Object

Type declaration

NameTypeDescription
axisautolabelrotation?booleanaxis auto label rotation
axisautolabelrotationangle?numberaxis auto label rotation angle
axisbaselinestyle?Typeaxis baseline style
axisbaselinevisible?booleanaxis baseline visibility
axisitem?Axisaxis item
axissize?numberaxis size
axistitle?Title | stringaxis title
axisvisible?booleanaxis visible
colorboxindependentrange?booleancolorbox independent range
colorboxlinestyle?Typecolorbox line style
colorboxsize?number | stringcolorbox size
colorprovider?ColorProviderdefault color provider
flip?booleanflip or not
location?ColorBarLocation | AnnotationLocationcolor bar location
max?numberdata range max value. If not specified then color provider's getMaxValue() is used.
min?numberdata range min value. If not specified then color provider's getMinValue() is used.
preciselimits?booleanenable keeping the precise limits and calculate only step
tickgenerator?TickGeneratortickgenerator
titleitem?Texttitle item
titlesize?numbertitle size
titletext?stringtitle text
titletextstyle?Typetitle text style
titlevisible?booleantitle visible

OptionsOut

Ƭ OptionsOut: OptionsOut & Required<OptionsBase> & { axis: Omit<Partial<OptionsOut>, "title"> & Omit<Required<AxisType>, "baseline"> & { baseline: Required<AxisBaselineType> } ; colorbox: Omit<Required<ColorBoxType>, "marker"> & { marker: Partial<OptionsOut> & Required<MarkerType> } ; componentsizes: Required<ComponentSizesType> ; namedcolors: Required<NamedColorsType> ; range: Required<RangeType> ; title: Required<TitleType> }

properties


RangeType

Ƭ RangeType: Object

Type declaration

NameTypeDescription
max?numberdata range max value. If not specified then color provider's getMaxValue() is used.
min?numberdata range min value. If not specified then color provider's getMinValue() is used.

TitleType

Ƭ TitleType: Object

Type declaration

NameTypeDescription
item?Texttitle text object instance
preservereadingorientation?booleanis preserve reading orientation activated
showellipsis?booleanellipsis flag
size?numbertitle area desired size
sizeisindevicespace?booleansize is in device space
text?stringtitle text
textstyle?Typetitle textstyle
visible?booleantitle visibility