@oracle/oraclejet-webdriver 10.0.8

package/elements/oj-thematic-map/OjThematicMapBase.ts

@@ -0,0 +1,777 @@
+import {OjWebElement} from "../";
+
+/**
+ * This is the base class for OjThematicMap, and is generated from
+ * the component metadata.  Do not put overrides in here as the
+ * contents are meant to be replaced by the generated functions.
+ * Put overrides into the component's default class, found in
+ * index.ts.
+ */
+export class OjThematicMapBase extends OjWebElement {
+  /**
+   * Gets the value of "animationDuration" property.
+   * The duration of the animations in milliseconds. See the Help documentation for more information.
+   * @return The value of "animationDuration" property.
+   */
+  public getAnimationDuration(): Promise<number> {
+    return this.getProperty<number>("animationDuration");
+  }
+
+  /**
+   * Gets the value of "animationOnDisplay" property.
+   * Specifies the animation that is shown on initial display.
+   * @return The value of "animationOnDisplay" property.
+   */
+  public getAnimationOnDisplay(): Promise<string> {
+    return this.getProperty<string>("animationOnDisplay");
+  }
+
+  /**
+   * Gets the value of "areaData" property.
+   * Specifies the DataProvider for the areas of the thematic map. See the Help documentation for more information.
+   * @return The value of "areaData" property.
+   */
+  public getAreaData(): Promise<object|null> {
+    return this.getProperty<object|null>("areaData");
+  }
+
+  /**
+   * Gets the value of "areas" property.
+   * An array of objects that define area data layers. Also accepts a Promise for deferred data rendering. See the Help documentation for more information.
+   * @return The value of "areas" property.
+   */
+  public getAreas(): Promise<Array<OjThematicMapBase.Areas>|null|null> {
+    return this.getProperty<Array<OjThematicMapBase.Areas>|null|null>("areas");
+  }
+
+  /**
+   * Gets the value of "as" property.
+   * An alias for the '$current' context variable passed to slot content for the areaTemplate, markerTemplate, or linkTemplate slots.
+   * @return The value of "as" property.
+   */
+  public getAs(): Promise<string> {
+    return this.getProperty<string>("as");
+  }
+
+  /**
+   * Gets the value of "focusRenderer" property.
+   * An optional callback function to update the data item in response to changes in keyboard focus state. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.
+   * @return The value of "focusRenderer" property.
+   */
+  public getFocusRenderer(): Promise<null|null> {
+    return this.getProperty<null|null>("focusRenderer");
+  }
+
+  /**
+   * Sets the value of "hiddenCategories" property.
+   * An array of category strings used for filtering. Data items matching categories in this array will be filtered.
+   * @param hiddenCategories The value to set for "hiddenCategories"
+   */
+  public changeHiddenCategories(hiddenCategories: Array<string>): Promise<void> {
+    return this.setProperty<Array<string>>("hiddenCategories", hiddenCategories);
+  }
+
+  /**
+   * Gets the value of "hiddenCategories" property.
+   * An array of category strings used for filtering. Data items matching categories in this array will be filtered.
+   * @return The value of "hiddenCategories" property.
+   */
+  public getHiddenCategories(): Promise<Array<string>> {
+    return this.getProperty<Array<string>>("hiddenCategories");
+  }
+
+  /**
+   * Gets the value of "highlightMatch" property.
+   * The matching condition for the highlightedCategories property. See the Help documentation for more information.
+   * @return The value of "highlightMatch" property.
+   */
+  public getHighlightMatch(): Promise<string> {
+    return this.getProperty<string>("highlightMatch");
+  }
+
+  /**
+   * Sets the value of "highlightedCategories" property.
+   * An array of category strings used for highlighting. Data items matching categories in this array will be highlighted.
+   * @param highlightedCategories The value to set for "highlightedCategories"
+   */
+  public changeHighlightedCategories(highlightedCategories: Array<string>): Promise<void> {
+    return this.setProperty<Array<string>>("highlightedCategories", highlightedCategories);
+  }
+
+  /**
+   * Gets the value of "highlightedCategories" property.
+   * An array of category strings used for highlighting. Data items matching categories in this array will be highlighted.
+   * @return The value of "highlightedCategories" property.
+   */
+  public getHighlightedCategories(): Promise<Array<string>> {
+    return this.getProperty<Array<string>>("highlightedCategories");
+  }
+
+  /**
+   * Gets the value of "hoverBehavior" property.
+   * Defines the behavior applied when hovering over data items.
+   * @return The value of "hoverBehavior" property.
+   */
+  public getHoverBehavior(): Promise<string> {
+    return this.getProperty<string>("hoverBehavior");
+  }
+
+  /**
+   * Gets the value of "hoverRenderer" property.
+   * An optional callback function to update the node in response to changes in hover state. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.
+   * @return The value of "hoverRenderer" property.
+   */
+  public getHoverRenderer(): Promise<null|null> {
+    return this.getProperty<null|null>("hoverRenderer");
+  }
+
+  /**
+   * Gets the value of "initialZooming" property.
+   * Specifies whether the map will zoom to fit the data objects on initial render.
+   * @return The value of "initialZooming" property.
+   */
+  public getInitialZooming(): Promise<string> {
+    return this.getProperty<string>("initialZooming");
+  }
+
+  /**
+   * Gets the value of "isolatedItem" property.
+   * The id for the isolated area of this area data layer. If set, only the isolated area will be displayed.
+   * @return The value of "isolatedItem" property.
+   */
+  public getIsolatedItem(): Promise<any> {
+    return this.getProperty<any>("isolatedItem");
+  }
+
+  /**
+   * Gets the value of "labelDisplay" property.
+   * Specifies how labels for this layer should be displayed.
+   * @return The value of "labelDisplay" property.
+   */
+  public getLabelDisplay(): Promise<string> {
+    return this.getProperty<string>("labelDisplay");
+  }
+
+  /**
+   * Gets the value of "labelType" property.
+   * Specifies which type of map labels to display.
+   * @return The value of "labelType" property.
+   */
+  public getLabelType(): Promise<string> {
+    return this.getProperty<string>("labelType");
+  }
+
+  /**
+   * Gets the value of "linkData" property.
+   * Specifies the DataProvider for the links of the thematic map. See the Help documentation for more information.
+   * @return The value of "linkData" property.
+   */
+  public getLinkData(): Promise<object|null> {
+    return this.getProperty<object|null>("linkData");
+  }
+
+  /**
+   * Gets the value of "links" property.
+   * An array of objects that define the map links. Also accepts a Promise for deferred data rendering. See the Help documentation for more information.
+   * @return The value of "links" property.
+   */
+  public getLinks(): Promise<Array<OjThematicMapBase.Links>|null|null> {
+    return this.getProperty<Array<OjThematicMapBase.Links>|null|null>("links");
+  }
+
+  /**
+   * Gets the value of "mapProvider" property.
+   * An object defining a custom map.
+   * @return The value of "mapProvider" property.
+   */
+  public getMapProvider(): Promise<OjThematicMapBase.MapProvider> {
+    return this.getProperty<OjThematicMapBase.MapProvider>("mapProvider");
+  }
+
+  /**
+   * Gets the value of "markerData" property.
+   * Specifies the DataProvider for the markers of the thematic map. See the Help documentation for more information.
+   * @return The value of "markerData" property.
+   */
+  public getMarkerData(): Promise<object|null> {
+    return this.getProperty<object|null>("markerData");
+  }
+
+  /**
+   * Gets the value of "markerZoomBehavior" property.
+   * Specifies marker behavior on zoom.
+   * @return The value of "markerZoomBehavior" property.
+   */
+  public getMarkerZoomBehavior(): Promise<string> {
+    return this.getProperty<string>("markerZoomBehavior");
+  }
+
+  /**
+   * Gets the value of "markers" property.
+   * An array of objects that define marker data layers. Also accepts a Promise for deferred data rendering. See the Help documentation for more information.
+   * @return The value of "markers" property.
+   */
+  public getMarkers(): Promise<Array<OjThematicMapBase.Markers>|null|null> {
+    return this.getProperty<Array<OjThematicMapBase.Markers>|null|null>("markers");
+  }
+
+  /**
+   * Gets the value of "maxZoom" property.
+   * Specifies the maximum zoom level for this element. Must be greater than or equal to 1.0. See the Help documentation for more information.
+   * @return The value of "maxZoom" property.
+   */
+  public getMaxZoom(): Promise<number> {
+    return this.getProperty<number>("maxZoom");
+  }
+
+  /**
+   * Gets the value of "panning" property.
+   * Specifies whether element panning is allowed.
+   * @return The value of "panning" property.
+   */
+  public getPanning(): Promise<string> {
+    return this.getProperty<string>("panning");
+  }
+
+  /**
+   * Gets the value of "renderer" property.
+   * An optional callback function to stamp custom SVG elements for a data layer. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.
+   * @return The value of "renderer" property.
+   */
+  public getRenderer(): Promise<null|null> {
+    return this.getProperty<null|null>("renderer");
+  }
+
+  /**
+   * Sets the value of "selection" property.
+   * An array of strings containing the ids of the selected data items.
+   * @param selection The value to set for "selection"
+   */
+  public changeSelection(selection: Array<any>): Promise<void> {
+    return this.setProperty<Array<any>>("selection", selection);
+  }
+
+  /**
+   * Gets the value of "selection" property.
+   * An array of strings containing the ids of the selected data items.
+   * @return The value of "selection" property.
+   */
+  public getSelection(): Promise<Array<any>> {
+    return this.getProperty<Array<any>>("selection");
+  }
+
+  /**
+   * Gets the value of "selectionMode" property.
+   * Specifies the selection mode.
+   * @return The value of "selectionMode" property.
+   */
+  public getSelectionMode(): Promise<string> {
+    return this.getProperty<string>("selectionMode");
+  }
+
+  /**
+   * Gets the value of "selectionRenderer" property.
+   * An optional callback function to update the data item in response to changes in selection state. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.
+   * @return The value of "selectionRenderer" property.
+   */
+  public getSelectionRenderer(): Promise<null|null> {
+    return this.getProperty<null|null>("selectionRenderer");
+  }
+
+  /**
+   * Gets the value of "styleDefaults" property.
+   * An object defining the style defaults for this thematic map. See the Help documentation for more information.
+   * @return The value of "styleDefaults" property.
+   */
+  public getStyleDefaults(): Promise<OjThematicMapBase.StyleDefaults> {
+    return this.getProperty<OjThematicMapBase.StyleDefaults>("styleDefaults");
+  }
+
+  /**
+   * Gets the value of "tooltip" property.
+   * An object containing an optional callback function for tooltip customization.
+   * @return The value of "tooltip" property.
+   */
+  public getTooltip(): Promise<OjThematicMapBase.Tooltip> {
+    return this.getProperty<OjThematicMapBase.Tooltip>("tooltip");
+  }
+
+  /**
+   * Gets the value of "tooltipDisplay" property.
+   * Specifies the tooltip behavior of the thematic map.
+   * @return The value of "tooltipDisplay" property.
+   */
+  public getTooltipDisplay(): Promise<string> {
+    return this.getProperty<string>("tooltipDisplay");
+  }
+
+  /**
+   * Gets the value of "touchResponse" property.
+   * Specifies configuration options for touch and hold delays on mobile devices. See the Help documentation for more information.
+   * @return The value of "touchResponse" property.
+   */
+  public getTouchResponse(): Promise<string> {
+    return this.getProperty<string>("touchResponse");
+  }
+
+  /**
+   * Gets the value of "trackResize" property.
+   * Defines whether the element will automatically render in response to changes in size. See the Help documentation for more information.
+   * @return The value of "trackResize" property.
+   */
+  public getTrackResize(): Promise<string> {
+    return this.getProperty<string>("trackResize");
+  }
+
+  /**
+   * Gets the value of "translations" property.
+   * A collection of translated resources from the translation bundle, or null if this component has no resources.
+   * @return The value of "translations" property.
+   */
+  public getTranslations(): Promise<OjThematicMapBase.Translations|null> {
+    return this.getProperty<OjThematicMapBase.Translations|null>("translations");
+  }
+
+  /**
+   * Gets the value of "zooming" property.
+   * Specifies whether element zooming is allowed.
+   * @return The value of "zooming" property.
+   */
+  public getZooming(): Promise<string> {
+    return this.getProperty<string>("zooming");
+  }
+
+}
+
+namespace OjThematicMapBase {
+  export interface Areas {
+    /**
+     * An array of category strings corresponding to this area. This allows highlighting and filtering of areas.
+     */
+    "categories": Array<string>;
+    /**
+     * The area color.
+     */
+    "color": string;
+    /**
+     * The identifier for this area. The id should be set by the application if the DataProvider is not being used. The row key will be used as id in the case.
+     */
+    "id": any;
+    /**
+     * Text used for the area's label.
+     */
+    "label": string;
+    /**
+     * The CSS style defining the label style for this area. The following style properties are supported: color, cursor, fontFamily, fontSize, fontStyle, fontWeight, textDecoration.
+     */
+    "labelStyle": object;
+    /**
+     * An identifier corresponding to a Feature provided in the mapProvider geo object that this area is associated with.
+     */
+    "location": string;
+    /**
+     * The area opacity.
+     */
+    "opacity": number;
+    /**
+     * Specifies whether or not the area will be selectable.
+     */
+    "selectable": string;
+    /**
+     * The text that displays in the area's tooltip.
+     */
+    "shortDesc": string;
+    /**
+     * The CSS style class defining the style of the area.
+     */
+    "svgClassName": string;
+    /**
+     * The CSS style object defining the style of the area. Only SVG CSS style properties are supported.
+     */
+    "svgStyle": object;
+  }
+  export interface Links {
+    /**
+     * An array of category strings corresponding to this link. This allows highlighting and filtering of links.
+     */
+    "categories": Array<string>;
+    /**
+     * The link color.
+     */
+    "color": string;
+    /**
+     * An object used to determine the end point of the link.
+     */
+    "endLocation": OjThematicMapBase.LinksEndLocation;
+    /**
+     * The identifier for this link. The id should be set by the application if the DataProvider is not being used. The row key will be used as id in the case.
+     */
+    "id": any;
+    /**
+     * Specifies whether or not the link will be selectable.
+     */
+    "selectable": string;
+    /**
+     * The text that displays in the links's tooltip.
+     */
+    "shortDesc": string;
+    /**
+     * An object used to determine the start point of the link.
+     */
+    "startLocation": OjThematicMapBase.LinksStartLocation;
+    /**
+     * The CSS style class defining the style of the link.
+     */
+    "svgClassName": string;
+    /**
+     * The CSS style object defining the style of the link. Only SVG CSS style properties are supported.
+     */
+    "svgStyle": object;
+    /**
+     * The link width in pixels.
+     */
+    "width": number;
+  }
+  export interface LinksEndLocation {
+    /**
+     * The marker or area id to be used as the end point.
+     */
+    "id": any;
+    /**
+     * An identifier corresponding to a Feature provided in the mapProvider geo object to be used as the end point.
+     */
+    "location": string;
+    /**
+     * The x coordinate which can represent latitude of the end point.
+     */
+    "x": number;
+    /**
+     * The y coordinate which can represent longitude of the end point.
+     */
+    "y": number;
+  }
+  export interface LinksStartLocation {
+    /**
+     * The marker id to be used as the start point.
+     */
+    "id": any;
+    /**
+     * An identifier corresponding to a Feature provided in the mapProvider geo object to be used as the start point.
+     */
+    "location": string;
+    /**
+     * The x coordinate which can represent latitude of the start point.
+     */
+    "x": number;
+    /**
+     * The y coordinate which can represent longitude of the start point.
+     */
+    "y": number;
+  }
+  export interface MapProvider {
+    /**
+     * An object defining a custom area's coordinates and "properties" object. See the Help documentation for more information.
+     */
+    "geo": object;
+    /**
+     * An object specifying "properties" object keys to use for custom area id and label mappings.
+     */
+    "propertiesKeys": OjThematicMapBase.MapProviderPropertiesKeys;
+  }
+  export interface MapProviderPropertiesKeys {
+    /**
+     * The required name of the "properties" key to use as the location id that will map a data item to a map area.
+     */
+    "id": string;
+    /**
+     * The optional name of the "properties" key to use for rendering area labels when labelType is set to "long".
+     */
+    "longLabel": string;
+    /**
+     * The optional name of the "properties" key to use for rendering area labels when labelType is set to "short".
+     */
+    "shortLabel": string;
+  }
+  export interface Markers {
+    /**
+     * The marker border color.
+     */
+    "borderColor": string;
+    /**
+     * The marker border style.
+     */
+    "borderStyle": string;
+    /**
+     * The marker border width in pixels.
+     */
+    "borderWidth": number;
+    /**
+     * An array of category strings corresponding to this marker. This allows highlighting and filtering of markers.
+     */
+    "categories": Array<string>;
+    /**
+     * The marker color.
+     */
+    "color": string;
+    /**
+     * The pixel height for this marker. Note that this attribute will be ignored if a value is provided to calculate marker sizes.
+     */
+    "height": number;
+    /**
+     * The identifier for this marker. The id should be set by the application if the DataProvider is not being used. The row key will be used as id in the case.
+     */
+    "id": any;
+    /**
+     * Text used for the marker's label.
+     */
+    "label": string;
+    /**
+     * Determines the label position relative to the marker.
+     */
+    "labelPosition": string;
+    /**
+     * The CSS style object defining the style of the marker. The following style properties are supported: color, cursor, fontFamily, fontSize, fontStyle, fontWeight, textDecoration.
+     */
+    "labelStyle": object;
+    /**
+     * An identifier corresponding to a Feature provided in the mapProvider geo object that this marker is associated with.
+     */
+    "location": string;
+    /**
+     * The marker opacity.
+     */
+    "opacity": number;
+    /**
+     * The angle to rotate the marker in clockwise degrees around the marker center.
+     */
+    "rotation": number;
+    /**
+     * Specifies whether or not the marker will be selectable.
+     */
+    "selectable": string;
+    /**
+     * Specifies the shape of a marker. Can take the name of a built-in shape or the SVG path commands for a custom shape.
+     */
+    "shape": string;
+    /**
+     * The text that displays in the area's tooltip.
+     */
+    "shortDesc": string;
+    /**
+     * Specifies an URI specifying the location of the image resource to use for the marker instead of a built-in shape. The shape attribute is ignored if the source image is defined.
+     */
+    "source": string;
+    /**
+     * An optional URI specifying the location of the hover image resource. If not defined, the source image will be used.
+     */
+    "sourceHover": string;
+    /**
+     * An optional URI specifying the location of the selected image resource on hover. If not defined, the sourceSelected image will be used. If sourceSelected is not defined, then the source image will be used.
+     */
+    "sourceHoverSelected": string;
+    /**
+     * An optional URI specifying the location of the selected image. If not defined, the source image will be used.
+     */
+    "sourceSelected": string;
+    /**
+     * The CSS style class defining the style of the marker.
+     */
+    "svgClassName": string;
+    /**
+     * The CSS style object defining the style of the marker. Only SVG CSS style properties are supported.
+     */
+    "svgStyle": object;
+    /**
+     * A data value used to calculate the marker dimensions based on the range of all the data values and the element size. Markers with negative or zero data values will not be rendered. If specified, this value takes precedence over the width and height attributes.
+     */
+    "value": number;
+    /**
+     * The pixel width for this marker. Note that this attribute will be ignored if a value is provided to calculate marker.
+     */
+    "width": number;
+    /**
+     * The x coordinate of the marker transformed using the map projection, which can be null if location is set instead.
+     */
+    "x": number;
+    /**
+     * The y coordinate of the marker transformed using the map projection, which can be null if location is set instead.
+     */
+    "y": number;
+  }
+  export interface StyleDefaults {
+    /**
+     * The CSS style object defining the style of the area layer areas.
+     */
+    "areaSvgStyle": object;
+    /**
+     * An object defining the default styles for data areas.
+     */
+    "dataAreaDefaults": OjThematicMapBase.StyleDefaultsDataAreaDefaults;
+    /**
+     * An object defining the default styles for data markers.
+     */
+    "dataMarkerDefaults": OjThematicMapBase.StyleDefaultsDataMarkerDefaults;
+    /**
+     * Specifies initial hover delay in milliseconds for highlighting data items.
+     */
+    "hoverBehaviorDelay": number;
+    /**
+     * The CSS style object defining the style of the area layer labels.
+     */
+    "labelStyle": object;
+    /**
+     * An object defining the default styles for data links.
+     */
+    "linkDefaults": OjThematicMapBase.StyleDefaultsLinkDefaults;
+  }
+  export interface StyleDefaultsDataAreaDefaults {
+    /**
+     * The area stroke color for the area data layer.
+     */
+    "borderColor": string;
+    /**
+     * The hover data area border color.
+     */
+    "hoverColor": string;
+    /**
+     * The inner selected data area border color.
+     */
+    "selectedInnerColor": string;
+    /**
+     * The outer selected data area border color.
+     */
+    "selectedOuterColor": string;
+  }
+  export interface StyleDefaultsDataMarkerDefaults {
+    /**
+     * The border color.
+     */
+    "borderColor": string;
+    /**
+     * The border style.
+     */
+    "borderStyle": string;
+    /**
+     * The border width in pixels.
+     */
+    "borderWidth": number;
+    /**
+     * The fill color of a marker.
+     */
+    "color": string;
+    /**
+     * The default marker pixel height.
+     */
+    "height": number;
+    /**
+     * The CSS style object defining the style of the marker label.
+     */
+    "labelStyle": object;
+    /**
+     * The default marker opacity.
+     */
+    "opacity": number;
+    /**
+     * The default marker shape. Can take the name of a built-in shape or the SVG path commands for a custom shape.
+     */
+    "shape": string;
+    /**
+     * The default marker pixel width.
+     */
+    "width": number;
+  }
+  export interface StyleDefaultsLinkDefaults {
+    /**
+     * The stroke color for links.
+     */
+    "color": string;
+    /**
+     * The stroke width for links in pixels.
+     */
+    "width": number;
+  }
+  export interface Tooltip {
+  }
+  export interface Translations {
+    /**
+     * Used to describe the areas map layer for accessibility.
+     */
+    "areasRegion": string;
+    /**
+     * Used to describe the data visualization type for accessibility.
+     */
+    "componentName": string;
+    /**
+     * Used to display a label and its value.
+     */
+    "labelAndValue": string;
+    /**
+     * Text shown for clearing multiple selection on touch devices.
+     */
+    "labelClearSelection": string;
+    /**
+     * Used to display a count out of a total.
+     */
+    "labelCountWithTotal": string;
+    /**
+     * Label for data visualizations used for accessibility.
+     */
+    "labelDataVisualization": string;
+    /**
+     * Text shown when the component receives invalid data.
+     */
+    "labelInvalidData": string;
+    /**
+     * Text shown when the component receives no data.
+     */
+    "labelNoData": string;
+    /**
+     * Used to describe the links map layer for accessibility.
+     */
+    "linksRegion": string;
+    /**
+     * Used to describe the markers map layer for accessibility.
+     */
+    "markersRegion": string;
+    /**
+     * Used to describe the collapsed state for accessibility.
+     */
+    "stateCollapsed": string;
+    /**
+     * Used to describe a drillable object for accessibility.
+     */
+    "stateDrillable": string;
+    /**
+     * Used to describe the expanded state for accessibility.
+     */
+    "stateExpanded": string;
+    /**
+     * Used to describe the hidden state for accessibility.
+     */
+    "stateHidden": string;
+    /**
+     * Used to describe the isolated state for accessibility.
+     */
+    "stateIsolated": string;
+    /**
+     * Used to describe the maximized state for accessibility.
+     */
+    "stateMaximized": string;
+    /**
+     * Used to describe the minimized state for accessibility.
+     */
+    "stateMinimized": string;
+    /**
+     * Used to describe the selected state for accessibility.
+     */
+    "stateSelected": string;
+    /**
+     * Used to describe the unselected state for accessibility.
+     */
+    "stateUnselected": string;
+    /**
+     * Used to describe the visible state for accessibility.
+     */
+    "stateVisible": string;
+  }
+}