Type class
StockLegend is a legend of StockPanel.
Inheritance
StockLegend extends AmLegend.
StockLegend is not extended by any other symbol.
Properties
|
valueTextComparing # |
Type Default The text which will be displayed in the value portion of the legend when graph is comparable and at least one dataSet is selected for comparing. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents.value/open/close/low/high]], [[description]]. |
|---|---|
|
valueTextRegular # |
Type Default The text which will be displayed in the value portion of the legend. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents]], [[description]]. |
|
align # |
Type Default Inherited from Alignment of legend entries. Possible values are: "left", "center", "right". |
|
autoMargins # |
Type Default Inherited from Used if chart is Serial or XY. In case true, margins of the legend are adjusted and made equal to chart's margins. |
|
backgroundAlpha # |
Type Default Inherited from Opacity of legend's background. Value range is 0 - 1 |
|
backgroundColor # |
Type Default Inherited from Background color. You should set backgroundAlpha to >0 vallue in order background to be visible. |
|
borderAlpha # |
Type Default Inherited from Opacity of chart's border. Value range is 0 - 1. |
|
borderColor # |
Type Default Inherited from Color of legend's border. You should set borderAlpha >0 in order border to be visible. |
|
bottom # |
Type Inherited from In case legend position is set to "absolute", you can set distance from bottom of the chart, in pixels. |
|
color # |
Type Inherited from Text color. Will use chart's color if not set. |
|
data # |
Type Inherited from This can be used by AmMap only. You can pass array of objects with title, color, markerType values, for example: [{title: "One", color: "#3366CC"},{title: "Two", color: "#FFCC33"}] |
|
equalWidths # |
Type Default Inherited from Specifies if each of legend entry should be equal to the most wide entry. Won't look good if legend has more than one line. |
|
fontSize # |
Type Inherited from Font size. Will use chart's font size if not set. |
|
horizontalGap # |
Type Default Inherited from Horizontal space between legend item and left/right border. |
|
labelText # |
Type Default Inherited from The text which will be displayed in the legend. Tag [[title]] will be replaced with the title of the graph. |
|
left # |
Type Inherited from In case legend position is set to "absolute", you can set distance from left side of the chart, in pixels. |
|
marginBottom # |
Type Default Inherited from Bottom margin. |
|
marginLeft # |
Type Default Inherited from Left margin. This property will be ignored if chart is Serial or XY and autoMargins property of the legend is true (default). |
|
marginRight # |
Type Default Inherited from Right margin. This property will be ignored if chart is Serial or XY and autoMargins property of the legend is true (default). |
|
marginTop # |
Type Default Inherited from Top margin. |
|
markerBorderAlpha # |
Type Default Inherited from Marker border opacity. |
|
markerBorderColor # |
Type Inherited from Marker border color. If not set, will use the same color as marker. |
|
markerBorderThickness # |
Type Default Inherited from Thickness of the legend border. The default value (0) means the line will be a "hairline" (1 px). In case marker type is line, this style will be used for line thickness. |
|
markerDisabledColor # |
Type Default Inherited from The color of the disabled marker (when the graph is hidden). |
|
markerLabelGap # |
Type Default Inherited from Space between legend marker and legend text, in pixels. |
|
markerSize # |
Type Default Inherited from Size of the legend marker (key). |
|
markerType # |
Type Default Inherited from Shape of the legend marker (key). Possible values are: "square", "circle", "line", "dashedLine", "triangleUp", "triangleDown", "bubble", "none". |
|
maxColumns # |
Type Inherited from Maximum number of columns in the legend. If Legend's position is set to "right" or "left", maxColumns is automatically set to 1. |
|
position # |
Type Default Inherited from Position of a legend. Possible values are: "bottom", "top", "left", "right" and "absolute". In case "absolute", you should set left and top properties too. (this setting is ignored in Stock charts). In case legend is used with AmMap, position is set to "absolute" automatically. |
|
reversedOrder # |
Type Default Inherited from Specifies whether legend entries should be placed in reversed order. |
|
right # |
Type Inherited from In case legend position is set to "absolute", you can set distance from right side of the chart, in pixels. |
|
rollOverColor # |
Type Default Inherited from Legend item text color on roll-over. |
|
rollOverGraphAlpha # |
Type Default Inherited from When you roll-over the legend entry, all other graphs can reduce their opacity, so that the graph you rolled-over would be distinguished. This style specifies the opacity of the graphs. |
|
showEntries # |
Type Default Inherited from You can use this property to turn all the legend entries off. |
|
spacing # |
Type Default Inherited from Horizontal space between legend items, in pixels. |
|
switchable # |
Type Default Inherited from Whether showing/hiding of graphs by clicking on the legend marker is enabled or not. In case legend is used with AmMap, this is set to false automatically. |
|
switchColor # |
Type Default Inherited from Legend switch color. |
|
switchType # |
Type Default Inherited from Legend switch type (in case the legend is switchable). Possible values are "x" and "v". |
|
textClickEnabled # |
Type Default Inherited from If true, clicking on the text will show/hide balloon of the graph. Otherwise it will show/hide graph/slice, if switchable is set to true. |
|
top # |
Type Inherited from In case legend position is set to "absolute", you can set distance from top of the chart, in pixels. |
|
useMarkerColorForLabels # |
Type Default Inherited from Labels will use marker color if you set this to true. |
|
useMarkerColorForValues # |
Type Default Inherited from Specifies if legend values should be use same color as corresponding markers. |
|
valueAlign # |
Type Default Inherited from Alignment of the value text. Possible values are "left" and "right". |
|
valueText # |
Type Default Inherited from The text which will be displayed in the value portion of the legend. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents]], [[description]]. |
|
valueWidth # |
Type Default Inherited from Width of the value text. |
|
verticalGap # |
Type Default Inherited from Vertical space between legend items also between legend border and first and last legend row. |
| There are 44 inherited items currently hidden from this list. | |
Methods
|
addListener( |
Returns Inherited from Adds event listener to the object. type - string like 'clickLabel' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens |
|---|---|
|
removeListener( |
Returns Inherited from Removes event listener from the legend object. |
| There are 2 inherited items currently hidden from this list. | |
Events
| #clickLabel |
Param Inherited from Dispatched when legend label is clicked. |
|---|---|
| #clickMarker |
Param Inherited from Dispatched when legend marker is clicked. |
| #hideItem |
Param Inherited from Dispatched when user clicks on a legend item marker and hides corresponding object. |
| #rollOutItem |
Param Inherited from Dispatched when user rolls-out of the legend item label (or whole item, if switchable is set to false). |
| #rollOverItem |
Param Inherited from Dispatched when user rolls-over the legend item label (or whole item, if switchable is set to false). |
| #rollOverMarker |
Param Inherited from Dispatched when user rolls-over the legend item marker. |
| #showItem |
Param Inherited from Dispatched when user clicks on a legend item marker and shows corresponding object. |
| There are 7 inherited items currently hidden from this list. | |
Adapters
StockLegend does not have any adapters.