API / geotoolkit / widgets / timeseries / TimeSeriesObjectGroup / TimeSeriesObjectGroup
timeseries.TimeSeriesObjectGroup.TimeSeriesObjectGroup
TimeSeriesObject is a container of visuals used in TimeSeries Widget. It primarily lets you get and set options of the different visuals.
↳
TimeSeriesObjectGroup
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
curveaxis | AxisOptions | JSON which defines axis object |
curveaxis-autocoloraxis | boolean | Synchronize axis color with curve color |
curveaxis-autocolorlabel | boolean | Synchronize axis and label color with curve color |
curveaxis-autolabelrotation | boolean | Automatic label rotation |
curveaxis-axisautolabelrotation | boolean | Axis automatic label rotation |
curveaxis-axiscolor | string | Axis color is autocoloraxis is false |
curveaxis-axisvisible | boolean | Axis visibility |
curveaxis-axiswidth | number | Curve axis width |
curveaxis-baselinestyle | LineStyle | Base line style. Color set to curve's color, width = 1 by default |
curveaxis-baselinestyle-color | string | Color in CSS form |
curveaxis-baselinestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
curveaxis-baselinestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
curveaxis-baselinestyle-fill-color | string | Color in CSS form |
curveaxis-baselinestyle-fill-evenoddmode | boolean | Even-odd fill mode |
curveaxis-baselinestyle-fill-fillpattern | Pattern | Pattern |
curveaxis-baselinestyle-fill-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 |
curveaxis-baselinestyle-fill-fillpattern-patternname | string | Name of this pattern for indexing |
curveaxis-baselinestyle-fill-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
curveaxis-baselinestyle-fill-foreground | string | Foreground color |
curveaxis-baselinestyle-fill-pattern | Pattern | Pattern |
curveaxis-baselinestyle-linecap | CapStyle | The line cap style |
curveaxis-baselinestyle-linedashoffset | number | Line dash offset of dashed line |
curveaxis-baselinestyle-linejoin | JoinStyle | The line join style |
curveaxis-baselinestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
curveaxis-baselinestyle-scalable | boolean | True if width should depend on transformation |
curveaxis-baselinestyle-unit | string | Optional unit for the width |
curveaxis-baselinestyle-width | number | string | The line thickness |
curveaxis-compact | boolean | Compact |
curveaxis-font | string | Curve axis text font |
curveaxis-labelorientation | string | number | Rotation of the curveaxis labels; can be automatic, vertical, horizontal |
curveaxis-labelorientation | Orientation | Rotation of the curveaxis labels; can be automatic, vertical, horizontal |
curveaxis-labeltext | string | Title text override |
curveaxis-logarithmicscale | boolean | Logarithmic scale |
curveaxis-position | string | Curve axis position 'left'/'right' |
curveaxis-textcolor | string | Text color if autocolorlabel is false |
curveaxis-textwidth | number | Curve text width |
curveaxis-tickgenerator | NumericTickGenerator | Tick generator |
curveaxis-tickgenerator-labelstyles | TextStyle | An object containing label style for specified grades |
curveaxis-tickgenerator-labelstyles-alignment | AlignmentStyle | Alignment |
curveaxis-tickgenerator-labelstyles-autosize | boolean | Auto font size on high definition display |
curveaxis-tickgenerator-labelstyles-background | string | Background style |
curveaxis-tickgenerator-labelstyles-background | FillStyle | Background style |
curveaxis-tickgenerator-labelstyles-baseline | BaseLineStyle | Base line |
curveaxis-tickgenerator-labelstyles-color | string | Color in CSS form |
curveaxis-tickgenerator-labelstyles-fill | FillStyle | Text fill style |
curveaxis-tickgenerator-labelstyles-font | string | Font see |
curveaxis-tickgenerator-labelstyles-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
curveaxis-tickgenerator-labelstyles-lineheight | string | number | Line height |
curveaxis-tickgenerator-labelstyles-multiline | boolean | Allow multi-line text |
curveaxis-tickgenerator-labelstyles-outline | string | Outline style |
curveaxis-tickgenerator-labelstyles-outline | LineStyle | Outline style |
curveaxis-tickgenerator-labelstyles-overflowwrap | OverflowWrapStyle | Overflow wrap |
curveaxis-tickgenerator-labelstyles-strikethrough | string | Strikethrough style |
curveaxis-tickgenerator-labelstyles-strikethrough | LineStyle | Strikethrough style |
curveaxis-tickgenerator-labelstyles-textoverflow | TextOverflowStyle | Text overflow |
curveaxis-tickgenerator-labelstyles-underline | string | Underline style |
curveaxis-tickgenerator-labelstyles-underline | LineStyle | Underline style |
curveaxis-tickgenerator-labelstyles-underlineoffset | string | number | Underline offset distance |
curveaxis-tickgenerator-labelstyles-whitespace | WhiteSpaceStyle | White space |
curveaxis-tickgenerator-labelstyles-wordbreak | WordBreakStyle | Word break |
curveaxis-tickgenerator-tag | any | Tag user can specify info associated with current object |
curveaxis-tickgenerator-tickstyles | LineStyle | An object containing tick styles for specified grades |
curveaxis-titlerotateangle | number | Title rotate angle |
curveaxis-titlevisible | boolean | Curve axis label visibility |
curveaxis-visible | boolean | Visibility of curve axis |
id | string | Object's id/uri |
name | string | Object/curve's name |
Constructors
• new TimeSeriesObjectGroup(options?)
| Name | Type |
|---|---|
Optional options | Options |
TimeSeriesObjectBase.constructor
Methods
▸ addObject(item): TimeSeriesObjectGroup
Add time series object to group. If the item (or any item in the array) is a member of another group, none of the items are added
| Name | Type | Description |
|---|---|---|
item | TimeSeriesObject | TimeSeriesObject[] | item |
this
▸ dispose(): void
Dispose.
void
▸ getAxis(): Axis
get axis
▸ getAxisOptions(): AxisOptionsOut
Get axis options
JSON which defines curve axis
TimeSeriesObjectBase.getAxisOptions
▸ getClassName(): string
string
TimeSeriesObjectBase.getClassName
▸ getId(): string
Get object's ID
string
▸ getMax(): number
Get max
number
▸ getMin(): number
Get min
number
▸ getName(): string
Gets time series object name
string
▸ getProperties(): OptionsOut
Returns all properties
properties object
TimeSeriesObjectBase.getProperties
▸ getShareLimits(): boolean
Get max
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
TimeSeriesObjectBase.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
TimeSeriesObjectBase.isDisposed
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): TimeSeriesObjectGroup
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | TimeSeriesObjectBase | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): TimeSeriesObjectGroup
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: TimeSeriesObjectGroup, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): TimeSeriesObjectGroup
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: TimeSeriesObjectGroup, args: EventMap[E]) => void | to be called |
this
▸ removeObject(item): TimeSeriesObjectGroup
Remove time series object from group
| Name | Type | Description |
|---|---|---|
item | TimeSeriesObject | TimeSeriesObject[] | item |
this
▸ setAxisOptions(options?): TimeSeriesObjectGroup
Set axis options
| Name | Type | Description |
|---|---|---|
Optional options | AxisOptions | JSON which defines curve axis |
this
TimeSeriesObjectBase.setAxisOptions
▸ setMax(value): TimeSeriesObjectGroup
Set max
| Name | Type | Description |
|---|---|---|
value | number | max value curve's |
this
▸ setMin(value): TimeSeriesObjectGroup
Set min
| Name | Type | Description |
|---|---|---|
value | number | min value curve's |
this
▸ Protected setName(name): void
Set time series object name
| Name | Type | Description |
|---|---|---|
name | string | name of the object |
void
▸ setProperties(props?): TimeSeriesObjectGroup
Sets all properties
| Name | Type | Description |
|---|---|---|
Optional props | Options | properties object |
this
TimeSeriesObjectBase.setProperties
▸ setShareLimits(value): TimeSeriesObjectGroup
Sets if limits are shared between groups member
| Name | Type | Description |
|---|---|---|
value | boolean | if limits are shared between groups member |
▸ setSilent(bool): TimeSeriesObjectGroup
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
TimeSeriesObjectBase.setSilent
▸ updateLayout(): void
Update layout if it is necessary if object is changed
void
TimeSeriesObjectBase.updateLayout
▸ Static getClassName(): string
string