Constructor. Pass an instance of WebDriver's WebElement that represents the DOM node on which we"ll perform operations.
The basic WebElement with which this WebElement will work.
Sets the value of dataCursorPosition property.
Specifies the position of the data cursor. Used for synchronizing data cursors across multiple charts. Null if the data cursor is not displayed.
The value to set for dataCursorPosition
Sets the value of hiddenCategories property.
An array of category strings used for filtering. Series or data items with any category matching an item in this array will be filtered.
The value to set for hiddenCategories
Sets the value of highlightedCategories property.
An array of category strings used for highlighting. Series or data items matching categories in this array will be highlighted.
The value to set for highlightedCategories
Schedule a command to find a descendant of this element. If the element cannot be found, a bot.ErrorCode.NO_SUCH_ELEMENT result will be returned by the driver. Unlike other commands, this error cannot be suppressed. In other words, scheduling a command to find an element doubles as an assert that the element is present on the page. To test whether an element is present on the page, use #findElements.
The search criteria for an element may be defined using one of the factories in the By namespace, or as a short-hand By.Hash object. For example, the following two statements are equivalent:
var e1 = element.findElement(By.id('foo'));
var e2 = element.findElement({id:'foo'});
You may also provide a custom locator function, which takes as input this WebDriver instance and returns a WebElement, or a promise that will resolve to a WebElement. For example, to find the first visible link on a page, you could write:
var link = element.findElement(firstVisibleLink);
function firstVisibleLink(element) {
var links = element.findElements(By.tagName('a'));
return promise.filter(links, function(link) {
return links.isDisplayed();
}).then(function(visibleLinks) {
return visibleLinks[0];
});
}
The locator strategy to use when searching for the element.
A WebElement that can be used to issue commands against the located element. If the element is not found, the element will be invalidated and all scheduled commands aborted.
Schedules a command to find all of the descendants of this element that match the given search criteria.
The locator strategy to use when searching for the element.
A promise that will resolve to an array of WebElements.
Gets the value of as property.
An alias for the '$current' context variable passed to slot content for the itemTemplate, seriesTemplate, or groupTemplate slots.
The value of as property.
Since 6.2.0. Set the alias directly on the template element using the data-oj-as attribute instead.
Schedules a command to query for the value of the given attribute of the element. Will return the current value, even if it has been modified after the page has been loaded. More exactly, this method will return the value of the given attribute, unless that attribute is not present, in which case the value of the property with the same name is returned. If neither value is set, null is returned (for example, the 'value' property of a textarea element). The 'style' attribute is converted as best can be to a text representation with a trailing semi-colon. The following are deemed to be 'boolean' attributes and will return either 'true' or null:
async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked, defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate, nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking, selected, spellcheck, truespeed, willvalidate
Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:
The name of the attribute to query.
A promise that will be resolved with the attribute's value. The returned value will always be either a string or null.
Gets the value of comboSeriesOrder property.
Specifies the series render order for combo charts. If set to 'seriesType', the combo chart rendering order between series types will follow a set z-ordering aimed at minimizing overlap: area and line with area series type in the background, then bar series, then line series in the foreground. Series within the same type are rendered in the order presented in the data. If set to 'data', series z-order follows the series order in the data. Note that, series-comparator can be used to change the series order in the data.
The value of comboSeriesOrder property.
Schedules a command to query for the computed style of the element represented by this instance. If the element inherits the named style from its parent, the parent will be queried for its value. Where possible, color values will be converted to their hex representation (e.g. #00ff00 instead of rgb(0, 255, 0)).
Warning: the value returned will be as the browser interprets it, so it may be tricky to form a proper assertion.
The name of the CSS style property to look up.
A promise that will be resolved with the requested CSS value.
Gets the value of dataCursorPosition property.
Specifies the position of the data cursor. Used for synchronizing data cursors across multiple charts. Null if the data cursor is not displayed.
The value of dataCursorPosition property.
Gets the value of drilling property.
Specifies whether drilling is enabled. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). See the Help documentation for more information.
The value of drilling property.
Gets the value of groupComparator property.
A comparator function that determines the ordering of the chart groups when using a DataProvider. If undefined, the group will follow the order in which they are found in the data.
The value of groupComparator property.
Gets the value of groups property.
An array of strings identifying the group labels, or an array of objects specifying group labels and styles. See the Help documentation for more information.
The value of groups property.
Gets the value of hideAndShowBehavior property.
Defines the hide and show behavior that is performed when clicking on a legend item. When data items are hidden, the y axes can be optionally rescaled to fit to the remaining data.
The value of hideAndShowBehavior property.
Gets the value of initialZooming property.
Specifies whether automatic initial zooming is enabled. Only applies to bar, line, area, and combo charts with zoomAndScroll turned on. See the Help documentation for more information.
The value of initialZooming property.
Gets the value of multiSeriesDrilling property.
Specifies whether drilling on chart objects representing multiple series (e.g. other slice and legend item in pie charts) is enabled or not. Multiseries drill event is fired from the other slice and legend item of pieChart.
The value of multiSeriesDrilling property.
Gets the value of otherThreshold property.
Specifies the fraction of the whole pie under which a slice would be aggregated into an "Other" slice. Valid values range from 0 (default) to 1. For example, a value of 0.1 would cause all slices which are less than 10% of the pie to be aggregated into the "Other" slice. Only applies to pie chart.
The value of otherThreshold property.
Get a named property value from this component. This function will wait for the application's busy context to complete before attempting to get the property value.
The name of the property
A Promise that yields a value for the named property.
Returns an object describing an element's location, in pixels relative to the document element, and the element's size in pixels.
Gets the value of seriesComparator property.
A comparator function that determines the ordering of the chart series when using a DataProvider. If undefined, the series will follow the order in which they are found in the data.
The value of seriesComparator property.
Get the shadow root of the current web element.
A promise that will be resolved with the elements shadow root or rejected with NoSuchShadowRootError
Gets the value of sorting property.
Specifies the sorting of the data. It should only be used for pie charts, bar/line/area charts with one series, or stacked bar/area charts. Sorting will not apply when using a hierarchical group axis.
The value of sorting property.
Gets the value of splitDualY property.
Defines whether the plot area is split into two sections, so that sets of data assigned to the different Y-axes appear in different parts of the plot area. Stock charts do not support "off".
The value of splitDualY property.
Gets the value of stackLabelProvider property.
A function that returns a custom stack label. The function takes a context argument, provided by the chart. See the Help documentation for more information.
The value of stackLabelProvider property.
Gets the value of styleDefaults property.
An object defining the default styles for series colors, marker shapes, and other style attributes. Properties specified on this object may be overridden by specifications on the data object.
The value of styleDefaults property.
Gets the value of timeAxisType property.
The type of time axis to display in the chart. Time axis is only supported for Cartesian bar, line, area, stock, box plot, and combo charts. See the Help documentation for more information.
The value of timeAxisType property.
Gets the value of touchResponse property.
Specifies configuration options for touch and hold delays on mobile devices. See the Help documentation for more information.
The value of touchResponse property.
Since 18.0.0. This attribute is deprecated and no longer recommended in the Redwood Design system. The "auto" value behavior will be applied instead.
Gets the value of translations property.
A collection of translated resources from the translation bundle, or null if this component has no resources.
The value of translations property.
Gets the value of valueFormats property.
An object specifying value formatting and tooltip behavior, whose keys generally correspond to the attribute names on the data items.
The value of valueFormats property.
Protected hasCreate a wait condition that is satisfied when the element's DOM has a non-zero size.
The Condition to be used with driver.wait() that's satisfied when the element's DOM has a non-zero size.
Since 11.0.0. Call the appropriate WebElement method to test the size of the element.
Protected hasCreate a wait condition that is satisfid when the element is visible. The condition is satisfied when the element is displayed, as reported by #isDisplayed, and is scrolled into view. This is method is deprecated. Use WebElement.isDisplayed instead to test the display of the element, and scroll it into view if necessary.
Schedules a command to type a sequence on the DOM element represented by this promsieinstance.
Modifier keys (SHIFT, CONTROL, ALT, META) are stateful; once a modifier is processed in the keysequence, that key state is toggled until one of the following occurs:
The modifier key is encountered again in the sequence. At this point the state of the key is toggled (along with the appropriate keyup/down events).
The Key.NULL key is encountered in the sequence. When this key is encountered, all modifier keys current in the down state are released (with accompanying keyup events). The NULL key can be used to simulate common keyboard shortcuts:
element.sendKeys('text was',
Key.CONTROL, 'a', Key.NULL,
'now text is');
// Alternatively:
element.sendKeys('text was',
Key.chord(Key.CONTROL, 'a'),
'now text is');
The end of the keysequence is encountered. When there are no more keys to type, all depressed modifier keys are released (with accompanying keyup events).
If this element is a file input ({@code }), the specified key sequence should specify the path to the file to attach to the element. This is analgous to the user clicking 'Browse...' and entering the path into the file select dialog.
var form = driver.findElement(By.css('form'));
var element = form.findElement(By.css('input[type=file]'));
element.sendKeys('/path/to/file.txt');
form.submit();
For uploads to function correctly, the entered path must reference a file on the browser's machine, not the local machine running this script. When running against a remote Selenium server, a FileDetector may be used to transparently copy files to the remote machine before attempting to upload them in the browser.
Note: On browsers where native keyboard events are not supported (e.g. Firefox on OS X), key events will be synthesized. Special punctionation keys will be synthesized according to a standard QWERTY en-us keyboard layout.
Rest ...varArgs: (string | number | Promise<string | number>)[]The sequence of keys to type. All arguments will be joined into a single sequence.
A promise that will be resolved when all keys have been typed.
Protected setSet a property value on the remote element. This function first waits for the BusyContext to clear before setting the property, then after setting, waits again to ensure that no additional busy states were created due to the property setting.
The property name to set
The value to set for the property
A Promise which resolves when the remote property has been set to the value. Any value returned from the call to set the remote property is returned in the Promise.
Take a screenshot of the visible region encompassed by this element's bounding rectangle.
Optional optScroll: booleanOptional argument that indicates whether the element should be scrolled into view before taking a screenshot. Defaults to false.
A promise that will be resolved to the screenshot as a base-64 encoded PNG.
Returns a Promise that is resolved when the application's busy state reports ready. This method checks only that the application's busy context is ready, and not that the DOM element is actually displayed or has a physical size, such as is the case with #whenReady. Operations which are read-only in nature should call this method prior to execution.
A Promise which is resolved when the page's busy state is ready.
Returns a Promise that is resolved when the element is ready for interaction--it is visible, has a size, and the app's busy context is ready. Operations on the DOM which rely on its physical location and size to be in a "ready" state should use this command, such as clicking, sending keys, locating child elements, and so on.
A Promise that's resolved when all conditions are met.
Static buildThe raw ID.
Optional opt_noLegacy: booleanWhether to exclude the legacy element key.
The element ID for use with WebDriver's wire protocol.
Static equalsCompares two WebElements for equality.
A WebElement.
A WebElement.
A promise that will be resolved to whether the two WebElements are equal.
Static extractExtracts the encoded WebElement ID from the object.
The object to extract the ID from.
the extracted ID.
if the object is not a valid encoded ID.
Static isthe object to test.
whether the object is a valid encoded WebElement ID.
Generated using TypeDoc
This is the base class for oj-chart WebElement, and is generated from the component's metadata. Do not modify these contents since they'll be replaced during the next generation. Put overrides into the WebElements's subclass, OjChart.ts.