igniteui-webcomponents-charts
Version:
Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.
137 lines (136 loc) • 5.07 kB
TypeScript
import { IgDataTemplate } from "igniteui-webcomponents-core";
import { MarkerType } from "./MarkerType";
import { MarkerOutlineMode } from "./MarkerOutlineMode";
import { MarkerFillMode } from "./MarkerFillMode";
import { IgcSeriesComponent } from "./igc-series-component";
import { MarkerSeries } from "./MarkerSeries";
/**
* Represents the base class for series containing markers.
*
* MarkerSeries represents the base class for series containing markers.
*
* Example:
*/
export declare abstract class IgcMarkerSeriesComponent extends IgcSeriesComponent {
/**
* @hidden
*/
get i(): MarkerSeries;
constructor();
connectedCallback(): void;
disconnectedCallback(): void;
private static _observedAttributesIgcMarkerSeriesComponent;
static get observedAttributes(): string[];
/**
* Returns whether the current series supports visual markers.
*
* `HasMarkers` property is overriden, it returns whether the current series supports visual markers. You can use it like this:
*
* ```ts
* let gotMarkers: boolean = this.series.hasMarkers;
* ```
*/
get hasMarkers(): boolean;
get hasVisibleMarkers(): boolean;
/**
* Gets or sets the marker type for the current series object.
* This property is ignored when the MarkerTemplate property is set
*
* `MarkerType` property gets or sets the marker type for the current series object. For example, you can set it like this:
*
* ```ts
* this.series.markerType = "circle";
* ```
*/
get markerType(): MarkerType;
set markerType(v: MarkerType);
/**
* Represents the resolved marker type for the series.
*/
get actualMarkerType(): MarkerType;
set actualMarkerType(v: MarkerType);
/**
* Gets or sets whether the marker for the current series object should be treated as circular.
*/
get isCustomMarkerCircular(): boolean;
set isCustomMarkerCircular(v: boolean);
/**
* Gets whether the markers for the current series are in circular shape
*/
get effectiveIsMarkerCircular(): boolean;
/**
* Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.
*/
get markerOutlineMode(): MarkerOutlineMode;
set markerOutlineMode(v: MarkerOutlineMode);
/**
* Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection.
*/
get markerFillMode(): MarkerFillMode;
set markerFillMode(v: MarkerFillMode);
/**
* Gets or sets the MarkerTemplate for the current series object.
*
* `MarkerTemplate` property gets or sets the MarkerTemplate for the current series object. For example, you can use it like this:
*/
get markerTemplate(): IgDataTemplate;
set markerTemplate(v: IgDataTemplate);
/**
* Gets or sets thickness of the marker outline
*/
get markerThickness(): number;
set markerThickness(v: number);
/**
* Gets the effective marker template for the current series object.
*
* `ActualMarkerTemplate` property gets the effective marker template for the current series object. You can use it like this:
*/
get actualMarkerTemplate(): IgDataTemplate;
set actualMarkerTemplate(v: IgDataTemplate);
/**
* Gets or sets the brush that specifies how the current series object's marker interiors are painted.
*
* `MarkerBrush` property gets or sets the brush that specifies how the current series object's marker interiors are painted. You can use it like this:
*
* ```ts
* this.series.markerBrush = "red";
* ```
*/
get markerBrush(): string;
set markerBrush(v: string);
/**
* Gets the effective marker brush for the current series object.
*
* `ActualMarkerBrush` property gets the effective marker brush for the current series object. For example, you can use it like this:
*
* ```ts
* let effectiveMarkerBrush: string = this.series.actualMarkerBrush;
*
* ```
*/
get actualMarkerBrush(): string;
set actualMarkerBrush(v: string);
/**
* Gets or sets the brush that specifies how the current series object's marker outlines are painted.
*
* `MarkerOutline` property gets or sets the brush that specifies how the current series object's marker outlines are painted. You can use it like this:
*
* ```ts
* this.series.markerOutline = "red";
* ```
*/
get markerOutline(): string;
set markerOutline(v: string);
/**
* Gets the effective marker outline for the current series object.
*
* `ActualMarkerOutline` property gets the effective marker outline for the current series object. You can use it like this:
*
* ```ts
* let effectiveMarkerOutline: string = this.series.actualMarkerOutline;
*
* ```
*/
get actualMarkerOutline(): string;
set actualMarkerOutline(v: string);
}