cartoframes.viz.source module

class cartoframes.viz.source.Source(data, context=None, bounds=None, schema=None)

Bases: object

:param data (str, GeoFrame,: Dataset ): a table name, SQL query

,GeoJSON file, GeoFrame object or Dataset object.

Parameters:

• context (Context) – A Conext instance. If not provided the context will be automatically obtained from the default context.
• bounds (dict or list) – a dict with east,`north`,`west`,`south` properties, or a list of floats in the following order: [west, south, east, north]. If not provided the bounds will be automatically calculated to fit all features.

Example

Table name.

from cartoframes.auth import set_default_context
from cartoframes.viz import Source

set_default_context(
    base_url='https://your_user_name.carto.com',
    api_key='your api key'
)

Source('table_name')

SQL query.

from cartoframes.auth import set_default_context
from cartoframes.viz import Source

set_default_context(
    base_url='https://your_user_name.carto.com',
    api_key='your api key'
)

Source('SELECT * FROM table_name')

GeoJSON file.

from cartoframes.auth import set_default_context
from cartoframes.viz import Source

set_default_context(
    base_url='https://your_user_name.carto.com',
    api_key='your api key'
)

Source('path/to/file.geojson')

Dataset object.

from cartoframes.auth import set_default_context
from cartoframes.viz import Source
from cartoframes import Dataset

set_default_context(
    base_url='https://your_user_name.carto.com',
    api_key='your api key'
)

ds = Dataset.from_table('table_name')

Source(ds)

Setting the context.

from cartoframes.auth import Context
from cartoframes.viz import Source

context = Context(
    base_url='https://your_user_name.carto.com',
    api_key='your api key'
)

Source('table_name', context)

Setting the bounds.

from cartoframes.auth import set_default_context
from cartoframes.viz import Source

set_default_context(
    base_url='https://your_user_name.carto.com',
    api_key='your api key'
)

bounds = {
    'west': -10,
    'east': 10,
    'north': -10,
    'south': 10
}

Source('table_name', bounds=bounds)

class cartoframes.viz.source.SourceType

GEOJSON = 'GeoJSON'

QUERY = 'Query'