@vcmap/core
    Preparing search index...

    Type Alias LayerOptions

    LayerOptions: VcsObjectOptions & {
        activeOnStartup?: boolean;
        allowPicking?: boolean;
        copyright?: CopyrightOptions;
        datasourceId?: string;
        exclusiveGroups?: (string | symbol)[];
        extent?: ExtentOptions;
        featureProvider?:
            | AbstractFeatureProvider
            | AbstractAttributeProvider
            | AbstractFeatureProviderOptions
            | AbstractAttributeProviderOptions;
        headers?: Record<string, string>;
        hiddenObjectIds?: string[];
        ignoreMapLayerTypes?: boolean;
        mapNames?: string[];
        url?: string | Record<string, string>;
        zIndex?: number;
    }

    Type Declaration

    • OptionalactiveOnStartup?: boolean

      if true the layer will be activated on initialization

    • OptionalallowPicking?: boolean

      whether to allow picking on this layer

    • Optionalcopyright?: CopyrightOptions
    • OptionaldatasourceId?: string

      Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.

    • OptionalexclusiveGroups?: (string | symbol)[]
    • Optionalextent?: ExtentOptions

      metadata on the data extent of the layer.

    • OptionalfeatureProvider?:
          | AbstractFeatureProvider
          | AbstractAttributeProvider
          | AbstractFeatureProviderOptions
          | AbstractAttributeProviderOptions

      An optional feature or attribute provider to provide or augment features on click events.

    • Optionalheaders?: Record<string, string>

      Optional Request Headers which will be sent with each request.

    • OptionalhiddenObjectIds?: string[]

      an array of building ids which should be hidden if this layer is active

    • OptionalignoreMapLayerTypes?: boolean

      if true, the layer types of the map will be ignored when checking if the layer is supported

    • OptionalmapNames?: string[]

      the map names on which this layer is shown, all if empty or undefined

    • Optionalurl?: string | Record<string, string>
    • OptionalzIndex?: number

      zIndex of this layer

    Settings

    Member Visibility