Optional ReadonlyeventsProtectedoptionsStaticoptionscolor for rising trend
marker
color for sideways trends and connections
color for rising trend
line width in pixels. Valid values:
returns or sets the attribute of an option this function should be used with care - modifications of internal properties might break stuff!
Optionalv: anySets the config of the layer, can be overridden to employ special options logic (for example when performing changes to the schema.
must be called after willUpdateOptions once all actions that might potentially changed values of any options are done
IMPORTANT: methods must be called in balance; e.g. for each call to willUpdateOptions, you must call didUpdateOptions exactly once.
returns a flat representation of all available config options in the form of a key-value-object optionally only values that are not read-only can be returned
IMPORTANT: this method will always convert I18NStrings to strings, so for displaying strings in a UI use individual calls to Object:get instead
OptionalreadWriteOnly: booleandefault: true
OptionalmodifiedOnly: booleandefault: true
OptionalnonEphemeralOnly: booleandefault: true
returns the value of the requested option, or a list of all available config options if no parameter is specified.
Optionals: stringOptionalflags: numberreturns the bounds of this layer
returns the layers chart
returns the categorization of the objects options can be used for displaying a more structured user interface
retrieves the layers icon
Creates list of legend entry chunks to be displayed in the legend for the index pickerIndex
returns the primary color of this layer mainly used for the chart legend entries
Optionalindex: numberretrieves the scale group the layer belongs to
returns the objects current state
returns the style object
Automatically toggles the EXPOSED flag on dependent options when a 'parent' option changes value.
For each entry in optionDependencies, whenever the parent option
emits an optionChanged event, its dependents (listed in dependentNames)
will be exposed (flag added) if the new value === exposeWhen, or
hidden (flag removed) otherwise.
Map where:
exposeWhen: the boolean that triggers exposing the dependents or a function with the newValue for custom validationdependentNames: array of dependent option names whose EXPOSED flag will be toggledclass Test extends ChartbreakerObject {
constructor() {
super();
this.registerOptionDependencyVisibility(new Map([
['showLine', { exposeWhen: true, dependentNames: ['lineColor', 'lineStyle'] }],
['advancedMode', { exposeWhen: false, dependentNames: ['simpleModeOnlyOption'] }],
['description'], { exposeWhen: (text) => !!text.length, ['fontSize', 'fontColor']}
]));
}
}
checks if any values displayed by this layer are less than or equal to zero
checks if the layer uses the specified point
a point on the chart
maximum distance to the point
life cycle method; called when the object should start normal operation at this point is is already completely initialized
life cycle method; called when the object should stop normal operation if objects have any pending subscriptions/requests, they should all be stopped here
the object is also responsible for clearing the loading flag from it's state if it is currently active failing to do so will trigger a fatal error
object might be started again afterwards (start) or destroyed (destroy) this is not known yet at this point
called after start or restart
can be called to tell the object that it should recover from an error and resume will have no effect if no retryable error is currently associated with the object
will set validate and then set the specified option(s) to the provided value(s) after validation
NOTE: if multiple options are used, will return false if at least one value is not valid values are applied individually however, so one option might be set even if the value for another is invalid
Optionalv: anyOptionalflags: ObjectEFlagsby default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that limit to be increased. Set to zero for unlimited.
Sets the objName and objType of the Object reverts to the default ones if no arguments are given
OptionalobjType: stringOptionalobjName: stringReturns a string representation of an object.
update bounds
will set validate value(s) for the specified option(s)
NOTE: if multiple options are used, will return false if at least one value is not valid
Optionalv: anyOptionalflags: ObjectEFlagswhen using custom getters/setters (via _get/_set) in options, the values of options can change
without .set being called - or there might not even be a setter for readonly options;
for example, if the getter simply returns the value of a member variable
this variable could be modified directly.
In this case, events such as optionChanged would not be fired, and listeners would not be informed about the change.
To account for such cases, the methods willUpdateOptions and didUpdateOptions should be called directly BEFORE and AFTER
actions that might potentially change values of options.
the correct events will then automatically be triggered when calling didUpdateOptions.
if the options that could change are known, they can be supplied via the optional parameter. This provides a small performance gain in most situations.
IMPORTANT: methods must be called in balance; e.g. for each call to willUpdateOptions, you must call didUpdateOptions exactly once.
Optionaloptions: string | string[]StaticguardStaticlistenerStaticset
layer displaying a DirectionalLine in contrast to a normal line layer, each point on the line has an associated direction: up or down depending on the direction, a different color is used to draw the respective point