@igo2/geo/lib/filter/shared/ogc-filter.interface.d.ts

IGO Library

import { DOMValue } from '@igo2/common/dom';
import olFormatFilter from 'ol/format/filter/Filter';
import olGeometry from 'ol/geom/Geometry';
import olSource from 'ol/source/Source';
import olSourceVector from 'ol/source/Vector';
import { DataSource } from '../../datasource/shared/datasources/datasource';
import { DataSourceOptions } from '../../datasource/shared/datasources/datasource.interface';
import { OgcFilterOperatorType } from './ogc-filter.enum';
export type OgcFilter = olFormatFilter;
export interface WFSWriteGetFeatureOptions {
    featureNS?: string;
    featurePrefix?: string;
    featureTypes: string[];
    srsName?: string;
    handle?: string;
    outputFormat?: string;
    maxFeatures?: number;
    geometryName?: string;
    propertyNames?: string[];
    startIndex?: number;
    count?: number;
    bbox?: [number, number, number, number];
    filter?: olFormatFilter;
    resultType?: string;
}
export type AnyBaseOgcFilterOptions = OgcFilterConditionsArrayOptions | OgcFilterSpatialOptions | OgcFilterDuringOptions | OgcFilterIsBetweenOptions | OgcFilterEqualToOptions | OgcFilterGreaterLessOptions | OgcFilterIsLikeOptions | OgcFilterIsNullOptions;
export type IgoOgcFilterObject = IgoLogicalArrayOptions | AnyBaseOgcFilterOptions;
export interface OgcFiltersOptions {
    enabled?: boolean;
    editable?: boolean;
    filters?: (IgoLogicalArrayOptions | AnyBaseOgcFilterOptions) & {
        filterid?: string;
    };
    pushButtons?: IgoOgcSelector;
    checkboxes?: IgoOgcSelector;
    radioButtons?: IgoOgcSelector;
    select?: IgoOgcSelector;
    autocomplete?: IgoOgcSelector;
    interfaceOgcFilters?: OgcInterfaceFilterOptions[];
    filtered?: boolean;
    advancedOgcFilters?: boolean;
    geometryName?: string;
    allowedOperatorsType?: OgcFilterOperatorType;
}
export interface IgoOgcSelector {
    groups: SelectorGroup[];
    bundles: OgcSelectorBundle[];
    selectorType: 'pushButton' | 'checkbox' | 'radioButton' | 'select' | 'autocomplete';
    order?: number;
}
export declare const OgcSelectorFields: readonly ["pushButtons", "checkboxes", "radioButtons", "select", "autocomplete"];
export interface SelectorGroup {
    enabled?: boolean;
    title?: string;
    name: string;
    ids?: any;
    computedSelectors?: OgcSelectorBundle[];
}
export interface OgcSelectorBundle {
    id: string;
    title?: string;
    logical?: string;
    vertical?: boolean;
    multiple?: boolean;
    unfiltered?: boolean;
    showChips?: boolean;
    selectors?: OgcPushButton[] | OgcCheckbox[] | OgcRadioButton[] | OgcSelect[] | OgcAutocomplete[];
    domSelectors?: IgoDomSelector[];
    width?: string;
}
export interface OgcPushButton {
    title: string;
    tooltip?: string;
    enabled?: boolean;
    filters: IgoOgcFilterObject;
    color?: string;
}
export interface OgcCheckbox {
    title: string;
    tooltip?: string;
    enabled?: boolean;
    filters: IgoOgcFilterObject;
}
export interface OgcRadioButton {
    title: string;
    tooltip?: string;
    enabled?: boolean;
    filters: IgoOgcFilterObject;
}
export interface OgcSelect {
    title: string;
    tooltip?: string;
    enabled?: boolean;
    filters: IgoOgcFilterObject;
}
export interface OgcAutocomplete {
    title: string;
    tooltip?: string;
    enabled?: boolean;
    filters: IgoOgcFilterObject;
}
export interface OgcFilterableDataSourceOptions extends DataSourceOptions {
    ogcFilters?: OgcFiltersOptions;
    ol?: olSourceVector | olSource;
}
export interface OgcFilterableDataSource extends DataSource {
    options: OgcFilterableDataSourceOptions;
    setOgcFilters(ogcFilters: OgcFiltersOptions, triggerEvent?: boolean): any;
}
export interface IgoLogicalArrayOptions {
    logical: string;
    filters: IgoLogicalArrayOptions | AnyBaseOgcFilterOptions[];
}
export interface IgoDomSelector {
    id: number;
    name: string;
    operator: string;
    propertyName: string;
    domValue: DOMValue[];
}
export interface OgcFilterConditionsArrayOptions {
    conditions: OgcFilter[];
}
export interface OgcFilterSpatialOptions {
    geometryName: string;
    geometry?: olGeometry;
    wkt_geometry?: string;
    extent?: [number, number, number, number];
    srsName?: string;
    active: boolean;
    id: string;
}
export interface OgcFilterAttributeOptions {
    propertyName: string;
    operator: string;
    active?: boolean;
    id?: string;
}
export interface OgcFilterDuringOptions extends OgcFilterAttributeOptions {
    begin: string;
    end?: string;
    step: string;
    restrictToStep?: boolean;
    sliderOptions?: SliderOptionsInterface;
    displayFormat?: string;
    calendarModeYear?: boolean;
    title?: string;
}
export interface OgcFilterIsBetweenOptions extends OgcFilterAttributeOptions {
    lowerBoundary: number;
    upperBoundary: number;
}
export interface OgcFilterEqualToOptions extends OgcFilterAttributeOptions {
    expression: string | number;
    matchCase?: boolean;
}
export interface OgcFilterGreaterLessOptions extends OgcFilterAttributeOptions {
    expression: number;
}
export interface OgcFilterIsLikeOptions extends OgcFilterAttributeOptions {
    pattern: string;
    wildCard?: string;
    singleChar?: string;
    escapeChar?: string;
    matchCase: boolean;
}
export type OgcFilterIsNullOptions = OgcFilterAttributeOptions;
export interface OgcInterfaceFilterOptions {
    active?: boolean;
    begin?: string;
    end?: string;
    step?: string;
    restrictToStep?: boolean;
    sliderOptions?: SliderOptionsInterface;
    displayFormat?: string;
    escapeChar?: string;
    expression?: string | number;
    extent?: [number, number, number, number];
    filterid?: any;
    geometry?: olGeometry;
    geometryName?: string;
    igoSpatialSelector?: string;
    igoSNRC?: string;
    level?: number;
    lowerBoundary?: number;
    matchCase?: boolean;
    operator?: string;
    parentLogical?: string;
    pattern?: string;
    propertyName?: string;
    singleChar?: string;
    srsName?: string;
    upperBoundary?: number;
    wildCard?: string;
    wkt_geometry?: string;
}
export interface SliderOptionsInterface extends OgcFilterDuringOptions {
    interval?: number;
    displayFormat?: string;
    enabled?: boolean;
}
export interface IOgcFiltersOptionSaveable extends Omit<OgcFiltersOptions, 'interfaceOgcFilters'> {
    interfaceOgcFilters: IOgcInterfaceFilterOptions[];
}
export type IOgcInterfaceFilterOptions = Pick<OgcInterfaceFilterOptions, 'propertyName' | 'begin' | 'end' | 'active' | 'operator' | 'expression'>;