@magiclane/maps-sdk
    Preparing search index...

    Class LandmarkBrowseSessionSettings

    Used in specifying the settings of a LandmarkBrowseSession

    Index

    Constructors

    constructor

    Properties

    categoryIdFilter coordinates descendingOrder nameFilter orderBy

    Methods

    equals toJson fromJson

    Constructors

    • Parameters

      • __namedParameters: {
            categoryIdFilter?: number;
            coordinates?: Coordinates;
            descendingOrder?: boolean;
            nameFilter?: string;
            orderBy?: LandmarkOrder;
        } = {}

      Returns LandmarkBrowseSessionSettings

    Properties

    categoryIdFilter: number

    Specify the category filter. By default it is LandmarkStore.invalidLandmarkCategId.

    coordinates: Coordinates

    Coordinates relative to which the order by distance is made in case of LandmarkOrder.distance

    descendingOrder: boolean

    Specify if descending order is desired. By default it is ascending.

    nameFilter: string

    Specify the name filter. By default it is empty.

    orderBy: LandmarkOrder

    Specify the kind of order desired. By default the landmarks are ordered by name.

    Methods

    • Returns Record<string, any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods